all: autogenerated update (2018-01-04)
Update:
- adexchangebuyer2/v2beta1
- bigquerydatatransfer/v1
- books/v1
- classroom/v1
- cloudtasks/v2beta2
- dataflow/v1b3
- firebasedynamiclinks/v1
- iam/v1
diff --git a/abusiveexperiencereport/v1/abusiveexperiencereport-api.json b/abusiveexperiencereport/v1/abusiveexperiencereport-api.json
index d5148a7..f059b04 100644
--- a/abusiveexperiencereport/v1/abusiveexperiencereport-api.json
+++ b/abusiveexperiencereport/v1/abusiveexperiencereport-api.json
@@ -1,29 +1,107 @@
{
- "ownerName": "Google",
- "resources": {
- "violatingSites": {
- "methods": {
- "list": {
- "response": {
- "$ref": "ViolatingSitesResponse"
- },
- "parameterOrder": [],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/xapi.zoo"
+ "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": {
+ "properties": {
+ "enforcementTime": {
+ "description": "The date on which enforcement begins.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "filterStatus": {
+ "enum": [
+ "UNKNOWN",
+ "ON",
+ "OFF",
+ "PAUSED",
+ "PENDING"
],
- "parameters": {},
- "flatPath": "v1/violatingSites",
- "path": "v1/violatingSites",
- "id": "abusiveexperiencereport.violatingSites.list",
- "description": "Lists sites with Abusive Experience Report statuses of \"Failing\"."
+ "description": "The abusive experience enforcement status of the site.",
+ "type": "string",
+ "enumDescriptions": [
+ "N/A.",
+ "Ad filtering is on.",
+ "Ad filtering is off.",
+ "Ad filtering is paused.",
+ "Ad filtering is pending."
+ ]
+ },
+ "underReview": {
+ "description": "Whether the site is currently under review.",
+ "type": "boolean"
+ },
+ "reportUrl": {
+ "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"
+ },
+ "abusiveStatus": {
+ "enum": [
+ "UNKNOWN",
+ "PASSING",
+ "FAILING"
+ ],
+ "description": "The status of the site reviewed for the abusive experiences.",
+ "type": "string",
+ "enumDescriptions": [
+ "Not reviewed.",
+ "Passing.",
+ "Failing."
+ ]
+ }
+ },
+ "id": "SiteSummaryResponse",
+ "description": "Response message for GetSiteSummary.",
+ "type": "object"
+ }
+ },
+ "icons": {
+ "x16": "http://www.google.com/images/icons/product/search-16.gif",
+ "x32": "http://www.google.com/images/icons/product/search-32.gif"
+ },
+ "protocol": "rest",
+ "canonicalName": "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",
+ "ownerName": "Google",
+ "resources": {
"sites": {
"methods": {
"get": {
- "description": "Gets a summary of the abusive experience rating of a site.",
"response": {
"$ref": "SiteSummaryResponse"
},
@@ -31,9 +109,6 @@
"name"
],
"httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/xapi.zoo"
- ],
"parameters": {
"name": {
"pattern": "^sites/[^/]+$",
@@ -43,18 +118,41 @@
"type": "string"
}
},
+ "scopes": [
+ "https://www.googleapis.com/auth/xapi.zoo"
+ ],
"flatPath": "v1/sites/{sitesId}",
"path": "v1/{+name}",
- "id": "abusiveexperiencereport.sites.get"
+ "id": "abusiveexperiencereport.sites.get",
+ "description": "Gets a summary of the abusive experience rating of a site."
+ }
+ }
+ },
+ "violatingSites": {
+ "methods": {
+ "list": {
+ "description": "Lists sites with Abusive Experience Report statuses of \"Failing\".",
+ "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"
}
}
}
},
"parameters": {
"upload_protocol": {
- "location": "query",
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"prettyPrint": {
"location": "query",
@@ -72,25 +170,27 @@
"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",
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query"
- },
- "callback": {
- "description": "JSONP",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"alt": {
+ "description": "Data format for response.",
+ "default": "json",
"enum": [
"json",
"media",
@@ -102,24 +202,22 @@
"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"
+ "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"
+ "type": "string",
+ "location": "query"
},
"pp": {
"description": "Pretty-print response.",
@@ -127,124 +225,26 @@
"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": {
+ "location": "query",
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string"
}
},
"version": "v1",
"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": "",
+ "description": "View Abusive Experience Report data, and get a list of sites that have a significant number of abusive experiences.",
+ "kind": "discovery#restDescription",
"basePath": "",
- "revision": "20171129",
- "documentationLink": "https://developers.google.com/abusive-experience-report/",
"id": "abusiveexperiencereport:v1",
+ "documentationLink": "https://developers.google.com/abusive-experience-report/",
+ "revision": "20171129",
"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": {
- "reportUrl": {
- "description": "A link that leads to a full abusive experience report.",
- "type": "string"
- },
- "reviewedSite": {
- "description": "The name of the site reviewed.",
- "type": "string"
- },
- "lastChangeTime": {
- "description": "The last time that the site changed status.",
- "format": "google-datetime",
- "type": "string"
- },
- "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": {
- "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"
- }
- },
- "id": "SiteSummaryResponse"
- }
- },
- "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": "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"
+ "version_module": true
}
diff --git a/acceleratedmobilepageurl/v1/acceleratedmobilepageurl-api.json b/acceleratedmobilepageurl/v1/acceleratedmobilepageurl-api.json
index e53d80e..bd881b0 100644
--- a/acceleratedmobilepageurl/v1/acceleratedmobilepageurl-api.json
+++ b/acceleratedmobilepageurl/v1/acceleratedmobilepageurl-api.json
@@ -1,4 +1,5 @@
{
+ "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": "",
@@ -7,45 +8,45 @@
"ownerDomain": "google.com",
"name": "acceleratedmobilepageurl",
"batchPath": "batch",
- "revision": "20171202",
- "documentationLink": "https://developers.google.com/amp/cache/",
"id": "acceleratedmobilepageurl:v1",
+ "documentationLink": "https://developers.google.com/amp/cache/",
+ "revision": "20171202",
"title": "Accelerated Mobile Pages (AMP) URL API",
- "ownerName": "Google",
"discoveryVersion": "v1",
+ "ownerName": "Google",
"version_module": true,
"resources": {
"ampUrls": {
"methods": {
"batchGet": {
- "flatPath": "v1/ampUrls:batchGet",
- "path": "v1/ampUrls:batchGet",
- "id": "acceleratedmobilepageurl.ampUrls.batchGet",
- "request": {
- "$ref": "BatchGetAmpUrlsRequest"
- },
- "description": "Returns AMP URL(s) and equivalent\n[AMP Cache URL(s)](/amp/cache/overview#amp-cache-url-format).",
"response": {
"$ref": "BatchGetAmpUrlsResponse"
},
"parameterOrder": [],
"httpMethod": "POST",
- "parameters": {}
+ "parameters": {},
+ "flatPath": "v1/ampUrls:batchGet",
+ "path": "v1/ampUrls:batchGet",
+ "id": "acceleratedmobilepageurl.ampUrls.batchGet",
+ "description": "Returns AMP URL(s) and equivalent\n[AMP Cache URL(s)](/amp/cache/overview#amp-cache-url-format).",
+ "request": {
+ "$ref": "BatchGetAmpUrlsRequest"
+ }
}
}
}
},
"parameters": {
"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"
+ "default": "true",
+ "location": "query"
},
"uploadType": {
"location": "query",
@@ -53,16 +54,12 @@
"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."
- },
- "callback": {
- "type": "string",
- "location": "query",
- "description": "JSONP"
+ "location": "query"
},
"$.xgafv": {
+ "description": "V1 error format.",
"type": "string",
"enumDescriptions": [
"v1 error format",
@@ -72,10 +69,19 @@
"enum": [
"1",
"2"
- ],
- "description": "V1 error format."
+ ]
+ },
+ "callback": {
+ "location": "query",
+ "description": "JSONP",
+ "type": "string"
},
"alt": {
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
"location": "query",
"description": "Data format for response.",
"default": "json",
@@ -84,27 +90,22 @@
"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": {
- "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",
@@ -112,92 +113,31 @@
"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."
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string"
+ },
+ "bearer_token": {
+ "description": "OAuth bearer token.",
+ "type": "string",
+ "location": "query"
}
},
"schemas": {
- "BatchGetAmpUrlsRequest": {
- "description": "AMP URL request for a batch of URLs.",
- "type": "object",
- "properties": {
- "lookupStrategy": {
- "type": "string",
- "enumDescriptions": [
- "FETCH_LIVE_DOC strategy involves live document fetch of URLs not found in\nthe index. Any request URL not found in the index is crawled in realtime\nto validate if there is a corresponding AMP URL. This strategy has higher\ncoverage but with extra latency introduced by realtime crawling. This is\nthe default strategy. Applications using this strategy should set higher\nHTTP timeouts of the API calls.",
- "IN_INDEX_DOC strategy skips fetching live documents of URL(s) not found\nin index. For applications which need low latency use of IN_INDEX_DOC\nstrategy is recommended."
- ],
- "enum": [
- "FETCH_LIVE_DOC",
- "IN_INDEX_DOC"
- ],
- "description": "The lookup_strategy being requested."
- },
- "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",
- "properties": {
- "ampUrls": {
- "type": "array",
- "items": {
- "$ref": "AmpUrl"
- },
- "description": "For each URL in BatchAmpUrlsRequest, the URL response. The response might\nnot be in the same order as URLs in the batch request.\nIf BatchAmpUrlsRequest contains duplicate URLs, AmpUrl is generated\nonly once."
- },
- "urlErrors": {
- "description": "The errors for requested URLs that have no AMP URL.",
- "type": "array",
- "items": {
- "$ref": "AmpUrlError"
- }
- }
- },
- "id": "BatchGetAmpUrlsResponse"
- },
- "AmpUrl": {
- "description": "AMP URL response for a requested URL.",
- "type": "object",
- "properties": {
- "originalUrl": {
- "description": "The original non-AMP URL.",
- "type": "string"
- },
- "ampUrl": {
- "description": "The AMP URL pointing to the publisher's web server.",
- "type": "string"
- },
- "cdnAmpUrl": {
- "description": "The [AMP Cache URL](/amp/cache/overview#amp-cache-url-format) pointing to\nthe cached document in the Google AMP Cache.",
- "type": "string"
- }
- },
- "id": "AmpUrl"
- },
"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",
@@ -207,23 +147,84 @@
"URL_IS_INVALID_AMP"
],
"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."
- ]
+ "type": "string"
},
"originalUrl": {
"description": "The original non-AMP URL.",
"type": "string"
+ },
+ "errorMessage": {
+ "description": "An optional descriptive error message.",
+ "type": "string"
}
},
- "id": "AmpUrlError",
- "description": "AMP URL Error resource for a requested URL that couldn't be found."
+ "id": "AmpUrlError"
+ },
+ "BatchGetAmpUrlsRequest": {
+ "description": "AMP URL request for a batch of URLs.",
+ "type": "object",
+ "properties": {
+ "urls": {
+ "description": "List of URLs to look up for the paired AMP URLs.\nThe URLs are case-sensitive. Up to 50 URLs per lookup\n(see [Usage Limits](/amp/cache/reference/limits)).",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "lookupStrategy": {
+ "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"
+ }
+ },
+ "id": "BatchGetAmpUrlsRequest"
+ },
+ "BatchGetAmpUrlsResponse": {
+ "properties": {
+ "ampUrls": {
+ "description": "For each URL in BatchAmpUrlsRequest, the URL response. The response might\nnot be in the same order as URLs in the batch request.\nIf BatchAmpUrlsRequest contains duplicate URLs, AmpUrl is generated\nonly once.",
+ "type": "array",
+ "items": {
+ "$ref": "AmpUrl"
+ }
+ },
+ "urlErrors": {
+ "description": "The errors for requested URLs that have no AMP URL.",
+ "type": "array",
+ "items": {
+ "$ref": "AmpUrlError"
+ }
+ }
+ },
+ "id": "BatchGetAmpUrlsResponse",
+ "description": "Batch AMP URL response.",
+ "type": "object"
+ },
+ "AmpUrl": {
+ "description": "AMP URL response for a requested URL.",
+ "type": "object",
+ "properties": {
+ "cdnAmpUrl": {
+ "description": "The [AMP Cache URL](/amp/cache/overview#amp-cache-url-format) pointing to\nthe cached document in the Google AMP Cache.",
+ "type": "string"
+ },
+ "originalUrl": {
+ "description": "The original non-AMP URL.",
+ "type": "string"
+ },
+ "ampUrl": {
+ "description": "The AMP URL pointing to the publisher's web server.",
+ "type": "string"
+ }
+ },
+ "id": "AmpUrl"
}
},
"protocol": "rest",
@@ -231,6 +232,5 @@
"x32": "http://www.google.com/images/icons/product/search-32.gif",
"x16": "http://www.google.com/images/icons/product/search-16.gif"
},
- "version": "v1",
- "baseUrl": "https://acceleratedmobilepageurl.googleapis.com/"
+ "version": "v1"
}
diff --git a/adexchangebuyer2/v2beta1/adexchangebuyer2-api.json b/adexchangebuyer2/v2beta1/adexchangebuyer2-api.json
index 598cb2f..82c300d 100644
--- a/adexchangebuyer2/v2beta1/adexchangebuyer2-api.json
+++ b/adexchangebuyer2/v2beta1/adexchangebuyer2-api.json
@@ -1,18 +1,4 @@
{
- "canonicalName": "AdExchangeBuyerII",
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/adexchange.buyer": {
- "description": "Manage your Ad Exchange buyer account configuration"
- }
- }
- }
- },
- "rootUrl": "https://adexchangebuyer.googleapis.com/",
- "ownerDomain": "google.com",
- "name": "adexchangebuyer2",
- "batchPath": "batch",
"title": "Ad Exchange Buyer API II",
"ownerName": "Google",
"resources": {
@@ -20,34 +6,95 @@
"resources": {
"filterSets": {
"methods": {
- "create": {
+ "get": {
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "name"
+ ],
"response": {
"$ref": "FilterSet"
},
+ "parameters": {
+ "name": {
+ "location": "path",
+ "description": "Full name of the resource being requested.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`",
+ "required": true,
+ "type": "string",
+ "pattern": "^bidders/[^/]+/filterSets/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ],
+ "flatPath": "v2beta1/bidders/{biddersId}/filterSets/{filterSetsId}",
+ "id": "adexchangebuyer2.bidders.filterSets.get",
+ "path": "v2beta1/{+name}",
+ "description": "Retrieves the requested filter set for the account with the given account\nID."
+ },
+ "list": {
+ "description": "Lists all filter sets for the account with the given account ID.",
+ "response": {
+ "$ref": "ListFilterSetsResponse"
+ },
"parameterOrder": [
"ownerName"
],
- "httpMethod": "POST",
+ "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": {
+ "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",
+ "pattern": "^bidders/[^/]+$"
+ }
+ },
+ "flatPath": "v2beta1/bidders/{biddersId}/filterSets",
+ "path": "v2beta1/{+ownerName}/filterSets",
+ "id": "adexchangebuyer2.bidders.filterSets.list"
+ },
+ "create": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "ownerName"
+ ],
+ "response": {
+ "$ref": "FilterSet"
+ },
+ "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": {
+ "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/[^/]+$",
- "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"
+ "pattern": "^bidders/[^/]+$"
}
},
"scopes": [
"https://www.googleapis.com/auth/adexchange.buyer"
],
"flatPath": "v2beta1/bidders/{biddersId}/filterSets",
- "path": "v2beta1/{+ownerName}/filterSets",
"id": "adexchangebuyer2.bidders.filterSets.create",
+ "path": "v2beta1/{+ownerName}/filterSets",
"request": {
"$ref": "FilterSet"
},
@@ -77,73 +124,191 @@
"path": "v2beta1/{+name}",
"id": "adexchangebuyer2.bidders.filterSets.delete",
"description": "Deletes the requested filter set from the account with the given account\nID."
- },
- "get": {
- "description": "Retrieves the requested filter set for the account with the given account\nID.",
- "response": {
- "$ref": "FilterSet"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "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"
- },
- "list": {
- "response": {
- "$ref": "ListFilterSetsResponse"
- },
- "parameterOrder": [
- "ownerName"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ],
- "parameters": {
- "ownerName": {
- "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`",
- "required": true,
- "type": "string"
- },
- "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"
- }
- },
- "flatPath": "v2beta1/bidders/{biddersId}/filterSets",
- "path": "v2beta1/{+ownerName}/filterSets",
- "id": "adexchangebuyer2.bidders.filterSets.list",
- "description": "Lists all filter sets for the account with the given account ID."
}
},
"resources": {
+ "nonBillableWinningBids": {
+ "methods": {
+ "list": {
+ "flatPath": "v2beta1/bidders/{biddersId}/filterSets/{filterSetsId}/nonBillableWinningBids",
+ "path": "v2beta1/{+filterSetName}/nonBillableWinningBids",
+ "id": "adexchangebuyer2.bidders.filterSets.nonBillableWinningBids.list",
+ "description": "List all reasons for which winning bids were not billable, with the number\nof bids not billed for each reason.",
+ "response": {
+ "$ref": "ListNonBillableWinningBidsResponse"
+ },
+ "parameterOrder": [
+ "filterSetName"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ],
+ "parameters": {
+ "pageSize": {
+ "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
+ "format": "int32",
+ "type": "integer",
+ "location": "query"
+ },
+ "filterSetName": {
+ "location": "path",
+ "description": "Name of the filter set that should be applied to the requested metrics.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`",
+ "required": true,
+ "type": "string",
+ "pattern": "^bidders/[^/]+/filterSets/[^/]+$"
+ },
+ "pageToken": {
+ "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListNonBillableWinningBidsResponse.nextPageToken\nreturned from the previous call to the nonBillableWinningBids.list\nmethod.",
+ "type": "string",
+ "location": "query"
+ }
+ }
+ }
+ }
+ },
+ "filteredBids": {
+ "methods": {
+ "list": {
+ "description": "List all reasons for which bids were filtered, with the number of bids\nfiltered for each reason.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "filterSetName"
+ ],
+ "response": {
+ "$ref": "ListFilteredBidsResponse"
+ },
+ "parameters": {
+ "filterSetName": {
+ "location": "path",
+ "description": "Name of the filter set that should be applied to the requested metrics.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`",
+ "required": true,
+ "type": "string",
+ "pattern": "^bidders/[^/]+/filterSets/[^/]+$"
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListFilteredBidsResponse.nextPageToken\nreturned from the previous call to the filteredBids.list\nmethod.",
+ "type": "string"
+ },
+ "pageSize": {
+ "location": "query",
+ "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ],
+ "flatPath": "v2beta1/bidders/{biddersId}/filterSets/{filterSetsId}/filteredBids",
+ "id": "adexchangebuyer2.bidders.filterSets.filteredBids.list",
+ "path": "v2beta1/{+filterSetName}/filteredBids"
+ }
+ },
+ "resources": {
+ "creatives": {
+ "methods": {
+ "list": {
+ "response": {
+ "$ref": "ListCreativeStatusBreakdownByCreativeResponse"
+ },
+ "parameterOrder": [
+ "filterSetName",
+ "creativeStatusId"
+ ],
+ "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/[^/]+$"
+ },
+ "creativeStatusId": {
+ "location": "path",
+ "description": "The ID of the creative status for which to retrieve a breakdown by\ncreative.\nSee\n[creative-status-codes](https://developers.google.com/ad-exchange/rtb/downloads/creative-status-codes).",
+ "format": "int32",
+ "required": true,
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListCreativeStatusBreakdownByCreativeResponse.nextPageToken\nreturned from the previous call to the filteredBids.creatives.list\nmethod.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageSize": {
+ "location": "query",
+ "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "flatPath": "v2beta1/bidders/{biddersId}/filterSets/{filterSetsId}/filteredBids/{creativeStatusId}/creatives",
+ "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."
+ }
+ }
+ },
+ "details": {
+ "methods": {
+ "list": {
+ "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": {
+ "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": {
+ "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}/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."
+ }
+ }
+ }
+ }
+ },
"losingBids": {
"methods": {
"list": {
+ "description": "List all reasons for which bids lost in the auction, with the number of\nbids that lost for each reason.",
"httpMethod": "GET",
"parameterOrder": [
"filterSetName"
@@ -152,16 +317,98 @@
"$ref": "ListLosingBidsResponse"
},
"parameters": {
+ "pageSize": {
+ "location": "query",
+ "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
+ "format": "int32",
+ "type": "integer"
+ },
"filterSetName": {
- "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/[^/]+$"
+ },
+ "pageToken": {
+ "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListLosingBidsResponse.nextPageToken\nreturned from the previous call to the losingBids.list\nmethod.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ],
+ "flatPath": "v2beta1/bidders/{biddersId}/filterSets/{filterSetsId}/losingBids",
+ "id": "adexchangebuyer2.bidders.filterSets.losingBids.list",
+ "path": "v2beta1/{+filterSetName}/losingBids"
+ }
+ }
+ },
+ "impressionMetrics": {
+ "methods": {
+ "list": {
+ "description": "Lists all metrics that are measured in terms of number of impressions.",
+ "response": {
+ "$ref": "ListImpressionMetricsResponse"
+ },
+ "parameterOrder": [
+ "filterSetName"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "pageSize": {
+ "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
+ "format": "int32",
+ "type": "integer",
+ "location": "query"
+ },
+ "filterSetName": {
+ "location": "path",
+ "description": "Name of the filter set that should be applied to the requested metrics.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`",
+ "required": true,
+ "type": "string",
+ "pattern": "^bidders/[^/]+/filterSets/[^/]+$"
+ },
+ "pageToken": {
+ "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListImpressionMetricsResponse.nextPageToken\nreturned from the previous call to the impressionMetrics.list\nmethod.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ],
+ "flatPath": "v2beta1/bidders/{biddersId}/filterSets/{filterSetsId}/impressionMetrics",
+ "path": "v2beta1/{+filterSetName}/impressionMetrics",
+ "id": "adexchangebuyer2.bidders.filterSets.impressionMetrics.list"
+ }
+ }
+ },
+ "bidMetrics": {
+ "methods": {
+ "list": {
+ "response": {
+ "$ref": "ListBidMetricsResponse"
+ },
+ "parameterOrder": [
+ "filterSetName"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ],
+ "parameters": {
+ "filterSetName": {
+ "location": "path",
+ "description": "Name of the filter set that should be applied to the requested metrics.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`",
+ "required": true,
+ "type": "string",
+ "pattern": "^bidders/[^/]+/filterSets/[^/]+$"
},
"pageToken": {
"location": "query",
- "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListLosingBidsResponse.nextPageToken\nreturned from the previous call to the losingBids.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": {
@@ -171,99 +418,17 @@
"location": "query"
}
},
- "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",
- "description": "List all reasons for which bids lost in the auction, with the number of\nbids that lost for each reason."
- }
- }
- },
- "impressionMetrics": {
- "methods": {
- "list": {
- "httpMethod": "GET",
- "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": {
- "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}/impressionMetrics",
- "id": "adexchangebuyer2.bidders.filterSets.impressionMetrics.list",
- "path": "v2beta1/{+filterSetName}/impressionMetrics",
- "description": "Lists all metrics that are measured in terms of number of impressions."
- }
- }
- },
- "bidMetrics": {
- "methods": {
- "list": {
- "description": "Lists all metrics that are measured in terms of number of bids.",
- "response": {
- "$ref": "ListBidMetricsResponse"
- },
- "parameterOrder": [
- "filterSetName"
- ],
- "httpMethod": "GET",
- "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": {
- "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListBidMetricsResponse.nextPageToken\nreturned from the previous call to the bidMetrics.list\nmethod.",
- "type": "string",
- "location": "query"
- },
- "pageSize": {
- "location": "query",
- "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
- "format": "int32",
- "type": "integer"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ],
"flatPath": "v2beta1/bidders/{biddersId}/filterSets/{filterSetsId}/bidMetrics",
"path": "v2beta1/{+filterSetName}/bidMetrics",
- "id": "adexchangebuyer2.bidders.filterSets.bidMetrics.list"
+ "id": "adexchangebuyer2.bidders.filterSets.bidMetrics.list",
+ "description": "Lists all metrics that are measured in terms of number of bids."
}
}
},
"bidResponseErrors": {
"methods": {
"list": {
+ "description": "List all errors that occurred in bid responses, with the number of bid\nresponses affected for each reason.",
"response": {
"$ref": "ListBidResponseErrorsResponse"
},
@@ -283,279 +448,100 @@
"location": "path"
},
"pageToken": {
+ "location": "query",
"description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListBidResponseErrorsResponse.nextPageToken\nreturned from the previous call to the bidResponseErrors.list\nmethod.",
- "type": "string",
- "location": "query"
+ "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"
+ "type": "integer",
+ "location": "query"
}
},
"flatPath": "v2beta1/bidders/{biddersId}/filterSets/{filterSetsId}/bidResponseErrors",
"path": "v2beta1/{+filterSetName}/bidResponseErrors",
- "id": "adexchangebuyer2.bidders.filterSets.bidResponseErrors.list",
- "description": "List all errors that occurred in bid responses, with the number of bid\nresponses affected for each reason."
+ "id": "adexchangebuyer2.bidders.filterSets.bidResponseErrors.list"
}
}
},
"bidResponsesWithoutBids": {
"methods": {
"list": {
+ "flatPath": "v2beta1/bidders/{biddersId}/filterSets/{filterSetsId}/bidResponsesWithoutBids",
+ "path": "v2beta1/{+filterSetName}/bidResponsesWithoutBids",
+ "id": "adexchangebuyer2.bidders.filterSets.bidResponsesWithoutBids.list",
"description": "List all reasons for which bid responses were considered to have no\napplicable bids, with the number of bid responses affected for each reason.",
- "httpMethod": "GET",
- "parameterOrder": [
- "filterSetName"
- ],
"response": {
"$ref": "ListBidResponsesWithoutBidsResponse"
},
+ "parameterOrder": [
+ "filterSetName"
+ ],
+ "httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/adexchange.buyer"
],
"parameters": {
- "filterSetName": {
- "pattern": "^bidders/[^/]+/filterSets/[^/]+$",
- "location": "path",
- "description": "Name of the filter set that should be applied to the requested metrics.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`",
- "required": true,
- "type": "string"
- },
- "pageToken": {
- "location": "query",
- "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListBidResponsesWithoutBidsResponse.nextPageToken\nreturned from the previous call to the bidResponsesWithoutBids.list\nmethod.",
- "type": "string"
- },
"pageSize": {
"description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
"format": "int32",
"type": "integer",
"location": "query"
+ },
+ "filterSetName": {
+ "description": "Name of the filter set that should be applied to the requested metrics.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`",
+ "required": true,
+ "type": "string",
+ "pattern": "^bidders/[^/]+/filterSets/[^/]+$",
+ "location": "path"
+ },
+ "pageToken": {
+ "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListBidResponsesWithoutBidsResponse.nextPageToken\nreturned from the previous call to the bidResponsesWithoutBids.list\nmethod.",
+ "type": "string",
+ "location": "query"
}
- },
- "flatPath": "v2beta1/bidders/{biddersId}/filterSets/{filterSetsId}/bidResponsesWithoutBids",
- "id": "adexchangebuyer2.bidders.filterSets.bidResponsesWithoutBids.list",
- "path": "v2beta1/{+filterSetName}/bidResponsesWithoutBids"
+ }
}
}
},
"filteredBidRequests": {
"methods": {
"list": {
- "description": "List all reasons that caused a bid request not to be sent for an\nimpression, with the number of bid requests not sent for each reason.",
- "response": {
- "$ref": "ListFilteredBidRequestsResponse"
- },
+ "httpMethod": "GET",
"parameterOrder": [
"filterSetName"
],
- "httpMethod": "GET",
+ "response": {
+ "$ref": "ListFilteredBidRequestsResponse"
+ },
"parameters": {
+ "pageSize": {
+ "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
+ "format": "int32",
+ "type": "integer",
+ "location": "query"
+ },
"filterSetName": {
- "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/[^/]+$"
},
"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",
+ "id": "adexchangebuyer2.bidders.filterSets.filteredBidRequests.list",
"path": "v2beta1/{+filterSetName}/filteredBidRequests",
- "id": "adexchangebuyer2.bidders.filterSets.filteredBidRequests.list"
- }
- }
- },
- "filteredBids": {
- "methods": {
- "list": {
- "response": {
- "$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": {
- "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."
- }
- },
- "resources": {
- "creatives": {
- "methods": {
- "list": {
- "httpMethod": "GET",
- "response": {
- "$ref": "ListCreativeStatusBreakdownByCreativeResponse"
- },
- "parameterOrder": [
- "filterSetName",
- "creativeStatusId"
- ],
- "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"
- },
- "creativeStatusId": {
- "description": "The ID of the creative status for which to retrieve a breakdown by\ncreative.\nSee\n[creative-status-codes](https://developers.google.com/ad-exchange/rtb/downloads/creative-status-codes).",
- "format": "int32",
- "required": true,
- "type": "integer",
- "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": {
- "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",
- "id": "adexchangebuyer2.bidders.filterSets.filteredBids.creatives.list",
- "path": "v2beta1/{+filterSetName}/filteredBids/{creativeStatusId}/creatives",
- "description": "List all creatives associated with a specific reason for which bids were\nfiltered, with the number of bids filtered for each creative."
- }
- }
- },
- "details": {
- "methods": {
- "list": {
- "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.",
- "response": {
- "$ref": "ListCreativeStatusBreakdownByDetailResponse"
- },
- "parameterOrder": [
- "filterSetName",
- "creativeStatusId"
- ],
- "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"
- },
- "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}/details"
- }
- }
- }
- }
- },
- "nonBillableWinningBids": {
- "methods": {
- "list": {
- "description": "List all reasons for which winning bids were not billable, with the number\nof bids not billed for each reason.",
- "response": {
- "$ref": "ListNonBillableWinningBidsResponse"
- },
- "parameterOrder": [
- "filterSetName"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ],
- "parameters": {
- "filterSetName": {
- "description": "Name of the filter set that should be applied to the requested metrics.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`",
- "required": true,
- "type": "string",
- "pattern": "^bidders/[^/]+/filterSets/[^/]+$",
- "location": "path"
- },
- "pageToken": {
- "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListNonBillableWinningBidsResponse.nextPageToken\nreturned from the previous call to the nonBillableWinningBids.list\nmethod.",
- "type": "string",
- "location": "query"
- },
- "pageSize": {
- "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- }
- },
- "flatPath": "v2beta1/bidders/{biddersId}/filterSets/{filterSetsId}/nonBillableWinningBids",
- "path": "v2beta1/{+filterSetName}/nonBillableWinningBids",
- "id": "adexchangebuyer2.bidders.filterSets.nonBillableWinningBids.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."
}
}
}
@@ -564,13 +550,134 @@
"accounts": {
"resources": {
"filterSets": {
+ "methods": {
+ "get": {
+ "description": "Retrieves the requested filter set for the account with the given account\nID.",
+ "response": {
+ "$ref": "FilterSet"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ],
+ "parameters": {
+ "name": {
+ "location": "path",
+ "description": "Full name of the resource being requested.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`",
+ "required": true,
+ "type": "string",
+ "pattern": "^bidders/[^/]+/accounts/[^/]+/filterSets/[^/]+$"
+ }
+ },
+ "flatPath": "v2beta1/bidders/{biddersId}/accounts/{accountsId}/filterSets/{filterSetsId}",
+ "path": "v2beta1/{+name}",
+ "id": "adexchangebuyer2.bidders.accounts.filterSets.get"
+ },
+ "list": {
+ "description": "Lists all filter sets for the account with the given account ID.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "ownerName"
+ ],
+ "response": {
+ "$ref": "ListFilterSetsResponse"
+ },
+ "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": {
+ "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"
+ },
+ "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"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ],
+ "flatPath": "v2beta1/bidders/{biddersId}/accounts/{accountsId}/filterSets",
+ "id": "adexchangebuyer2.bidders.accounts.filterSets.list",
+ "path": "v2beta1/{+ownerName}/filterSets"
+ },
+ "create": {
+ "request": {
+ "$ref": "FilterSet"
+ },
+ "description": "Creates the specified filter set for the account with the given account ID.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "ownerName"
+ ],
+ "response": {
+ "$ref": "FilterSet"
+ },
+ "parameters": {
+ "isTransient": {
+ "location": "query",
+ "description": "Whether the filter set is transient, or should be persisted indefinitely.\nBy default, filter sets are not transient.\nIf transient, it will be available for at least 1 hour after creation.",
+ "type": "boolean"
+ },
+ "ownerName": {
+ "location": "path",
+ "description": "Name of the owner (bidder or account) of the filter set to be created.\nFor example:\n\n- For a bidder-level filter set for bidder 123: `bidders/123`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456`",
+ "required": true,
+ "type": "string",
+ "pattern": "^bidders/[^/]+/accounts/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ],
+ "flatPath": "v2beta1/bidders/{biddersId}/accounts/{accountsId}/filterSets",
+ "id": "adexchangebuyer2.bidders.accounts.filterSets.create",
+ "path": "v2beta1/{+ownerName}/filterSets"
+ },
+ "delete": {
+ "description": "Deletes the requested filter set from the account with the given account\nID.",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "DELETE",
+ "parameters": {
+ "name": {
+ "description": "Full name of the resource to delete.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`",
+ "required": true,
+ "type": "string",
+ "pattern": "^bidders/[^/]+/accounts/[^/]+/filterSets/[^/]+$",
+ "location": "path"
+ }
+ },
+ "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"
+ }
+ },
"resources": {
- "bidResponseErrors": {
+ "filteredBids": {
"methods": {
"list": {
- "description": "List all errors that occurred in bid responses, with the number of bid\nresponses affected for each reason.",
+ "description": "List all reasons for which bids were filtered, with the number of bids\nfiltered for each reason.",
"response": {
- "$ref": "ListBidResponseErrorsResponse"
+ "$ref": "ListFilteredBidsResponse"
},
"parameterOrder": [
"filterSetName"
@@ -581,132 +688,15 @@
],
"parameters": {
"filterSetName": {
- "description": "Name of the filter set that should be applied to the requested metrics.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`",
- "required": true,
- "type": "string",
- "pattern": "^bidders/[^/]+/accounts/[^/]+/filterSets/[^/]+$",
- "location": "path"
- },
- "pageToken": {
- "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListBidResponseErrorsResponse.nextPageToken\nreturned from the previous call to the bidResponseErrors.list\nmethod.",
- "type": "string",
- "location": "query"
- },
- "pageSize": {
- "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- }
- },
- "flatPath": "v2beta1/bidders/{biddersId}/accounts/{accountsId}/filterSets/{filterSetsId}/bidResponseErrors",
- "path": "v2beta1/{+filterSetName}/bidResponseErrors",
- "id": "adexchangebuyer2.bidders.accounts.filterSets.bidResponseErrors.list"
- }
- }
- },
- "bidResponsesWithoutBids": {
- "methods": {
- "list": {
- "response": {
- "$ref": "ListBidResponsesWithoutBidsResponse"
- },
- "parameterOrder": [
- "filterSetName"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ],
- "parameters": {
- "filterSetName": {
- "description": "Name of the filter set that should be applied to the requested metrics.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`",
- "required": true,
- "type": "string",
- "pattern": "^bidders/[^/]+/accounts/[^/]+/filterSets/[^/]+$",
- "location": "path"
- },
- "pageToken": {
- "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\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.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- }
- },
- "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": {
- "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.",
- "response": {
- "$ref": "ListFilteredBidRequestsResponse"
- },
- "parameterOrder": [
- "filterSetName"
- ],
- "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"
- },
- "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": {
- "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}/filteredBidRequests"
- }
- }
- },
- "nonBillableWinningBids": {
- "methods": {
- "list": {
- "description": "List all reasons for which winning bids were not billable, with the number\nof bids not billed for each reason.",
- "response": {
- "$ref": "ListNonBillableWinningBidsResponse"
- },
- "parameterOrder": [
- "filterSetName"
- ],
- "httpMethod": "GET",
- "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/[^/]+$"
},
"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.",
+ "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": {
@@ -716,52 +706,9 @@
"type": "integer"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ],
- "flatPath": "v2beta1/bidders/{biddersId}/accounts/{accountsId}/filterSets/{filterSetsId}/nonBillableWinningBids",
- "path": "v2beta1/{+filterSetName}/nonBillableWinningBids",
- "id": "adexchangebuyer2.bidders.accounts.filterSets.nonBillableWinningBids.list"
- }
- }
- },
- "filteredBids": {
- "methods": {
- "list": {
- "id": "adexchangebuyer2.bidders.accounts.filterSets.filteredBids.list",
+ "flatPath": "v2beta1/bidders/{biddersId}/accounts/{accountsId}/filterSets/{filterSetsId}/filteredBids",
"path": "v2beta1/{+filterSetName}/filteredBids",
- "description": "List all reasons for which bids were filtered, with the number of bids\nfiltered for each reason.",
- "httpMethod": "GET",
- "response": {
- "$ref": "ListFilteredBidsResponse"
- },
- "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\nListFilteredBidsResponse.nextPageToken\nreturned from the previous call to the filteredBids.list\nmethod.",
- "type": "string",
- "location": "query"
- },
- "pageSize": {
- "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ],
- "flatPath": "v2beta1/bidders/{biddersId}/accounts/{accountsId}/filterSets/{filterSetsId}/filteredBids"
+ "id": "adexchangebuyer2.bidders.accounts.filterSets.filteredBids.list"
}
},
"resources": {
@@ -778,30 +725,30 @@
],
"httpMethod": "GET",
"parameters": {
+ "pageSize": {
+ "location": "query",
+ "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
+ "format": "int32",
+ "type": "integer"
+ },
"filterSetName": {
- "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"
+ "type": "string",
+ "pattern": "^bidders/[^/]+/accounts/[^/]+/filterSets/[^/]+$"
},
"creativeStatusId": {
- "location": "path",
"description": "The ID of the creative status for which to retrieve a breakdown by\ncreative.\nSee\n[creative-status-codes](https://developers.google.com/ad-exchange/rtb/downloads/creative-status-codes).",
"format": "int32",
"required": true,
- "type": "integer"
+ "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\nListCreativeStatusBreakdownByCreativeResponse.nextPageToken\nreturned from the previous call to the filteredBids.creatives.list\nmethod.",
- "type": "string",
- "location": "query"
- },
- "pageSize": {
- "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
- "format": "int32",
- "type": "integer",
- "location": "query"
+ "type": "string"
}
},
"scopes": [
@@ -816,6 +763,7 @@
"details": {
"methods": {
"list": {
+ "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.",
@@ -827,16 +775,13 @@
"creativeStatusId"
],
"httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ],
"parameters": {
"filterSetName": {
- "pattern": "^bidders/[^/]+/accounts/[^/]+/filterSets/[^/]+$",
- "location": "path",
"description": "Name of the filter set that should be applied to the requested metrics.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`",
"required": true,
- "type": "string"
+ "type": "string",
+ "pattern": "^bidders/[^/]+/accounts/[^/]+/filterSets/[^/]+$",
+ "location": "path"
},
"creativeStatusId": {
"location": "path",
@@ -851,64 +796,25 @@
"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"
+ "type": "integer",
+ "location": "query"
}
},
- "flatPath": "v2beta1/bidders/{biddersId}/accounts/{accountsId}/filterSets/{filterSetsId}/filteredBids/{creativeStatusId}/details"
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
}
}
}
}
},
- "losingBids": {
+ "nonBillableWinningBids": {
"methods": {
"list": {
- "httpMethod": "GET",
- "parameterOrder": [
- "filterSetName"
- ],
"response": {
- "$ref": "ListLosingBidsResponse"
- },
- "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\nListLosingBidsResponse.nextPageToken\nreturned from the previous call to the losingBids.list\nmethod.",
- "type": "string",
- "location": "query"
- },
- "pageSize": {
- "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- }
- },
- "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",
- "description": "List all reasons for which bids lost in the auction, with the number of\nbids that lost for each reason."
- }
- }
- },
- "impressionMetrics": {
- "methods": {
- "list": {
- "description": "Lists all metrics that are measured in terms of number of impressions.",
- "response": {
- "$ref": "ListImpressionMetricsResponse"
+ "$ref": "ListNonBillableWinningBidsResponse"
},
"parameterOrder": [
"filterSetName"
@@ -926,7 +832,45 @@
"location": "path"
},
"pageToken": {
- "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListImpressionMetricsResponse.nextPageToken\nreturned from the previous call to the impressionMetrics.list\nmethod.",
+ "location": "query",
+ "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListNonBillableWinningBidsResponse.nextPageToken\nreturned from the previous call to the nonBillableWinningBids.list\nmethod.",
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
+ "format": "int32",
+ "type": "integer",
+ "location": "query"
+ }
+ },
+ "flatPath": "v2beta1/bidders/{biddersId}/accounts/{accountsId}/filterSets/{filterSetsId}/nonBillableWinningBids",
+ "path": "v2beta1/{+filterSetName}/nonBillableWinningBids",
+ "id": "adexchangebuyer2.bidders.accounts.filterSets.nonBillableWinningBids.list",
+ "description": "List all reasons for which winning bids were not billable, with the number\nof bids not billed for each reason."
+ }
+ }
+ },
+ "losingBids": {
+ "methods": {
+ "list": {
+ "description": "List all reasons for which bids lost in the auction, with the number of\nbids that lost for each reason.",
+ "response": {
+ "$ref": "ListLosingBidsResponse"
+ },
+ "parameterOrder": [
+ "filterSetName"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "filterSetName": {
+ "location": "path",
+ "description": "Name of the filter set that should be applied to the requested metrics.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`",
+ "required": true,
+ "type": "string",
+ "pattern": "^bidders/[^/]+/accounts/[^/]+/filterSets/[^/]+$"
+ },
+ "pageToken": {
+ "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListLosingBidsResponse.nextPageToken\nreturned from the previous call to the losingBids.list\nmethod.",
"type": "string",
"location": "query"
},
@@ -937,15 +881,62 @@
"type": "integer"
}
},
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ],
+ "flatPath": "v2beta1/bidders/{biddersId}/accounts/{accountsId}/filterSets/{filterSetsId}/losingBids",
+ "path": "v2beta1/{+filterSetName}/losingBids",
+ "id": "adexchangebuyer2.bidders.accounts.filterSets.losingBids.list"
+ }
+ }
+ },
+ "impressionMetrics": {
+ "methods": {
+ "list": {
+ "description": "Lists all metrics that are measured in terms of number of impressions.",
+ "httpMethod": "GET",
+ "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/[^/]+/accounts/[^/]+/filterSets/[^/]+$",
+ "location": "path"
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListImpressionMetricsResponse.nextPageToken\nreturned from the previous call to the impressionMetrics.list\nmethod.",
+ "type": "string"
+ },
+ "pageSize": {
+ "location": "query",
+ "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ],
"flatPath": "v2beta1/bidders/{biddersId}/accounts/{accountsId}/filterSets/{filterSetsId}/impressionMetrics",
- "path": "v2beta1/{+filterSetName}/impressionMetrics",
- "id": "adexchangebuyer2.bidders.accounts.filterSets.impressionMetrics.list"
+ "id": "adexchangebuyer2.bidders.accounts.filterSets.impressionMetrics.list",
+ "path": "v2beta1/{+filterSetName}/impressionMetrics"
}
}
},
"bidMetrics": {
"methods": {
"list": {
+ "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.",
"response": {
"$ref": "ListBidMetricsResponse"
},
@@ -957,6 +948,45 @@
"https://www.googleapis.com/auth/adexchange.buyer"
],
"parameters": {
+ "pageSize": {
+ "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
+ "format": "int32",
+ "type": "integer",
+ "location": "query"
+ },
+ "filterSetName": {
+ "location": "path",
+ "description": "Name of the filter set that should be applied to the requested metrics.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`",
+ "required": true,
+ "type": "string",
+ "pattern": "^bidders/[^/]+/accounts/[^/]+/filterSets/[^/]+$"
+ },
+ "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"
+ }
+ }
+ }
+ }
+ },
+ "bidResponseErrors": {
+ "methods": {
+ "list": {
+ "response": {
+ "$ref": "ListBidResponseErrorsResponse"
+ },
+ "parameterOrder": [
+ "filterSetName"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "pageSize": {
+ "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
+ "format": "int32",
+ "type": "integer",
+ "location": "query"
+ },
"filterSetName": {
"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,
@@ -966,143 +996,99 @@
},
"pageToken": {
"location": "query",
- "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListBidMetricsResponse.nextPageToken\nreturned from the previous call to the bidMetrics.list\nmethod.",
+ "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"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ],
+ "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",
+ "parameterOrder": [
+ "filterSetName"
+ ],
+ "response": {
+ "$ref": "ListBidResponsesWithoutBidsResponse"
+ },
+ "parameters": {
+ "filterSetName": {
+ "location": "path",
+ "description": "Name of the filter set that should be applied to the requested metrics.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`",
+ "required": true,
+ "type": "string",
+ "pattern": "^bidders/[^/]+/accounts/[^/]+/filterSets/[^/]+$"
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListBidResponsesWithoutBidsResponse.nextPageToken\nreturned from the previous call to the bidResponsesWithoutBids.list\nmethod.",
"type": "string"
},
"pageSize": {
- "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"
+ "type": "integer",
+ "location": "query"
}
},
- "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."
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ],
+ "flatPath": "v2beta1/bidders/{biddersId}/accounts/{accountsId}/filterSets/{filterSetsId}/bidResponsesWithoutBids",
+ "id": "adexchangebuyer2.bidders.accounts.filterSets.bidResponsesWithoutBids.list",
+ "path": "v2beta1/{+filterSetName}/bidResponsesWithoutBids"
}
}
- }
- },
- "methods": {
- "create": {
- "response": {
- "$ref": "FilterSet"
- },
- "parameterOrder": [
- "ownerName"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ],
- "parameters": {
- "isTransient": {
- "location": "query",
- "description": "Whether the filter set is transient, or should be persisted indefinitely.\nBy default, filter sets are not transient.\nIf transient, it will be available for at least 1 hour after creation.",
- "type": "boolean"
- },
- "ownerName": {
- "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"
+ },
+ "filteredBidRequests": {
+ "methods": {
+ "list": {
+ "description": "List all reasons that caused a bid request not to be sent for an\nimpression, with the number of bid requests not sent for each reason.",
+ "response": {
+ "$ref": "ListFilteredBidRequestsResponse"
+ },
+ "parameterOrder": [
+ "filterSetName"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ],
+ "parameters": {
+ "pageSize": {
+ "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
+ "format": "int32",
+ "type": "integer",
+ "location": "query"
+ },
+ "filterSetName": {
+ "location": "path",
+ "description": "Name of the filter set that should be applied to the requested metrics.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`",
+ "required": true,
+ "type": "string",
+ "pattern": "^bidders/[^/]+/accounts/[^/]+/filterSets/[^/]+$"
+ },
+ "pageToken": {
+ "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"
+ }
+ },
+ "flatPath": "v2beta1/bidders/{biddersId}/accounts/{accountsId}/filterSets/{filterSetsId}/filteredBidRequests",
+ "path": "v2beta1/{+filterSetName}/filteredBidRequests",
+ "id": "adexchangebuyer2.bidders.accounts.filterSets.filteredBidRequests.list"
}
- },
- "flatPath": "v2beta1/bidders/{biddersId}/accounts/{accountsId}/filterSets",
- "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"
}
- },
- "delete": {
- "path": "v2beta1/{+name}",
- "id": "adexchangebuyer2.bidders.accounts.filterSets.delete",
- "description": "Deletes the requested filter set from the account with the given account\nID.",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "DELETE",
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ],
- "parameters": {
- "name": {
- "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}"
- },
- "get": {
- "path": "v2beta1/{+name}",
- "id": "adexchangebuyer2.bidders.accounts.filterSets.get",
- "description": "Retrieves the requested filter set for the account with the given account\nID.",
- "response": {
- "$ref": "FilterSet"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "parameters": {
- "name": {
- "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}"
- },
- "list": {
- "response": {
- "$ref": "ListFilterSetsResponse"
- },
- "parameterOrder": [
- "ownerName"
- ],
- "httpMethod": "GET",
- "parameters": {
- "pageToken": {
- "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListFilterSetsResponse.nextPageToken\nreturned from the previous call to the\naccounts.filterSets.list\nmethod.",
- "type": "string",
- "location": "query"
- },
- "pageSize": {
- "location": "query",
- "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
- "format": "int32",
- "type": "integer"
- },
- "ownerName": {
- "pattern": "^bidders/[^/]+/accounts/[^/]+$",
- "location": "path",
- "description": "Name of the owner (bidder or account) of the filter sets to be listed.\nFor example:\n\n- For a bidder-level filter set for bidder 123: `bidders/123`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456`",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ],
- "flatPath": "v2beta1/bidders/{biddersId}/accounts/{accountsId}/filterSets",
- "path": "v2beta1/{+ownerName}/filterSets",
- "id": "adexchangebuyer2.bidders.accounts.filterSets.list",
- "description": "Lists all filter sets for the account with the given account ID."
}
}
}
@@ -1113,277 +1099,17 @@
"accounts": {
"resources": {
"clients": {
- "resources": {
- "invitations": {
- "methods": {
- "create": {
- "response": {
- "$ref": "ClientUserInvitation"
- },
- "parameterOrder": [
- "accountId",
- "clientAccountId"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ],
- "parameters": {
- "accountId": {
- "description": "Numerical account ID of the client's sponsor buyer. (required)",
- "format": "int64",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "clientAccountId": {
- "description": "Numerical account ID of the client buyer that the user\nshould be associated with. (required)",
- "format": "int64",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "flatPath": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/invitations",
- "path": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/invitations",
- "id": "adexchangebuyer2.accounts.clients.invitations.create",
- "description": "Creates and sends out an email invitation to access\nan Ad Exchange client buyer account.",
- "request": {
- "$ref": "ClientUserInvitation"
- }
- },
- "get": {
- "response": {
- "$ref": "ClientUserInvitation"
- },
- "parameterOrder": [
- "accountId",
- "clientAccountId",
- "invitationId"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ],
- "parameters": {
- "invitationId": {
- "description": "Numerical identifier of the user invitation to retrieve. (required)",
- "format": "int64",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "accountId": {
- "location": "path",
- "description": "Numerical account ID of the client's sponsor buyer. (required)",
- "format": "int64",
- "required": true,
- "type": "string"
- },
- "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}",
- "path": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/invitations/{invitationId}",
- "id": "adexchangebuyer2.accounts.clients.invitations.get",
- "description": "Retrieves an existing client user invitation."
- },
- "list": {
- "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.",
- "httpMethod": "GET",
- "parameterOrder": [
- "accountId",
- "clientAccountId"
- ],
- "response": {
- "$ref": "ListClientUserInvitationsResponse"
- },
- "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\nListClientUserInvitationsResponse.nextPageToken\nreturned from the previous call to the\nclients.invitations.list\nmethod.",
- "type": "string"
- },
- "accountId": {
- "description": "Numerical account ID of the client's sponsor buyer. (required)",
- "format": "int64",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "pageSize": {
- "location": "query",
- "description": "Requested page size. Server may return fewer clients than requested.\nIf unspecified, server will pick an appropriate default.",
- "format": "int32",
- "type": "integer"
- },
- "clientAccountId": {
- "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"
- }
- }
- },
- "users": {
- "methods": {
- "list": {
- "description": "Lists all the known client users for a specified\nsponsor buyer account ID.",
- "response": {
- "$ref": "ListClientUsersResponse"
- },
- "parameterOrder": [
- "accountId",
- "clientAccountId"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ],
- "parameters": {
- "pageToken": {
- "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",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "pageSize": {
- "description": "Requested page size. The server may return fewer clients than requested.\nIf unspecified, the server will pick an appropriate default.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- },
- "clientAccountId": {
- "location": "path",
- "description": "The account ID of the client buyer to list users for. (required)\nYou must specify either a string representation of a\nnumerical account identifier or the `-` character\nto list all the client users for all the clients\nof a given sponsor buyer.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/users",
- "path": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/users",
- "id": "adexchangebuyer2.accounts.clients.users.list"
- },
- "get": {
- "httpMethod": "GET",
- "response": {
- "$ref": "ClientUser"
- },
- "parameterOrder": [
- "accountId",
- "clientAccountId",
- "userId"
- ],
- "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": {
- "description": "Numerical account ID of the client buyer\nthat the user to be retrieved is associated with. (required)",
- "format": "int64",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ],
- "flatPath": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/users/{userId}",
- "id": "adexchangebuyer2.accounts.clients.users.get",
- "path": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/users/{userId}",
- "description": "Retrieves an existing client user."
- },
- "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": {
- "description": "Numerical account ID of the client buyer that the user to be retrieved\nis associated with. (required)",
- "format": "int64",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "flatPath": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/users/{userId}",
- "path": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/users/{userId}",
- "id": "adexchangebuyer2.accounts.clients.users.update"
- }
- }
- }
- },
"methods": {
"get": {
- "id": "adexchangebuyer2.accounts.clients.get",
- "path": "v2beta1/accounts/{accountId}/clients/{clientAccountId}",
"description": "Gets a client buyer with a given client account ID.",
- "httpMethod": "GET",
+ "response": {
+ "$ref": "Client"
+ },
"parameterOrder": [
"accountId",
"clientAccountId"
],
- "response": {
- "$ref": "Client"
- },
+ "httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/adexchange.buyer"
],
@@ -1403,11 +1129,11 @@
"location": "path"
}
},
- "flatPath": "v2beta1/accounts/{accountId}/clients/{clientAccountId}"
+ "flatPath": "v2beta1/accounts/{accountId}/clients/{clientAccountId}",
+ "path": "v2beta1/accounts/{accountId}/clients/{clientAccountId}",
+ "id": "adexchangebuyer2.accounts.clients.get"
},
"list": {
- "path": "v2beta1/accounts/{accountId}/clients",
- "id": "adexchangebuyer2.accounts.clients.list",
"description": "Lists all the clients for the current sponsor buyer.",
"response": {
"$ref": "ListClientsResponse"
@@ -1421,21 +1147,21 @@
],
"parameters": {
"pageToken": {
- "location": "query",
"description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListClientsResponse.nextPageToken\nreturned from the previous call to the\naccounts.clients.list method.",
- "type": "string"
- },
- "partnerClientId": {
- "description": "Optional unique identifier (from the standpoint of an Ad Exchange sponsor\nbuyer partner) of the client to return.\nIf specified, at most one client will be returned in the response.",
"type": "string",
"location": "query"
},
+ "partnerClientId": {
+ "location": "query",
+ "description": "Optional unique identifier (from the standpoint of an Ad Exchange sponsor\nbuyer partner) of the client to return.\nIf specified, at most one client will be returned in the response.",
+ "type": "string"
+ },
"accountId": {
- "location": "path",
"description": "Unique numerical account ID of the sponsor buyer to list the clients for.",
"format": "int64",
"required": true,
- "type": "string"
+ "type": "string",
+ "location": "path"
},
"pageSize": {
"location": "query",
@@ -1444,7 +1170,9 @@
"type": "integer"
}
},
- "flatPath": "v2beta1/accounts/{accountId}/clients"
+ "flatPath": "v2beta1/accounts/{accountId}/clients",
+ "path": "v2beta1/accounts/{accountId}/clients",
+ "id": "adexchangebuyer2.accounts.clients.list"
},
"update": {
"response": {
@@ -1455,6 +1183,9 @@
"clientAccountId"
],
"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)",
@@ -1471,22 +1202,19 @@
"type": "string"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ],
"flatPath": "v2beta1/accounts/{accountId}/clients/{clientAccountId}",
"path": "v2beta1/accounts/{accountId}/clients/{clientAccountId}",
"id": "adexchangebuyer2.accounts.clients.update",
+ "description": "Updates an existing client buyer.",
"request": {
"$ref": "Client"
- },
- "description": "Updates an existing client buyer."
+ }
},
"create": {
- "description": "Creates a new client buyer.",
"request": {
"$ref": "Client"
},
+ "description": "Creates a new client buyer.",
"response": {
"$ref": "Client"
},
@@ -1494,26 +1222,318 @@
"accountId"
],
"httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ],
"parameters": {
"accountId": {
- "location": "path",
"description": "Unique numerical account ID for the buyer of which the client buyer\nis a customer; the sponsor buyer to create a client for. (required)",
"format": "int64",
"required": true,
- "type": "string"
+ "type": "string",
+ "location": "path"
}
},
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ],
"flatPath": "v2beta1/accounts/{accountId}/clients",
"path": "v2beta1/accounts/{accountId}/clients",
"id": "adexchangebuyer2.accounts.clients.create"
}
+ },
+ "resources": {
+ "invitations": {
+ "methods": {
+ "get": {
+ "description": "Retrieves an existing client user invitation.",
+ "response": {
+ "$ref": "ClientUserInvitation"
+ },
+ "parameterOrder": [
+ "accountId",
+ "clientAccountId",
+ "invitationId"
+ ],
+ "httpMethod": "GET",
+ "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 invitation\nto be retrieved is associated with. (required)",
+ "format": "int64",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "invitationId": {
+ "description": "Numerical identifier of the user invitation to retrieve. (required)",
+ "format": "int64",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "flatPath": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/invitations/{invitationId}",
+ "path": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/invitations/{invitationId}",
+ "id": "adexchangebuyer2.accounts.clients.invitations.get"
+ },
+ "list": {
+ "description": "Lists all the client users invitations for a client\nwith a given account ID.",
+ "response": {
+ "$ref": "ListClientUserInvitationsResponse"
+ },
+ "parameterOrder": [
+ "accountId",
+ "clientAccountId"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ],
+ "parameters": {
+ "accountId": {
+ "location": "path",
+ "description": "Numerical account ID of the client's sponsor buyer. (required)",
+ "format": "int64",
+ "required": true,
+ "type": "string"
+ },
+ "pageSize": {
+ "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": {
+ "description": "Numerical account ID of the client buyer to list invitations for.\n(required)\nYou must either specify a string representation of a\nnumerical account identifier or the `-` character\nto list all the invitations for all the clients\nof a given sponsor buyer.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "pageToken": {
+ "location": "query",
+ "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"
+ }
+ },
+ "flatPath": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/invitations",
+ "path": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/invitations",
+ "id": "adexchangebuyer2.accounts.clients.invitations.list"
+ },
+ "create": {
+ "flatPath": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/invitations",
+ "path": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/invitations",
+ "id": "adexchangebuyer2.accounts.clients.invitations.create",
+ "description": "Creates and sends out an email invitation to access\nan Ad Exchange client buyer account.",
+ "request": {
+ "$ref": "ClientUserInvitation"
+ },
+ "response": {
+ "$ref": "ClientUserInvitation"
+ },
+ "parameterOrder": [
+ "accountId",
+ "clientAccountId"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "Numerical account ID of the client's sponsor buyer. (required)",
+ "format": "int64",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "clientAccountId": {
+ "location": "path",
+ "description": "Numerical account ID of the client buyer that the user\nshould be associated with. (required)",
+ "format": "int64",
+ "required": true,
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "users": {
+ "methods": {
+ "list": {
+ "description": "Lists all the known client users for a specified\nsponsor buyer account ID.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "accountId",
+ "clientAccountId"
+ ],
+ "response": {
+ "$ref": "ListClientUsersResponse"
+ },
+ "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": {
+ "description": "Numerical account ID of the sponsor buyer of the client to list users for.\n(required)",
+ "format": "int64",
+ "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"
+ ],
+ "flatPath": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/users",
+ "id": "adexchangebuyer2.accounts.clients.users.list",
+ "path": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/users"
+ },
+ "get": {
+ "description": "Retrieves an existing client user.",
+ "response": {
+ "$ref": "ClientUser"
+ },
+ "parameterOrder": [
+ "accountId",
+ "clientAccountId",
+ "userId"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "accountId": {
+ "description": "Numerical account ID of the client's sponsor buyer. (required)",
+ "format": "int64",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "clientAccountId": {
+ "description": "Numerical account ID of the client buyer\nthat the user to be retrieved is associated with. (required)",
+ "format": "int64",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "userId": {
+ "location": "path",
+ "description": "Numerical identifier of the user to retrieve. (required)",
+ "format": "int64",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "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"
+ },
+ "update": {
+ "flatPath": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/users/{userId}",
+ "path": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/users/{userId}",
+ "id": "adexchangebuyer2.accounts.clients.users.update",
+ "description": "Updates an existing client user.\nOnly the user status can be changed on update.",
+ "request": {
+ "$ref": "ClientUser"
+ },
+ "response": {
+ "$ref": "ClientUser"
+ },
+ "parameterOrder": [
+ "accountId",
+ "clientAccountId",
+ "userId"
+ ],
+ "httpMethod": "PUT",
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ],
+ "parameters": {
+ "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": {
+ "description": "Numerical account ID of the client buyer that the user to be retrieved\nis associated with. (required)",
+ "format": "int64",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ }
+ }
+ }
+ }
}
},
"creatives": {
"methods": {
+ "stopWatching": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "accountId",
+ "creativeId"
+ ],
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameters": {
+ "accountId": {
+ "description": "The account of the creative to stop notifications for.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "creativeId": {
+ "location": "path",
+ "description": "The creative ID of the creative to stop notifications for.\nSpecify \"-\" to specify stopping account level notifications.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ],
+ "flatPath": "v2beta1/accounts/{accountId}/creatives/{creativeId}:stopWatching",
+ "id": "adexchangebuyer2.accounts.creatives.stopWatching",
+ "path": "v2beta1/accounts/{accountId}/creatives/{creativeId}:stopWatching",
+ "request": {
+ "$ref": "StopWatchingCreativeRequest"
+ },
+ "description": "Stops watching a creative. Will stop push notifications being sent to the\ntopics when the creative changes status."
+ },
"get": {
"description": "Gets a creative.",
"httpMethod": "GET",
@@ -1526,10 +1546,10 @@
},
"parameters": {
"accountId": {
- "location": "path",
"description": "The account the creative belongs to.",
"required": true,
- "type": "string"
+ "type": "string",
+ "location": "path"
},
"creativeId": {
"description": "The ID of the creative to retrieve.",
@@ -1546,6 +1566,10 @@
"path": "v2beta1/accounts/{accountId}/creatives/{creativeId}"
},
"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"
},
@@ -1558,32 +1582,28 @@
"https://www.googleapis.com/auth/adexchange.buyer"
],
"parameters": {
- "creativeId": {
- "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.",
+ "accountId": {
+ "description": "The account of the creative to watch.",
"required": true,
"type": "string",
"location": "path"
},
- "accountId": {
+ "creativeId": {
"location": "path",
- "description": "The account of the creative to watch.",
+ "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",
- "description": "Watches a creative. Will result in push notifications being sent to the\ntopic when the creative changes status.",
- "request": {
- "$ref": "WatchCreativeRequest"
- }
+ "id": "adexchangebuyer2.accounts.creatives.watch"
},
"update": {
- "description": "Updates a creative.",
"request": {
"$ref": "Creative"
},
+ "description": "Updates a creative.",
"response": {
"$ref": "Creative"
},
@@ -1592,47 +1612,42 @@
"creativeId"
],
"httpMethod": "PUT",
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ],
"parameters": {
+ "accountId": {
+ "location": "path",
+ "description": "The account that this creative belongs to.\nCan be used to filter the response of the\ncreatives.list\nmethod.",
+ "required": true,
+ "type": "string"
+ },
"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": {
- "location": "path",
- "description": "The account that this creative belongs to.\nCan be used to filter the response of the\ncreatives.list\nmethod.",
- "required": true,
+ "accountId1": {
+ "location": "query",
+ "description": "The account the creative belongs to.",
"type": "string"
}
},
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ],
"flatPath": "v2beta1/accounts/{accountId}/creatives/{creativeId}",
"path": "v2beta1/accounts/{accountId}/creatives/{creativeId}",
"id": "adexchangebuyer2.accounts.creatives.update"
},
"list": {
- "path": "v2beta1/accounts/{accountId}/creatives",
- "id": "adexchangebuyer2.accounts.creatives.list",
"description": "Lists creatives.",
- "response": {
- "$ref": "ListCreativesResponse"
- },
+ "httpMethod": "GET",
"parameterOrder": [
"accountId"
],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ],
+ "response": {
+ "$ref": "ListCreativesResponse"
+ },
"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,
@@ -1649,11 +1664,28 @@
"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": {
+ "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"
}
},
- "flatPath": "v2beta1/accounts/{accountId}/creatives"
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ],
+ "flatPath": "v2beta1/accounts/{accountId}/creatives",
+ "id": "adexchangebuyer2.accounts.creatives.list",
+ "path": "v2beta1/accounts/{accountId}/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"
@@ -1661,141 +1693,41 @@
"response": {
"$ref": "Creative"
},
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ],
"parameters": {
"duplicateIdMode": {
+ "location": "query",
"enum": [
"NO_DUPLICATES",
"FORCE_ENABLE_DUPLICATE_IDS"
],
"description": "Indicates if multiple creatives can share an ID or not. Default is\nNO_DUPLICATES (one ID per creative).",
- "type": "string",
- "location": "query"
+ "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"
+ },
+ "accountId1": {
+ "location": "query",
+ "description": "The account the creative belongs to.",
+ "type": "string"
}
},
- "flatPath": "v2beta1/accounts/{accountId}/creatives",
- "id": "adexchangebuyer2.accounts.creatives.create",
- "path": "v2beta1/accounts/{accountId}/creatives",
- "description": "Creates a creative.",
- "request": {
- "$ref": "Creative"
- }
- },
- "stopWatching": {
- "description": "Stops watching a creative. Will stop push notifications being sent to the\ntopics when the creative changes status.",
- "request": {
- "$ref": "StopWatchingCreativeRequest"
- },
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "accountId",
- "creativeId"
- ],
- "httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/adexchange.buyer"
- ],
- "parameters": {
- "accountId": {
- "location": "path",
- "description": "The account of the creative to stop notifications for.",
- "required": true,
- "type": "string"
- },
- "creativeId": {
- "location": "path",
- "description": "The creative ID of the creative to stop notifications for.\nSpecify \"-\" to specify stopping account level notifications.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v2beta1/accounts/{accountId}/creatives/{creativeId}:stopWatching",
- "path": "v2beta1/accounts/{accountId}/creatives/{creativeId}:stopWatching",
- "id": "adexchangebuyer2.accounts.creatives.stopWatching"
+ ]
}
},
"resources": {
"dealAssociations": {
"methods": {
- "add": {
- "description": "Associate an existing deal with a creative.",
- "request": {
- "$ref": "AddDealAssociationRequest"
- },
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "accountId",
- "creativeId"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ],
- "parameters": {
- "creativeId": {
- "location": "path",
- "description": "The ID of the creative associated with the deal.",
- "required": true,
- "type": "string"
- },
- "accountId": {
- "description": "The account the creative belongs to.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "flatPath": "v2beta1/accounts/{accountId}/creatives/{creativeId}/dealAssociations:add",
- "path": "v2beta1/accounts/{accountId}/creatives/{creativeId}/dealAssociations:add",
- "id": "adexchangebuyer2.accounts.creatives.dealAssociations.add"
- },
- "remove": {
- "path": "v2beta1/accounts/{accountId}/creatives/{creativeId}/dealAssociations:remove",
- "id": "adexchangebuyer2.accounts.creatives.dealAssociations.remove",
- "description": "Remove the association between a deal and a creative.",
- "request": {
- "$ref": "RemoveDealAssociationRequest"
- },
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "accountId",
- "creativeId"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ],
- "parameters": {
- "accountId": {
- "description": "The account the creative belongs to.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "creativeId": {
- "description": "The ID of the creative associated with the deal.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "flatPath": "v2beta1/accounts/{accountId}/creatives/{creativeId}/dealAssociations:remove"
- },
"list": {
+ "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.",
"response": {
"$ref": "ListDealAssociationsResponse"
},
@@ -1804,21 +1736,7 @@
"creativeId"
],
"httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ],
"parameters": {
- "creativeId": {
- "description": "The creative ID to list the associations from.\nSpecify \"-\" to list all creatives under the above account.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "pageToken": {
- "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListDealAssociationsResponse.next_page_token\nreturned from the previous call to 'ListDealAssociations' 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.",
@@ -1835,12 +1753,90 @@
"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.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "pageToken": {
+ "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListDealAssociationsResponse.next_page_token\nreturned from the previous call to 'ListDealAssociations' method.",
+ "type": "string",
+ "location": "query"
}
},
- "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."
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ]
+ },
+ "add": {
+ "flatPath": "v2beta1/accounts/{accountId}/creatives/{creativeId}/dealAssociations:add",
+ "path": "v2beta1/accounts/{accountId}/creatives/{creativeId}/dealAssociations:add",
+ "id": "adexchangebuyer2.accounts.creatives.dealAssociations.add",
+ "description": "Associate an existing deal with a creative.",
+ "request": {
+ "$ref": "AddDealAssociationRequest"
+ },
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "accountId",
+ "creativeId"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ],
+ "parameters": {
+ "accountId": {
+ "location": "path",
+ "description": "The account the creative belongs to.",
+ "required": true,
+ "type": "string"
+ },
+ "creativeId": {
+ "location": "path",
+ "description": "The ID of the creative associated with the deal.",
+ "required": true,
+ "type": "string"
+ }
+ }
+ },
+ "remove": {
+ "request": {
+ "$ref": "RemoveDealAssociationRequest"
+ },
+ "description": "Remove the association between a deal and a creative.",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "accountId",
+ "creativeId"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "accountId": {
+ "location": "path",
+ "description": "The account the creative belongs to.",
+ "required": true,
+ "type": "string"
+ },
+ "creativeId": {
+ "location": "path",
+ "description": "The ID of the creative associated with the deal.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ],
+ "flatPath": "v2beta1/accounts/{accountId}/creatives/{creativeId}/dealAssociations:remove",
+ "path": "v2beta1/accounts/{accountId}/creatives/{creativeId}/dealAssociations:remove",
+ "id": "adexchangebuyer2.accounts.creatives.dealAssociations.remove"
}
}
}
@@ -1850,13 +1846,56 @@
}
},
"parameters": {
- "alt": {
+ "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": {
+ "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": {
+ "description": "V1 error format.",
+ "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"
+ "v1 error format",
+ "v2 error format"
],
"location": "query",
+ "enum": [
+ "1",
+ "2"
+ ]
+ },
+ "alt": {
"description": "Data format for response.",
"default": "json",
"enum": [
@@ -1864,7 +1903,13 @@
"media",
"proto"
],
- "type": "string"
+ "type": "string",
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query"
},
"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.",
@@ -1882,73 +1927,554 @@
"location": "query"
},
"pp": {
- "location": "query",
"description": "Pretty-print response.",
"type": "boolean",
- "default": "true"
- },
- "oauth_token": {
- "location": "query",
- "description": "OAuth 2.0 token for the current user.",
- "type": "string"
- },
- "bearer_token": {
- "description": "OAuth bearer token.",
- "type": "string",
+ "default": "true",
"location": "query"
- },
- "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": {
- "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"
}
},
"version": "v2beta1",
"baseUrl": "https://adexchangebuyer.googleapis.com/",
- "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.",
+ "kind": "discovery#restDescription",
+ "servicePath": "",
"basePath": "",
- "revision": "20171219",
+ "revision": "20180101",
"documentationLink": "https://developers.google.com/ad-exchange/buyer-rest/reference/rest/",
"id": "adexchangebuyer2:v2beta1",
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
+ "ListBidMetricsResponse": {
+ "description": "Response message for listing the metrics that are measured in number of bids.",
+ "type": "object",
+ "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"
+ },
+ "Reason": {
+ "description": "A specific filtering status and how many times it occurred.",
+ "type": "object",
+ "properties": {
+ "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.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "count": {
+ "description": "The number of times the creative was filtered for the status. The\ncount is aggregated across all publishers on the exchange.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "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": {
+ "description": "Response message for listing all reasons that bids lost in the auction.",
+ "type": "object",
+ "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"
+ },
+ "ListNonBillableWinningBidsResponse": {
+ "description": "Response message for listing all reasons for which a buyer was not billed for\na winning bid.",
+ "type": "object",
+ "properties": {
+ "nextPageToken": {
+ "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"
+ },
+ "nonBillableWinningBidStatusRows": {
+ "description": "List of rows, with counts of bids not billed aggregated by reason.",
+ "type": "array",
+ "items": {
+ "$ref": "NonBillableWinningBidStatusRow"
+ }
+ }
+ },
+ "id": "ListNonBillableWinningBidsResponse"
+ },
+ "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": {
+ "inventoryMatches": {
+ "$ref": "MetricValue",
+ "description": "The number of impressions that match the buyer's inventory pretargeting."
+ },
+ "bidRequests": {
+ "$ref": "MetricValue",
+ "description": "The number of impressions for which Ad Exchange sent the buyer a bid\nrequest."
+ },
+ "responsesWithBids": {
+ "description": "The number of impressions for which Ad Exchange received a response from\nthe buyer that contained at least one applicable bid.",
+ "$ref": "MetricValue"
+ },
+ "successfulResponses": {
+ "description": "The number of impressions for which the buyer successfully sent a response\nto Ad Exchange.",
+ "$ref": "MetricValue"
+ },
+ "rowDimensions": {
+ "description": "The values of all dimensions associated with metric values in this row.",
+ "$ref": "RowDimensions"
+ },
+ "availableImpressions": {
+ "description": "The number of impressions available to the buyer on Ad Exchange.\nIn some cases this value may be unavailable.",
+ "$ref": "MetricValue"
+ }
+ },
+ "id": "ImpressionMetricsRow"
+ },
+ "AuctionContext": {
+ "description": "@OutputOnly The auction type the restriction applies to.",
+ "type": "object",
+ "properties": {
+ "auctionTypes": {
+ "enumDescriptions": [
+ "The restriction applies to open auction.",
+ "The restriction applies to direct deals."
+ ],
+ "description": "The auction types this restriction applies to.",
+ "type": "array",
+ "items": {
+ "type": "string",
+ "enum": [
+ "OPEN_AUCTION",
+ "DIRECT_DEALS"
+ ]
+ }
+ }
+ },
+ "id": "AuctionContext"
+ },
+ "ListImpressionMetricsResponse": {
+ "description": "Response message for listing the metrics that are measured in number of\nimpressions.",
+ "type": "object",
+ "properties": {
+ "impressionMetricsRows": {
+ "description": "List of rows, each containing a set of impression metrics.",
+ "type": "array",
+ "items": {
+ "$ref": "ImpressionMetricsRow"
+ }
+ },
+ "nextPageToken": {
+ "description": "A token to retrieve the next page of results.\nPass this value in the\nListImpressionMetricsRequest.pageToken\nfield in the subsequent call to the impressionMetrics.list\nmethod to retrieve the next page of results.",
+ "type": "string"
+ }
+ },
+ "id": "ListImpressionMetricsResponse"
+ },
+ "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": {
+ "viewableImpressions": {
+ "$ref": "MetricValue",
+ "description": "The number of bids for which the corresponding impression was viewable (as\ndefined by Active View)."
+ },
+ "impressionsWon": {
+ "$ref": "MetricValue",
+ "description": "The number of bids that won an impression."
+ },
+ "measurableImpressions": {
+ "$ref": "MetricValue",
+ "description": "The number of bids for which the corresponding impression was measurable\nfor viewability (as defined by Active View)."
+ },
+ "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"
+ },
+ "rowDimensions": {
+ "description": "The values of all dimensions associated with metric values in this row.",
+ "$ref": "RowDimensions"
+ }
+ },
+ "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": {
+ "description": "The number of bids with the specified dimension values that did not win the\nauction (either were filtered pre-auction or lost the auction), as described\nby the specified creative status.",
+ "type": "object",
+ "properties": {
+ "bidCount": {
+ "$ref": "MetricValue",
+ "description": "The number of bids with the specified status."
+ },
+ "rowDimensions": {
+ "$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"
+ }
+ },
+ "id": "CreativeStatusRow"
+ },
+ "RealtimeTimeRange": {
+ "description": "An open-ended realtime time range specified by the start timestamp.\nFor filter sets that specify a realtime time range RTB metrics continue to\nbe aggregated throughout the lifetime of the filter set.",
+ "type": "object",
+ "properties": {
+ "startTimestamp": {
+ "description": "The start timestamp of the real-time RTB metrics aggregation.",
+ "format": "google-datetime",
+ "type": "string"
+ }
+ },
+ "id": "RealtimeTimeRange"
+ },
+ "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": {
+ "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"
+ },
+ "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 status.",
+ "$ref": "MetricValue"
+ }
+ },
+ "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": {
+ "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",
+ "properties": {
+ "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"
+ },
+ "startDate": {
+ "description": "The start date of the range (inclusive).\nMust be within the 30 days leading up to current date, and must be equal to\nor before end_date.",
+ "$ref": "Date"
+ }
+ },
+ "id": "AbsoluteDateRange"
+ },
+ "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": {
+ "description": "A request for watching changes to creative Status.",
+ "type": "object",
+ "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"
+ },
+ "TimeInterval": {
+ "description": "An interval of time, with an absolute start and end.",
+ "type": "object",
+ "properties": {
+ "endTime": {
+ "description": "The timestamp marking the end of the range (exclusive) for which data is\nincluded.",
+ "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"
+ },
+ "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": {
+ "$ref": "MetricValue",
+ "description": "The number of bids with the specified creative."
+ },
+ "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": {
+ "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"
+ },
+ "NativeContent": {
+ "description": "Native content for a creative.",
+ "type": "object",
+ "properties": {
+ "videoUrl": {
+ "description": "The URL to fetch a native video ad.",
+ "type": "string"
+ },
+ "logo": {
+ "description": "A smaller image, for the advertiser's logo.",
+ "$ref": "Image"
+ },
+ "clickLinkUrl": {
+ "description": "The URL that the browser/SDK will load when the user clicks the ad.",
+ "type": "string"
+ },
+ "priceDisplayText": {
+ "description": "The price of the promoted app including currency info.",
+ "type": "string"
+ },
+ "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": {
+ "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"
+ }
+ },
+ "id": "NativeContent"
+ },
+ "ListClientsResponse": {
+ "type": "object",
+ "properties": {
+ "clients": {
+ "description": "The returned list of clients.",
+ "type": "array",
+ "items": {
+ "$ref": "Client"
+ }
+ },
+ "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"
+ }
+ },
+ "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": {
+ "description": "The serving context for this restriction.",
+ "type": "object",
+ "properties": {
+ "appType": {
+ "description": "Matches impressions for a particular app type.",
+ "$ref": "AppContext"
+ },
+ "securityType": {
+ "$ref": "SecurityContext",
+ "description": "Matches impressions for a particular security type."
+ },
+ "platform": {
+ "description": "Matches impressions coming from a particular platform.",
+ "$ref": "PlatformContext"
+ },
+ "location": {
+ "description": "Matches impressions coming from users *or* publishers in a specific\nlocation.",
+ "$ref": "LocationContext"
+ },
+ "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"
+ },
+ "Image": {
+ "description": "An image resource. You may provide a larger image than was requested,\nso long as the aspect ratio is preserved.",
+ "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"
+ },
"ListFilterSetsResponse": {
"description": "Response message for listing filter sets.",
"type": "object",
@@ -1972,10 +2498,16 @@
"type": "object",
"properties": {
"impressionCount": {
- "description": "The number of impressions for which there was a bid response with the\nspecified status.",
- "$ref": "MetricValue"
+ "$ref": "MetricValue",
+ "description": "The number of impressions for which there was a bid response with the\nspecified status."
},
"status": {
+ "enumDescriptions": [
+ "A placeholder for an undefined status.\nThis value will never be returned in responses.",
+ "The response had no bids.",
+ "The response had no bids for the specified account, though it may have\nincluded bids on behalf of other accounts.",
+ "The response had no bids for the specified deal, though it may have\nincluded bids on other deals on behalf of the account to which the deal\nbelongs."
+ ],
"enum": [
"STATUS_UNSPECIFIED",
"RESPONSES_WITHOUT_BIDS",
@@ -1983,13 +2515,7 @@
"RESPONSES_WITHOUT_BIDS_FOR_DEAL"
],
"description": "The status specifying why the bid responses were considered to have no\napplicable bids.",
- "type": "string",
- "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."
- ]
+ "type": "string"
},
"rowDimensions": {
"$ref": "RowDimensions",
@@ -2002,10 +2528,6 @@
"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",
@@ -2015,6 +2537,10 @@
"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"
@@ -2039,22 +2565,44 @@
"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"
}
+ },
+ "nextPageToken": {
+ "description": "A token to retrieve the next page of results.\nPass this value in the\nListClientUsersRequest.pageToken\nfield in the subsequent call to the\nclients.invitations.list\nmethod to retrieve the next\npage of results.",
+ "type": "string"
}
},
"id": "ListClientUsersResponse"
},
"ListCreativeStatusBreakdownByDetailResponse": {
+ "description": "Response message for listing all details associated with a given filtered bid\nreason.",
+ "type": "object",
"properties": {
+ "detailType": {
+ "description": "The type of detail that the detail IDs represent.",
+ "type": "string",
+ "enumDescriptions": [
+ "A placeholder for an undefined status.\nThis value will never be returned in responses.",
+ "Indicates that the detail ID refers to a creative attribute; see\n[publisher-excludable-creative-attributes](https://developers.google.com/ad-exchange/rtb/downloads/publisher-excludable-creative-attributes).",
+ "Indicates that the detail ID refers to a vendor; see\n[vendors](https://developers.google.com/ad-exchange/rtb/downloads/vendors).",
+ "Indicates that the detail ID refers to a sensitive category; see\n[ad-sensitive-categories](https://developers.google.com/ad-exchange/rtb/downloads/ad-sensitive-categories).",
+ "Indicates that the detail ID refers to a product category; see\n[ad-product-categories](https://developers.google.com/ad-exchange/rtb/downloads/ad-product-categories).",
+ "Indicates that the detail ID refers to a disapproval reason; see\nDisapprovalReason enum in [snippet-status-report-proto](https://developers.google.com/ad-exchange/rtb/downloads/snippet-status-report-proto)."
+ ],
+ "enum": [
+ "DETAIL_TYPE_UNSPECIFIED",
+ "CREATIVE_ATTRIBUTE",
+ "VENDOR",
+ "SENSITIVE_CATEGORY",
+ "PRODUCT_CATEGORY",
+ "DISAPPROVAL_REASON"
+ ]
+ },
"filteredBidDetailRows": {
"description": "List of rows, with counts of bids with a given creative status aggregated\nby detail.",
"type": "array",
@@ -2065,31 +2613,9 @@
"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"
+ "id": "ListCreativeStatusBreakdownByDetailResponse"
},
"LocationContext": {
"description": "@OutputOnly The Geo criteria the restriction applies to.",
@@ -2107,6 +2633,8 @@
"id": "LocationContext"
},
"PlatformContext": {
+ "description": "@OutputOnly The type of platform the restriction applies to.",
+ "type": "object",
"properties": {
"platforms": {
"description": "The platforms this restriction applies to.",
@@ -2126,9 +2654,7 @@
]
}
},
- "id": "PlatformContext",
- "description": "@OutputOnly The type of platform the restriction applies to.",
- "type": "object"
+ "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).",
@@ -2148,7 +2674,25 @@
"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": {
+ "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",
@@ -2162,27 +2706,9 @@
"description": "Numerical account ID of the client buyer\nwith which the user is associated; the\nbuyer must be a client of the current sponsor buyer.\nThe value of this field is ignored in an update operation.",
"format": "int64",
"type": "string"
- },
- "status": {
- "enumDescriptions": [
- "A placeholder for an undefined user status.",
- "A user who was already created but hasn't accepted the invitation yet.",
- "A user that is currently active.",
- "A user that is currently disabled."
- ],
- "enum": [
- "USER_STATUS_UNSPECIFIED",
- "PENDING",
- "ACTIVE",
- "DISABLED"
- ],
- "description": "The status of the client user.",
- "type": "string"
}
},
- "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"
+ "id": "ClientUser"
},
"CreativeDealAssociation": {
"description": "The association between a creative and a deal.",
@@ -2207,146 +2733,27 @@
"description": "@OutputOnly Filtering reasons for this creative during a period of a single\nday (from midnight to midnight Pacific).",
"type": "object",
"properties": {
- "date": {
- "$ref": "Date",
- "description": "The day during which the data was collected.\nThe data is collected from 00:00:00 to 23:59:59 PT.\nDuring switches from PST to PDT and back, the day may\ncontain 23 or 25 hours of data instead of the usual 24."
- },
"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": {
+ "description": "A creative and its classification data.",
+ "type": "object",
"properties": {
- "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"
- },
- "detectedProductCategories": {
- "description": "@OutputOnly Detected product categories, if any.\nSee the ad-product-categories.txt file in the technical documentation\nfor a list of IDs.",
- "type": "array",
- "items": {
- "format": "int32",
- "type": "integer"
- }
- },
- "dealsStatus": {
- "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."
- ]
- },
- "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"
- },
- "detectedAdvertiserIds": {
- "description": "@OutputOnly Detected advertiser IDs, if any.",
- "type": "array",
- "items": {
- "format": "int64",
- "type": "string"
- }
- },
- "detectedDomains": {
- "description": "@OutputOnly\nThe detected domains for this creative.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
"filteringStats": {
- "$ref": "FilteringStats",
- "description": "@OutputOnly The filtering stats for this creative."
+ "description": "@OutputOnly The filtering stats for this creative.",
+ "$ref": "FilteringStats"
},
"attributes": {
"enumDescriptions": [
@@ -2432,8 +2839,8 @@
"$ref": "NativeContent"
},
"video": {
- "description": "A video creative.",
- "$ref": "VideoContent"
+ "$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).",
@@ -2453,19 +2860,138 @@
"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": {
+ "description": "The link to AdChoices destination page.",
+ "type": "string"
+ },
+ "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": {
+ "type": "string",
+ "enum": [
+ "NO_RESTRICTED_CATEGORIES",
+ "ALCOHOL"
+ ]
+ }
+ },
+ "corrections": {
+ "description": "@OutputOnly Shows any corrections that were applied to this creative.",
+ "type": "array",
+ "items": {
+ "$ref": "Correction"
+ }
+ },
+ "version": {
+ "description": "@OutputOnly The version of this creative.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "vendorIds": {
+ "description": "All vendor IDs for the ads that may be shown from this creative.\nSee https://storage.googleapis.com/adx-rtb-dictionaries/vendors.txt\nfor possible values.",
+ "type": "array",
+ "items": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "impressionTrackingUrls": {
+ "description": "The set of URLs to be called to record an impression.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "html": {
+ "$ref": "HtmlContent",
+ "description": "An HTML creative."
+ },
+ "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": {
+ "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.",
+ "type": "string"
+ },
+ "advertiserName": {
+ "description": "The name of the company being advertised in the creative.",
+ "type": "string"
+ },
+ "detectedAdvertiserIds": {
+ "description": "@OutputOnly Detected advertiser IDs, if any.",
+ "type": "array",
+ "items": {
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "detectedDomains": {
+ "description": "@OutputOnly\nThe detected domains for this creative.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
}
},
- "id": "Creative",
- "description": "A creative and its classification data.",
- "type": "object"
+ "id": "Creative"
},
"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."
+ "description": "The association between a creative and a deal that should be removed.",
+ "$ref": "CreativeDealAssociation"
}
},
"id": "RemoveDealAssociationRequest"
@@ -2474,16 +3000,16 @@
"description": "Response message for listing all creatives associated with a given filtered\nbid reason.",
"type": "object",
"properties": {
- "nextPageToken": {
- "description": "A token to retrieve the next page of results.\nPass this value in the\nListCreativeStatusBreakdownByCreativeRequest.pageToken\nfield in the subsequent call to the filteredBids.creatives.list\nmethod to retrieve the next page of results.",
- "type": "string"
- },
"filteredBidCreativeRows": {
"description": "List of rows, with counts of bids with a given creative status aggregated\nby creative.",
"type": "array",
"items": {
"$ref": "FilteredBidCreativeRow"
}
+ },
+ "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"
}
},
"id": "ListCreativeStatusBreakdownByCreativeResponse"
@@ -2492,11 +3018,36 @@
"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": {
+ "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": {
+ "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"
+ ],
+ "description": "The status of the client buyer.",
+ "type": "string"
+ },
"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": {
+ "description": "The type of the client entity: `ADVERTISER`, `BRAND`, or `AGENCY`.",
+ "type": "string",
"enumDescriptions": [
"A placeholder for an undefined client entity type. Should not be used.",
"An advertiser.",
@@ -2508,15 +3059,19 @@
"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",
@@ -2524,13 +3079,7 @@
"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",
- "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."
- ]
+ "type": "string"
},
"visibleToSeller": {
"description": "Whether the client buyer will be visible to sellers.",
@@ -2540,29 +3089,6 @@
"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"
@@ -2571,14 +3097,21 @@
"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",
@@ -2594,21 +3127,7 @@
"VIDEO_IN_SNIPPET_ATTRIBUTE_ADDED"
],
"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."
- ]
+ "type": "string"
},
"contexts": {
"description": "The contexts for the correction.",
@@ -2616,6 +3135,13 @@
"items": {
"$ref": "ServingContext"
}
+ },
+ "details": {
+ "description": "Additional details about what was corrected.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
}
},
"id": "Correction"
@@ -2624,45 +3150,6 @@
"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": {
- "relativeDateRange": {
- "$ref": "RelativeDateRange",
- "description": "A relative date range, defined by an offset from today and a duration.\nInterpreted relative to Pacific time zone."
- },
- "platforms": {
- "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"
- },
- "enumDescriptions": [
- "A placeholder for an undefined platform; indicates that no platform\nfilter will be applied.",
- "The ad impression appears on a desktop.",
- "The ad impression appears on a tablet.",
- "The ad impression appears on a mobile device."
- ]
- },
- "name": {
- "description": "A user-defined name of the filter set. Filter set names must be unique\nglobally and match one of the patterns:\n\n- `bidders/*/filterSets/*` (for accessing bidder-level troubleshooting\ndata)\n- `bidders/*/accounts/*/filterSets/*` (for accessing account-level\ntroubleshooting data)\n\nThis field is required in create operations.",
- "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": {
- "$ref": "AbsoluteDateRange",
- "description": "An absolute date range, defined by a start date and an end date.\nInterpreted relative to Pacific time zone."
- },
"environment": {
"enumDescriptions": [
"A placeholder for an undefined environment; indicates that no environment\nfilter will be applied.",
@@ -2678,17 +3165,17 @@
"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."
+ ],
+ "enum": [
+ "FORMAT_UNSPECIFIED",
+ "DISPLAY",
+ "VIDEO"
]
},
"dealId": {
@@ -2697,17 +3184,17 @@
"type": "string"
},
"timeSeriesGranularity": {
- "enum": [
- "TIME_SERIES_GRANULARITY_UNSPECIFIED",
- "HOURLY",
- "DAILY"
- ],
"description": "The granularity of time intervals if a time series breakdown is desired;\noptional.",
"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"
]
},
"realtimeTimeRange": {
@@ -2734,11 +3221,52 @@
"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": {
+ "$ref": "RelativeDateRange",
+ "description": "A relative date range, defined by an offset from today and a duration.\nInterpreted relative to Pacific time zone."
+ },
+ "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"
}
},
"id": "FilterSet"
},
"ListDealAssociationsResponse": {
+ "description": "A response for listing creative and deal associations",
+ "type": "object",
"properties": {
"nextPageToken": {
"description": "A token to retrieve the next page of results.\nPass this value in the\nListDealAssociationsRequest.page_token\nfield in the subsequent call to 'ListDealAssociation' method to retrieve\nthe next page of results.",
@@ -2752,31 +3280,31 @@
}
}
},
- "id": "ListDealAssociationsResponse",
- "description": "A response for listing creative and deal associations",
- "type": "object"
+ "id": "ListDealAssociationsResponse"
},
"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": {
"$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"
+ "$ref": "RowDimensions",
+ "description": "The values of all dimensions associated with metric values in this row."
}
},
- "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"
+ "id": "CalloutStatusRow"
},
"Disapproval": {
+ "description": "@OutputOnly The reason and details for a disapproval.",
+ "type": "object",
"properties": {
"details": {
"description": "Additional details about the reason for disapproval.",
@@ -2786,6 +3314,8 @@
}
},
"reason": {
+ "description": "The categorized reason for disapproval.",
+ "type": "string",
"enumDescriptions": [
"The length of the image animation is longer than allowed.",
"The click through URL doesn't work properly.",
@@ -2977,14 +3507,10 @@
"MAXIMUM_NUMBER_OF_COOKIES_EXCEEDED",
"PERSONAL_LOANS",
"UNSUPPORTED_FLASH_CONTENT"
- ],
- "description": "The categorized reason for disapproval.",
- "type": "string"
+ ]
}
},
- "id": "Disapproval",
- "description": "@OutputOnly The reason and details for a disapproval.",
- "type": "object"
+ "id": "Disapproval"
},
"StopWatchingCreativeRequest": {
"description": "A request for stopping notifications for changes to creative Status.",
@@ -2996,26 +3522,19 @@
"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.",
- "type": "array",
- "items": {
- "$ref": "ServingContext"
- }
- },
"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.",
@@ -3023,17 +3542,21 @@
"items": {
"$ref": "Disapproval"
}
+ },
+ "contexts": {
+ "description": "The contexts for the restriction.",
+ "type": "array",
+ "items": {
+ "$ref": "ServingContext"
+ }
}
},
"id": "ServingRestriction"
},
"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",
@@ -3043,11 +3566,14 @@
"description": "Day of month. Must be from 1 to 31 and valid for the year and month, or 0\nif specifying a year/month where the day is not significant.",
"format": "int32",
"type": "integer"
+ },
+ "month": {
+ "description": "Month of year. Must be from 1 to 12.",
+ "format": "int32",
+ "type": "integer"
}
},
- "id": "Date",
- "description": "Represents a whole calendar date, e.g. date of birth. The time of day and\ntime zone are either specified elsewhere or are not significant. The date\nis relative to the Proleptic Gregorian Calendar. The day may be 0 to\nrepresent a year and month where the day is not significant, e.g. credit card\nexpiration date. The year may be 0 to represent a month and day independent\nof year, e.g. anniversary date. Related types are google.type.TimeOfDay\nand `google.protobuf.Timestamp`.",
- "type": "object"
+ "id": "Date"
},
"RowDimensions": {
"description": "A response may include multiple rows, breaking down along various dimensions.\nEncapsulates the values of all dimensions for a given row.",
@@ -3061,12 +3587,14 @@
"id": "RowDimensions"
},
"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"
},
"AppContext": {
+ "description": "@OutputOnly The app type the restriction applies to for mobile device.",
+ "type": "object",
"properties": {
"appTypes": {
"description": "The app types this restriction applies to.",
@@ -3084,9 +3612,7 @@
]
}
},
- "id": "AppContext",
- "description": "@OutputOnly The app type the restriction applies to for mobile device.",
- "type": "object"
+ "id": "AppContext"
},
"ListFilteredBidsResponse": {
"description": "Response message for listing all reasons that bids were filtered from the\nauction.",
@@ -3107,16 +3633,18 @@
"id": "ListFilteredBidsResponse"
},
"SecurityContext": {
+ "description": "@OutputOnly A security context.",
+ "type": "object",
"properties": {
"securities": {
"description": "The security types in this context.",
"type": "array",
"items": {
+ "type": "string",
"enum": [
"INSECURE",
"SSL"
- ],
- "type": "string"
+ ]
},
"enumDescriptions": [
"Matches impressions that require insecure compatibility.",
@@ -3124,48 +3652,7 @@
]
}
},
- "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": {
- "properties": {
- "nextPageToken": {
- "description": "A token to retrieve the next page of results.\nPass this value in the\nListCreativesRequest.page_token\nfield in the subsequent call to `ListCreatives` method to retrieve the next\npage of results.",
- "type": "string"
- },
- "creatives": {
- "description": "The list of creatives.",
- "type": "array",
- "items": {
- "$ref": "Creative"
- }
- }
- },
- "id": "ListCreativesResponse",
- "description": "A response for listing creatives.",
- "type": "object"
+ "id": "SecurityContext"
},
"ListFilteredBidRequestsResponse": {
"description": "Response message for listing all reasons that bid requests were filtered and\nnot sent to the buyer.",
@@ -3185,540 +3672,63 @@
},
"id": "ListFilteredBidRequestsResponse"
},
- "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": {
- "properties": {
- "count": {
- "description": "The number of times the creative was filtered for the status. The\ncount is aggregated across all publishers on the exchange.",
- "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.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "Reason",
- "description": "A specific filtering status and how many times it occurred.",
- "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"
- },
- "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": {
- "description": "Response message for listing all reasons for which a buyer was not billed for\na winning bid.",
- "type": "object",
- "properties": {
- "nextPageToken": {
- "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"
- },
- "nonBillableWinningBidStatusRows": {
- "description": "List of rows, with counts of bids not billed aggregated by reason.",
- "type": "array",
- "items": {
- "$ref": "NonBillableWinningBidStatusRow"
- }
- }
- },
- "id": "ListNonBillableWinningBidsResponse"
- },
- "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": {
- "successfulResponses": {
- "description": "The number of impressions for which the buyer successfully sent a response\nto Ad Exchange.",
- "$ref": "MetricValue"
- },
- "rowDimensions": {
- "description": "The values of all dimensions associated with metric values in this row.",
- "$ref": "RowDimensions"
- },
- "availableImpressions": {
- "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"
- },
- "bidRequests": {
- "description": "The number of impressions for which Ad Exchange sent the buyer a bid\nrequest.",
- "$ref": "MetricValue"
- },
- "responsesWithBids": {
- "$ref": "MetricValue",
- "description": "The number of impressions for which Ad Exchange received a response from\nthe buyer that contained at least one applicable bid."
- }
- },
- "id": "ImpressionMetricsRow"
- },
- "AuctionContext": {
- "properties": {
- "auctionTypes": {
- "description": "The auction types this restriction applies to.",
- "type": "array",
- "items": {
- "enum": [
- "OPEN_AUCTION",
- "DIRECT_DEALS"
- ],
- "type": "string"
- },
- "enumDescriptions": [
- "The restriction applies to open auction.",
- "The restriction applies to direct deals."
- ]
- }
- },
- "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": {
- "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"
- },
- "rowDimensions": {
- "description": "The values of all dimensions associated with metric values in this row.",
- "$ref": "RowDimensions"
- },
- "viewableImpressions": {
- "description": "The number of bids for which the corresponding impression was viewable (as\ndefined by Active View).",
- "$ref": "MetricValue"
- },
- "impressionsWon": {
- "description": "The number of bids that won an impression.",
- "$ref": "MetricValue"
- },
- "measurableImpressions": {
- "$ref": "MetricValue",
- "description": "The number of bids for which the corresponding impression was measurable\nfor viewability (as defined by Active View)."
- },
- "bids": {
- "description": "The number of bids that Ad Exchange received from the buyer.",
- "$ref": "MetricValue"
- }
- },
- "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": {
- "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": {
- "$ref": "MetricValue",
- "description": "The number of bids with the specified status."
- }
- },
- "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": {
- "description": "The number of bids with the specified status.",
- "$ref": "MetricValue"
- },
- "status": {
- "enum": [
- "STATUS_UNSPECIFIED",
- "AD_NOT_RENDERED",
- "INVALID_IMPRESSION"
- ],
- "description": "The status specifying why the winning bids were not billed.",
- "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."
- ]
- }
- },
- "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": {
- "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": {
- "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 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"
- },
- "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",
- "properties": {
- "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"
- },
- "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"
- },
- "AddDealAssociationRequest": {
- "properties": {
- "association": {
- "$ref": "CreativeDealAssociation",
- "description": "The association between a creative and a deal that should be added."
- }
- },
- "id": "AddDealAssociationRequest",
- "description": "A request for associating a deal and a creative.",
- "type": "object"
- },
- "WatchCreativeRequest": {
- "description": "A request for watching changes to creative Status.",
- "type": "object",
- "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"
- },
- "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": {
- "description": "The number of filtered bids with the specified dimension values that have the\nspecified creative.",
- "type": "object",
- "properties": {
- "creativeId": {
- "description": "The ID of the creative.",
- "type": "string"
- },
- "rowDimensions": {
- "description": "The values of all dimensions associated with metric values in this row.",
- "$ref": "RowDimensions"
- },
- "bidCount": {
- "$ref": "MetricValue",
- "description": "The number of bids with the specified creative."
- }
- },
- "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": {
- "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"
- },
- "ListClientsResponse": {
- "type": "object",
- "properties": {
- "clients": {
- "description": "The returned list of clients.",
- "type": "array",
- "items": {
- "$ref": "Client"
- }
- },
- "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"
- }
- },
- "id": "ListClientsResponse"
- },
- "NativeContent": {
- "properties": {
- "logo": {
- "$ref": "Image",
- "description": "A smaller image, for the advertiser's logo."
- },
- "clickLinkUrl": {
- "description": "The URL that the browser/SDK will load when the user clicks the ad.",
- "type": "string"
- },
- "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",
- "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": {
- "description": "The serving context for this restriction.",
- "type": "object",
- "properties": {
- "appType": {
- "$ref": "AppContext",
- "description": "Matches impressions for a particular app type."
- },
- "securityType": {
- "description": "Matches impressions for a particular security type.",
- "$ref": "SecurityContext"
- },
- "platform": {
- "description": "Matches impressions coming from a particular platform.",
- "$ref": "PlatformContext"
- },
- "location": {
- "description": "Matches impressions coming from users *or* publishers in a specific\nlocation.",
- "$ref": "LocationContext"
- },
- "auctionType": {
- "$ref": "AuctionContext",
- "description": "Matches impressions for a particular auction type."
- },
- "all": {
- "enumDescriptions": [
- "A simple context."
- ],
- "enum": [
- "SIMPLE_CONTEXT"
- ],
- "description": "Matches all contexts.",
- "type": "string"
- }
- },
- "id": "ServingContext"
- },
- "Image": {
- "description": "An image resource. You may provide a larger image than was requested,\nso long as the aspect ratio is preserved.",
+ "HtmlContent": {
+ "description": "HTML content for a creative.",
"type": "object",
"properties": {
"height": {
- "description": "Image height in pixels.",
+ "description": "The height of the HTML snippet in pixels.",
"format": "int32",
"type": "integer"
},
"width": {
- "description": "Image width in pixels.",
+ "description": "The width of the HTML snippet in pixels.",
"format": "int32",
"type": "integer"
},
- "url": {
- "description": "The URL of the image.",
+ "snippet": {
+ "description": "The HTML snippet that displays the ad when inserted in the web page.",
"type": "string"
}
},
- "id": "Image"
+ "id": "HtmlContent"
+ },
+ "ListCreativesResponse": {
+ "description": "A response for listing creatives.",
+ "type": "object",
+ "properties": {
+ "creatives": {
+ "description": "The list of creatives.",
+ "type": "array",
+ "items": {
+ "$ref": "Creative"
+ }
+ },
+ "nextPageToken": {
+ "description": "A token to retrieve the next page of results.\nPass this value in the\nListCreativesRequest.page_token\nfield in the subsequent call to `ListCreatives` method to retrieve the next\npage of results.",
+ "type": "string"
+ }
+ },
+ "id": "ListCreativesResponse"
}
},
- "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": "AdExchangeBuyerII",
+ "auth": {
+ "oauth2": {
+ "scopes": {
+ "https://www.googleapis.com/auth/adexchange.buyer": {
+ "description": "Manage your Ad Exchange buyer account configuration"
+ }
+ }
+ }
+ },
+ "rootUrl": "https://adexchangebuyer.googleapis.com/",
+ "ownerDomain": "google.com",
+ "name": "adexchangebuyer2",
+ "batchPath": "batch"
}
diff --git a/adexchangebuyer2/v2beta1/adexchangebuyer2-gen.go b/adexchangebuyer2/v2beta1/adexchangebuyer2-gen.go
index 8041dee..04905e5 100644
--- a/adexchangebuyer2/v2beta1/adexchangebuyer2-gen.go
+++ b/adexchangebuyer2/v2beta1/adexchangebuyer2-gen.go
@@ -5095,6 +5095,13 @@
return c
}
+// AccountId1 sets the optional parameter "accountId1": The account the
+// creative belongs to.
+func (c *AccountsCreativesCreateCall) AccountId1(accountId1 string) *AccountsCreativesCreateCall {
+ c.urlParams_.Set("accountId1", accountId1)
+ return c
+}
+
// DuplicateIdMode sets the optional parameter "duplicateIdMode":
// Indicates if multiple creatives can share an ID or not. Default
// is
@@ -5208,6 +5215,11 @@
// "required": true,
// "type": "string"
// },
+ // "accountId1": {
+ // "description": "The account the creative belongs to.",
+ // "location": "query",
+ // "type": "string"
+ // },
// "duplicateIdMode": {
// "description": "Indicates if multiple creatives can share an ID or not. Default is\nNO_DUPLICATES (one ID per creative).",
// "enum": [
@@ -5772,6 +5784,13 @@
return c
}
+// AccountId1 sets the optional parameter "accountId1": The account the
+// creative belongs to.
+func (c *AccountsCreativesUpdateCall) AccountId1(accountId1 string) *AccountsCreativesUpdateCall {
+ c.urlParams_.Set("accountId1", accountId1)
+ return c
+}
+
// Fields allows partial responses to be retrieved. See
// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
// for more information.
@@ -5874,6 +5893,11 @@
// "required": true,
// "type": "string"
// },
+ // "accountId1": {
+ // "description": "The account the creative belongs to.",
+ // "location": "query",
+ // "type": "string"
+ // },
// "creativeId": {
// "description": "The buyer-defined creative ID of this creative.\nCan be used to filter the response of the\ncreatives.list\nmethod.",
// "location": "path",
diff --git a/adexperiencereport/v1/adexperiencereport-api.json b/adexperiencereport/v1/adexperiencereport-api.json
index 242e0c0..53c2ce6 100644
--- a/adexperiencereport/v1/adexperiencereport-api.json
+++ b/adexperiencereport/v1/adexperiencereport-api.json
@@ -1,149 +1,4 @@
{
- "title": "Google Ad Experience Report API",
- "ownerName": "Google",
- "resources": {
- "violatingSites": {
- "methods": {
- "list": {
- "response": {
- "$ref": "ViolatingSitesResponse"
- },
- "parameterOrder": [],
- "httpMethod": "GET",
- "parameters": {},
- "scopes": [
- "https://www.googleapis.com/auth/xapi.zoo"
- ],
- "flatPath": "v1/violatingSites",
- "path": "v1/violatingSites",
- "id": "adexperiencereport.violatingSites.list",
- "description": "Lists sites with Ad Experience Report statuses of \"Failing\" or \"Warning\"."
- }
- }
- },
- "sites": {
- "methods": {
- "get": {
- "description": "Gets a summary of the ad experience rating of a site.",
- "httpMethod": "GET",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "SiteSummaryResponse"
- },
- "parameters": {
- "name": {
- "pattern": "^sites/[^/]+$",
- "location": "path",
- "description": "The required site name. It should be the site property whose ad experiences\nmay have been reviewed, and it should be URL-encoded. For example,\nsites/https%3A%2F%2Fwww.google.com. The server will return an error of\nBAD_REQUEST if this field is not filled in. Note that if the site property\nis not yet verified in Search Console, the reportUrl field returned by the\nAPI will lead to the verification page, prompting the user to go through\nthat process before they can gain access to the Ad Experience Report.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/xapi.zoo"
- ],
- "flatPath": "v1/sites/{sitesId}",
- "id": "adexperiencereport.sites.get",
- "path": "v1/{+name}"
- }
- }
- }
- },
- "parameters": {
- "oauth_token": {
- "location": "query",
- "description": "OAuth 2.0 token for the current user.",
- "type": "string"
- },
- "bearer_token": {
- "location": "query",
- "description": "OAuth bearer token.",
- "type": "string"
- },
- "upload_protocol": {
- "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": {
- "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"
- }
- },
- "version": "v1",
- "baseUrl": "https://adexperiencereport.googleapis.com/",
- "kind": "discovery#restDescription",
- "description": "View Ad Experience Report data, and get a list of sites that have a significant number of annoying ads.",
- "servicePath": "",
"basePath": "",
"id": "adexperiencereport:v1",
"documentationLink": "https://developers.google.com/ad-experience-report/",
@@ -152,17 +7,12 @@
"version_module": true,
"schemas": {
"PlatformSummary": {
+ "description": "Summary of the ad experience rating of a site for a specific platform.",
+ "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": {
+ "description": "The status of the site reviewed for the Better Ads Standards.",
+ "type": "string",
"enumDescriptions": [
"Not reviewed.",
"Passing.",
@@ -174,20 +24,18 @@
"PASSING",
"WARNING",
"FAILING"
- ],
- "description": "The status of the site reviewed for the Better Ads Standards.",
- "type": "string"
+ ]
},
"region": {
"description": "The assigned regions for the site and platform.",
"type": "array",
"items": {
+ "type": "string",
"enum": [
"REGION_UNKNOWN",
"REGION_A",
"REGION_B"
- ],
- "type": "string"
+ ]
},
"enumDescriptions": [
"Ad standard not yet defined for your region.",
@@ -221,13 +69,22 @@
"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",
- "description": "Summary of the ad experience rating of a site for a specific platform.",
- "type": "object"
+ "id": "PlatformSummary"
},
"ViolatingSitesResponse": {
+ "description": "Response message for ListViolatingSites.",
+ "type": "object",
"properties": {
"violatingSites": {
"description": "A list of summaries of violating sites.",
@@ -237,16 +94,12 @@
}
}
},
- "id": "ViolatingSitesResponse",
- "description": "Response message for ListViolatingSites.",
- "type": "object"
+ "id": "ViolatingSitesResponse"
},
"SiteSummaryResponse": {
+ "description": "Response message for GetSiteSummary.",
+ "type": "object",
"properties": {
- "desktopSummary": {
- "description": "Summary for the desktop review of the site.",
- "$ref": "PlatformSummary"
- },
"mobileSummary": {
"$ref": "PlatformSummary",
"description": "Summary for the mobile review of the site."
@@ -254,16 +107,18 @@
"reviewedSite": {
"description": "The name of the site reviewed.",
"type": "string"
+ },
+ "desktopSummary": {
+ "description": "Summary for the desktop review of the site.",
+ "$ref": "PlatformSummary"
}
},
- "id": "SiteSummaryResponse",
- "description": "Response message for GetSiteSummary.",
- "type": "object"
+ "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"
+ "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",
@@ -279,5 +134,150 @@
"rootUrl": "https://adexperiencereport.googleapis.com/",
"ownerDomain": "google.com",
"name": "adexperiencereport",
- "batchPath": "batch"
+ "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.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "SiteSummaryResponse"
+ },
+ "parameters": {
+ "name": {
+ "description": "The required site name. It should be the site property whose ad experiences\nmay have been reviewed, and it should be URL-encoded. For example,\nsites/https%3A%2F%2Fwww.google.com. The server will return an error of\nBAD_REQUEST if this field is not filled in. Note that if the site property\nis not yet verified in Search Console, the reportUrl field returned by the\nAPI will lead to the verification page, prompting the user to go through\nthat process before they can gain access to the Ad Experience Report.",
+ "required": true,
+ "type": "string",
+ "pattern": "^sites/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/xapi.zoo"
+ ],
+ "flatPath": "v1/sites/{sitesId}",
+ "id": "adexperiencereport.sites.get",
+ "path": "v1/{+name}"
+ }
+ }
+ },
+ "violatingSites": {
+ "methods": {
+ "list": {
+ "description": "Lists sites with Ad Experience Report statuses of \"Failing\" or \"Warning\".",
+ "response": {
+ "$ref": "ViolatingSitesResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "GET",
+ "parameters": {},
+ "scopes": [
+ "https://www.googleapis.com/auth/xapi.zoo"
+ ],
+ "flatPath": "v1/violatingSites",
+ "path": "v1/violatingSites",
+ "id": "adexperiencereport.violatingSites.list"
+ }
+ }
+ }
+ },
+ "parameters": {
+ "pp": {
+ "location": "query",
+ "description": "Pretty-print response.",
+ "type": "boolean",
+ "default": "true"
+ },
+ "oauth_token": {
+ "location": "query",
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string"
+ },
+ "bearer_token": {
+ "description": "OAuth bearer token.",
+ "type": "string",
+ "location": "query"
+ },
+ "upload_protocol": {
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "type": "string",
+ "location": "query"
+ },
+ "prettyPrint": {
+ "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": {
+ "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"
+ }
+ },
+ "version": "v1",
+ "baseUrl": "https://adexperiencereport.googleapis.com/",
+ "kind": "discovery#restDescription",
+ "description": "View Ad Experience Report data, and get a list of sites that have a significant number of annoying ads.",
+ "servicePath": ""
}
diff --git a/analyticsreporting/v4/analyticsreporting-api.json b/analyticsreporting/v4/analyticsreporting-api.json
index 5c2cb33..f012887 100644
--- a/analyticsreporting/v4/analyticsreporting-api.json
+++ b/analyticsreporting/v4/analyticsreporting-api.json
@@ -1,393 +1,28 @@
{
- "ownerName": "Google",
- "resources": {
- "reports": {
- "methods": {
- "batchGet": {
- "response": {
- "$ref": "GetReportsResponse"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/analytics",
- "https://www.googleapis.com/auth/analytics.readonly"
- ],
- "parameters": {},
- "flatPath": "v4/reports:batchGet",
- "path": "v4/reports:batchGet",
- "id": "analyticsreporting.reports.batchGet",
- "description": "Returns the Analytics data.",
- "request": {
- "$ref": "GetReportsRequest"
- }
- }
- }
- }
- },
- "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": {
- "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": {
- "description": "Pretty-print response.",
- "type": "boolean",
- "default": "true",
- "location": "query"
- },
- "oauth_token": {
- "description": "OAuth 2.0 token for the current user.",
- "type": "string",
- "location": "query"
- },
- "bearer_token": {
- "location": "query",
- "description": "OAuth bearer token.",
- "type": "string"
- }
- },
- "version": "v4",
- "baseUrl": "https://analyticsreporting.googleapis.com/",
- "servicePath": "",
- "description": "Accesses Analytics report data.",
- "kind": "discovery#restDescription",
"basePath": "",
- "revision": "20171108",
"documentationLink": "https://developers.google.com/analytics/devguides/reporting/core/v4/",
+ "revision": "20171108",
"id": "analyticsreporting:v4",
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
- "SegmentDimensionFilter": {
- "description": "Dimension filter specifies the filtering options on a dimension.",
- "type": "object",
- "properties": {
- "minComparisonValue": {
- "description": "Minimum comparison values for `BETWEEN` match type.",
- "type": "string"
- },
- "maxComparisonValue": {
- "description": "Maximum comparison values for `BETWEEN` match type.",
- "type": "string"
- },
- "dimensionName": {
- "description": "Name of the dimension for which the filter is being applied.",
- "type": "string"
- },
- "operator": {
- "enum": [
- "OPERATOR_UNSPECIFIED",
- "REGEXP",
- "BEGINS_WITH",
- "ENDS_WITH",
- "PARTIAL",
- "EXACT",
- "IN_LIST",
- "NUMERIC_LESS_THAN",
- "NUMERIC_GREATER_THAN",
- "NUMERIC_BETWEEN"
- ],
- "description": "The operator to use to match the dimension with the expressions.",
- "type": "string",
- "enumDescriptions": [
- "If the match type is unspecified, it is treated as a REGEXP.",
- "The match expression is treated as a regular expression. All other match\ntypes are not treated as regular expressions.",
- "Matches the values which begin with the match expression provided.",
- "Matches the values which end with the match expression provided.",
- "Substring match.",
- "The value should match the match expression entirely.",
- "This option is used to specify a dimension filter whose expression can\ntake any value from a selected list of values. This helps avoiding\nevaluating multiple exact match dimension filters which are OR'ed for\nevery single response row. For example:\n\n expressions: [\"A\", \"B\", \"C\"]\n\nAny response row whose dimension has it is value as A, B or C, matches\nthis DimensionFilter.",
- "Integer comparison filters.\ncase sensitivity is ignored for these and the expression\nis assumed to be a string representing an integer.\nFailure conditions:\n\n- if expression is not a valid int64, the client should expect\n an error.\n- input dimensions that are not valid int64 values will never match the\n filter.\n\nChecks if the dimension is numerically less than the match expression.",
- "Checks if the dimension is numerically greater than the match\nexpression.",
- "Checks if the dimension is numerically between the minimum and maximum\nof the match expression, boundaries excluded."
- ]
- },
- "expressions": {
- "description": "The list of expressions, only the first element is used for all operators",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "caseSensitive": {
- "description": "Should the match be case sensitive, ignored for `IN_LIST` operator.",
- "type": "boolean"
- }
- },
- "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": {
- "description": "A dynamic segment definition in the request.",
- "$ref": "DynamicSegment"
- },
- "segmentId": {
- "description": "The segment ID of a built-in or custom segment, for example `gaid::-3`.",
- "type": "string"
- }
- },
- "id": "Segment"
- },
- "OrderBy": {
- "properties": {
- "fieldName": {
- "description": "The field which to sort by. The default sort order is ascending. Example:\n`ga:browser`.\nNote, that you can only specify one field for sort here. For example,\n`ga:browser, ga:city` is not valid.",
- "type": "string"
- },
- "orderType": {
- "enum": [
- "ORDER_TYPE_UNSPECIFIED",
- "VALUE",
- "DELTA",
- "SMART",
- "HISTOGRAM_BUCKET",
- "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."
- ]
- },
- "sortOrder": {
- "enumDescriptions": [
- "If the sort order is unspecified, the default is ascending.",
- "Ascending sort. The field will be sorted in an ascending manner.",
- "Descending sort. The field will be sorted in a descending manner."
- ],
- "enum": [
- "SORT_ORDER_UNSPECIFIED",
- "ASCENDING",
- "DESCENDING"
- ],
- "description": "The sorting order for the field.",
- "type": "string"
- }
- },
- "id": "OrderBy",
- "description": "Specifies the sorting options.",
- "type": "object"
- },
- "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"
- }
- },
- "matchType": {
- "enum": [
- "UNSPECIFIED_MATCH_TYPE",
- "PRECEDES",
- "IMMEDIATELY_PRECEDES"
- ],
- "description": "Specifies if the step immediately precedes or can be any time before the\nnext step.",
- "type": "string",
- "enumDescriptions": [
- "Unspecified match type is treated as precedes.",
- "Operator indicates that the previous step precedes the next step.",
- "Operator indicates that the previous step immediately precedes the next\nstep."
- ]
- }
- },
- "id": "SegmentSequenceStep"
- },
- "Metric": {
- "description": "[Metrics](https://support.google.com/analytics/answer/1033861)\nare the quantitative measurements. For example, the metric `ga:users`\nindicates the total number of users for the requested time period.",
- "type": "object",
- "properties": {
- "alias": {
- "description": "An alias for the metric expression is an alternate name for the\nexpression. The alias can be used for filtering and sorting. This field\nis optional and is useful if the expression is not a single metric but\na complex expression which cannot be used in filtering and sorting.\nThe alias is also used in the response column header.",
- "type": "string"
- },
- "expression": {
- "description": "A metric expression in the request. An expression is constructed from one\nor more metrics and numbers. Accepted operators include: Plus (+), Minus\n(-), Negation (Unary -), Divided by (/), Multiplied by (*), Parenthesis,\nPositive cardinal numbers (0-9), can include decimals and is limited to\n1024 characters. Example `ga:totalRefunds/ga:users`, in most cases the\nmetric expression is just a single metric name like `ga:users`.\nAdding mixed `MetricType` (E.g., `CURRENCY` + `PERCENTAGE`) metrics\nwill result in unexpected results.",
- "type": "string"
- },
- "formattingType": {
- "enum": [
- "METRIC_TYPE_UNSPECIFIED",
- "INTEGER",
- "FLOAT",
- "CURRENCY",
- "PERCENT",
- "TIME"
- ],
- "description": "Specifies how the metric expression should be formatted, for example\n`INTEGER`.",
- "type": "string",
- "enumDescriptions": [
- "Metric type is unspecified.",
- "Integer metric.",
- "Float metric.",
- "Currency metric.",
- "Percentage metric.",
- "Time metric in `HH:MM:SS` format."
- ]
- }
- },
- "id": "Metric"
- },
- "PivotValueRegion": {
- "properties": {
- "values": {
- "description": "The values of the metrics in each of the pivot regions.",
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "id": "PivotValueRegion",
- "description": "The metric values in the pivot region.",
- "type": "object"
- },
- "Report": {
- "properties": {
- "data": {
- "description": "Response data.",
- "$ref": "ReportData"
- },
- "nextPageToken": {
- "description": "Page token to retrieve the next page of results in the list.",
- "type": "string"
- },
- "columnHeader": {
- "$ref": "ColumnHeader",
- "description": "The column headers."
- }
- },
- "id": "Report",
- "description": "The data response corresponding to the request.",
- "type": "object"
- },
- "PivotHeader": {
- "properties": {
- "pivotHeaderEntries": {
- "description": "A single pivot section header.",
- "type": "array",
- "items": {
- "$ref": "PivotHeaderEntry"
- }
- },
- "totalPivotGroupsCount": {
- "description": "The total number of groups for this pivot.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "PivotHeader",
- "description": "The headers for each of the pivot sections defined in the request.",
- "type": "object"
- },
"DateRange": {
+ "description": "A contiguous set of days: startDate, startDate + 1 day, ..., endDate.\nThe start and end dates are specified in\n[ISO8601](https://en.wikipedia.org/wiki/ISO_8601) date format `YYYY-MM-DD`.",
+ "type": "object",
"properties": {
- "startDate": {
- "description": "The start date for the query in the format `YYYY-MM-DD`.",
- "type": "string"
- },
"endDate": {
"description": "The end date for the query in the format `YYYY-MM-DD`.",
"type": "string"
+ },
+ "startDate": {
+ "description": "The start date for the query in the format `YYYY-MM-DD`.",
+ "type": "string"
}
},
- "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"
+ "id": "DateRange"
},
"ReportRequest": {
- "description": "The main request class which specifies the Reporting API request.",
- "type": "object",
"properties": {
- "pivots": {
- "description": "The pivot definitions. Requests can have a maximum of 2 pivots.",
- "type": "array",
- "items": {
- "$ref": "Pivot"
- }
- },
- "includeEmptyRows": {
- "description": "If set to false, the response does not include rows if all the retrieved\nmetrics are equal to zero. The default is false which will exclude these\nrows.",
- "type": "boolean"
- },
"metricFilterClauses": {
"description": "The metric filter clauses. They are logically combined with the `AND`\noperator. Metric filters look at only the first date range and not the\ncomparing date range. Note that filtering on metrics occurs after the\nmetrics are aggregated.",
"type": "array",
@@ -400,17 +35,17 @@
"format": "int32",
"type": "integer"
},
- "hideTotals": {
- "description": "If set to true, hides the total of all metrics for all the matching rows,\nfor every date range. The default false and will return the totals.",
- "type": "boolean"
- },
"hideValueRanges": {
"description": "If set to true, hides the minimum and maximum across all matching rows.\nThe default is false and the value ranges are returned.",
"type": "boolean"
},
+ "hideTotals": {
+ "description": "If set to true, hides the total of all metrics for all the matching rows,\nfor every date range. The default false and will return the totals.",
+ "type": "boolean"
+ },
"cohortGroup": {
- "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"
+ "$ref": "CohortGroup",
+ "description": "Cohort group associated with this request. If there is a cohort group\nin the request the `ga:cohort` dimension must be present.\nEvery [ReportRequest](#ReportRequest) within a `batchGet` method must\ncontain the same `cohortGroup` definition."
},
"filtersExpression": {
"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).",
@@ -481,22 +116,27 @@
"pageToken": {
"description": "A continuation token to get the next page of the results. Adding this to\nthe request will return the rows after the pageToken. The pageToken should\nbe the value returned in the nextPageToken parameter in the response to\nthe GetReports request.",
"type": "string"
+ },
+ "pivots": {
+ "description": "The pivot definitions. Requests can have a maximum of 2 pivots.",
+ "type": "array",
+ "items": {
+ "$ref": "Pivot"
+ }
+ },
+ "includeEmptyRows": {
+ "description": "If set to false, the response does not include rows if all the retrieved\nmetrics are equal to zero. The default is false which will exclude these\nrows.",
+ "type": "boolean"
}
},
- "id": "ReportRequest"
+ "id": "ReportRequest",
+ "description": "The main request class which specifies the Reporting API request.",
+ "type": "object"
},
"MetricFilter": {
"description": "MetricFilter specifies the filter on a metric.",
"type": "object",
"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": {
"enumDescriptions": [
"If the operator is not specified, it is treated as `EQUAL`.",
@@ -518,11 +158,21 @@
"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"
},
"Dimension": {
+ "description": "[Dimensions](https://support.google.com/analytics/answer/1033861)\nare attributes of your data. For example, the dimension `ga:city`\nindicates the city, for example, \"Paris\" or \"New York\", from which\na session originates.",
+ "type": "object",
"properties": {
"histogramBuckets": {
"description": "If non-empty, we place dimension values into buckets after string to\nint64. Dimension values that are not the string representation of an\nintegral value will be converted to zero. The bucket values have to be in\nincreasing order. Each bucket is closed on the lower end, and open on the\nupper end. The \"first\" bucket includes all values less than the first\nboundary, the \"last\" bucket includes all values up to infinity. Dimension\nvalues that fall in a bucket get transformed to a new dimension value. For\nexample, if one gives a list of \"0, 1, 3, 4, 7\", then we return the\nfollowing buckets:\n\n- bucket #1: values \u003c 0, dimension value \"\u003c0\"\n- bucket #2: values in [0,1), dimension value \"0\"\n- bucket #3: values in [1,3), dimension value \"1-2\"\n- bucket #4: values in [3,4), dimension value \"3\"\n- bucket #5: values in [4,7), dimension value \"4-6\"\n- bucket #6: values \u003e= 7, dimension value \"7+\"\n\nNOTE: If you are applying histogram mutation on any dimension, and using\nthat dimension in sort, you will want to use the sort type\n`HISTOGRAM_BUCKET` for that purpose. Without that the dimension values\nwill be sorted according to dictionary\n(lexicographic) order. For example the ascending dictionary order is:\n\n \"\u003c50\", \"1001+\", \"121-1000\", \"50-120\"\n\nAnd the ascending `HISTOGRAM_BUCKET` order is:\n\n \"\u003c50\", \"50-120\", \"121-1000\", \"1001+\"\n\nThe client has to explicitly request `\"orderType\": \"HISTOGRAM_BUCKET\"`\nfor a histogram-mutated dimension.",
@@ -537,13 +187,9 @@
"type": "string"
}
},
- "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"
+ "id": "Dimension"
},
"SimpleSegment": {
- "description": "A Simple segment conditions consist of one or more dimension/metric\nconditions that can be combined.",
- "type": "object",
"properties": {
"orFiltersForSegment": {
"description": "A list of segment filters groups which are combined with logical `AND`\noperator.",
@@ -553,13 +199,15 @@
}
}
},
- "id": "SimpleSegment"
+ "id": "SimpleSegment",
+ "description": "A Simple segment conditions consist of one or more dimension/metric\nconditions that can be combined.",
+ "type": "object"
},
"DynamicSegment": {
"properties": {
"sessionSegment": {
- "$ref": "SegmentDefinition",
- "description": "Session Segment to select sessions to include in the segment."
+ "description": "Session Segment to select sessions to include in the segment.",
+ "$ref": "SegmentDefinition"
},
"name": {
"description": "The name of the dynamic segment.",
@@ -575,8 +223,6 @@
"type": "object"
},
"ColumnHeader": {
- "description": "Column headers.",
- "type": "object",
"properties": {
"dimensions": {
"description": "The dimension names in the response.",
@@ -586,53 +232,57 @@
}
},
"metricHeader": {
- "description": "Metric headers for the metrics in the response.",
- "$ref": "MetricHeader"
+ "$ref": "MetricHeader",
+ "description": "Metric headers for the metrics in the response."
}
},
- "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": {
"not": {
"description": "Matches the complement (`!`) of the filter.",
"type": "boolean"
},
"dimensionFilter": {
- "description": "Dimension Filter for the segment definition.",
- "$ref": "SegmentDimensionFilter"
+ "$ref": "SegmentDimensionFilter",
+ "description": "Dimension Filter for the segment definition."
},
"metricFilter": {
"description": "Metric Filter for the segment definition.",
"$ref": "SegmentMetricFilter"
}
},
- "id": "SegmentFilterClause",
- "description": "Filter Clause to be used in a segment definition, can be wither a metric or\na dimension filter.",
- "type": "object"
+ "id": "SegmentFilterClause"
},
"ReportRow": {
- "description": "A row in the report.",
- "type": "object",
"properties": {
- "metrics": {
- "description": "List of metrics for each requested DateRange.",
- "type": "array",
- "items": {
- "$ref": "DateRangeValues"
- }
- },
"dimensions": {
"description": "List of requested dimensions.",
"type": "array",
"items": {
"type": "string"
}
+ },
+ "metrics": {
+ "description": "List of metrics for each requested DateRange.",
+ "type": "array",
+ "items": {
+ "$ref": "DateRangeValues"
+ }
}
},
- "id": "ReportRow"
+ "id": "ReportRow",
+ "description": "A row in the report.",
+ "type": "object"
},
"Cohort": {
+ "description": "Defines a cohort. A cohort is a group of users who share a common\ncharacteristic. For example, all users with the same acquisition date\nbelong to the same cohort.",
+ "type": "object",
"properties": {
"name": {
"description": "A unique name for the cohort. If not defined name will be auto-generated\nwith values cohort_[1234...].",
@@ -643,37 +293,35 @@
"$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",
- "enumDescriptions": [
- "If unspecified it's treated as `FIRST_VISIT_DATE`.",
- "Cohorts that are selected based on first visit date."
- ]
+ "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"
+ "id": "Cohort"
},
"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"
+ "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.",
@@ -702,29 +350,27 @@
"type": "object"
},
"MetricHeader": {
+ "description": "The headers for the metrics.",
+ "type": "object",
"properties": {
- "metricHeaderEntries": {
- "description": "Headers for the metrics in the response.",
- "type": "array",
- "items": {
- "$ref": "MetricHeaderEntry"
- }
- },
"pivotHeaders": {
"description": "Headers for the pivots in the response.",
"type": "array",
"items": {
"$ref": "PivotHeader"
}
+ },
+ "metricHeaderEntries": {
+ "description": "Headers for the metrics in the response.",
+ "type": "array",
+ "items": {
+ "$ref": "MetricHeaderEntry"
+ }
}
},
- "id": "MetricHeader",
- "description": "The headers for the metrics.",
- "type": "object"
+ "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": [
@@ -748,15 +394,15 @@
}
}
},
- "id": "DimensionFilterClause"
+ "id": "DimensionFilterClause",
+ "description": "A group of dimension filters. Set the operator value to specify how\nthe filters are logically combined.",
+ "type": "object"
},
"GetReportsResponse": {
- "description": "The main response class which holds the reports from the Reporting API\n`batchGet` call.",
- "type": "object",
"properties": {
"resourceQuotasRemaining": {
- "$ref": "ResourceQuotasRemaining",
- "description": "The amount of resource quota remaining for the property."
+ "description": "The amount of resource quota remaining for the property.",
+ "$ref": "ResourceQuotasRemaining"
},
"reports": {
"description": "Responses corresponding to each of the request.",
@@ -771,7 +417,9 @@
"type": "integer"
}
},
- "id": "GetReportsResponse"
+ "id": "GetReportsResponse",
+ "description": "The main response class which holds the reports from the Reporting API\n`batchGet` call.",
+ "type": "object"
},
"SequenceSegment": {
"description": "Sequence conditions consist of one or more steps, where each step is defined\nby one or more dimension/metric conditions. Multiple steps can be combined\nwith special sequence operators.",
@@ -792,12 +440,21 @@
"id": "SequenceSegment"
},
"SegmentMetricFilter": {
+ "description": "Metric filter to be used in a segment filter clause.",
+ "type": "object",
"properties": {
"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",
@@ -806,14 +463,7 @@
"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",
- "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."
- ]
+ "type": "string"
},
"maxComparisonValue": {
"description": "Max comparison value is only used for `BETWEEN` operator.",
@@ -842,13 +492,9 @@
]
}
},
- "id": "SegmentMetricFilter",
- "description": "Metric filter to be used in a segment filter clause.",
- "type": "object"
+ "id": "SegmentMetricFilter"
},
"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.",
@@ -865,38 +511,40 @@
}
}
},
- "id": "DateRangeValues"
+ "id": "DateRangeValues",
+ "description": "Used to return a list of metrics for a single DateRange / dimension\ncombination",
+ "type": "object"
},
"CohortGroup": {
"description": "Defines a cohort group.\nFor example:\n\n \"cohortGroup\": {\n \"cohorts\": [{\n \"name\": \"cohort 1\",\n \"type\": \"FIRST_VISIT_DATE\",\n \"dateRange\": { \"startDate\": \"2015-08-01\", \"endDate\": \"2015-08-01\" }\n },{\n \"name\": \"cohort 2\"\n \"type\": \"FIRST_VISIT_DATE\"\n \"dateRange\": { \"startDate\": \"2015-07-01\", \"endDate\": \"2015-07-01\" }\n }]\n }",
"type": "object",
"properties": {
- "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"
- },
"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": {
"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"
}
+ },
+ "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"
}
},
"id": "GetReportsRequest",
@@ -904,21 +552,7 @@
"type": "object"
},
"Pivot": {
- "description": "The Pivot describes the pivot section in the request.\nThe Pivot helps rearrange the information in the table for certain reports\nby pivoting your data on a second dimension.",
- "type": "object",
"properties": {
- "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",
@@ -937,14 +571,33 @@
"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"
+ },
+ "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"
+ }
}
},
- "id": "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"
},
"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": {
+ "description": "The values for the dimensions in the pivot.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
"dimensionNames": {
"description": "The name of the dimensions in the pivot response.",
"type": "array",
@@ -955,37 +608,34 @@
"metric": {
"description": "The metric header for the metric in the pivot.",
"$ref": "MetricHeaderEntry"
- },
- "dimensionValues": {
- "description": "The values for the dimensions in the pivot.",
- "type": "array",
- "items": {
- "type": "string"
- }
}
},
- "id": "PivotHeaderEntry"
+ "id": "PivotHeaderEntry",
+ "description": "The headers for the each of the metric column corresponding to the metrics\nrequested in the pivots section of the response.",
+ "type": "object"
},
"SegmentFilter": {
+ "description": "SegmentFilter defines the segment to be either a simple or a sequence\nsegment. A simple segment condition contains dimension and metric conditions\nto select the sessions or users. A sequence segment condition can be used to\nselect users or sessions based on sequential conditions.",
+ "type": "object",
"properties": {
"not": {
"description": "If true, match the complement of simple or sequence segment.\nFor example, to match all visits not from \"New York\", we can define the\nsegment as follows:\n\n \"sessionSegment\": {\n \"segmentFilters\": [{\n \"simpleSegment\" :{\n \"orFiltersForSegment\": [{\n \"segmentFilterClauses\":[{\n \"dimensionFilter\": {\n \"dimensionName\": \"ga:city\",\n \"expressions\": [\"New York\"]\n }\n }]\n }]\n },\n \"not\": \"True\"\n }]\n },",
"type": "boolean"
},
"simpleSegment": {
- "description": "A Simple segment conditions consist of one or more dimension/metric\nconditions that can be combined",
- "$ref": "SimpleSegment"
+ "$ref": "SimpleSegment",
+ "description": "A Simple segment conditions consist of one or more dimension/metric\nconditions that can be combined"
},
"sequenceSegment": {
- "$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."
+ "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"
+ "id": "SegmentFilter"
},
"SegmentDefinition": {
+ "description": "SegmentDefinition defines the segment to be a set of SegmentFilters which\nare combined together with a logical `AND` operation.",
+ "type": "object",
"properties": {
"segmentFilters": {
"description": "A segment is defined by a set of segment filters which are combined\ntogether with a logical `AND` operation.",
@@ -995,9 +645,7 @@
}
}
},
- "id": "SegmentDefinition",
- "description": "SegmentDefinition defines the segment to be a set of SegmentFilters which\nare combined together with a logical `AND` operation.",
- "type": "object"
+ "id": "SegmentDefinition"
},
"ResourceQuotasRemaining": {
"properties": {
@@ -1023,6 +671,14 @@
"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",
@@ -1032,15 +688,7 @@
"TIME"
],
"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."
- ]
+ "type": "string"
}
},
"id": "MetricHeaderEntry",
@@ -1051,13 +699,6 @@
"description": "The data part of the report.",
"type": "object",
"properties": {
- "minimums": {
- "description": "Minimum and maximum values seen over all matching rows. These are both\nempty when `hideValueRanges` in the request is false, or when\nrowCount is zero.",
- "type": "array",
- "items": {
- "$ref": "DateRangeValues"
- }
- },
"samplingSpaceSizes": {
"description": "If the results are\n[sampled](https://support.google.com/analytics/answer/2637192),\nthis returns the total number of\nsamples present, one entry per date range. If the results are not sampled\nthis field will not be defined. See\n[developer guide](/analytics/devguides/reporting/core/v4/basics#sampling)\nfor details.",
"type": "array",
@@ -1066,6 +707,13 @@
"type": "string"
}
},
+ "minimums": {
+ "description": "Minimum and maximum values seen over all matching rows. These are both\nempty when `hideValueRanges` in the request is false, or when\nrowCount is zero.",
+ "type": "array",
+ "items": {
+ "$ref": "DateRangeValues"
+ }
+ },
"totals": {
"description": "For each requested date range, for the set of all rows that match\nthe query, every requested value format gets a total. The total\nfor a value format is computed by first totaling the metrics\nmentioned in the value format and then evaluating the value\nformat as a scalar expression. E.g., The \"totals\" for\n`3 / (ga:sessions + 2)` we compute\n`3 / ((sum of all relevant ga:sessions) + 2)`.\nTotals are computed before pagination.",
"type": "array",
@@ -1081,9 +729,10 @@
"type": "string"
}
},
- "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"
+ "rowCount": {
+ "description": "Total number of matching rows for this query.",
+ "format": "int32",
+ "type": "integer"
},
"rows": {
"description": "There's one ReportRow for every unique combination of dimensions.",
@@ -1092,10 +741,9 @@
"$ref": "ReportRow"
}
},
- "rowCount": {
- "description": "Total number of matching rows for this query.",
- "format": "int32",
- "type": "integer"
+ "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"
},
"dataLastRefreshed": {
"description": "The last time the data in the report was refreshed. All the hits received\nbefore this timestamp are included in the calculation of the report.",
@@ -1113,9 +761,11 @@
"id": "ReportData"
},
"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"
@@ -1158,18 +808,249 @@
"items": {
"type": "string"
}
- },
- "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": {
+ "properties": {
+ "caseSensitive": {
+ "description": "Should the match be case sensitive, ignored for `IN_LIST` operator.",
+ "type": "boolean"
+ },
+ "minComparisonValue": {
+ "description": "Minimum comparison values for `BETWEEN` match type.",
+ "type": "string"
+ },
+ "maxComparisonValue": {
+ "description": "Maximum comparison values for `BETWEEN` match type.",
+ "type": "string"
+ },
+ "dimensionName": {
+ "description": "Name of the dimension for which the filter is being applied.",
+ "type": "string"
+ },
+ "operator": {
+ "enum": [
+ "OPERATOR_UNSPECIFIED",
+ "REGEXP",
+ "BEGINS_WITH",
+ "ENDS_WITH",
+ "PARTIAL",
+ "EXACT",
+ "IN_LIST",
+ "NUMERIC_LESS_THAN",
+ "NUMERIC_GREATER_THAN",
+ "NUMERIC_BETWEEN"
+ ],
+ "description": "The operator to use to match the dimension with the expressions.",
+ "type": "string",
+ "enumDescriptions": [
+ "If the match type is unspecified, it is treated as a REGEXP.",
+ "The match expression is treated as a regular expression. All other match\ntypes are not treated as regular expressions.",
+ "Matches the values which begin with the match expression provided.",
+ "Matches the values which end with the match expression provided.",
+ "Substring match.",
+ "The value should match the match expression entirely.",
+ "This option is used to specify a dimension filter whose expression can\ntake any value from a selected list of values. This helps avoiding\nevaluating multiple exact match dimension filters which are OR'ed for\nevery single response row. For example:\n\n expressions: [\"A\", \"B\", \"C\"]\n\nAny response row whose dimension has it is value as A, B or C, matches\nthis DimensionFilter.",
+ "Integer comparison filters.\ncase sensitivity is ignored for these and the expression\nis assumed to be a string representing an integer.\nFailure conditions:\n\n- if expression is not a valid int64, the client should expect\n an error.\n- input dimensions that are not valid int64 values will never match the\n filter.\n\nChecks if the dimension is numerically less than the match expression.",
+ "Checks if the dimension is numerically greater than the match\nexpression.",
+ "Checks if the dimension is numerically between the minimum and maximum\nof the match expression, boundaries excluded."
+ ]
+ },
+ "expressions": {
+ "description": "The list of expressions, only the first element is used for all operators",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "id": "SegmentDimensionFilter",
+ "description": "Dimension filter specifies the filtering options on a dimension.",
+ "type": "object"
+ },
+ "OrderBy": {
+ "description": "Specifies the sorting options.",
+ "type": "object",
+ "properties": {
+ "sortOrder": {
+ "enum": [
+ "SORT_ORDER_UNSPECIFIED",
+ "ASCENDING",
+ "DESCENDING"
+ ],
+ "description": "The sorting order for the field.",
+ "type": "string",
+ "enumDescriptions": [
+ "If the sort order is unspecified, the default is ascending.",
+ "Ascending sort. The field will be sorted in an ascending manner.",
+ "Descending sort. The field will be sorted in a descending manner."
+ ]
+ },
+ "fieldName": {
+ "description": "The field which to sort by. The default sort order is ascending. Example:\n`ga:browser`.\nNote, that you can only specify one field for sort here. For example,\n`ga:browser, ga:city` is not valid.",
+ "type": "string"
+ },
+ "orderType": {
+ "enum": [
+ "ORDER_TYPE_UNSPECIFIED",
+ "VALUE",
+ "DELTA",
+ "SMART",
+ "HISTOGRAM_BUCKET",
+ "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."
+ ]
+ }
+ },
+ "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": {
+ "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"
+ },
+ "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"
+ }
+ },
+ "matchType": {
+ "enum": [
+ "UNSPECIFIED_MATCH_TYPE",
+ "PRECEDES",
+ "IMMEDIATELY_PRECEDES"
+ ],
+ "description": "Specifies if the step immediately precedes or can be any time before the\nnext step.",
+ "type": "string",
+ "enumDescriptions": [
+ "Unspecified match type is treated as precedes.",
+ "Operator indicates that the previous step precedes the next step.",
+ "Operator indicates that the previous step immediately precedes the next\nstep."
+ ]
+ }
+ },
+ "id": "SegmentSequenceStep"
+ },
+ "Metric": {
+ "description": "[Metrics](https://support.google.com/analytics/answer/1033861)\nare the quantitative measurements. For example, the metric `ga:users`\nindicates the total number of users for the requested time period.",
+ "type": "object",
+ "properties": {
+ "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": [
+ "Metric type is unspecified.",
+ "Integer metric.",
+ "Float metric.",
+ "Currency metric.",
+ "Percentage metric.",
+ "Time metric in `HH:MM:SS` format."
+ ]
+ },
+ "alias": {
+ "description": "An alias for the metric expression is an alternate name for the\nexpression. The alias can be used for filtering and sorting. This field\nis optional and is useful if the expression is not a single metric but\na complex expression which cannot be used in filtering and sorting.\nThe alias is also used in the response column header.",
+ "type": "string"
+ },
+ "expression": {
+ "description": "A metric expression in the request. An expression is constructed from one\nor more metrics and numbers. Accepted operators include: Plus (+), Minus\n(-), Negation (Unary -), Divided by (/), Multiplied by (*), Parenthesis,\nPositive cardinal numbers (0-9), can include decimals and is limited to\n1024 characters. Example `ga:totalRefunds/ga:users`, in most cases the\nmetric expression is just a single metric name like `ga:users`.\nAdding mixed `MetricType` (E.g., `CURRENCY` + `PERCENTAGE`) metrics\nwill result in unexpected results.",
+ "type": "string"
+ }
+ },
+ "id": "Metric"
+ },
+ "PivotValueRegion": {
+ "properties": {
+ "values": {
+ "description": "The values of the metrics in each of the pivot regions.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "id": "PivotValueRegion",
+ "description": "The metric values in the pivot region.",
+ "type": "object"
+ },
+ "Report": {
+ "description": "The data response corresponding to the request.",
+ "type": "object",
+ "properties": {
+ "data": {
+ "$ref": "ReportData",
+ "description": "Response data."
+ },
+ "nextPageToken": {
+ "description": "Page token to retrieve the next page of results in the list.",
+ "type": "string"
+ },
+ "columnHeader": {
+ "description": "The column headers.",
+ "$ref": "ColumnHeader"
+ }
+ },
+ "id": "Report"
+ },
+ "PivotHeader": {
+ "properties": {
+ "pivotHeaderEntries": {
+ "description": "A single pivot section header.",
+ "type": "array",
+ "items": {
+ "$ref": "PivotHeaderEntry"
+ }
+ },
+ "totalPivotGroupsCount": {
+ "description": "The total number of groups for this pivot.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "PivotHeader",
+ "description": "The headers for each of the pivot sections defined in the request.",
+ "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": "AnalyticsReporting",
@@ -1189,5 +1070,124 @@
"ownerDomain": "google.com",
"name": "analyticsreporting",
"batchPath": "batch",
- "title": "Google Analytics Reporting API"
+ "title": "Google Analytics Reporting API",
+ "ownerName": "Google",
+ "resources": {
+ "reports": {
+ "methods": {
+ "batchGet": {
+ "path": "v4/reports:batchGet",
+ "id": "analyticsreporting.reports.batchGet",
+ "description": "Returns the Analytics data.",
+ "request": {
+ "$ref": "GetReportsRequest"
+ },
+ "response": {
+ "$ref": "GetReportsResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/analytics",
+ "https://www.googleapis.com/auth/analytics.readonly"
+ ],
+ "parameters": {},
+ "flatPath": "v4/reports:batchGet"
+ }
+ }
+ }
+ },
+ "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": {
+ "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": {
+ "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"
+ }
+ },
+ "version": "v4",
+ "baseUrl": "https://analyticsreporting.googleapis.com/",
+ "servicePath": "",
+ "description": "Accesses Analytics report data.",
+ "kind": "discovery#restDescription"
}
diff --git a/androiddeviceprovisioning/v1/androiddeviceprovisioning-api.json b/androiddeviceprovisioning/v1/androiddeviceprovisioning-api.json
index 81ea798..f39f672 100644
--- a/androiddeviceprovisioning/v1/androiddeviceprovisioning-api.json
+++ b/androiddeviceprovisioning/v1/androiddeviceprovisioning-api.json
@@ -1,414 +1,119 @@
{
- "rootUrl": "https://androiddeviceprovisioning.googleapis.com/",
- "basePath": "",
- "ownerDomain": "google.com",
- "name": "androiddeviceprovisioning",
- "batchPath": "batch",
- "revision": "20171216",
- "documentationLink": "https://developers.google.com/zero-touch/",
- "id": "androiddeviceprovisioning:v1",
- "title": "Android Device Provisioning Partner API",
- "discoveryVersion": "v1",
"ownerName": "Google",
+ "discoveryVersion": "v1",
"version_module": true,
"resources": {
- "operations": {
- "methods": {
- "get": {
- "httpMethod": "GET",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Operation"
- },
- "parameters": {
- "name": {
- "required": true,
- "type": "string",
- "pattern": "^operations/.+$",
- "location": "path",
- "description": "The name of the operation resource."
- }
- },
- "flatPath": "v1/operations/{operationsId}",
- "id": "androiddeviceprovisioning.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."
- }
- }
- },
- "customers": {
- "methods": {
- "list": {
- "response": {
- "$ref": "CustomerListCustomersResponse"
- },
- "parameterOrder": [],
- "httpMethod": "GET",
- "parameters": {
- "pageToken": {
- "location": "query",
- "description": "The next_page_token value returned from a previous List request, if any.",
- "type": "string"
- },
- "pageSize": {
- "type": "integer",
- "location": "query",
- "description": "The maximum number of items to return.",
- "format": "int32"
- }
- },
- "flatPath": "v1/customers",
- "path": "v1/customers",
- "id": "androiddeviceprovisioning.customers.list",
- "description": "List the user's customer accounts."
- }
- },
- "resources": {
- "configurations": {
- "methods": {
- "get": {
- "description": "Gets the details of a configuration.",
- "response": {
- "$ref": "Configuration"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "parameters": {
- "name": {
- "location": "path",
- "description": "Required. The configuration to get. An API resource name in the format\n`customers/[CUSTOMER_ID]/configurations/[CONFIGURATION_ID]`.",
- "required": true,
- "type": "string",
- "pattern": "^customers/[^/]+/configurations/[^/]+$"
- }
- },
- "flatPath": "v1/customers/{customersId}/configurations/{configurationsId}",
- "path": "v1/{+name}",
- "id": "androiddeviceprovisioning.customers.configurations.get"
- },
- "patch": {
- "flatPath": "v1/customers/{customersId}/configurations/{configurationsId}",
- "id": "androiddeviceprovisioning.customers.configurations.patch",
- "path": "v1/{+name}",
- "request": {
- "$ref": "Configuration"
- },
- "description": "Updates a configuration's field values.",
- "httpMethod": "PATCH",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Configuration"
- },
- "parameters": {
- "updateMask": {
- "type": "string",
- "location": "query",
- "description": "Required. The field mask applied to the target `Configuration` before\nupdating the fields. To learn more about using field masks, read\n[FieldMask](/protocol-buffers/docs/reference/google.protobuf#fieldmask) in\nthe Protocol Buffers documentation.",
- "format": "google-fieldmask"
- },
- "name": {
- "required": true,
- "type": "string",
- "pattern": "^customers/[^/]+/configurations/[^/]+$",
- "location": "path",
- "description": "Output only. The API resource name in the format\n`customers/[CUSTOMER_ID]/configurations/[CONFIGURATION_ID]`. Assigned by\nthe server."
- }
- }
- },
- "list": {
- "flatPath": "v1/customers/{customersId}/configurations",
- "path": "v1/{+parent}/configurations",
- "id": "androiddeviceprovisioning.customers.configurations.list",
- "description": "Lists a customer's configurations.",
- "response": {
- "$ref": "CustomerListConfigurationsResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "GET",
- "parameters": {
- "parent": {
- "required": true,
- "type": "string",
- "pattern": "^customers/[^/]+$",
- "location": "path",
- "description": "Required. The customer that manages the listed configurations. An API\nresource name in the format `customers/[CUSTOMER_ID]`."
- }
- }
- },
- "create": {
- "response": {
- "$ref": "Configuration"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "POST",
- "parameters": {
- "parent": {
- "location": "path",
- "description": "Required. The customer that manages the configuration. An API resource name\nin the format `customers/[CUSTOMER_ID]`.",
- "required": true,
- "type": "string",
- "pattern": "^customers/[^/]+$"
- }
- },
- "flatPath": "v1/customers/{customersId}/configurations",
- "path": "v1/{+parent}/configurations",
- "id": "androiddeviceprovisioning.customers.configurations.create",
- "description": "Creates a new configuration. Once created, a customer can apply the\nconfiguration to devices.",
- "request": {
- "$ref": "Configuration"
- }
- },
- "delete": {
- "description": "Deletes an unused configuration. The API call fails if the customer has\ndevices with the configuration applied.",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "DELETE",
- "parameters": {
- "name": {
- "location": "path",
- "description": "Required. The configuration to delete. An API resource name in the format\n`customers/[CUSTOMER_ID]/configurations/[CONFIGURATION_ID]`. If the\nconfiguration is applied to any devices, the API call fails.",
- "required": true,
- "type": "string",
- "pattern": "^customers/[^/]+/configurations/[^/]+$"
- }
- },
- "flatPath": "v1/customers/{customersId}/configurations/{configurationsId}",
- "path": "v1/{+name}",
- "id": "androiddeviceprovisioning.customers.configurations.delete"
- }
- }
- },
- "dpcs": {
- "methods": {
- "list": {
- "description": "Lists the DPCs (device policy controllers) that support zero-touch\nenrollment.",
- "response": {
- "$ref": "CustomerListDpcsResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "GET",
- "parameters": {
- "parent": {
- "required": true,
- "type": "string",
- "pattern": "^customers/[^/]+$",
- "location": "path",
- "description": "Required. The customer that can use the DPCs in configurations. An API\nresource name in the format `customers/[CUSTOMER_ID]`."
- }
- },
- "flatPath": "v1/customers/{customersId}/dpcs",
- "path": "v1/{+parent}/dpcs",
- "id": "androiddeviceprovisioning.customers.dpcs.list"
- }
- }
- },
- "devices": {
- "methods": {
- "list": {
- "response": {
- "$ref": "CustomerListDevicesResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "GET",
- "parameters": {
- "parent": {
- "location": "path",
- "description": "Required. The customer managing the devices. An API resource name in the\nformat `customers/[CUSTOMER_ID]`.",
- "required": true,
- "type": "string",
- "pattern": "^customers/[^/]+$"
- },
- "pageToken": {
- "location": "query",
- "description": "A token specifying which result page to return.",
- "type": "string"
- },
- "pageSize": {
- "type": "string",
- "location": "query",
- "description": "The maximum number of devices to show in a page of results. The default\nvalue returns all the devices in a single page.",
- "format": "int64"
- }
- },
- "flatPath": "v1/customers/{customersId}/devices",
- "path": "v1/{+parent}/devices",
- "id": "androiddeviceprovisioning.customers.devices.list",
- "description": "Lists a customer's devices."
- },
- "get": {
- "flatPath": "v1/customers/{customersId}/devices/{devicesId}",
- "id": "androiddeviceprovisioning.customers.devices.get",
- "path": "v1/{+name}",
- "description": "Gets the details of a device.",
- "httpMethod": "GET",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Device"
- },
- "parameters": {
- "name": {
- "required": true,
- "type": "string",
- "pattern": "^customers/[^/]+/devices/[^/]+$",
- "location": "path",
- "description": "Required. The device to get. An API resource name in the format\n`customers/[CUSTOMER_ID]/devices/[DEVICE_ID]`."
- }
- }
- },
- "unclaim": {
- "request": {
- "$ref": "CustomerUnclaimDeviceRequest"
- },
- "description": "Unclaims a device from a customer and removes it from zero-touch\nenrollment.\n\nAfter removing a device, a customer must contact their reseller to register\nthe device into zero-touch enrollment again.",
- "httpMethod": "POST",
- "parameterOrder": [
- "parent"
- ],
- "response": {
- "$ref": "Empty"
- },
- "parameters": {
- "parent": {
- "location": "path",
- "description": "Required. The customer managing the device. An API resource name in the\nformat `customers/[CUSTOMER_ID]`.",
- "required": true,
- "type": "string",
- "pattern": "^customers/[^/]+$"
- }
- },
- "flatPath": "v1/customers/{customersId}/devices:unclaim",
- "id": "androiddeviceprovisioning.customers.devices.unclaim",
- "path": "v1/{+parent}/devices:unclaim"
- },
- "removeConfiguration": {
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "POST",
- "parameters": {
- "parent": {
- "required": true,
- "type": "string",
- "pattern": "^customers/[^/]+$",
- "location": "path",
- "description": "Required. The customer managing the device in the format\n`customers/[CUSTOMER_ID]`."
- }
- },
- "flatPath": "v1/customers/{customersId}/devices:removeConfiguration",
- "path": "v1/{+parent}/devices:removeConfiguration",
- "id": "androiddeviceprovisioning.customers.devices.removeConfiguration",
- "description": "Removes a configuration from device.",
- "request": {
- "$ref": "CustomerRemoveConfigurationRequest"
- }
- },
- "applyConfiguration": {
- "description": "Applies a Configuration to the device to register the device for zero-touch\nenrollment. After applying a configuration to a device, the device\nautomatically provisions itself on first boot, or next factory reset.",
- "request": {
- "$ref": "CustomerApplyConfigurationRequest"
- },
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "POST",
- "parameters": {
- "parent": {
- "required": true,
- "type": "string",
- "pattern": "^customers/[^/]+$",
- "location": "path",
- "description": "Required. The customer managing the device. An API resource name in the\nformat `customers/[CUSTOMER_ID]`."
- }
- },
- "flatPath": "v1/customers/{customersId}/devices:applyConfiguration",
- "path": "v1/{+parent}/devices:applyConfiguration",
- "id": "androiddeviceprovisioning.customers.devices.applyConfiguration"
- }
- }
- }
- }
- },
"partners": {
"resources": {
- "devices": {
+ "customers": {
"methods": {
- "get": {
- "response": {
- "$ref": "Device"
- },
- "parameterOrder": [
- "name"
- ],
+ "list": {
+ "description": "Lists the customers that are enrolled to the reseller identified by the\n`partnerId` argument. This list includes customers that the reseller\ncreated and customers that enrolled themselves using the portal.",
"httpMethod": "GET",
+ "parameterOrder": [
+ "partnerId"
+ ],
+ "response": {
+ "$ref": "ListCustomersResponse"
+ },
"parameters": {
- "name": {
- "location": "path",
- "description": "Resource name in `partners/[PARTNER_ID]/devices/[DEVICE_ID]`.",
+ "partnerId": {
+ "description": "The ID of the partner.",
+ "pattern": "^[^/]+$",
+ "format": "int64",
"required": true,
"type": "string",
- "pattern": "^partners/[^/]+/devices/[^/]+$"
+ "location": "path"
}
},
- "flatPath": "v1/partners/{partnersId}/devices/{devicesId}",
- "path": "v1/{+name}",
- "id": "androiddeviceprovisioning.partners.devices.get",
- "description": "Get a device."
+ "flatPath": "v1/partners/{partnersId}/customers",
+ "id": "androiddeviceprovisioning.partners.customers.list",
+ "path": "v1/partners/{+partnerId}/customers"
},
- "unclaim": {
+ "create": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "parent"
+ ],
"response": {
- "$ref": "Empty"
+ "$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",
+ "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."
+ }
+ }
+ },
+ "devices": {
+ "methods": {
+ "updateMetadataAsync": {
+ "parameters": {
+ "partnerId": {
+ "pattern": "^[^/]+$",
+ "format": "int64",
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "description": "Partner ID."
+ }
+ },
+ "flatPath": "v1/partners/{partnersId}/devices:updateMetadataAsync",
+ "path": "v1/partners/{+partnerId}/devices:updateMetadataAsync",
+ "id": "androiddeviceprovisioning.partners.devices.updateMetadataAsync",
+ "request": {
+ "$ref": "UpdateDeviceMetadataInBatchRequest"
+ },
+ "description": "Set metadata in batch asynchronously.",
+ "response": {
+ "$ref": "Operation"
},
"parameterOrder": [
"partnerId"
],
- "httpMethod": "POST",
+ "httpMethod": "POST"
+ },
+ "get": {
"parameters": {
- "partnerId": {
+ "name": {
+ "description": "Resource name in `partners/[PARTNER_ID]/devices/[DEVICE_ID]`.",
"required": true,
"type": "string",
- "location": "path",
- "description": "ID of the partner.",
- "pattern": "^[^/]+$",
- "format": "int64"
+ "pattern": "^partners/[^/]+/devices/[^/]+$",
+ "location": "path"
}
},
- "flatPath": "v1/partners/{partnersId}/devices:unclaim",
- "path": "v1/partners/{+partnerId}/devices:unclaim",
- "id": "androiddeviceprovisioning.partners.devices.unclaim",
+ "flatPath": "v1/partners/{partnersId}/devices/{devicesId}",
+ "id": "androiddeviceprovisioning.partners.devices.get",
+ "path": "v1/{+name}",
+ "description": "Get a device.",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "Device"
+ },
+ "parameterOrder": [
+ "name"
+ ]
+ },
+ "unclaim": {
"description": "Unclaim the device identified by the `device_id` or the `deviceIdentifier`.",
"request": {
"$ref": "UnclaimDeviceRequest"
- }
- },
- "findByOwner": {
+ },
"response": {
- "$ref": "FindDevicesByOwnerResponse"
+ "$ref": "Empty"
},
"parameterOrder": [
"partnerId"
@@ -424,9 +129,31 @@
"pattern": "^[^/]+$"
}
},
+ "flatPath": "v1/partners/{partnersId}/devices:unclaim",
+ "path": "v1/partners/{+partnerId}/devices:unclaim",
+ "id": "androiddeviceprovisioning.partners.devices.unclaim"
+ },
+ "findByOwner": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "partnerId"
+ ],
+ "response": {
+ "$ref": "FindDevicesByOwnerResponse"
+ },
+ "parameters": {
+ "partnerId": {
+ "description": "ID of the partner.",
+ "pattern": "^[^/]+$",
+ "format": "int64",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
"flatPath": "v1/partners/{partnersId}/devices:findByOwner",
- "path": "v1/partners/{+partnerId}/devices:findByOwner",
"id": "androiddeviceprovisioning.partners.devices.findByOwner",
+ "path": "v1/partners/{+partnerId}/devices:findByOwner",
"request": {
"$ref": "FindDevicesByOwnerRequest"
},
@@ -437,61 +164,58 @@
"request": {
"$ref": "ClaimDeviceRequest"
},
- "response": {
- "$ref": "ClaimDeviceResponse"
- },
+ "httpMethod": "POST",
"parameterOrder": [
"partnerId"
],
- "httpMethod": "POST",
+ "response": {
+ "$ref": "ClaimDeviceResponse"
+ },
"parameters": {
"partnerId": {
"format": "int64",
- "type": "string",
"required": true,
+ "type": "string",
"location": "path",
"description": "ID of the partner.",
"pattern": "^[^/]+$"
}
},
"flatPath": "v1/partners/{partnersId}/devices:claim",
- "path": "v1/partners/{+partnerId}/devices:claim",
- "id": "androiddeviceprovisioning.partners.devices.claim"
+ "id": "androiddeviceprovisioning.partners.devices.claim",
+ "path": "v1/partners/{+partnerId}/devices:claim"
},
"claimAsync": {
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "partnerId"
- ],
- "httpMethod": "POST",
"parameters": {
"partnerId": {
- "type": "string",
+ "format": "int64",
"required": true,
+ "type": "string",
"location": "path",
"description": "Partner ID.",
- "pattern": "^[^/]+$",
- "format": "int64"
+ "pattern": "^[^/]+$"
}
},
"flatPath": "v1/partners/{partnersId}/devices:claimAsync",
- "path": "v1/partners/{+partnerId}/devices:claimAsync",
"id": "androiddeviceprovisioning.partners.devices.claimAsync",
+ "path": "v1/partners/{+partnerId}/devices:claimAsync",
"description": "Claim devices asynchronously.",
"request": {
"$ref": "ClaimDevicesRequest"
+ },
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "partnerId"
+ ],
+ "response": {
+ "$ref": "Operation"
}
},
"findByIdentifier": {
- "flatPath": "v1/partners/{partnersId}/devices:findByIdentifier",
- "path": "v1/partners/{+partnerId}/devices:findByIdentifier",
- "id": "androiddeviceprovisioning.partners.devices.findByIdentifier",
- "description": "Find devices by device identifier.",
"request": {
"$ref": "FindDevicesByDeviceIdentifierRequest"
},
+ "description": "Find devices by device identifier.",
"response": {
"$ref": "FindDevicesByDeviceIdentifierResponse"
},
@@ -501,17 +225,19 @@
"httpMethod": "POST",
"parameters": {
"partnerId": {
+ "pattern": "^[^/]+$",
+ "format": "int64",
"required": true,
"type": "string",
"location": "path",
- "description": "ID of the partner.",
- "pattern": "^[^/]+$",
- "format": "int64"
+ "description": "ID of the partner."
}
- }
+ },
+ "flatPath": "v1/partners/{partnersId}/devices:findByIdentifier",
+ "path": "v1/partners/{+partnerId}/devices:findByIdentifier",
+ "id": "androiddeviceprovisioning.partners.devices.findByIdentifier"
},
"unclaimAsync": {
- "flatPath": "v1/partners/{partnersId}/devices:unclaimAsync",
"path": "v1/partners/{+partnerId}/devices:unclaimAsync",
"id": "androiddeviceprovisioning.partners.devices.unclaimAsync",
"description": "Unclaim devices asynchronously.",
@@ -527,64 +253,6 @@
"httpMethod": "POST",
"parameters": {
"partnerId": {
- "pattern": "^[^/]+$",
- "format": "int64",
- "type": "string",
- "required": true,
- "location": "path",
- "description": "Partner ID."
- }
- }
- },
- "metadata": {
- "request": {
- "$ref": "UpdateDeviceMetadataRequest"
- },
- "description": "Update the metadata.",
- "httpMethod": "POST",
- "parameterOrder": [
- "metadataOwnerId",
- "deviceId"
- ],
- "response": {
- "$ref": "DeviceMetadata"
- },
- "parameters": {
- "metadataOwnerId": {
- "format": "int64",
- "type": "string",
- "required": true,
- "location": "path",
- "description": "The owner of the newly set metadata. Set this to the partner ID.",
- "pattern": "^[^/]+$"
- },
- "deviceId": {
- "format": "int64",
- "required": true,
- "type": "string",
- "location": "path",
- "description": "ID of the partner.",
- "pattern": "^[^/]+$"
- }
- },
- "flatPath": "v1/partners/{partnersId}/devices/{devicesId}/metadata",
- "id": "androiddeviceprovisioning.partners.devices.metadata",
- "path": "v1/partners/{+metadataOwnerId}/devices/{+deviceId}/metadata"
- },
- "updateMetadataAsync": {
- "description": "Set metadata in batch asynchronously.",
- "request": {
- "$ref": "UpdateDeviceMetadataInBatchRequest"
- },
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "partnerId"
- ],
- "httpMethod": "POST",
- "parameters": {
- "partnerId": {
"format": "int64",
"required": true,
"type": "string",
@@ -593,40 +261,264 @@
"pattern": "^[^/]+$"
}
},
- "flatPath": "v1/partners/{partnersId}/devices:updateMetadataAsync",
- "path": "v1/partners/{+partnerId}/devices:updateMetadataAsync",
- "id": "androiddeviceprovisioning.partners.devices.updateMetadataAsync"
- }
- }
- },
- "customers": {
- "methods": {
- "list": {
+ "flatPath": "v1/partners/{partnersId}/devices:unclaimAsync"
+ },
+ "metadata": {
"response": {
- "$ref": "ListCustomersResponse"
+ "$ref": "DeviceMetadata"
},
"parameterOrder": [
- "partnerId"
+ "metadataOwnerId",
+ "deviceId"
],
- "httpMethod": "GET",
+ "httpMethod": "POST",
"parameters": {
- "partnerId": {
+ "metadataOwnerId": {
+ "pattern": "^[^/]+$",
+ "format": "int64",
"required": true,
"type": "string",
"location": "path",
- "description": "The ID of the partner.",
+ "description": "The owner of the newly set metadata. Set this to the partner ID."
+ },
+ "deviceId": {
"pattern": "^[^/]+$",
- "format": "int64"
+ "format": "int64",
+ "type": "string",
+ "required": true,
+ "location": "path",
+ "description": "ID of the partner."
}
},
- "flatPath": "v1/partners/{partnersId}/customers",
- "path": "v1/partners/{+partnerId}/customers",
- "id": "androiddeviceprovisioning.partners.customers.list",
- "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."
+ "flatPath": "v1/partners/{partnersId}/devices/{devicesId}/metadata",
+ "path": "v1/partners/{+metadataOwnerId}/devices/{+deviceId}/metadata",
+ "id": "androiddeviceprovisioning.partners.devices.metadata",
+ "request": {
+ "$ref": "UpdateDeviceMetadataRequest"
+ },
+ "description": "Update the metadata."
+ }
+ }
+ }
+ }
+ },
+ "operations": {
+ "methods": {
+ "get": {
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "name": {
+ "pattern": "^operations/.+$",
+ "location": "path",
+ "description": "The name of the operation resource.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1/operations/{operationsId}",
+ "path": "v1/{+name}",
+ "id": "androiddeviceprovisioning.operations.get",
+ "description": "Gets the latest state of a long-running operation. Clients can use this\nmethod to poll the operation result at intervals as recommended by the API\nservice."
+ }
+ }
+ },
+ "customers": {
+ "methods": {
+ "list": {
+ "response": {
+ "$ref": "CustomerListCustomersResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "GET",
+ "parameters": {
+ "pageToken": {
+ "description": "The next_page_token value returned from a previous List request, if any.",
+ "type": "string",
+ "location": "query"
},
+ "pageSize": {
+ "description": "The maximum number of items to return.",
+ "format": "int32",
+ "type": "integer",
+ "location": "query"
+ }
+ },
+ "flatPath": "v1/customers",
+ "path": "v1/customers",
+ "id": "androiddeviceprovisioning.customers.list",
+ "description": "List the user's customer accounts."
+ }
+ },
+ "resources": {
+ "configurations": {
+ "methods": {
"create": {
+ "parameters": {
+ "parent": {
+ "description": "Required. The customer that manages the configuration. An API resource name\nin the format `customers/[CUSTOMER_ID]`.",
+ "required": true,
+ "type": "string",
+ "pattern": "^customers/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/customers/{customersId}/configurations",
+ "path": "v1/{+parent}/configurations",
+ "id": "androiddeviceprovisioning.customers.configurations.create",
+ "description": "Creates a new configuration. Once created, a customer can apply the\nconfiguration to devices.",
+ "request": {
+ "$ref": "Configuration"
+ },
"response": {
- "$ref": "Company"
+ "$ref": "Configuration"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "POST"
+ },
+ "delete": {
+ "parameters": {
+ "name": {
+ "description": "Required. The configuration to delete. An API resource name in the format\n`customers/[CUSTOMER_ID]/configurations/[CONFIGURATION_ID]`. If the\nconfiguration is applied to any devices, the API call fails.",
+ "required": true,
+ "type": "string",
+ "pattern": "^customers/[^/]+/configurations/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/customers/{customersId}/configurations/{configurationsId}",
+ "id": "androiddeviceprovisioning.customers.configurations.delete",
+ "path": "v1/{+name}",
+ "description": "Deletes an unused configuration. The API call fails if the customer has\ndevices with the configuration applied.",
+ "httpMethod": "DELETE",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Empty"
+ }
+ },
+ "get": {
+ "id": "androiddeviceprovisioning.customers.configurations.get",
+ "path": "v1/{+name}",
+ "description": "Gets the details of a configuration.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Configuration"
+ },
+ "parameters": {
+ "name": {
+ "pattern": "^customers/[^/]+/configurations/[^/]+$",
+ "location": "path",
+ "description": "Required. The configuration to get. An API resource name in the format\n`customers/[CUSTOMER_ID]/configurations/[CONFIGURATION_ID]`.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1/customers/{customersId}/configurations/{configurationsId}"
+ },
+ "patch": {
+ "id": "androiddeviceprovisioning.customers.configurations.patch",
+ "path": "v1/{+name}",
+ "request": {
+ "$ref": "Configuration"
+ },
+ "description": "Updates a configuration's field values.",
+ "httpMethod": "PATCH",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Configuration"
+ },
+ "parameters": {
+ "updateMask": {
+ "description": "Required. The field mask applied to the target `Configuration` before\nupdating the fields. To learn more about using field masks, read\n[FieldMask](/protocol-buffers/docs/reference/google.protobuf#fieldmask) in\nthe Protocol Buffers documentation.",
+ "format": "google-fieldmask",
+ "type": "string",
+ "location": "query"
+ },
+ "name": {
+ "pattern": "^customers/[^/]+/configurations/[^/]+$",
+ "location": "path",
+ "description": "Output only. The API resource name in the format\n`customers/[CUSTOMER_ID]/configurations/[CONFIGURATION_ID]`. Assigned by\nthe server.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1/customers/{customersId}/configurations/{configurationsId}"
+ },
+ "list": {
+ "parameters": {
+ "parent": {
+ "pattern": "^customers/[^/]+$",
+ "location": "path",
+ "description": "Required. The customer that manages the listed configurations. An API\nresource name in the format `customers/[CUSTOMER_ID]`.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1/customers/{customersId}/configurations",
+ "path": "v1/{+parent}/configurations",
+ "id": "androiddeviceprovisioning.customers.configurations.list",
+ "description": "Lists a customer's configurations.",
+ "response": {
+ "$ref": "CustomerListConfigurationsResponse"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "GET"
+ }
+ }
+ },
+ "dpcs": {
+ "methods": {
+ "list": {
+ "parameters": {
+ "parent": {
+ "description": "Required. The customer that can use the DPCs in configurations. An API\nresource name in the format `customers/[CUSTOMER_ID]`.",
+ "required": true,
+ "type": "string",
+ "pattern": "^customers/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/customers/{customersId}/dpcs",
+ "path": "v1/{+parent}/dpcs",
+ "id": "androiddeviceprovisioning.customers.dpcs.list",
+ "description": "Lists the DPCs (device policy controllers) that support zero-touch\nenrollment.",
+ "response": {
+ "$ref": "CustomerListDpcsResponse"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "GET"
+ }
+ }
+ },
+ "devices": {
+ "methods": {
+ "unclaim": {
+ "path": "v1/{+parent}/devices:unclaim",
+ "id": "androiddeviceprovisioning.customers.devices.unclaim",
+ "description": "Unclaims a device from a customer and removes it from zero-touch\nenrollment.\n\nAfter removing a device, a customer must contact their reseller to register\nthe device into zero-touch enrollment again.",
+ "request": {
+ "$ref": "CustomerUnclaimDeviceRequest"
+ },
+ "response": {
+ "$ref": "Empty"
},
"parameterOrder": [
"parent"
@@ -634,20 +526,119 @@
"httpMethod": "POST",
"parameters": {
"parent": {
- "required": true,
- "type": "string",
- "pattern": "^partners/[^/]+$",
+ "pattern": "^customers/[^/]+$",
"location": "path",
- "description": "Required. The parent resource ID in the format `partners/[PARTNER_ID]` that\nidentifies the reseller."
+ "description": "Required. The customer managing the device. An API resource name in the\nformat `customers/[CUSTOMER_ID]`.",
+ "required": true,
+ "type": "string"
}
},
- "flatPath": "v1/partners/{partnersId}/customers",
- "path": "v1/{+parent}/customers",
- "id": "androiddeviceprovisioning.partners.customers.create",
- "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.",
+ "flatPath": "v1/customers/{customersId}/devices:unclaim"
+ },
+ "removeConfiguration": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "parent"
+ ],
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameters": {
+ "parent": {
+ "description": "Required. The customer managing the device in the format\n`customers/[CUSTOMER_ID]`.",
+ "required": true,
+ "type": "string",
+ "pattern": "^customers/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/customers/{customersId}/devices:removeConfiguration",
+ "id": "androiddeviceprovisioning.customers.devices.removeConfiguration",
+ "path": "v1/{+parent}/devices:removeConfiguration",
"request": {
- "$ref": "CreateCustomerRequest"
- }
+ "$ref": "CustomerRemoveConfigurationRequest"
+ },
+ "description": "Removes a configuration from device."
+ },
+ "applyConfiguration": {
+ "description": "Applies a Configuration to the device to register the device for zero-touch\nenrollment. After applying a configuration to a device, the device\nautomatically provisions itself on first boot, or next factory reset.",
+ "request": {
+ "$ref": "CustomerApplyConfigurationRequest"
+ },
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "parent": {
+ "pattern": "^customers/[^/]+$",
+ "location": "path",
+ "description": "Required. The customer managing the device. An API resource name in the\nformat `customers/[CUSTOMER_ID]`.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1/customers/{customersId}/devices:applyConfiguration",
+ "path": "v1/{+parent}/devices:applyConfiguration",
+ "id": "androiddeviceprovisioning.customers.devices.applyConfiguration"
+ },
+ "list": {
+ "description": "Lists a customer's devices.",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "CustomerListDevicesResponse"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "parameters": {
+ "parent": {
+ "pattern": "^customers/[^/]+$",
+ "location": "path",
+ "description": "Required. The customer managing the devices. An API resource name in the\nformat `customers/[CUSTOMER_ID]`.",
+ "required": true,
+ "type": "string"
+ },
+ "pageToken": {
+ "description": "A token specifying which result page to return.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageSize": {
+ "description": "The maximum number of devices to show in a page of results. The default\nvalue returns all the devices in a single page.",
+ "format": "int64",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "flatPath": "v1/customers/{customersId}/devices",
+ "id": "androiddeviceprovisioning.customers.devices.list",
+ "path": "v1/{+parent}/devices"
+ },
+ "get": {
+ "description": "Gets the details of a device.",
+ "response": {
+ "$ref": "Device"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "name": {
+ "pattern": "^customers/[^/]+/devices/[^/]+$",
+ "location": "path",
+ "description": "Required. The device to get. An API resource name in the format\n`customers/[CUSTOMER_ID]/devices/[DEVICE_ID]`.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1/customers/{customersId}/devices/{devicesId}",
+ "path": "v1/{+name}",
+ "id": "androiddeviceprovisioning.customers.devices.get"
}
}
}
@@ -655,10 +646,20 @@
}
},
"parameters": {
- "upload_protocol": {
- "type": "string",
+ "bearer_token": {
"location": "query",
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")."
+ "description": "OAuth bearer token.",
+ "type": "string"
+ },
+ "oauth_token": {
+ "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",
@@ -666,17 +667,23 @@
"type": "boolean",
"default": "true"
},
- "fields": {
- "type": "string",
- "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\")."
+ "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",
@@ -686,70 +693,265 @@
"enum": [
"1",
"2"
- ],
- "description": "V1 error format."
- },
- "callback": {
- "type": "string",
- "location": "query",
- "description": "JSONP"
+ ]
},
"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": {
+ ],
"type": "string",
- "location": "query",
- "description": "OAuth access token."
+ "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",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token."
+ "location": "query"
+ },
+ "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",
- "description": "Available 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": {
+ "description": "Pretty-print response.",
"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"
+ "location": "query"
}
},
"schemas": {
- "Dpc": {
+ "CustomerListDevicesResponse": {
+ "id": "CustomerListDevicesResponse",
+ "description": "Response message of customer's liting devices.",
"type": "object",
"properties": {
- "dpcName": {
- "type": "string",
- "description": "Output only. The title of the DPC app in Google Play. For example, _Google\nApps Device Policy_. Useful in an application's user interface."
+ "devices": {
+ "description": "The customer's devices.",
+ "type": "array",
+ "items": {
+ "$ref": "Device"
+ }
},
+ "nextPageToken": {
+ "description": "A token used to access the next page of results. Omitted if no further\nresults are available.",
+ "type": "string"
+ }
+ }
+ },
+ "DeviceClaim": {
+ "id": "DeviceClaim",
+ "description": "A record of a device claimed by a reseller for a customer. Devices claimed\nfor zero-touch enrollment have a claim with the type\n`SECTION_TYPE_ZERO_TOUCH`. To learn more, read\n[Claim devices for customers](/zero-touch/guides/how-it-works#claim).",
+ "type": "object",
+ "properties": {
+ "ownerCompanyId": {
+ "description": "The ID of the Customer that purchased the device.",
+ "format": "int64",
+ "type": "string"
+ },
+ "sectionType": {
+ "description": "Output only. The type of claim made on the device.",
+ "type": "string",
+ "enumDescriptions": [
+ "Unspecified section type.",
+ "Zero-touch enrollment section type."
+ ],
+ "enum": [
+ "SECTION_TYPE_UNSPECIFIED",
+ "SECTION_TYPE_ZERO_TOUCH"
+ ]
+ }
+ }
+ },
+ "DevicesLongRunningOperationResponse": {
+ "description": "Long running operation response.",
+ "type": "object",
+ "properties": {
+ "successCount": {
+ "description": "Number of succeesfully processed ones.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "perDeviceStatus": {
+ "description": "Processing status for each device.\nOne `PerDeviceStatus` per device. The order is the same as in your requests.",
+ "type": "array",
+ "items": {
+ "$ref": "OperationPerDevice"
+ }
+ }
+ },
+ "id": "DevicesLongRunningOperationResponse"
+ },
+ "PerDeviceStatusInBatch": {
+ "description": "Stores the processing result for each device.",
+ "type": "object",
+ "properties": {
+ "status": {
+ "description": "Process result.",
+ "type": "string",
+ "enumDescriptions": [
+ "Invalid code. Shouldn't be used.",
+ "Unknown error.\nWe don't expect this error to occur here.",
+ "Other error.\nWe know/expect this error, but there's no defined error code for the\nerror.",
+ "Success.",
+ "Permission denied.",
+ "Invalid device identifier.",
+ "Invalid section type.",
+ "This section is claimed by another company."
+ ],
+ "enum": [
+ "SINGLE_DEVICE_STATUS_UNSPECIFIED",
+ "SINGLE_DEVICE_STATUS_UNKNOWN_ERROR",
+ "SINGLE_DEVICE_STATUS_OTHER_ERROR",
+ "SINGLE_DEVICE_STATUS_SUCCESS",
+ "SINGLE_DEVICE_STATUS_PERMISSION_DENIED",
+ "SINGLE_DEVICE_STATUS_INVALID_DEVICE_IDENTIFIER",
+ "SINGLE_DEVICE_STATUS_INVALID_SECTION_TYPE",
+ "SINGLE_DEVICE_STATUS_SECTION_NOT_YOURS"
+ ]
+ },
+ "errorIdentifier": {
+ "description": "Error identifier.",
+ "type": "string"
+ },
+ "errorMessage": {
+ "description": "Error message.",
+ "type": "string"
+ },
+ "deviceId": {
+ "description": "Device ID of the device if process succeeds.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "id": "PerDeviceStatusInBatch"
+ },
+ "ClaimDevicesRequest": {
+ "id": "ClaimDevicesRequest",
+ "description": "Request to claim devices asynchronously in batch.",
+ "type": "object",
+ "properties": {
+ "claims": {
+ "description": "List of claims.",
+ "type": "array",
+ "items": {
+ "$ref": "PartnerClaim"
+ }
+ }
+ }
+ },
+ "FindDevicesByOwnerRequest": {
+ "description": "Request to find devices by customers.",
+ "type": "object",
+ "properties": {
+ "pageToken": {
+ "description": "Page token.",
+ "type": "string"
+ },
+ "sectionType": {
+ "description": "The section type.",
+ "type": "string",
+ "enumDescriptions": [
+ "Unspecified section type.",
+ "Zero-touch enrollment section type."
+ ],
+ "enum": [
+ "SECTION_TYPE_UNSPECIFIED",
+ "SECTION_TYPE_ZERO_TOUCH"
+ ]
+ },
+ "customerId": {
+ "description": "List of customer IDs to search for.",
+ "type": "array",
+ "items": {
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "limit": {
+ "description": "The number of devices to show in the result.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "id": "FindDevicesByOwnerRequest"
+ },
+ "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": "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`.",
+ "$ref": "Status"
+ },
+ "metadata": {
+ "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"
+ },
+ "response": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "description": "This field will contain a `DevicesLongRunningOperationResponse` object if the operation is created by `claimAsync`, `unclaimAsync`, or `updateMetadataAsync`.",
+ "type": "object"
+ }
+ }
+ },
+ "DeviceIdentifier": {
+ "description": "Encapsulates hardware and product IDs to identify a manufactured device. To\nlearn more, read [Identifiers](/zero-touch/guides/identifiers).",
+ "type": "object",
+ "properties": {
+ "serialNumber": {
+ "description": "The manufacturer's serial number for the device. This value might not be\nunique.",
+ "type": "string"
+ },
+ "imei": {
+ "description": "The device’s IMEI number. Validated on input.",
+ "type": "string"
+ },
+ "meid": {
+ "description": "The device’s MEID number.",
+ "type": "string"
+ },
+ "manufacturer": {
+ "description": "Required. The device manufacturer’s name. Matches the device's built-in\nvalue returned from `android.os.Build.MANUFACTURER`. Allowed values are\nlisted in [manufacturer names](/zero-touch/resources/manufacturer-names).",
+ "type": "string"
+ }
+ },
+ "id": "DeviceIdentifier"
+ },
+ "Dpc": {
+ "id": "Dpc",
+ "description": "An EMM's DPC ([device policy controller](/android/work/dpc/build-dpc)).\nZero-touch enrollment installs a DPC (listed in the `Configuration`) on a\ndevice to maintain the customer's mobile policies. All the DPCs listed by the\nAPI support zero-touch enrollment and are available in Google Play.",
+ "type": "object",
+ "properties": {
"name": {
"description": "Output only. The API resource name in the format\n`customers/[CUSTOMER_ID]/dpcs/[DPC_ID]`. Assigned by\nthe server. To maintain a reference to a DPC across customer accounts,\npersist and match the last path component (`DPC_ID`).",
"type": "string"
@@ -757,12 +959,31 @@
"packageName": {
"description": "Output only. The DPC's Android application ID that looks like a Java\npackage name. Zero-touch enrollment installs the DPC app onto a device\nusing this identifier.",
"type": "string"
+ },
+ "dpcName": {
+ "description": "Output only. The title of the DPC app in Google Play. For example, _Google\nApps Device Policy_. Useful in an application's user interface.",
+ "type": "string"
}
- },
- "id": "Dpc",
- "description": "An EMM's DPC ([device policy controller](/android/work/dpc/build-dpc)).\nZero-touch enrollment installs a DPC (listed in the `Configuration`) on a\ndevice to maintain the customer's mobile policies. All the DPCs listed by the\nAPI support zero-touch enrollment and are available in Google Play."
+ }
+ },
+ "CustomerApplyConfigurationRequest": {
+ "id": "CustomerApplyConfigurationRequest",
+ "description": "Request message for customer to assign a configuration to device.",
+ "type": "object",
+ "properties": {
+ "device": {
+ "$ref": "DeviceReference",
+ "description": "Required. The device the configuration is applied to."
+ },
+ "configuration": {
+ "description": "Required. The configuration applied to the device in the format\n`customers/[CUSTOMER_ID]/configurations/[CONFIGURATION_ID]`.",
+ "type": "string"
+ }
+ }
},
"UnclaimDevicesRequest": {
+ "id": "UnclaimDevicesRequest",
+ "description": "Request to unclaim devices asynchronously in batch.",
"type": "object",
"properties": {
"unclaims": {
@@ -772,82 +993,88 @@
"$ref": "PartnerUnclaim"
}
}
- },
- "id": "UnclaimDevicesRequest",
- "description": "Request to unclaim devices asynchronously in batch."
- },
- "CustomerApplyConfigurationRequest": {
- "description": "Request message for customer to assign a configuration to device.",
- "type": "object",
- "properties": {
- "configuration": {
- "description": "Required. The configuration applied to the device in the format\n`customers/[CUSTOMER_ID]/configurations/[CONFIGURATION_ID]`.",
- "type": "string"
- },
- "device": {
- "$ref": "DeviceReference",
- "description": "Required. The device the configuration is applied to."
- }
- },
- "id": "CustomerApplyConfigurationRequest"
+ }
},
"CustomerUnclaimDeviceRequest": {
+ "description": "Request message for customer to unclaim a device.",
"type": "object",
"properties": {
"device": {
- "$ref": "DeviceReference",
- "description": "Required. The device to unclaim."
+ "description": "Required. The device to unclaim.",
+ "$ref": "DeviceReference"
}
},
- "id": "CustomerUnclaimDeviceRequest",
- "description": "Request message for customer to unclaim a device."
- },
- "Status": {
- "type": "object",
- "properties": {
- "code": {
- "type": "integer",
- "description": "The status code, which should be an enum value of google.rpc.Code.",
- "format": "int32"
- },
- "message": {
- "type": "string",
- "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client."
- },
- "details": {
- "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.",
- "type": "array",
- "items": {
- "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."
+ "id": "CustomerUnclaimDeviceRequest"
},
"FindDevicesByDeviceIdentifierRequest": {
+ "description": "Request to find devices.",
"type": "object",
"properties": {
"limit": {
- "type": "string",
"description": "Number of devices to show.",
- "format": "int64"
+ "format": "int64",
+ "type": "string"
},
"deviceIdentifier": {
- "$ref": "DeviceIdentifier",
- "description": "The device identifier to search."
+ "description": "The device identifier to search.",
+ "$ref": "DeviceIdentifier"
},
"pageToken": {
"description": "Page token.",
"type": "string"
}
},
- "id": "FindDevicesByDeviceIdentifierRequest",
- "description": "Request to find devices."
+ "id": "FindDevicesByDeviceIdentifierRequest"
+ },
+ "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"
+ }
+ }
+ }
+ }
+ },
+ "OperationPerDevice": {
+ "id": "OperationPerDevice",
+ "description": "Operation the server received for every device.",
+ "type": "object",
+ "properties": {
+ "updateMetadata": {
+ "description": "Request to set metadata for a device.",
+ "$ref": "UpdateMetadataArguments"
+ },
+ "unclaim": {
+ "$ref": "PartnerUnclaim",
+ "description": "Request to unclaim a device."
+ },
+ "result": {
+ "$ref": "PerDeviceStatusInBatch",
+ "description": "Processing result for every device."
+ },
+ "claim": {
+ "description": "Request to claim a device.",
+ "$ref": "PartnerClaim"
+ }
+ }
},
"CustomerListConfigurationsResponse": {
"description": "Response message of customer's listing configuration.",
@@ -863,48 +1090,26 @@
},
"id": "CustomerListConfigurationsResponse"
},
- "OperationPerDevice": {
- "type": "object",
- "properties": {
- "updateMetadata": {
- "$ref": "UpdateMetadataArguments",
- "description": "Request to set metadata for a device."
- },
- "unclaim": {
- "$ref": "PartnerUnclaim",
- "description": "Request to unclaim a device."
- },
- "result": {
- "$ref": "PerDeviceStatusInBatch",
- "description": "Processing result for every device."
- },
- "claim": {
- "$ref": "PartnerClaim",
- "description": "Request to claim a device."
- }
- },
- "id": "OperationPerDevice",
- "description": "Operation the server received for every device."
- },
"FindDevicesByOwnerResponse": {
+ "description": "Response containing found devices.",
"type": "object",
"properties": {
- "nextPageToken": {
- "type": "string",
- "description": "Page token of the next page."
- },
"devices": {
"description": "Devices found.",
"type": "array",
"items": {
"$ref": "Device"
}
+ },
+ "nextPageToken": {
+ "description": "Page token of the next page.",
+ "type": "string"
}
},
- "id": "FindDevicesByOwnerResponse",
- "description": "Response containing found devices."
+ "id": "FindDevicesByOwnerResponse"
},
"CustomerRemoveConfigurationRequest": {
+ "id": "CustomerRemoveConfigurationRequest",
"description": "Request message for customer to remove the configuration from device.",
"type": "object",
"properties": {
@@ -912,43 +1117,19 @@
"$ref": "DeviceReference",
"description": "Required. The device to remove the configuration from."
}
- },
- "id": "CustomerRemoveConfigurationRequest"
- },
- "ClaimDeviceRequest": {
- "description": "Request message to claim a device on behalf of a customer.",
- "type": "object",
- "properties": {
- "deviceIdentifier": {
- "$ref": "DeviceIdentifier",
- "description": "The device identifier of the device to claim."
- },
- "sectionType": {
- "enum": [
- "SECTION_TYPE_UNSPECIFIED",
- "SECTION_TYPE_ZERO_TOUCH"
- ],
- "description": "The section to claim.",
- "type": "string",
- "enumDescriptions": [
- "Unspecified section type.",
- "Zero-touch enrollment section type."
- ]
- },
- "customerId": {
- "type": "string",
- "description": "The customer to claim for.",
- "format": "int64"
- }
- },
- "id": "ClaimDeviceRequest"
+ }
},
"DevicesLongRunningOperationMetadata": {
+ "id": "DevicesLongRunningOperationMetadata",
"description": "Long running operation metadata.",
"type": "object",
"properties": {
+ "devicesCount": {
+ "description": "Number of devices parsed in your requests.",
+ "format": "int32",
+ "type": "integer"
+ },
"processingStatus": {
- "type": "string",
"enumDescriptions": [
"Invalid code. Shouldn't be used.",
"Pending.",
@@ -961,36 +1142,90 @@
"BATCH_PROCESS_IN_PROGRESS",
"BATCH_PROCESS_PROCESSED"
],
- "description": "The overall processing status."
+ "description": "The overall processing status.",
+ "type": "string"
},
"progress": {
"description": "Processing progress from 0 to 100.",
"format": "int32",
"type": "integer"
+ }
+ }
+ },
+ "ClaimDeviceRequest": {
+ "description": "Request message to claim a device on behalf of a customer.",
+ "type": "object",
+ "properties": {
+ "sectionType": {
+ "enumDescriptions": [
+ "Unspecified section type.",
+ "Zero-touch enrollment section type."
+ ],
+ "enum": [
+ "SECTION_TYPE_UNSPECIFIED",
+ "SECTION_TYPE_ZERO_TOUCH"
+ ],
+ "description": "The section to claim.",
+ "type": "string"
},
- "devicesCount": {
- "description": "Number of devices parsed in your requests.",
- "format": "int32",
- "type": "integer"
+ "customerId": {
+ "description": "The customer to claim for.",
+ "format": "int64",
+ "type": "string"
+ },
+ "deviceIdentifier": {
+ "description": "The device identifier of the device to claim.",
+ "$ref": "DeviceIdentifier"
}
},
- "id": "DevicesLongRunningOperationMetadata"
+ "id": "ClaimDeviceRequest"
},
"UpdateDeviceMetadataInBatchRequest": {
+ "description": "Request to update device metadata in batch.",
"type": "object",
"properties": {
"updates": {
+ "description": "List of metadata updates.",
"type": "array",
"items": {
"$ref": "UpdateMetadataArguments"
- },
- "description": "List of metadata updates."
+ }
}
},
- "id": "UpdateDeviceMetadataInBatchRequest",
- "description": "Request to update device metadata in batch."
+ "id": "UpdateDeviceMetadataInBatchRequest"
+ },
+ "ListCustomersResponse": {
+ "description": "Response message of all customers related to this partner.",
+ "type": "object",
+ "properties": {
+ "customers": {
+ "description": "List of customers related to this partner.",
+ "type": "array",
+ "items": {
+ "$ref": "Company"
+ }
+ }
+ },
+ "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]`.",
+ "type": "string"
+ },
+ "deviceId": {
+ "description": "The device ID of the claimed device.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "id": "ClaimDeviceResponse"
},
"UpdateMetadataArguments": {
+ "id": "UpdateMetadataArguments",
"description": "Identifies metdata updates to one device.",
"type": "object",
"properties": {
@@ -999,76 +1234,36 @@
"description": "Device identifier."
},
"deviceMetadata": {
- "$ref": "DeviceMetadata",
- "description": "The metadata to update."
+ "description": "The metadata to update.",
+ "$ref": "DeviceMetadata"
},
"deviceId": {
"description": "Device ID of the device.",
"format": "int64",
"type": "string"
}
- },
- "id": "UpdateMetadataArguments"
- },
- "ClaimDeviceResponse": {
- "description": "Response message containing device id of the claim.",
- "type": "object",
- "properties": {
- "deviceId": {
- "description": "The device ID of the claimed device.",
- "format": "int64",
- "type": "string"
- },
- "deviceName": {
- "type": "string",
- "description": "The resource name of the device in the format\n`partners/[PARTNER_ID]/devices/[DEVICE_ID]`."
- }
- },
- "id": "ClaimDeviceResponse"
- },
- "ListCustomersResponse": {
- "type": "object",
- "properties": {
- "customers": {
- "type": "array",
- "items": {
- "$ref": "Company"
- },
- "description": "List of customers related to this partner."
- }
- },
- "id": "ListCustomersResponse",
- "description": "Response message of all customers related to this partner."
+ }
},
"DeviceReference": {
+ "description": "A `DeviceReference` is an API abstraction that lets you supply a _device_\nargument to a method using one of the following identifier types:\n\n* A numeric API resource ID.\n* Real-world hardware IDs, such as IMEI number, belonging to the manufactured\n device.\n\nMethods that operate on devices take a `DeviceReference` as a parameter type\nbecause it's more flexible for the caller. To learn more about device\nidentifiers, read [Identifiers](/zero-touch/guides/identifiers).",
"type": "object",
"properties": {
"deviceId": {
- "type": "string",
"description": "The ID of the device.",
- "format": "int64"
+ "format": "int64",
+ "type": "string"
},
"deviceIdentifier": {
"$ref": "DeviceIdentifier",
"description": "The hardware IDs of the device."
}
},
- "id": "DeviceReference",
- "description": "A `DeviceReference` is an API abstraction that lets you supply a _device_\nargument to a method using one of the following identifier types:\n\n* A numeric API resource ID.\n* Real-world hardware IDs, such as IMEI number, belonging to the manufactured\n device.\n\nMethods that operate on devices take a `DeviceReference` as a parameter type\nbecause it's more flexible for the caller. To learn more about device\nidentifiers, read [Identifiers](/zero-touch/guides/identifiers)."
+ "id": "DeviceReference"
},
"Device": {
"description": "An Android device registered for zero-touch enrollment.",
"type": "object",
"properties": {
- "deviceId": {
- "type": "string",
- "description": "Output only. The ID of the device. Assigned by the server.",
- "format": "int64"
- },
- "configuration": {
- "type": "string",
- "description": "Not available to resellers."
- },
"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",
@@ -1077,16 +1272,25 @@
}
},
"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": {
- "$ref": "DeviceMetadata",
- "description": "The metadata attached to the device. Structured as key-value pairs. To\nlearn more, read [Device metadata](/zero-touch/guides/metadata)."
+ "description": "The metadata attached to the device. Structured as key-value pairs. To\nlearn more, read [Device metadata](/zero-touch/guides/metadata).",
+ "$ref": "DeviceMetadata"
},
"name": {
- "type": "string",
- "description": "Output only. The API resource name in the format\n`partners/[PARTNER_ID]/devices/[DEVICE_ID]`. Assigned by the server."
+ "description": "Output only. The API resource name in the format\n`partners/[PARTNER_ID]/devices/[DEVICE_ID]`. Assigned by the server.",
+ "type": "string"
+ },
+ "deviceId": {
+ "description": "Output only. The ID of the device. Assigned by the server.",
+ "format": "int64",
+ "type": "string"
+ },
+ "configuration": {
+ "description": "Not available to resellers.",
+ "type": "string"
}
},
"id": "Device"
@@ -1103,6 +1307,8 @@
"id": "CreateCustomerRequest"
},
"Company": {
+ "id": "Company",
+ "description": "A customer resource in the zero-touch enrollment API.",
"type": "object",
"properties": {
"name": {
@@ -1110,15 +1316,15 @@
"type": "string"
},
"companyName": {
- "type": "string",
- "description": "Required. The name of the company. For example _XYZ Corp_. Characters\nallowed are: Latin letters, numerals, hyphens, and spaces. Displayed to the\ncustomer's employees in the zero-touch enrollment portal."
+ "description": "Required. The name of the company. For example _XYZ Corp_. Characters\nallowed are: Latin letters, numerals, hyphens, and spaces. Displayed to the\ncustomer's employees in the zero-touch enrollment portal.",
+ "type": "string"
},
"adminEmails": {
+ "description": "Input only. Optional. Email address of customer's users in the admin role.\nEach email address must be associated with a Google Account.",
"type": "array",
"items": {
"type": "string"
- },
- "description": "Input only. Optional. Email address of customer's users in the admin role.\nEach email address must be associated with a Google Account."
+ }
},
"ownerEmails": {
"description": "Input only. Email address of customer's users in the owner role. At least\none `owner_email` is required. Each email address must be associated with a\nGoogle Account. Owners share the same access as admins but can also add,\ndelete, and edit your organization's portal users.",
@@ -1132,11 +1338,10 @@
"format": "int64",
"type": "string"
}
- },
- "id": "Company",
- "description": "A customer resource in the zero-touch enrollment API."
+ }
},
"UpdateDeviceMetadataRequest": {
+ "description": "Request to set metadata for a device.",
"type": "object",
"properties": {
"deviceMetadata": {
@@ -1144,90 +1349,75 @@
"description": "The metdata to set."
}
},
- "id": "UpdateDeviceMetadataRequest",
- "description": "Request to set metadata for a device."
+ "id": "UpdateDeviceMetadataRequest"
},
"Configuration": {
+ "description": "A configuration collects the provisioning options for Android devices. Each\nconfiguration combines the following:\n\n* The EMM device policy controller (DPC) installed on the devices.\n* EMM policies enforced on the devices.\n* Metadata displayed on the device to help users during setup.\n\nCustomers can add as many configurations as they need. However, zero-touch\nenrollment works best when a customer sets a default configuration that's\napplied to any new devices the organization purchases.",
"type": "object",
"properties": {
- "companyName": {
- "type": "string",
- "description": "Required. The name of the organization. Zero-touch enrollment shows this\norganization name to device users during device provisioning."
- },
- "configurationId": {
- "type": "string",
- "description": "Output only. The ID of the configuration. Assigned by the server.",
- "format": "int64"
- },
- "dpcResourcePath": {
- "type": "string",
- "description": "Required. The resource name of the selected DPC (device policy controller)\nin the format `customers/[CUSTOMER_ID]/dpcs/*`. To list the supported DPCs,\ncall\n`customers.dpcs.list`."
- },
"isDefault": {
"description": "Required. Whether this is the default configuration that zero-touch\nenrollment applies to any new devices the organization purchases in the\nfuture. Only one customer configuration can be the default. Setting this\nvalue to `true`, changes the previous default configuration's `isDefault`\nvalue to `false`.",
"type": "boolean"
},
- "dpcExtras": {
- "description": "The JSON-formatted EMM provisioning extras that are passed to the DPC.",
- "type": "string"
- },
"customMessage": {
"description": "A message, containing one or two sentences, to help device users get help\nor give them more details about what’s happening to their device.\nZero-touch enrollment shows this message before the device is provisioned.",
"type": "string"
},
+ "dpcExtras": {
+ "description": "The JSON-formatted EMM provisioning extras that are passed to the DPC.",
+ "type": "string"
+ },
"contactEmail": {
"description": "Required. The email address that device users can contact to get help.\nZero-touch enrollment shows this email address to device users before\ndevice provisioning. The value is validated on input.",
"type": "string"
},
"name": {
- "type": "string",
- "description": "Output only. The API resource name in the format\n`customers/[CUSTOMER_ID]/configurations/[CONFIGURATION_ID]`. Assigned by\nthe server."
+ "description": "Output only. The API resource name in the format\n`customers/[CUSTOMER_ID]/configurations/[CONFIGURATION_ID]`. Assigned by\nthe server.",
+ "type": "string"
},
"configurationName": {
- "type": "string",
- "description": "Required. A short name that describes the configuration's purpose. For\nexample, _Sales team_ or _Temporary employees_. The zero-touch enrollment\nportal displays this name to IT admins."
+ "description": "Required. A short name that describes the configuration's purpose. For\nexample, _Sales team_ or _Temporary employees_. The zero-touch enrollment\nportal displays this name to IT admins.",
+ "type": "string"
},
"contactPhone": {
"description": "Required. The telephone number that device users can call, using another\ndevice, to get help. Zero-touch enrollment shows this number to device\nusers before device provisioning. Accepts numerals, spaces, the plus sign,\nhyphens, and parentheses.",
"type": "string"
+ },
+ "dpcResourcePath": {
+ "description": "Required. The resource name of the selected DPC (device policy controller)\nin the format `customers/[CUSTOMER_ID]/dpcs/*`. To list the supported DPCs,\ncall\n`customers.dpcs.list`.",
+ "type": "string"
+ },
+ "configurationId": {
+ "description": "Output only. The ID of the configuration. Assigned by the server.",
+ "format": "int64",
+ "type": "string"
+ },
+ "companyName": {
+ "description": "Required. The name of the organization. Zero-touch enrollment shows this\norganization name to device users during device provisioning.",
+ "type": "string"
}
},
- "id": "Configuration",
- "description": "A configuration collects the provisioning options for Android devices. Each\nconfiguration combines the following:\n\n* The EMM device policy controller (DPC) installed on the devices.\n* EMM policies enforced on the devices.\n* Metadata displayed on the device to help users during setup.\n\nCustomers can add as many configurations as they need. However, zero-touch\nenrollment works best when a customer sets a default configuration that's\napplied to any new devices the organization purchases."
- },
- "CustomerListDpcsResponse": {
- "type": "object",
- "properties": {
- "dpcs": {
- "description": "The list of DPCs available to the customer that support zero-touch\nenrollment.",
- "type": "array",
- "items": {
- "$ref": "Dpc"
- }
- }
- },
- "id": "CustomerListDpcsResponse",
- "description": "Response message of customer's listing DPCs."
+ "id": "Configuration"
},
"PartnerUnclaim": {
"description": "Identifies one unclaim request.",
"type": "object",
"properties": {
"deviceIdentifier": {
- "$ref": "DeviceIdentifier",
- "description": "Device identifier of the device."
+ "description": "Device identifier of the device.",
+ "$ref": "DeviceIdentifier"
},
"sectionType": {
+ "enumDescriptions": [
+ "Unspecified section type.",
+ "Zero-touch enrollment section type."
+ ],
"enum": [
"SECTION_TYPE_UNSPECIFIED",
"SECTION_TYPE_ZERO_TOUCH"
],
"description": "Section type to unclaim.",
- "type": "string",
- "enumDescriptions": [
- "Unspecified section type.",
- "Zero-touch enrollment section type."
- ]
+ "type": "string"
},
"deviceId": {
"description": "Device ID of the device.",
@@ -1237,43 +1427,50 @@
},
"id": "PartnerUnclaim"
},
- "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 `{}`."
- },
- "FindDevicesByDeviceIdentifierResponse": {
+ "CustomerListDpcsResponse": {
+ "id": "CustomerListDpcsResponse",
+ "description": "Response message of customer's listing DPCs.",
"type": "object",
"properties": {
+ "dpcs": {
+ "description": "The list of DPCs available to the customer that support zero-touch\nenrollment.",
+ "type": "array",
+ "items": {
+ "$ref": "Dpc"
+ }
+ }
+ }
+ },
+ "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": {}
+ },
+ "FindDevicesByDeviceIdentifierResponse": {
+ "id": "FindDevicesByDeviceIdentifierResponse",
+ "description": "Response containing found devices.",
+ "type": "object",
+ "properties": {
+ "nextPageToken": {
+ "description": "Page token of the next page.",
+ "type": "string"
+ },
"devices": {
"description": "Found devices.",
"type": "array",
"items": {
"$ref": "Device"
}
- },
- "nextPageToken": {
- "type": "string",
- "description": "Page token of the next page."
}
- },
- "id": "FindDevicesByDeviceIdentifierResponse",
- "description": "Response containing found devices."
+ }
},
"PartnerClaim": {
+ "id": "PartnerClaim",
+ "description": "Identifies one claim request.",
"type": "object",
"properties": {
- "deviceIdentifier": {
- "$ref": "DeviceIdentifier",
- "description": "Device identifier of the device."
- },
- "deviceMetadata": {
- "$ref": "DeviceMetadata",
- "description": "Metadata to set at claim."
- },
"sectionType": {
- "type": "string",
"enumDescriptions": [
"Unspecified section type.",
"Zero-touch enrollment section type."
@@ -1282,60 +1479,68 @@
"SECTION_TYPE_UNSPECIFIED",
"SECTION_TYPE_ZERO_TOUCH"
],
- "description": "Section type to claim."
+ "description": "Section type to claim.",
+ "type": "string"
},
"customerId": {
"description": "Customer ID to claim for.",
"format": "int64",
"type": "string"
- }
- },
- "id": "PartnerClaim",
- "description": "Identifies one claim request."
- },
- "UnclaimDeviceRequest": {
- "type": "object",
- "properties": {
+ },
"deviceIdentifier": {
"$ref": "DeviceIdentifier",
- "description": "The device identifier you used when you claimed this device."
+ "description": "Device identifier of the device."
},
+ "deviceMetadata": {
+ "description": "Metadata to set at claim.",
+ "$ref": "DeviceMetadata"
+ }
+ }
+ },
+ "UnclaimDeviceRequest": {
+ "description": "Request message to unclaim a device.",
+ "type": "object",
+ "properties": {
"sectionType": {
- "enum": [
- "SECTION_TYPE_UNSPECIFIED",
- "SECTION_TYPE_ZERO_TOUCH"
- ],
"description": "The section type to unclaim for.",
"type": "string",
"enumDescriptions": [
"Unspecified section type.",
"Zero-touch enrollment section type."
+ ],
+ "enum": [
+ "SECTION_TYPE_UNSPECIFIED",
+ "SECTION_TYPE_ZERO_TOUCH"
]
},
"deviceId": {
- "type": "string",
"description": "The device ID returned by `ClaimDevice`.",
- "format": "int64"
+ "format": "int64",
+ "type": "string"
+ },
+ "deviceIdentifier": {
+ "description": "The device identifier you used when you claimed this device.",
+ "$ref": "DeviceIdentifier"
}
},
- "id": "UnclaimDeviceRequest",
- "description": "Request message to unclaim a device."
+ "id": "UnclaimDeviceRequest"
},
"DeviceMetadata": {
"description": "Metadata entries that can be attached to a `Device`. To learn more, read\n[Device metadata](/zero-touch/guides/metadata).",
"type": "object",
"properties": {
"entries": {
+ "description": "Metadata entries recorded as key-value pairs.",
+ "type": "object",
"additionalProperties": {
"type": "string"
- },
- "description": "Metadata entries recorded as key-value pairs.",
- "type": "object"
+ }
}
},
"id": "DeviceMetadata"
},
"CustomerListCustomersResponse": {
+ "id": "CustomerListCustomersResponse",
"description": "Response message for listing my customers.",
"type": "object",
"properties": {
@@ -1347,235 +1552,30 @@
}
},
"nextPageToken": {
- "type": "string",
- "description": "Token to retrieve the next page of results, or empty if there are no\nmore results in the list."
- }
- },
- "id": "CustomerListCustomersResponse"
- },
- "CustomerListDevicesResponse": {
- "type": "object",
- "properties": {
- "nextPageToken": {
- "type": "string",
- "description": "A token used to access the next page of results. Omitted if no further\nresults are available."
- },
- "devices": {
- "type": "array",
- "items": {
- "$ref": "Device"
- },
- "description": "The customer's devices."
- }
- },
- "id": "CustomerListDevicesResponse",
- "description": "Response message of customer's liting devices."
- },
- "DevicesLongRunningOperationResponse": {
- "description": "Long running operation response.",
- "type": "object",
- "properties": {
- "successCount": {
- "type": "integer",
- "description": "Number of succeesfully processed ones.",
- "format": "int32"
- },
- "perDeviceStatus": {
- "type": "array",
- "items": {
- "$ref": "OperationPerDevice"
- },
- "description": "Processing status for each device.\nOne `PerDeviceStatus` per device. The order is the same as in your requests."
- }
- },
- "id": "DevicesLongRunningOperationResponse"
- },
- "DeviceClaim": {
- "description": "A record of a device claimed by a reseller for a customer. Devices claimed\nfor zero-touch enrollment have a claim with the type\n`SECTION_TYPE_ZERO_TOUCH`. To learn more, read\n[Claim devices for customers](/zero-touch/guides/how-it-works#claim).",
- "type": "object",
- "properties": {
- "ownerCompanyId": {
- "type": "string",
- "description": "The ID of the Customer that purchased the device.",
- "format": "int64"
- },
- "sectionType": {
- "type": "string",
- "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."
- }
- },
- "id": "DeviceClaim"
- },
- "PerDeviceStatusInBatch": {
- "description": "Stores the processing result for each device.",
- "type": "object",
- "properties": {
- "errorMessage": {
- "description": "Error message.",
- "type": "string"
- },
- "deviceId": {
- "description": "Device ID of the device if process succeeds.",
- "format": "int64",
- "type": "string"
- },
- "status": {
- "enum": [
- "SINGLE_DEVICE_STATUS_UNSPECIFIED",
- "SINGLE_DEVICE_STATUS_UNKNOWN_ERROR",
- "SINGLE_DEVICE_STATUS_OTHER_ERROR",
- "SINGLE_DEVICE_STATUS_SUCCESS",
- "SINGLE_DEVICE_STATUS_PERMISSION_DENIED",
- "SINGLE_DEVICE_STATUS_INVALID_DEVICE_IDENTIFIER",
- "SINGLE_DEVICE_STATUS_INVALID_SECTION_TYPE",
- "SINGLE_DEVICE_STATUS_SECTION_NOT_YOURS"
- ],
- "description": "Process result.",
- "type": "string",
- "enumDescriptions": [
- "Invalid code. Shouldn't be used.",
- "Unknown error.\nWe don't expect this error to occur here.",
- "Other error.\nWe know/expect this error, but there's no defined error code for the\nerror.",
- "Success.",
- "Permission denied.",
- "Invalid device identifier.",
- "Invalid section type.",
- "This section is claimed by another company."
- ]
- },
- "errorIdentifier": {
- "description": "Error identifier.",
+ "description": "Token to retrieve the next page of results, or empty if there are no\nmore results in the list.",
"type": "string"
}
- },
- "id": "PerDeviceStatusInBatch"
- },
- "ClaimDevicesRequest": {
- "description": "Request to claim devices asynchronously in batch.",
- "type": "object",
- "properties": {
- "claims": {
- "description": "List of claims.",
- "type": "array",
- "items": {
- "$ref": "PartnerClaim"
- }
- }
- },
- "id": "ClaimDevicesRequest"
- },
- "FindDevicesByOwnerRequest": {
- "description": "Request to find devices by customers.",
- "type": "object",
- "properties": {
- "pageToken": {
- "description": "Page token.",
- "type": "string"
- },
- "sectionType": {
- "type": "string",
- "enumDescriptions": [
- "Unspecified section type.",
- "Zero-touch enrollment section type."
- ],
- "enum": [
- "SECTION_TYPE_UNSPECIFIED",
- "SECTION_TYPE_ZERO_TOUCH"
- ],
- "description": "The section type."
- },
- "customerId": {
- "description": "List of customer IDs to search for.",
- "type": "array",
- "items": {
- "type": "string",
- "format": "int64"
- }
- },
- "limit": {
- "type": "string",
- "description": "The number of devices to show in the result.",
- "format": "int64"
- }
- },
- "id": "FindDevicesByOwnerRequest"
- },
- "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": "This field will contain a `DevicesLongRunningOperationMetadata` object if the operation is created by `claimAsync`, `unclaimAsync`, or `updateMetadataAsync`.",
- "type": "object"
- },
- "done": {
- "description": "If the value is `false`, it means the operation is still in progress.\nIf `true`, the operation is completed, and either `error` or `response` is\navailable.",
- "type": "boolean"
- },
- "response": {
- "type": "object",
- "additionalProperties": {
- "type": "any",
- "description": "Properties of the object. Contains field @type with type URL."
- },
- "description": "This field will contain a `DevicesLongRunningOperationResponse` object if the operation is created by `claimAsync`, `unclaimAsync`, or `updateMetadataAsync`."
- },
- "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": "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`."
- }
- },
- "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": {
- "type": "string",
- "description": "The device’s MEID number."
- },
- "manufacturer": {
- "type": "string",
- "description": "Required. The device manufacturer’s name. Matches the device's built-in\nvalue returned from `android.os.Build.MANUFACTURER`. Allowed values are\nlisted in [manufacturer names](/zero-touch/resources/manufacturer-names)."
- },
- "serialNumber": {
- "description": "The manufacturer's serial number for the device. This value might not be\nunique.",
- "type": "string"
- }
- },
- "id": "DeviceIdentifier"
+ }
}
},
+ "protocol": "rest",
"icons": {
"x16": "http://www.google.com/images/icons/product/search-16.gif",
"x32": "http://www.google.com/images/icons/product/search-32.gif"
},
- "protocol": "rest",
"version": "v1",
"baseUrl": "https://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": ""
+ "servicePath": "",
+ "rootUrl": "https://androiddeviceprovisioning.googleapis.com/",
+ "basePath": "",
+ "ownerDomain": "google.com",
+ "name": "androiddeviceprovisioning",
+ "batchPath": "batch",
+ "revision": "20171216",
+ "documentationLink": "https://developers.google.com/zero-touch/",
+ "id": "androiddeviceprovisioning:v1",
+ "title": "Android Device Provisioning Partner API"
}
diff --git a/appengine/v1/appengine-api.json b/appengine/v1/appengine-api.json
index 25546d8..a2161e6 100644
--- a/appengine/v1/appengine-api.json
+++ b/appengine/v1/appengine-api.json
@@ -1,10 +1,152 @@
{
+ "discoveryVersion": "v1",
+ "ownerName": "Google",
+ "version_module": true,
"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",
+ "parameters": {
+ "appsId": {
+ "location": "path",
+ "description": "Part of `name`. Name of the Application resource to get. Example: apps/myapp.",
+ "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}"
+ },
+ "patch": {
+ "id": "appengine.apps.patch",
+ "path": "v1/apps/{appsId}",
+ "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.",
+ "httpMethod": "PATCH",
+ "parameterOrder": [
+ "appsId"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "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}"
+ },
+ "create": {
+ "httpMethod": "POST",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameters": {},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/apps",
+ "id": "appengine.apps.create",
+ "path": "v1/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/)."
+ },
+ "repair": {
+ "path": "v1/apps/{appsId}:repair",
+ "id": "appengine.apps.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": {
+ "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": "v1/apps/{appsId}:repair"
+ }
+ },
"resources": {
"services": {
"methods": {
+ "delete": {
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "appsId",
+ "servicesId"
+ ],
+ "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/services/default.",
+ "required": true,
+ "type": "string"
+ },
+ "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.delete",
+ "description": "Deletes the specified service and all enclosed versions."
+ },
"list": {
+ "path": "v1/apps/{appsId}/services",
+ "id": "appengine.apps.services.list",
"description": "Lists all the services in the application.",
"response": {
"$ref": "ListServicesResponse"
@@ -13,11 +155,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": {
"description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.",
@@ -26,9 +163,9 @@
"location": "path"
},
"pageToken": {
- "location": "query",
"description": "Continuation token for fetching the next page of results.",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"pageSize": {
"location": "query",
@@ -37,20 +174,22 @@
"type": "integer"
}
},
- "flatPath": "v1/apps/{appsId}/services",
- "path": "v1/apps/{appsId}/services",
- "id": "appengine.apps.services.list"
+ "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"
},
"get": {
- "description": "Gets the current configuration of the specified service.",
"httpMethod": "GET",
- "response": {
- "$ref": "Service"
- },
"parameterOrder": [
"appsId",
"servicesId"
],
+ "response": {
+ "$ref": "Service"
+ },
"parameters": {
"appsId": {
"description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default.",
@@ -72,18 +211,34 @@
],
"flatPath": "v1/apps/{appsId}/services/{servicesId}",
"id": "appengine.apps.services.get",
- "path": "v1/apps/{appsId}/services/{servicesId}"
+ "path": "v1/apps/{appsId}/services/{servicesId}",
+ "description": "Gets the current configuration of the specified service."
},
"patch": {
- "httpMethod": "PATCH",
+ "request": {
+ "$ref": "Service"
+ },
+ "description": "Updates the configuration of the specified service.",
+ "response": {
+ "$ref": "Operation"
+ },
"parameterOrder": [
"appsId",
"servicesId"
],
- "response": {
- "$ref": "Operation"
- },
+ "httpMethod": "PATCH",
"parameters": {
+ "appsId": {
+ "location": "path",
+ "description": "Part of `name`. Name of the resource to update. Example: apps/myapp/services/default.",
+ "required": true,
+ "type": "string"
+ },
+ "migrateTraffic": {
+ "description": "Set to true to gradually shift traffic to one or more versions that you specify. By default, traffic is shifted immediately. For gradual traffic migration, the target versions must be located within instances that are configured for both warmup requests (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#inboundservicetype) and automatic scaling (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#automaticscaling). You must specify the shardBy (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services#shardby) field in the Service resource. Gradual traffic migration is not supported in the App Engine flexible environment. For examples, see Migrating and Splitting Traffic (https://cloud.google.com/appengine/docs/admin-api/migrating-splitting-traffic).",
+ "type": "boolean",
+ "location": "query"
+ },
"updateMask": {
"description": "Standard field mask for the set of fields to be updated.",
"format": "google-fieldmask",
@@ -95,60 +250,14 @@
"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": {
- "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"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v1/apps/{appsId}/services/{servicesId}",
- "id": "appengine.apps.services.patch",
"path": "v1/apps/{appsId}/services/{servicesId}",
- "request": {
- "$ref": "Service"
- },
- "description": "Updates the configuration of the specified service."
- },
- "delete": {
- "description": "Deletes the specified service and all enclosed versions.",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "appsId",
- "servicesId"
- ],
- "httpMethod": "DELETE",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "servicesId": {
- "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": "v1/apps/{appsId}/services/{servicesId}",
- "path": "v1/apps/{appsId}/services/{servicesId}",
- "id": "appengine.apps.services.delete"
+ "id": "appengine.apps.services.patch"
}
},
"resources": {
@@ -156,44 +265,43 @@
"methods": {
"delete": {
"description": "Deletes an existing Version resource.",
- "response": {
- "$ref": "Operation"
- },
+ "httpMethod": "DELETE",
"parameterOrder": [
"appsId",
"servicesId",
"versionsId"
],
- "httpMethod": "DELETE",
+ "response": {
+ "$ref": "Operation"
+ },
"parameters": {
"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"
- },
"servicesId": {
- "location": "path",
"description": "Part of `name`. See documentation of `appsId`.",
"required": true,
- "type": "string"
+ "type": "string",
+ "location": "path"
}
},
"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.delete"
+ "id": "appengine.apps.services.versions.delete",
+ "path": "v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}"
},
"list": {
- "description": "Lists the versions of a service.",
"response": {
"$ref": "ListVersionsResponse"
},
@@ -202,51 +310,51 @@
"servicesId"
],
"httpMethod": "GET",
+ "parameters": {
+ "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": {
+ "description": "Maximum results to return per page.",
+ "format": "int32",
+ "type": "integer",
+ "location": "query"
+ },
+ "view": {
+ "enum": [
+ "BASIC",
+ "FULL"
+ ],
+ "description": "Controls the set of fields returned in the List response.",
+ "type": "string",
+ "location": "query"
+ },
+ "servicesId": {
+ "description": "Part of `parent`. 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"
],
- "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 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": {
- "description": "Controls the set of fields returned in the List response.",
- "type": "string",
- "location": "query",
- "enum": [
- "BASIC",
- "FULL"
- ]
- }
- },
"flatPath": "v1/apps/{appsId}/services/{servicesId}/versions",
"path": "v1/apps/{appsId}/services/{servicesId}/versions",
- "id": "appengine.apps.services.versions.list"
+ "id": "appengine.apps.services.versions.list",
+ "description": "Lists the versions of a service."
},
"get": {
- "httpMethod": "GET",
"response": {
"$ref": "Version"
},
@@ -255,6 +363,12 @@
"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",
@@ -263,19 +377,19 @@
"type": "string"
},
"view": {
+ "description": "Controls the set of fields returned in the Get response.",
+ "type": "string",
"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",
- "location": "path"
+ "type": "string"
},
"appsId": {
"location": "path",
@@ -284,45 +398,25 @@
"type": "string"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
"flatPath": "v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
- "id": "appengine.apps.services.versions.get",
"path": "v1/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."
},
"patch": {
- "id": "appengine.apps.services.versions.patch",
- "path": "v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
- "request": {
- "$ref": "Version"
+ "response": {
+ "$ref": "Operation"
},
- "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.",
- "httpMethod": "PATCH",
"parameterOrder": [
"appsId",
"servicesId",
"versionsId"
],
- "response": {
- "$ref": "Operation"
- },
+ "httpMethod": "PATCH",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
"parameters": {
- "appsId": {
- "description": "Part of `name`. Name of the resource to update. Example: apps/myapp/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"
- },
"updateMask": {
"description": "Standard field mask for the set of fields to be updated.",
"format": "google-fieldmask",
@@ -330,16 +424,31 @@
"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": {
"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}"
+ "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": {
"response": {
@@ -352,16 +461,16 @@
"httpMethod": "POST",
"parameters": {
"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 resource to create this version under. Example: apps/myapp/services/default.",
"required": true,
- "type": "string"
+ "type": "string",
+ "location": "path"
}
},
"scopes": [
@@ -379,105 +488,57 @@
"resources": {
"instances": {
"methods": {
- "delete": {
- "description": "Stops a running instance.",
- "httpMethod": "DELETE",
- "parameterOrder": [
- "appsId",
- "servicesId",
- "versionsId",
- "instancesId"
- ],
+ "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"
},
- "parameters": {
- "versionsId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string"
- },
- "servicesId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string"
- },
- "appsId": {
- "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"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}",
- "id": "appengine.apps.services.versions.instances.delete",
- "path": "v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}"
- },
- "list": {
- "description": "Lists the instances of a version.Tip: To aggregate details about instances over time, see the Stackdriver Monitoring API (https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.timeSeries/list).",
- "response": {
- "$ref": "ListInstancesResponse"
- },
"parameterOrder": [
"appsId",
"servicesId",
- "versionsId"
+ "versionsId",
+ "instancesId"
],
- "httpMethod": "GET",
+ "httpMethod": "POST",
"scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
+ "https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
- "pageSize": {
- "location": "query",
- "description": "Maximum results to return per page.",
- "format": "int32",
- "type": "integer"
- },
- "versionsId": {
- "location": "path",
- "description": "Part of `parent`. See documentation of `appsId`.",
- "required": true,
- "type": "string"
- },
"servicesId": {
- "description": "Part of `parent`. See documentation of `appsId`.",
+ "description": "Part of `name`. 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.",
+ "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1/instances/instance-1.",
"required": true,
"type": "string"
},
- "pageToken": {
- "location": "query",
- "description": "Continuation token for fetching the next page of results.",
- "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"
}
},
- "flatPath": "v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances",
- "path": "v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances",
- "id": "appengine.apps.services.versions.instances.list"
+ "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"
},
- "get": {
+ "delete": {
"response": {
- "$ref": "Instance"
+ "$ref": "Operation"
},
"parameterOrder": [
"appsId",
@@ -485,11 +546,9 @@
"versionsId",
"instancesId"
],
- "httpMethod": "GET",
+ "httpMethod": "DELETE",
"scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
+ "https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
"servicesId": {
@@ -499,10 +558,10 @@
"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": {
"location": "path",
@@ -519,56 +578,106 @@
},
"flatPath": "v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}",
"path": "v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}",
- "id": "appengine.apps.services.versions.instances.get",
- "description": "Gets instance information."
+ "id": "appengine.apps.services.versions.instances.delete",
+ "description": "Stops a running instance."
},
- "debug": {
- "request": {
- "$ref": "DebugInstanceRequest"
+ "list": {
+ "response": {
+ "$ref": "ListInstancesResponse"
},
- "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",
+ "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": {
+ "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"
+ },
+ "pageSize": {
+ "description": "Maximum results to return per page.",
+ "format": "int32",
+ "type": "integer",
+ "location": "query"
+ },
+ "versionsId": {
+ "description": "Part of `parent`. See documentation of `appsId`.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances",
+ "path": "v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances",
+ "id": "appengine.apps.services.versions.instances.list",
+ "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": {
+ "response": {
+ "$ref": "Instance"
+ },
"parameterOrder": [
"appsId",
"servicesId",
"versionsId",
"instancesId"
],
- "response": {
- "$ref": "Operation"
- },
+ "httpMethod": "GET",
"parameters": {
"servicesId": {
- "location": "path",
"description": "Part of `name`. See documentation of `appsId`.",
"required": true,
- "type": "string"
+ "type": "string",
+ "location": "path"
},
"appsId": {
+ "location": "path",
"description": "Part of `name`. Name of the resource 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": {
+ "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"
}
},
"scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
],
- "flatPath": "v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}:debug",
- "id": "appengine.apps.services.versions.instances.debug",
- "path": "v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}:debug"
+ "flatPath": "v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}",
+ "path": "v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}",
+ "id": "appengine.apps.services.versions.instances.get",
+ "description": "Gets instance information."
}
}
}
@@ -586,17 +695,12 @@
"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"
+ "type": "string",
+ "location": "path"
},
"pageToken": {
"description": "Continuation token for fetching the next page of results.",
@@ -610,6 +714,11 @@
"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",
"path": "v1/apps/{appsId}/authorizedDomains",
"id": "appengine.apps.authorizedDomains.list",
@@ -620,6 +729,9 @@
"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"
@@ -629,17 +741,6 @@
],
"httpMethod": "GET",
"parameters": {
- "appsId": {
- "location": "path",
- "description": "Part of `name`. The name of the operation's parent resource.",
- "required": true,
- "type": "string"
- },
- "pageToken": {
- "description": "The standard list page token.",
- "type": "string",
- "location": "query"
- },
"pageSize": {
"location": "query",
"description": "The standard list page size.",
@@ -650,23 +751,26 @@
"description": "The standard list filter.",
"type": "string",
"location": "query"
+ },
+ "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"
}
},
"scopes": [
"https://www.googleapis.com/auth/appengine.admin",
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1/apps/{appsId}/operations",
- "path": "v1/apps/{appsId}/operations",
- "id": "appengine.apps.operations.list"
+ ]
},
"get": {
- "flatPath": "v1/apps/{appsId}/operations/{operationsId}",
- "id": "appengine.apps.operations.get",
- "path": "v1/apps/{appsId}/operations/{operationsId}",
- "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
- "httpMethod": "GET",
"response": {
"$ref": "Operation"
},
@@ -674,6 +778,7 @@
"appsId",
"operationsId"
],
+ "httpMethod": "GET",
"parameters": {
"appsId": {
"location": "path",
@@ -692,51 +797,17 @@
"https://www.googleapis.com/auth/appengine.admin",
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
- ]
+ ],
+ "flatPath": "v1/apps/{appsId}/operations/{operationsId}",
+ "path": "v1/apps/{appsId}/operations/{operationsId}",
+ "id": "appengine.apps.operations.get",
+ "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service."
}
}
},
"domainMappings": {
"methods": {
- "create": {
- "flatPath": "v1/apps/{appsId}/domainMappings",
- "id": "appengine.apps.domainMappings.create",
- "path": "v1/apps/{appsId}/domainMappings",
- "request": {
- "$ref": "DomainMapping"
- },
- "description": "Maps a domain to an application. A user must be authorized to administer a domain in order to map it to an application. For a list of available authorized domains, see AuthorizedDomains.ListAuthorizedDomains.",
- "httpMethod": "POST",
- "parameterOrder": [
- "appsId"
- ],
- "response": {
- "$ref": "Operation"
- },
- "parameters": {
- "appsId": {
- "location": "path",
- "description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.",
- "required": true,
- "type": "string"
- },
- "overrideStrategy": {
- "location": "query",
- "enum": [
- "UNSPECIFIED_DOMAIN_OVERRIDE_STRATEGY",
- "STRICT",
- "OVERRIDE"
- ],
- "description": "Whether the domain creation should override any existing mappings for this domain. By default, overrides are rejected.",
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- },
"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"
},
@@ -745,29 +816,29 @@
"domainMappingsId"
],
"httpMethod": "DELETE",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
"parameters": {
"appsId": {
- "location": "path",
"description": "Part of `name`. Name of the resource to delete. Example: apps/myapp/domainMappings/example.com.",
"required": true,
- "type": "string"
- },
- "domainMappingsId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
"type": "string",
"location": "path"
+ },
+ "domainMappingsId": {
+ "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}/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",
"description": "Lists the domain mappings on an application.",
@@ -801,13 +872,10 @@
"format": "int32",
"type": "integer"
}
- }
+ },
+ "flatPath": "v1/apps/{appsId}/domainMappings"
},
"get": {
- "flatPath": "v1/apps/{appsId}/domainMappings/{domainMappingsId}",
- "path": "v1/apps/{appsId}/domainMappings/{domainMappingsId}",
- "id": "appengine.apps.domainMappings.get",
- "description": "Gets the specified domain mapping.",
"response": {
"$ref": "DomainMapping"
},
@@ -823,27 +891,24 @@
],
"parameters": {
"appsId": {
- "location": "path",
"description": "Part of `name`. Name of the resource requested. 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"
}
- }
+ },
+ "flatPath": "v1/apps/{appsId}/domainMappings/{domainMappingsId}",
+ "path": "v1/apps/{appsId}/domainMappings/{domainMappingsId}",
+ "id": "appengine.apps.domainMappings.get",
+ "description": "Gets the specified domain mapping."
},
"patch": {
- "flatPath": "v1/apps/{appsId}/domainMappings/{domainMappingsId}",
- "id": "appengine.apps.domainMappings.patch",
- "path": "v1/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.",
"httpMethod": "PATCH",
"parameterOrder": [
"appsId",
@@ -853,12 +918,6 @@
"$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`.",
@@ -870,11 +929,61 @@
"description": "Standard field mask for the set of fields to be updated.",
"format": "google-fieldmask",
"type": "string"
+ },
+ "appsId": {
+ "description": "Part of `name`. Name of the resource to update. Example: apps/myapp/domainMappings/example.com.",
+ "required": true,
+ "type": "string",
+ "location": "path"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
- ]
+ ],
+ "flatPath": "v1/apps/{appsId}/domainMappings/{domainMappingsId}",
+ "id": "appengine.apps.domainMappings.patch",
+ "path": "v1/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.",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "appsId"
+ ],
+ "httpMethod": "POST",
+ "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"
+ },
+ "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}/domainMappings",
+ "path": "v1/apps/{appsId}/domainMappings",
+ "id": "appengine.apps.domainMappings.create"
}
}
},
@@ -882,76 +991,8 @@
"resources": {
"ingressRules": {
"methods": {
- "list": {
- "httpMethod": "GET",
- "response": {
- "$ref": "ListIngressRulesResponse"
- },
- "parameterOrder": [
- "appsId"
- ],
- "parameters": {
- "matchingAddress": {
- "description": "A valid IP Address. If set, only rules matching this address will be returned. The first returned rule will be the rule that fires on requests from this IP.",
- "type": "string",
- "location": "query"
- },
- "appsId": {
- "location": "path",
- "description": "Part of `parent`. Name of the Firewall collection to retrieve. Example: apps/myapp/firewall/ingressRules.",
- "required": true,
- "type": "string"
- },
- "pageToken": {
- "description": "Continuation token for fetching the next page of results.",
- "type": "string",
- "location": "query"
- },
- "pageSize": {
- "description": "Maximum results to return per page.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1/apps/{appsId}/firewall/ingressRules",
- "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",
- "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": {
- "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": "v1/apps/{appsId}/firewall/ingressRules"
- },
"get": {
+ "description": "Gets the specified firewall rule.",
"response": {
"$ref": "FirewallRule"
},
@@ -961,17 +1002,17 @@
],
"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": {
- "location": "path",
"description": "Part of `name`. See documentation of `appsId`.",
"required": true,
- "type": "string"
+ "type": "string",
+ "location": "path"
+ },
+ "appsId": {
+ "description": "Part of `name`. Name of the Firewall resource to retrieve. Example: apps/myapp/firewall/ingressRules/100.",
+ "required": true,
+ "type": "string",
+ "location": "path"
}
},
"scopes": [
@@ -981,17 +1022,9 @@
],
"flatPath": "v1/apps/{appsId}/firewall/ingressRules/{ingressRulesId}",
"path": "v1/apps/{appsId}/firewall/ingressRules/{ingressRulesId}",
- "id": "appengine.apps.firewall.ingressRules.get",
- "description": "Gets the specified firewall rule."
+ "id": "appengine.apps.firewall.ingressRules.get"
},
"patch": {
- "flatPath": "v1/apps/{appsId}/firewall/ingressRules/{ingressRulesId}",
- "path": "v1/apps/{appsId}/firewall/ingressRules/{ingressRulesId}",
- "id": "appengine.apps.firewall.ingressRules.patch",
- "description": "Updates the specified firewall rule.",
- "request": {
- "$ref": "FirewallRule"
- },
"response": {
"$ref": "FirewallRule"
},
@@ -1000,9 +1033,6 @@
"ingressRulesId"
],
"httpMethod": "PATCH",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
"parameters": {
"updateMask": {
"description": "Standard field mask for the set of fields to be updated.",
@@ -1011,10 +1041,10 @@
"location": "query"
},
"appsId": {
+ "location": "path",
"description": "Part of `name`. Name of the Firewall resource to update. Example: apps/myapp/firewall/ingressRules/100.",
"required": true,
- "type": "string",
- "location": "path"
+ "type": "string"
},
"ingressRulesId": {
"description": "Part of `name`. See documentation of `appsId`.",
@@ -1022,9 +1052,23 @@
"type": "string",
"location": "path"
}
- }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/apps/{appsId}/firewall/ingressRules/{ingressRulesId}",
+ "path": "v1/apps/{appsId}/firewall/ingressRules/{ingressRulesId}",
+ "id": "appengine.apps.firewall.ingressRules.patch",
+ "request": {
+ "$ref": "FirewallRule"
+ },
+ "description": "Updates the specified firewall rule."
},
"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"
},
@@ -1034,10 +1078,10 @@
"httpMethod": "POST",
"parameters": {
"appsId": {
- "location": "path",
"description": "Part of `name`. Name of the Firewall collection to set. Example: apps/myapp/firewall/ingressRules.",
"required": true,
- "type": "string"
+ "type": "string",
+ "location": "path"
}
},
"scopes": [
@@ -1045,13 +1089,10 @@
],
"flatPath": "v1/apps/{appsId}/firewall/ingressRules:batchUpdate",
"path": "v1/apps/{appsId}/firewall/ingressRules:batchUpdate",
- "id": "appengine.apps.firewall.ingressRules.batchUpdate",
- "request": {
- "$ref": "BatchUpdateIngressRulesRequest"
- },
- "description": "Replaces the entire firewall ruleset in one bulk operation. This overrides and replaces the rules of an existing firewall with the new rules.If the final rule does not match traffic with the '*' wildcard IP range, then an \"allow all\" rule is explicitly added to the end of the list."
+ "id": "appengine.apps.firewall.ingressRules.batchUpdate"
},
"delete": {
+ "description": "Deletes the specified firewall rule.",
"response": {
"$ref": "Empty"
},
@@ -1064,23 +1105,91 @@
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
- "ingressRulesId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string"
- },
"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"
}
},
"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."
+ "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": {
+ "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"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "flatPath": "v1/apps/{appsId}/firewall/ingressRules",
+ "path": "v1/apps/{appsId}/firewall/ingressRules",
+ "id": "appengine.apps.firewall.ingressRules.list"
+ },
+ "create": {
+ "request": {
+ "$ref": "FirewallRule"
+ },
+ "description": "Creates a firewall rule for the application.",
+ "response": {
+ "$ref": "FirewallRule"
+ },
+ "parameterOrder": [
+ "appsId"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "appsId": {
+ "description": "Part of `parent`. Name of the parent Firewall collection in which to create a new rule. Example: apps/myapp/firewall/ingressRules.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/apps/{appsId}/firewall/ingressRules",
+ "path": "v1/apps/{appsId}/firewall/ingressRules",
+ "id": "appengine.apps.firewall.ingressRules.create"
}
}
}
@@ -1100,37 +1209,38 @@
"appsId"
],
"httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
"parameters": {
+ "pageSize": {
+ "description": "The standard list page size.",
+ "format": "int32",
+ "type": "integer",
+ "location": "query"
+ },
"filter": {
"description": "The standard list filter.",
"type": "string",
"location": "query"
},
"appsId": {
+ "location": "path",
"description": "Part of `name`. The resource that owns the locations collection, if applicable.",
"required": true,
- "type": "string",
- "location": "path"
- },
- "pageToken": {
- "location": "query",
- "description": "The standard list page token.",
"type": "string"
},
- "pageSize": {
- "location": "query",
- "description": "The standard list page size.",
- "format": "int32",
- "type": "integer"
+ "pageToken": {
+ "description": "The standard list page token.",
+ "type": "string",
+ "location": "query"
}
- }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ]
},
"get": {
+ "description": "Get information about a location.",
"response": {
"$ref": "Location"
},
@@ -1160,15 +1270,40 @@
},
"flatPath": "v1/apps/{appsId}/locations/{locationsId}",
"path": "v1/apps/{appsId}/locations/{locationsId}",
- "id": "appengine.apps.locations.get",
- "description": "Get information about a location."
+ "id": "appengine.apps.locations.get"
}
}
},
"authorizedCertificates": {
"methods": {
+ "create": {
+ "description": "Uploads the specified SSL certificate.",
+ "request": {
+ "$ref": "AuthorizedCertificate"
+ },
+ "response": {
+ "$ref": "AuthorizedCertificate"
+ },
+ "parameterOrder": [
+ "appsId"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "appsId": {
+ "location": "path",
+ "description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1/apps/{appsId}/authorizedCertificates",
+ "path": "v1/apps/{appsId}/authorizedCertificates",
+ "id": "appengine.apps.authorizedCertificates.create"
+ },
"delete": {
- "description": "Deletes the specified SSL certificate.",
"response": {
"$ref": "Empty"
},
@@ -1177,26 +1312,27 @@
"authorizedCertificatesId"
],
"httpMethod": "DELETE",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
"parameters": {
+ "appsId": {
+ "location": "path",
+ "description": "Part of `name`. Name of the resource to delete. Example: apps/myapp/authorizedCertificates/12345.",
+ "required": true,
+ "type": "string"
+ },
"authorizedCertificatesId": {
"location": "path",
"description": "Part of `name`. See documentation of `appsId`.",
"required": true,
"type": "string"
- },
- "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}",
"path": "v1/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.",
@@ -1245,6 +1381,10 @@
"id": "appengine.apps.authorizedCertificates.list"
},
"get": {
+ "flatPath": "v1/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}",
+ "path": "v1/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}",
+ "id": "appengine.apps.authorizedCertificates.get",
+ "description": "Gets the specified SSL certificate.",
"response": {
"$ref": "AuthorizedCertificate"
},
@@ -1253,23 +1393,12 @@
"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": {
- "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/authorizedCertificates/12345.",
"required": true,
- "type": "string",
- "location": "path"
+ "type": "string"
},
"view": {
"location": "query",
@@ -1279,29 +1408,29 @@
],
"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"
}
},
- "flatPath": "v1/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}",
- "path": "v1/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}",
- "id": "appengine.apps.authorizedCertificates.get",
- "description": "Gets the specified SSL 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"
+ ]
},
"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"
- },
+ "httpMethod": "PATCH",
"parameterOrder": [
"appsId",
"authorizedCertificatesId"
],
- "httpMethod": "PATCH",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
+ "response": {
+ "$ref": "AuthorizedCertificate"
+ },
"parameters": {
"authorizedCertificatesId": {
"location": "path",
@@ -1322,171 +1451,36 @@
"location": "path"
}
},
- "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": {
- "description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
- "flatPath": "v1/apps/{appsId}/authorizedCertificates"
+ "flatPath": "v1/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}",
+ "id": "appengine.apps.authorizedCertificates.patch",
+ "path": "v1/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."
}
}
}
- },
- "methods": {
- "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",
- "parameters": {},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/apps",
- "path": "v1/apps",
- "id": "appengine.apps.create"
- },
- "repair": {
- "httpMethod": "POST",
- "parameterOrder": [
- "appsId"
- ],
- "response": {
- "$ref": "Operation"
- },
- "parameters": {
- "appsId": {
- "location": "path",
- "description": "Part of `name`. Name of the application to repair. Example: apps/myapp",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/apps/{appsId}:repair",
- "id": "appengine.apps.repair",
- "path": "v1/apps/{appsId}:repair",
- "request": {
- "$ref": "RepairApplicationRequest"
- },
- "description": "Recreates the required App Engine features for the specified App Engine application, for example a Cloud Storage bucket or App Engine service account. Use this method if you receive an error message about a missing feature, for example, Error retrieving the App Engine service account."
- },
- "get": {
- "description": "Gets information about an application.",
- "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"
- }
- },
- "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}",
- "path": "v1/apps/{appsId}",
- "id": "appengine.apps.get"
- },
- "patch": {
- "flatPath": "v1/apps/{appsId}",
- "path": "v1/apps/{appsId}",
- "id": "appengine.apps.patch",
- "request": {
- "$ref": "Application"
- },
- "description": "Updates the specified Application resource. You can update the following fields:\nauth_domain - Google authentication domain for controlling user access to the application.\ndefault_cookie_expiration - Cookie expiration policy for the application.",
- "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"
- ]
- }
}
}
},
"parameters": {
- "upload_protocol": {
+ "uploadType": {
"location": "query",
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"type": "string"
},
- "prettyPrint": {
- "description": "Returns response with indentations and line breaks.",
- "type": "boolean",
- "default": "true",
- "location": "query"
- },
"fields": {
"description": "Selector specifying which fields to include in a partial response.",
"type": "string",
"location": "query"
},
- "uploadType": {
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string",
- "location": "query"
- },
"$.xgafv": {
+ "description": "V1 error format.",
+ "type": "string",
"enumDescriptions": [
"v1 error format",
"v2 error format"
@@ -1495,30 +1489,28 @@
"enum": [
"1",
"2"
- ],
- "description": "V1 error format.",
- "type": "string"
+ ]
},
"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",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query",
"description": "Data format for response.",
"default": "json",
"enum": [
"json",
"media",
"proto"
- ]
+ ],
+ "type": "string",
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query"
},
"access_token": {
"location": "query",
@@ -1547,775 +1539,58 @@
"location": "query"
},
"bearer_token": {
+ "location": "query",
"description": "OAuth bearer token.",
- "type": "string",
- "location": "query"
+ "type": "string"
+ },
+ "upload_protocol": {
+ "location": "query",
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "type": "string"
+ },
+ "prettyPrint": {
+ "location": "query",
+ "description": "Returns response with indentations and line breaks.",
+ "type": "boolean",
+ "default": "true"
}
},
"schemas": {
- "AuthorizedCertificate": {
- "description": "An SSL certificate that a user has been authorized to administer. A user is authorized to administer any certificate that applies to one of their authorized domains.",
- "type": "object",
- "properties": {
- "displayName": {
- "description": "The user-specified display name of the certificate. This is not guaranteed to be unique. Example: My Certificate.",
- "type": "string"
- },
- "certificateRawData": {
- "description": "The SSL certificate serving the AuthorizedCertificate resource. This must be obtained independently from a certificate authority.",
- "$ref": "CertificateRawData"
- },
- "visibleDomainMappings": {
- "description": "The full paths to user visible Domain Mapping resources that have this certificate mapped. Example: apps/myapp/domainMappings/example.com.This may not represent the full list of mapped domain mappings if the user does not have VIEWER permissions on all of the applications that have this certificate mapped. See domain_mappings_count for a complete count.Only returned by GET or LIST requests when specifically requested by the view=FULL_CERTIFICATE option.@OutputOnly",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "expireTime": {
- "description": "The time when this certificate expires. To update the renewal time on this certificate, upload an SSL certificate with a different expiration time using AuthorizedCertificates.UpdateAuthorizedCertificate.@OutputOnly",
- "format": "google-datetime",
- "type": "string"
- },
- "name": {
- "description": "Full path to the AuthorizedCertificate resource in the API. Example: apps/myapp/authorizedCertificates/12345.@OutputOnly",
- "type": "string"
- },
- "domainMappingsCount": {
- "description": "Aggregate count of the domain mappings with this certificate mapped. This count includes domain mappings on applications for which the user does not have VIEWER permissions.Only returned by GET or LIST requests when specifically requested by the view=FULL_CERTIFICATE option.@OutputOnly",
- "format": "int32",
- "type": "integer"
- },
- "domainNames": {
- "description": "Topmost applicable domains of this certificate. This certificate applies to these domains and their subdomains. Example: example.com.@OutputOnly",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "id": {
- "description": "Relative name of the certificate. This is a unique value autogenerated on AuthorizedCertificate resource creation. Example: 12345.@OutputOnly",
- "type": "string"
- }
- },
- "id": "AuthorizedCertificate"
- },
- "ResourceRecord": {
- "description": "A DNS resource record.",
- "type": "object",
- "properties": {
- "name": {
- "description": "Relative name of the object affected by this record. Only applicable for CNAME records. Example: 'www'.",
- "type": "string"
- },
- "type": {
- "enum": [
- "RECORD_TYPE_UNSPECIFIED",
- "A",
- "AAAA",
- "CNAME"
- ],
- "description": "Resource record type. Example: AAAA.",
- "type": "string",
- "enumDescriptions": [
- "An unknown resource record.",
- "An A resource record. Data is an IPv4 address.",
- "An AAAA resource record. Data is an IPv6 address.",
- "A CNAME resource record. Data is a domain name to be aliased."
- ]
- },
- "rrdata": {
- "description": "Data for this record. Values vary by record type, as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1).",
- "type": "string"
- }
- },
- "id": "ResourceRecord"
- },
- "Library": {
- "description": "Third-party Python runtime library that is required by the application.",
- "type": "object",
- "properties": {
- "name": {
- "description": "Name of the library. Example: \"django\".",
- "type": "string"
- },
- "version": {
- "description": "Version of the library to select, or \"latest\".",
- "type": "string"
- }
- },
- "id": "Library"
- },
- "ListLocationsResponse": {
- "description": "The response message for Locations.ListLocations.",
- "type": "object",
- "properties": {
- "locations": {
- "description": "A list of locations that matches the specified filter in the request.",
- "type": "array",
- "items": {
- "$ref": "Location"
- }
- },
- "nextPageToken": {
- "description": "The standard List next-page token.",
- "type": "string"
- }
- },
- "id": "ListLocationsResponse"
- },
- "ContainerInfo": {
- "description": "Docker image that is used to create a container and start a VM instance for the version that you deploy. Only applicable for instances running in the App Engine flexible environment.",
- "type": "object",
- "properties": {
- "image": {
- "description": "URI to the hosted container image in Google Container Registry. The URI must be fully qualified and include a tag or digest. Examples: \"gcr.io/my-project/image:tag\" or \"gcr.io/my-project/image@digest\"",
- "type": "string"
- }
- },
- "id": "ContainerInfo"
- },
- "RequestUtilization": {
- "description": "Target scaling by request utilization. Only applicable in the App Engine flexible environment.",
- "type": "object",
- "properties": {
- "targetRequestCountPerSecond": {
- "description": "Target requests per second.",
- "format": "int32",
- "type": "integer"
- },
- "targetConcurrentRequests": {
- "description": "Target number of concurrent requests.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "RequestUtilization"
- },
- "EndpointsApiService": {
- "description": "Cloud Endpoints (https://cloud.google.com/endpoints) configuration. The Endpoints API Service provides tooling for serving Open API and gRPC endpoints via an NGINX proxy.The fields here refer to the name and configuration id of a \"service\" resource in the Service Management API (https://cloud.google.com/service-management/overview).",
- "type": "object",
- "properties": {
- "name": {
- "description": "Endpoints service name which is the name of the \"service\" resource in the Service Management API. For example \"myapi.endpoints.myproject.cloud.goog\"",
- "type": "string"
- },
- "configId": {
- "description": "Endpoints service configuration id as specified by the Service Management API. For example \"2016-09-19r1\"",
- "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": {
- "description": "Returns the contents of a file, such as an image, as the response.",
- "$ref": "StaticFilesHandler"
- },
- "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": {
- "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": "URL prefix. Uses regular expression syntax, which means regexp special characters must be escaped, but should not contain groupings. All URLs that begin with this prefix are handled by this handler, using the portion of the URL after the prefix as part of the file path.",
- "type": "string"
- },
- "login": {
- "description": "Level of login required to access this resource.",
- "type": "string",
- "enumDescriptions": [
- "Not specified. LOGIN_OPTIONAL is assumed.",
- "Does not require that the user is signed in.",
- "If the user is not signed in, the auth_fail_action is taken. In addition, if the user is not an administrator for the application, they are given an error message regardless of auth_fail_action. If the user is an administrator, the handler proceeds.",
- "If the user has signed in, the handler proceeds normally. Otherwise, the auth_fail_action is taken."
- ],
- "enum": [
- "LOGIN_UNSPECIFIED",
- "LOGIN_OPTIONAL",
- "LOGIN_ADMIN",
- "LOGIN_REQUIRED"
- ]
- },
- "apiEndpoint": {
- "description": "Uses API Endpoints to handle requests.",
- "$ref": "ApiEndpointHandler"
- }
- },
- "id": "UrlMap"
- },
- "ApiConfigHandler": {
- "description": "Google Cloud Endpoints (https://cloud.google.com/appengine/docs/python/endpoints/) configuration for API handlers.",
- "type": "object",
- "properties": {
- "url": {
- "description": "URL to serve the endpoint at.",
- "type": "string"
- },
- "securityLevel": {
- "enumDescriptions": [
- "Not specified.",
- "Both HTTP and HTTPS requests with URLs that match the handler succeed without redirects. The application can examine the request to determine which protocol was used, and respond accordingly.",
- "Requests for a URL that match this handler that use HTTPS are automatically redirected to the HTTP equivalent URL.",
- "Both HTTP and HTTPS requests with URLs that match the handler succeed without redirects. The application can examine the request to determine which protocol was used and respond accordingly.",
- "Requests for a URL that match this handler that do not use HTTPS are automatically redirected to the HTTPS URL with the same path. Query parameters are reserved for the redirect."
- ],
- "enum": [
- "SECURE_UNSPECIFIED",
- "SECURE_DEFAULT",
- "SECURE_NEVER",
- "SECURE_OPTIONAL",
- "SECURE_ALWAYS"
- ],
- "description": "Security (HTTPS) enforcement for this URL.",
- "type": "string"
- },
- "authFailAction": {
- "enumDescriptions": [
- "Not specified. AUTH_FAIL_ACTION_REDIRECT is assumed.",
- "Redirects user to \"accounts.google.com\". The user is redirected back to the application URL after signing in or creating an account.",
- "Rejects request with a 401 HTTP status code and an error message."
- ],
- "enum": [
- "AUTH_FAIL_ACTION_UNSPECIFIED",
- "AUTH_FAIL_ACTION_REDIRECT",
- "AUTH_FAIL_ACTION_UNAUTHORIZED"
- ],
- "description": "Action to take when users access resources that require authentication. Defaults to redirect.",
- "type": "string"
- },
- "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"
- ]
- }
- },
- "id": "ApiConfigHandler"
- },
- "Operation": {
- "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",
- "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": {
- "expiration": {
- "description": "Time a static file served by this handler should be cached by web proxies and browsers.",
- "format": "google-duration",
- "type": "string"
- },
- "applicationReadable": {
- "description": "Whether files should also be uploaded as code data. By default, files declared in static file handlers are uploaded as static data and are only served to end users; they cannot be read by the application. If enabled, uploads are charged against both your code and static data storage resource quotas.",
- "type": "boolean"
- },
- "httpHeaders": {
- "description": "HTTP headers to use for all responses from these URLs.",
- "type": "object",
- "additionalProperties": {
- "type": "string"
- }
- },
- "uploadPathRegex": {
- "description": "Regular expression that matches the file paths for all files that should be referenced by this handler.",
- "type": "string"
- },
- "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": {
- "properties": {
- "maxInstances": {
- "description": "Maximum number of instances to create for this version.",
- "format": "int32",
- "type": "integer"
- },
- "idleTimeout": {
- "description": "Duration of time after the last request that an instance must wait before the instance is shut down.",
- "format": "google-duration",
- "type": "string"
- }
- },
- "id": "BasicScaling",
- "description": "A service with basic scaling will create an instance when the application receives a request. The instance will be turned down when the app becomes idle. Basic scaling is ideal for work that is intermittent or driven by user activity.",
- "type": "object"
- },
- "DiskUtilization": {
- "properties": {
- "targetWriteOpsPerSecond": {
- "description": "Target ops written per second.",
- "format": "int32",
- "type": "integer"
- },
- "targetWriteBytesPerSecond": {
- "description": "Target bytes written per second.",
- "format": "int32",
- "type": "integer"
- },
- "targetReadBytesPerSecond": {
- "description": "Target bytes read per second.",
- "format": "int32",
- "type": "integer"
- },
- "targetReadOpsPerSecond": {
- "description": "Target ops read per seconds.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "DiskUtilization",
- "description": "Target scaling by disk usage. Only applicable in the App Engine flexible environment.",
- "type": "object"
- },
- "CpuUtilization": {
- "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",
- "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": {
- "details": {
- "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.",
- "type": "array",
- "items": {
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- },
- "type": "object"
- }
- },
- "code": {
- "description": "The status code, which should be an enum value of google.rpc.Code.",
- "format": "int32",
- "type": "integer"
- },
- "message": {
- "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.",
- "type": "string"
- }
- },
- "id": "Status"
- },
- "IdentityAwareProxy": {
- "description": "Identity-Aware Proxy",
- "type": "object",
- "properties": {
- "oauth2ClientSecret": {
- "description": "OAuth2 client secret to use for the authentication flow.For security reasons, this value cannot be retrieved via the API. Instead, the SHA-256 hash of the value is returned in the oauth2_client_secret_sha256 field.@InputOnly",
- "type": "string"
- },
- "oauth2ClientId": {
- "description": "OAuth2 client ID to use for the authentication flow.",
- "type": "string"
- },
- "oauth2ClientSecretSha256": {
- "description": "Hex-encoded SHA-256 hash of the client secret.@OutputOnly",
- "type": "string"
- },
- "enabled": {
- "description": "Whether the serving infrastructure will authenticate and authorize all incoming requests.If true, the oauth2_client_id and oauth2_client_secret fields must be non-empty.",
- "type": "boolean"
- }
- },
- "id": "IdentityAwareProxy"
- },
- "ManualScaling": {
- "description": "A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time.",
- "type": "object",
- "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"
- },
- "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": {
- "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."
- },
- "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"
- },
- "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"
- },
- "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"
- },
- "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": {
- "enum": [
- "UNSPECIFIED_ACTION",
- "ALLOW",
- "DENY"
- ],
- "description": "The action to take on matched requests.",
- "type": "string",
- "enumDescriptions": [
- "",
- "Matching requests are allowed.",
- "Matching requests are denied."
- ]
- }
- },
- "id": "FirewallRule"
- },
- "ListAuthorizedCertificatesResponse": {
- "description": "Response message for AuthorizedCertificates.ListAuthorizedCertificates.",
- "type": "object",
- "properties": {
- "nextPageToken": {
- "description": "Continuation token for fetching the next page of results.",
- "type": "string"
- },
- "certificates": {
- "description": "The SSL certificates the user is authorized to administer.",
- "type": "array",
- "items": {
- "$ref": "AuthorizedCertificate"
- }
- }
- },
- "id": "ListAuthorizedCertificatesResponse"
- },
- "FeatureSettings": {
- "properties": {
- "splitHealthChecks": {
- "description": "Boolean value indicating if split health checks should be used instead of the legacy health checks. At an app.yaml level, this means defaulting to 'readiness_check' and 'liveness_check' values instead of 'health_check' ones. Once the legacy 'health_check' behavior is deprecated, and this value is always true, this setting can be removed.",
- "type": "boolean"
- }
- },
- "id": "FeatureSettings",
- "description": "The feature specific settings to be used in the application. These define behaviors that are user configurable.",
- "type": "object"
- },
- "OperationMetadataV1": {
- "description": "Metadata for the given google.longrunning.Operation.",
- "type": "object",
- "properties": {
- "insertTime": {
- "description": "Time that this operation was created.@OutputOnly",
- "format": "google-datetime",
- "type": "string"
- },
- "warning": {
- "description": "Durable messages that persist on every operation poll. @OutputOnly",
- "type": "array",
- "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"
- },
- "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": {
- "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",
- "description": "Custom static error page to be served when an error occurs.",
- "type": "object"
- },
- "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": {
+ "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"
+ },
+ "featureSettings": {
+ "description": "The feature specific settings to be used in the application.",
+ "$ref": "FeatureSettings"
+ },
+ "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"
+ },
"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"
@@ -2339,61 +1614,52 @@
"description": "Full path to the Application resource in the API. Example: apps/myapp.@OutputOnly",
"type": "string"
},
+ "id": {
+ "description": "Identifier of the Application resource. This identifier is equivalent to the project ID of the Google Cloud Platform project where you want to deploy your application. Example: myapp.",
+ "type": "string"
+ },
"defaultCookieExpiration": {
"description": "Cookie expiration policy for this application.",
"format": "google-duration",
"type": "string"
},
- "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": {
- "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"
}
},
- "id": "Application",
- "description": "An Application resource contains the top-level configuration of an App Engine application.",
+ "id": "Application"
+ },
+ "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"
},
"Instance": {
+ "description": "An Instance resource is the computing unit that App Engine uses to automatically scale an application.",
+ "type": "object",
"properties": {
- "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",
@@ -2403,14 +1669,14 @@
"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"
},
+ "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",
@@ -2434,23 +1700,23 @@
"format": "int32",
"type": "integer"
},
+ "vmStatus": {
+ "description": "Status of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment.@OutputOnly",
+ "type": "string"
+ },
"availability": {
- "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"
+ "type": "string",
+ "enumDescriptions": [
+ "",
+ "",
+ ""
+ ]
},
"startTime": {
"description": "Time that this instance was started.@OutputOnly",
@@ -2469,31 +1735,18 @@
"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",
- "description": "An Instance resource is the computing unit that App Engine uses to automatically scale an application.",
- "type": "object"
+ "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",
@@ -2503,12 +1756,27 @@
"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"
},
- "successThreshold": {
- "description": "Number of consecutive successful checks required before considering the VM healthy.",
+ "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"
}
@@ -2529,40 +1797,15 @@
"description": "Request message for Firewall.BatchUpdateIngressRules.",
"type": "object"
},
- "Location": {
- "properties": {
- "labels": {
- "description": "Cross-service attributes for the location. For example\n{\"cloud.googleapis.com/region\": \"us-east1\"}\n",
- "type": "object",
- "additionalProperties": {
- "type": "string"
- }
- },
- "name": {
- "description": "Resource name for the location, which may vary between implementations. For example: \"projects/example-project/locations/us-east1\"",
- "type": "string"
- },
- "locationId": {
- "description": "The canonical id for this location. For example: \"us-east1\".",
- "type": "string"
- },
- "metadata": {
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- },
- "description": "Service-specific metadata. For example the available capacity at the given location.",
- "type": "object"
- }
- },
- "id": "Location",
- "description": "A resource that represents Google Cloud Platform location.",
- "type": "object"
- },
"NetworkUtilization": {
"description": "Target scaling by network usage. Only applicable in the App Engine flexible environment.",
"type": "object",
"properties": {
+ "targetSentBytesPerSecond": {
+ "description": "Target bytes sent per second.",
+ "format": "int32",
+ "type": "integer"
+ },
"targetSentPacketsPerSecond": {
"description": "Target packets sent per second.",
"format": "int32",
@@ -2577,19 +1820,49 @@
"description": "Target packets received per second.",
"format": "int32",
"type": "integer"
- },
- "targetSentBytesPerSecond": {
- "description": "Target bytes sent per second.",
- "format": "int32",
- "type": "integer"
}
},
"id": "NetworkUtilization"
},
+ "Location": {
+ "properties": {
+ "locationId": {
+ "description": "The canonical id for this location. For example: \"us-east1\".",
+ "type": "string"
+ },
+ "metadata": {
+ "description": "Service-specific metadata. For example the available capacity at the given 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",
+ "description": "A resource that represents Google Cloud Platform location.",
+ "type": "object"
+ },
"HealthCheck": {
"description": "Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances. Only applicable for instances in App Engine flexible environment.",
"type": "object",
"properties": {
+ "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"
@@ -2617,41 +1890,24 @@
"description": "Time before the health check is considered failed.",
"format": "google-duration",
"type": "string"
- },
- "unhealthyThreshold": {
- "description": "Number of consecutive failed health checks required before removing traffic.",
- "format": "uint32",
- "type": "integer"
}
},
"id": "HealthCheck"
},
"ReadinessCheck": {
+ "description": "Readiness checking configuration for VM instances. Unhealthy instances are removed from traffic rotation.",
+ "type": "object",
"properties": {
- "successThreshold": {
- "description": "Number of consecutive successful checks required before receiving traffic.",
+ "failureThreshold": {
+ "description": "Number of consecutive failed checks required before removing 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",
@@ -2660,22 +1916,23 @@
"path": {
"description": "The request path.",
"type": "string"
- }
- },
- "id": "ReadinessCheck",
- "description": "Readiness checking configuration for VM instances. Unhealthy instances are removed from traffic rotation.",
- "type": "object"
- },
- "DebugInstanceRequest": {
- "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).",
+ },
+ "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": "DebugInstanceRequest",
- "description": "Request message for Instances.DebugInstance.",
- "type": "object"
+ "id": "ReadinessCheck"
},
"StandardSchedulerSettings": {
"description": "Scheduler settings for standard environment.",
@@ -2704,10 +1961,27 @@
},
"id": "StandardSchedulerSettings"
},
- "OperationMetadataV1Beta5": {
- "description": "Metadata for the given google.longrunning.Operation.",
- "type": "object",
+ "DebugInstanceRequest": {
"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"
+ },
+ "OperationMetadataV1Beta5": {
+ "properties": {
+ "user": {
+ "description": "User who requested this operation.@OutputOnly",
+ "type": "string"
+ },
+ "target": {
+ "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly",
+ "type": "string"
+ },
"method": {
"description": "API method name that initiated this operation. Example: google.appengine.v1beta5.Version.CreateVersion.@OutputOnly",
"type": "string"
@@ -2721,131 +1995,16 @@
"description": "Timestamp that this operation completed.@OutputOnly",
"format": "google-datetime",
"type": "string"
- },
- "user": {
- "description": "User who requested this operation.@OutputOnly",
- "type": "string"
- },
- "target": {
- "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly",
- "type": "string"
}
},
- "id": "OperationMetadataV1Beta5"
+ "id": "OperationMetadataV1Beta5",
+ "description": "Metadata for the given google.longrunning.Operation.",
+ "type": "object"
},
"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": {
- "$ref": "AutomaticScaling",
- "description": "Automatic scaling is based on request rate, response latencies, and other application metrics."
- },
- "diskUsageBytes": {
- "description": "Total size in bytes of all the files that are included in this version and currently hosted on the App Engine disk.@OutputOnly",
- "format": "int64",
- "type": "string"
- },
- "healthCheck": {
- "description": "Configures health checking for VM instances. Unhealthy instances are stopped and replaced with new instances. Only applicable in the App Engine flexible environment.Only returned in GET requests if view=FULL is set.",
- "$ref": "HealthCheck"
- },
- "threadsafe": {
- "description": "Whether multiple requests can be dispatched to this version at once.",
- "type": "boolean"
- },
- "readinessCheck": {
- "description": "Configures readiness health checking for VM instances. Unhealthy instances are not put into the backend traffic rotation.Only returned in GET requests if view=FULL is set.",
- "$ref": "ReadinessCheck"
- },
- "manualScaling": {
- "description": "A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time.",
- "$ref": "ManualScaling"
- },
- "name": {
- "description": "Full path to the Version resource in the API. Example: apps/myapp/services/default/versions/v1.@OutputOnly",
- "type": "string"
- },
- "apiConfig": {
- "$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": {
- "$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"
- },
- "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."
- ]
- },
- "deployment": {
- "description": "Code and application artifacts that make up this version.Only returned in GET requests if view=FULL is set.",
- "$ref": "Deployment"
- },
- "runtimeApiVersion": {
- "description": "The version of the API in the given runtime environment. Please see the app.yaml reference for valid values at https://cloud.google.com/appengine/docs/standard/\u003clanguage\u003e/config/appref",
- "type": "string"
- },
- "createTime": {
- "description": "Time that this version was created.@OutputOnly",
- "format": "google-datetime",
- "type": "string"
- },
- "resources": {
- "$ref": "Resources",
- "description": "Machine resources for this version. Only applicable for VM runtimes."
- },
- "inboundServices": {
- "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"
- ]
- },
- "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."
- ]
- },
"errorHandlers": {
"description": "Custom static error pages. Limited to 10KB per page.Only returned in GET requests if view=FULL is set.",
"type": "array",
@@ -2917,6 +2076,115 @@
"items": {
"$ref": "UrlMap"
}
+ },
+ "automaticScaling": {
+ "$ref": "AutomaticScaling",
+ "description": "Automatic scaling is based on request rate, response latencies, and other application metrics."
+ },
+ "diskUsageBytes": {
+ "description": "Total size in bytes of all the files that are included in this version and currently hosted on the App Engine disk.@OutputOnly",
+ "format": "int64",
+ "type": "string"
+ },
+ "healthCheck": {
+ "$ref": "HealthCheck",
+ "description": "Configures health checking for VM instances. Unhealthy instances are stopped and replaced with new instances. Only applicable in the App Engine flexible environment.Only returned in GET requests if view=FULL is set."
+ },
+ "threadsafe": {
+ "description": "Whether multiple requests can be dispatched to this version at once.",
+ "type": "boolean"
+ },
+ "readinessCheck": {
+ "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"
+ },
+ "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": {
+ "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"
+ },
+ "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.",
+ "Allows an application to receive mail.",
+ "Allows an application to receive email-bound notifications.",
+ "Allows an application to receive error stanzas.",
+ "Allows an application to receive instant messages.",
+ "Allows an application to receive user subscription POSTs.",
+ "Allows an application to receive a user's chat presence.",
+ "Registers an application for notifications when a client connects or disconnects from a channel.",
+ "Enables warmup requests."
+ ],
+ "description": "Before an application can receive email or XMPP messages, the application must be configured to enable the service.",
+ "type": "array",
+ "items": {
+ "enum": [
+ "INBOUND_SERVICE_UNSPECIFIED",
+ "INBOUND_SERVICE_MAIL",
+ "INBOUND_SERVICE_MAIL_BOUNCE",
+ "INBOUND_SERVICE_XMPP_ERROR",
+ "INBOUND_SERVICE_XMPP_MESSAGE",
+ "INBOUND_SERVICE_XMPP_SUBSCRIBE",
+ "INBOUND_SERVICE_XMPP_PRESENCE",
+ "INBOUND_SERVICE_CHANNEL_PRESENCE",
+ "INBOUND_SERVICE_WARMUP"
+ ],
+ "type": "string"
+ }
}
},
"id": "Version"
@@ -2962,27 +2230,27 @@
"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"
+ "id": "ScriptHandler",
+ "description": "Executes a script to handle the request that matches the URL pattern.",
+ "type": "object"
},
"AuthorizedDomain": {
"description": "A domain that a user has been authorized to administer. To authorize use of a domain, verify ownership via Webmaster Central (https://www.google.com/webmasters/verification/home).",
"type": "object",
"properties": {
- "name": {
- "description": "Full path to the AuthorizedDomain resource in the API. Example: apps/myapp/authorizedDomains/example.com.@OutputOnly",
- "type": "string"
- },
"id": {
"description": "Fully qualified domain name of the domain authorized for use. Example: example.com.",
"type": "string"
+ },
+ "name": {
+ "description": "Full path to the AuthorizedDomain resource in the API. Example: apps/myapp/authorizedDomains/example.com.@OutputOnly",
+ "type": "string"
}
},
"id": "AuthorizedDomain"
@@ -2992,6 +2260,12 @@
"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",
@@ -2999,13 +2273,7 @@
"RANDOM"
],
"description": "Mechanism used to determine which version a request is sent to. The traffic selection algorithm will be stable for either type until allocations are changed.",
- "type": "string",
- "enumDescriptions": [
- "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."
- ]
+ "type": "string"
},
"allocations": {
"additionalProperties": {
@@ -3019,8 +2287,6 @@
"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",
@@ -3034,14 +2300,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"
@@ -3056,9 +2322,13 @@
"type": "string"
}
},
- "id": "OperationMetadataV1Beta"
+ "id": "OperationMetadataV1Beta",
+ "description": "Metadata for the given google.longrunning.Operation.",
+ "type": "object"
},
"ListIngressRulesResponse": {
+ "description": "Response message for Firewall.ListIngressRules.",
+ "type": "object",
"properties": {
"nextPageToken": {
"description": "Continuation token for fetching the next page of results.",
@@ -3072,9 +2342,7 @@
}
}
},
- "id": "ListIngressRulesResponse",
- "description": "Response message for Firewall.ListIngressRules.",
- "type": "object"
+ "id": "ListIngressRulesResponse"
},
"ListServicesResponse": {
"description": "Response message for Services.ListServices.",
@@ -3095,14 +2363,16 @@
"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"
+ "$ref": "ZipInfo",
+ "description": "The zip file for this deployment, if this is a zip deployment."
},
"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."
+ "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": {
"additionalProperties": {
@@ -3112,9 +2382,7 @@
"type": "object"
}
},
- "id": "Deployment",
- "description": "Code and application artifacts used to deploy a version to App Engine.",
- "type": "object"
+ "id": "Deployment"
},
"Resources": {
"description": "Machine resources for a version.",
@@ -3163,10 +2431,6 @@
"description": "Volumes mounted within the app container. Only applicable in the App Engine flexible environment.",
"type": "object",
"properties": {
- "volumeType": {
- "description": "Underlying volume type, e.g. 'tmpfs'.",
- "type": "string"
- },
"sizeGb": {
"description": "Volume size in gigabytes.",
"format": "double",
@@ -3175,6 +2439,10 @@
"name": {
"description": "Unique name for the volume.",
"type": "string"
+ },
+ "volumeType": {
+ "description": "Underlying volume type, e.g. 'tmpfs'.",
+ "type": "string"
}
},
"id": "Volume"
@@ -3201,22 +2469,45 @@
"description": "Response message for DomainMappings.ListDomainMappings.",
"type": "object",
"properties": {
+ "nextPageToken": {
+ "description": "Continuation token for fetching the next page of results.",
+ "type": "string"
+ },
"domainMappings": {
"description": "The domain mappings for the application.",
"type": "array",
"items": {
"$ref": "DomainMapping"
}
- },
- "nextPageToken": {
- "description": "Continuation token for fetching the next page of results.",
- "type": "string"
}
},
"id": "ListDomainMappingsResponse"
},
"OperationMetadataV1Alpha": {
+ "description": "Metadata for the given google.longrunning.Operation.",
+ "type": "object",
"properties": {
+ "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"
+ },
+ "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"
@@ -3228,32 +2519,9 @@
"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",
- "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.",
@@ -3314,14 +2582,6 @@
"description": "A domain serving an App Engine application.",
"type": "object",
"properties": {
- "name": {
- "description": "Full path to the DomainMapping resource in the API. Example: apps/myapp/domainMapping/example.com.@OutputOnly",
- "type": "string"
- },
- "sslSettings": {
- "description": "SSL configuration for this domain. If unconfigured, this domain will not serve with SSL.",
- "$ref": "SslSettings"
- },
"id": {
"description": "Relative name of the domain serving the application. Example: example.com.",
"type": "string"
@@ -3332,6 +2592,14 @@
"items": {
"$ref": "ResourceRecord"
}
+ },
+ "name": {
+ "description": "Full path to the DomainMapping resource in the API. Example: apps/myapp/domainMapping/example.com.@OutputOnly",
+ "type": "string"
+ },
+ "sslSettings": {
+ "description": "SSL configuration for this domain. If unconfigured, this domain will not serve with SSL.",
+ "$ref": "SslSettings"
}
},
"id": "DomainMapping"
@@ -3355,23 +2623,31 @@
},
"AutomaticScaling": {
"properties": {
+ "cpuUtilization": {
+ "$ref": "CpuUtilization",
+ "description": "Target scaling by CPU usage."
+ },
+ "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"
},
- "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": {
- "description": "Target scaling by request utilization.",
- "$ref": "RequestUtilization"
+ "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.",
@@ -3392,28 +2668,20 @@
"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 in the App Engine flexible environment.",
- "format": "google-duration",
- "type": "string"
- },
"maxConcurrentRequests": {
"description": "Number of concurrent requests an automatic scaling instance can accept before the scheduler spawns a new instance.Defaults to a runtime-specific value.",
"format": "int32",
"type": "integer"
},
+ "coolDownPeriod": {
+ "description": "Amount of time that the Autoscaler (https://cloud.google.com/compute/docs/autoscaler/) should wait between changes to the number of virtual machines. Only applicable in the App Engine flexible environment.",
+ "format": "google-duration",
+ "type": "string"
+ },
"maxPendingLatency": {
"description": "Maximum amount of time that a request should wait in the pending queue before starting a new instance to handle it.",
"format": "google-duration",
"type": "string"
- },
- "cpuUtilization": {
- "description": "Target scaling by CPU usage.",
- "$ref": "CpuUtilization"
- },
- "diskUtilization": {
- "$ref": "DiskUtilization",
- "description": "Target scaling by disk usage."
}
},
"id": "AutomaticScaling",
@@ -3421,47 +2689,782 @@
"type": "object"
},
"ZipInfo": {
- "description": "The zip file information for a zip deployment.",
- "type": "object",
"properties": {
- "sourceUrl": {
- "description": "URL of the zip file to deploy from. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googleapis.com/\u003cbucket\u003e/\u003cobject\u003e'.",
- "type": "string"
- },
"filesCount": {
"description": "An estimate of the number of files in a zip for a zip deployment. If set, must be greater than or equal to the actual number of files. Used for optimizing performance; if not provided, deployment may be slow.",
"format": "int32",
"type": "integer"
+ },
+ "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"
+ "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": {
+ "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."
+ },
+ "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"
+ }
+ },
+ "id": "AuthorizedCertificate"
+ },
+ "ResourceRecord": {
+ "description": "A DNS resource record.",
+ "type": "object",
+ "properties": {
+ "type": {
+ "description": "Resource record type. Example: AAAA.",
+ "type": "string",
+ "enumDescriptions": [
+ "An unknown resource record.",
+ "An A resource record. Data is an IPv4 address.",
+ "An AAAA resource record. Data is an IPv6 address.",
+ "A CNAME resource record. Data is a domain name to be aliased."
+ ],
+ "enum": [
+ "RECORD_TYPE_UNSPECIFIED",
+ "A",
+ "AAAA",
+ "CNAME"
+ ]
+ },
+ "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"
+ },
+ "Library": {
+ "description": "Third-party Python runtime library that is required by the application.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "Name of the library. Example: \"django\".",
+ "type": "string"
+ },
+ "version": {
+ "description": "Version of the library to select, or \"latest\".",
+ "type": "string"
+ }
+ },
+ "id": "Library"
+ },
+ "ListLocationsResponse": {
+ "description": "The response message for Locations.ListLocations.",
+ "type": "object",
+ "properties": {
+ "locations": {
+ "description": "A list of locations that matches the specified filter in the request.",
+ "type": "array",
+ "items": {
+ "$ref": "Location"
+ }
+ },
+ "nextPageToken": {
+ "description": "The standard List next-page token.",
+ "type": "string"
+ }
+ },
+ "id": "ListLocationsResponse"
+ },
+ "ContainerInfo": {
+ "description": "Docker image that is used to create a container and start a VM instance for the version that you deploy. Only applicable for instances running in the App Engine flexible environment.",
+ "type": "object",
+ "properties": {
+ "image": {
+ "description": "URI to the hosted container image in Google Container Registry. The URI must be fully qualified and include a tag or digest. Examples: \"gcr.io/my-project/image:tag\" or \"gcr.io/my-project/image@digest\"",
+ "type": "string"
+ }
+ },
+ "id": "ContainerInfo"
+ },
+ "RequestUtilization": {
+ "description": "Target scaling by request utilization. Only applicable in the App Engine flexible environment.",
+ "type": "object",
+ "properties": {
+ "targetRequestCountPerSecond": {
+ "description": "Target requests per second.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "targetConcurrentRequests": {
+ "description": "Target number of concurrent requests.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "RequestUtilization"
+ },
+ "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": {
+ "script": {
+ "$ref": "ScriptHandler",
+ "description": "Executes a script to handle the request that matches this URL pattern."
+ },
+ "urlRegex": {
+ "description": "URL prefix. Uses regular expression syntax, which means regexp special characters must be escaped, but should not contain groupings. All URLs that begin with this prefix are handled by this handler, using the portion of the URL after the prefix as part of the file path.",
+ "type": "string"
+ },
+ "login": {
+ "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"
+ },
+ "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": {
+ "enumDescriptions": [
+ "Not specified. AUTH_FAIL_ACTION_REDIRECT is assumed.",
+ "Redirects user to \"accounts.google.com\". The user is redirected back to the application URL after signing in or creating an account.",
+ "Rejects request with a 401 HTTP status code and an error message."
+ ],
+ "enum": [
+ "AUTH_FAIL_ACTION_UNSPECIFIED",
+ "AUTH_FAIL_ACTION_REDIRECT",
+ "AUTH_FAIL_ACTION_UNAUTHORIZED"
+ ],
+ "description": "Action to take when users access resources that require authentication. Defaults to redirect.",
+ "type": "string"
+ }
+ },
+ "id": "UrlMap"
+ },
+ "EndpointsApiService": {
+ "description": "Cloud Endpoints (https://cloud.google.com/endpoints) configuration. The Endpoints API Service provides tooling for serving Open API and gRPC endpoints via an NGINX proxy.The fields here refer to the name and configuration id of a \"service\" resource in the Service Management API (https://cloud.google.com/service-management/overview).",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "Endpoints service name which is the name of the \"service\" resource in the Service Management API. For example \"myapi.endpoints.myproject.cloud.goog\"",
+ "type": "string"
+ },
+ "configId": {
+ "description": "Endpoints service configuration id as specified by the Service Management API. For example \"2016-09-19r1\"",
+ "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": {
+ "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": {
+ "description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.",
+ "type": "object",
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ }
+ }
+ },
+ "id": "Operation"
+ },
+ "ApiConfigHandler": {
+ "description": "Google Cloud Endpoints (https://cloud.google.com/appengine/docs/python/endpoints/) configuration for API handlers.",
+ "type": "object",
+ "properties": {
+ "url": {
+ "description": "URL to serve the endpoint at.",
+ "type": "string"
+ },
+ "securityLevel": {
+ "enum": [
+ "SECURE_UNSPECIFIED",
+ "SECURE_DEFAULT",
+ "SECURE_NEVER",
+ "SECURE_OPTIONAL",
+ "SECURE_ALWAYS"
+ ],
+ "description": "Security (HTTPS) enforcement for this URL.",
+ "type": "string",
+ "enumDescriptions": [
+ "Not specified.",
+ "Both HTTP and HTTPS requests with URLs that match the handler succeed without redirects. The application can examine the request to determine which protocol was used, and respond accordingly.",
+ "Requests for a URL that match this handler that use HTTPS are automatically redirected to the HTTP equivalent URL.",
+ "Both HTTP and HTTPS requests with URLs that match the handler succeed without redirects. The application can examine the request to determine which protocol was used and respond accordingly.",
+ "Requests for a URL that match this handler that do not use HTTPS are automatically redirected to the HTTPS URL with the same path. Query parameters are reserved for the redirect."
+ ]
+ },
+ "authFailAction": {
+ "enum": [
+ "AUTH_FAIL_ACTION_UNSPECIFIED",
+ "AUTH_FAIL_ACTION_REDIRECT",
+ "AUTH_FAIL_ACTION_UNAUTHORIZED"
+ ],
+ "description": "Action to take when users access resources that require authentication. Defaults to redirect.",
+ "type": "string",
+ "enumDescriptions": [
+ "Not specified. AUTH_FAIL_ACTION_REDIRECT is assumed.",
+ "Redirects user to \"accounts.google.com\". The user is redirected back to the application URL after signing in or creating an account.",
+ "Rejects request with 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"
+ ]
+ }
+ },
+ "id": "ApiConfigHandler"
+ },
+ "StaticFilesHandler": {
+ "description": "Files served directly to the user for a given URL, such as images, CSS stylesheets, or JavaScript source files. Static file handlers describe which files in the application directory are static files, and which URLs serve them.",
+ "type": "object",
+ "properties": {
+ "requireMatchingFile": {
+ "description": "Whether this handler should match the request if the file referenced by the handler does not exist.",
+ "type": "boolean"
+ },
+ "expiration": {
+ "description": "Time a static file served by this handler should be cached by web proxies and browsers.",
+ "format": "google-duration",
+ "type": "string"
+ },
+ "applicationReadable": {
+ "description": "Whether files should also be uploaded as code data. By default, files declared in static file handlers are uploaded as static data and are only served to end users; they cannot be read by the application. If enabled, uploads are charged against both your code and static data storage resource quotas.",
+ "type": "boolean"
+ },
+ "httpHeaders": {
+ "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"
+ }
+ },
+ "id": "StaticFilesHandler"
+ },
+ "BasicScaling": {
+ "description": "A service with basic scaling will create an instance when the application receives a request. The instance will be turned down when the app becomes idle. Basic scaling is ideal for work that is intermittent or driven by user activity.",
+ "type": "object",
+ "properties": {
+ "maxInstances": {
+ "description": "Maximum number of instances to create for this version.",
+ "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"
+ },
+ "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"
+ },
+ "CpuUtilization": {
+ "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",
+ "description": "Target scaling by CPU usage.",
+ "type": "object"
+ },
+ "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": {
+ "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": {
+ "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.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "ManualScaling"
+ },
+ "LocationMetadata": {
+ "description": "Metadata for the given google.cloud.location.Location.",
+ "type": "object",
+ "properties": {
+ "standardEnvironmentAvailable": {
+ "description": "App Engine Standard Environment is available in the given location.@OutputOnly",
+ "type": "boolean"
+ },
+ "flexibleEnvironmentAvailable": {
+ "description": "App Engine Flexible Environment is available in the given location.@OutputOnly",
+ "type": "boolean"
+ }
+ },
+ "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."
+ },
+ "id": {
+ "description": "Relative name of the service within the application. Example: default.@OutputOnly",
+ "type": "string"
+ }
+ },
+ "id": "Service"
+ },
+ "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"
+ },
+ "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": {
+ "properties": {
+ "endTime": {
+ "description": "Timestamp that this operation completed.@OutputOnly",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "operationType": {
+ "description": "Type of this operation. Deprecated, use method field instead. Example: \"create_version\".@OutputOnly",
+ "type": "string"
+ },
+ "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"
+ }
+ },
+ "id": "OperationMetadata",
+ "description": "Metadata for the given google.longrunning.Operation.",
+ "type": "object"
+ },
+ "ListAuthorizedCertificatesResponse": {
+ "description": "Response message for AuthorizedCertificates.ListAuthorizedCertificates.",
+ "type": "object",
+ "properties": {
+ "nextPageToken": {
+ "description": "Continuation token for fetching the next page of results.",
+ "type": "string"
+ },
+ "certificates": {
+ "description": "The SSL certificates the user is authorized to administer.",
+ "type": "array",
+ "items": {
+ "$ref": "AuthorizedCertificate"
+ }
+ }
+ },
+ "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"
+ },
+ "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"
+ },
+ "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": {
+ "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",
+ "description": "Metadata for the given google.longrunning.Operation.",
+ "type": "object"
}
},
- "protocol": "rest",
"icons": {
"x32": "http://www.google.com/images/icons/product/search-32.gif",
"x16": "http://www.google.com/images/icons/product/search-16.gif"
},
+ "protocol": "rest",
"version": "v1",
"baseUrl": "https://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"
+ },
+ "https://www.googleapis.com/auth/appengine.admin": {
+ "description": "View and manage your applications deployed on Google App Engine"
}
}
}
},
- "kind": "discovery#restDescription",
"description": "The App Engine Admin API enables developers to provision and manage their App Engine applications.",
"servicePath": "",
+ "kind": "discovery#restDescription",
"rootUrl": "https://appengine.googleapis.com/",
"basePath": "",
"ownerDomain": "google.com",
@@ -3470,8 +3473,5 @@
"revision": "20171213",
"documentationLink": "https://cloud.google.com/appengine/docs/admin-api/",
"id": "appengine:v1",
- "title": "Google App Engine Admin API",
- "discoveryVersion": "v1",
- "ownerName": "Google",
- "version_module": true
+ "title": "Google App Engine Admin API"
}
diff --git a/appengine/v1alpha/appengine-api.json b/appengine/v1alpha/appengine-api.json
index 7f672f8..2be3b5a 100644
--- a/appengine/v1alpha/appengine-api.json
+++ b/appengine/v1alpha/appengine-api.json
@@ -1,27 +1,4 @@
{
- "baseUrl": "https://appengine.googleapis.com/",
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/appengine.admin": {
- "description": "View and manage your applications deployed on Google App Engine"
- },
- "https://www.googleapis.com/auth/cloud-platform.read-only": {
- "description": "View your data across Google Cloud Platform services"
- },
- "https://www.googleapis.com/auth/cloud-platform": {
- "description": "View and manage your data across Google Cloud Platform services"
- }
- }
- }
- },
- "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:v1alpha",
@@ -35,26 +12,14 @@
"authorizedDomains": {
"methods": {
"list": {
- "description": "Lists all domains the user is authorized to administer.",
+ "httpMethod": "GET",
"response": {
"$ref": "ListAuthorizedDomainsResponse"
},
"parameterOrder": [
"appsId"
],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
"parameters": {
- "pageSize": {
- "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,
@@ -65,43 +30,9 @@
"description": "Continuation token for fetching the next page of results.",
"type": "string",
"location": "query"
- }
- },
- "flatPath": "v1alpha/apps/{appsId}/authorizedDomains",
- "path": "v1alpha/apps/{appsId}/authorizedDomains",
- "id": "appengine.apps.authorizedDomains.list"
- }
- }
- },
- "operations": {
- "methods": {
- "list": {
- "httpMethod": "GET",
- "parameterOrder": [
- "appsId"
- ],
- "response": {
- "$ref": "ListOperationsResponse"
- },
- "parameters": {
- "filter": {
- "location": "query",
- "description": "The standard list filter.",
- "type": "string"
- },
- "appsId": {
- "location": "path",
- "description": "Part of `name`. The name of the operation's parent resource.",
- "required": true,
- "type": "string"
- },
- "pageToken": {
- "location": "query",
- "description": "The standard list page token.",
- "type": "string"
},
"pageSize": {
- "description": "The standard list page size.",
+ "description": "Maximum results to return per page.",
"format": "int32",
"type": "integer",
"location": "query"
@@ -112,13 +43,59 @@
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
],
+ "flatPath": "v1alpha/apps/{appsId}/authorizedDomains",
+ "id": "appengine.apps.authorizedDomains.list",
+ "path": "v1alpha/apps/{appsId}/authorizedDomains",
+ "description": "Lists all domains the user is authorized to administer."
+ }
+ }
+ },
+ "operations": {
+ "methods": {
+ "list": {
+ "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": {
+ "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": {
+ "location": "query",
+ "description": "The standard list page size.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "filter": {
+ "description": "The standard list filter.",
+ "type": "string",
+ "location": "query"
+ }
+ },
"flatPath": "v1alpha/apps/{appsId}/operations",
- "id": "appengine.apps.operations.list",
"path": "v1alpha/apps/{appsId}/operations",
+ "id": "appengine.apps.operations.list",
"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.NOTE: the name binding allows API services to override the binding to use different resource name schemes, such as users/*/operations. To override the binding, API services can add a binding such as \"/v1/{name=users/*}/operations\" to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id."
},
"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"
},
@@ -126,19 +103,18 @@
"appsId",
"operationsId"
],
- "httpMethod": "GET",
"parameters": {
+ "operationsId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
"appsId": {
"location": "path",
"description": "Part of `name`. The name of the operation resource.",
"required": true,
"type": "string"
- },
- "operationsId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string"
}
},
"scopes": [
@@ -147,17 +123,15 @@
"https://www.googleapis.com/auth/cloud-platform.read-only"
],
"flatPath": "v1alpha/apps/{appsId}/operations/{operationsId}",
+ "id": "appengine.apps.operations.get",
"path": "v1alpha/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": {
- "flatPath": "v1alpha/apps/{appsId}/locations",
- "path": "v1alpha/apps/{appsId}/locations",
- "id": "appengine.apps.locations.list",
"description": "Lists information about the supported locations for this service.",
"response": {
"$ref": "ListLocationsResponse"
@@ -166,18 +140,12 @@
"appsId"
],
"httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
"parameters": {
- "pageSize": {
- "location": "query",
- "description": "The standard list page size.",
- "format": "int32",
- "type": "integer"
- },
- "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.",
@@ -185,18 +153,28 @@
"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"
+ },
+ "filter": {
+ "description": "The standard list filter.",
+ "type": "string",
+ "location": "query"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ]
+ "flatPath": "v1alpha/apps/{appsId}/locations",
+ "path": "v1alpha/apps/{appsId}/locations",
+ "id": "appengine.apps.locations.list"
},
"get": {
+ "description": "Get information about a location.",
"response": {
"$ref": "Location"
},
@@ -213,10 +191,10 @@
"type": "string"
},
"locationsId": {
+ "location": "path",
"description": "Part of `name`. See documentation of `appsId`.",
"required": true,
- "type": "string",
- "location": "path"
+ "type": "string"
}
},
"scopes": [
@@ -226,14 +204,45 @@
],
"flatPath": "v1alpha/apps/{appsId}/locations/{locationsId}",
"path": "v1alpha/apps/{appsId}/locations/{locationsId}",
- "id": "appengine.apps.locations.get",
- "description": "Get information about a location."
+ "id": "appengine.apps.locations.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.",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "appsId",
+ "domainMappingsId"
+ ],
+ "httpMethod": "DELETE",
+ "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 to delete. Example: apps/myapp/domainMappings/example.com.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1alpha/apps/{appsId}/domainMappings/{domainMappingsId}",
+ "path": "v1alpha/apps/{appsId}/domainMappings/{domainMappingsId}",
+ "id": "appengine.apps.domainMappings.delete"
+ },
"list": {
+ "description": "Lists the domain mappings on an application.",
"response": {
"$ref": "ListDomainMappingsResponse"
},
@@ -241,34 +250,33 @@
"appsId"
],
"httpMethod": "GET",
- "parameters": {
- "appsId": {
- "location": "path",
- "description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.",
- "required": true,
- "type": "string"
- },
- "pageToken": {
- "location": "query",
- "description": "Continuation token for fetching the next page of results.",
- "type": "string"
- },
- "pageSize": {
- "description": "Maximum results to return per page.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- }
- },
"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": "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": {
"description": "Gets the specified domain mapping.",
@@ -280,25 +288,25 @@
"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",
- "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/domainMappings/example.com.",
- "required": true,
- "type": "string"
- },
"domainMappingsId": {
"description": "Part of `name`. See documentation of `appsId`.",
"required": true,
"type": "string",
"location": "path"
+ },
+ "appsId": {
+ "location": "path",
+ "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/domainMappings/example.com.",
+ "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": "v1alpha/apps/{appsId}/domainMappings/{domainMappingsId}",
"path": "v1alpha/apps/{appsId}/domainMappings/{domainMappingsId}",
"id": "appengine.apps.domainMappings.get"
@@ -324,21 +332,21 @@
"location": "path"
},
"noManagedCertificate": {
- "location": "query",
"description": "Whether a managed certificate should be provided by App Engine. If true, a certificate ID must be manually set in the DomainMapping resource to configure SSL for this domain. If false, a managed certificate will be provisioned and a certificate ID will be automatically populated. Only applicable if ssl_settings.certificate_id is specified in the update mask.",
- "type": "boolean"
+ "type": "boolean",
+ "location": "query"
},
"updateMask": {
- "location": "query",
"description": "Standard field mask for the set of fields to be updated.",
"format": "google-fieldmask",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"appsId": {
+ "location": "path",
"description": "Part of `name`. Name of the resource to update. Example: apps/myapp/domainMappings/example.com.",
"required": true,
- "type": "string",
- "location": "path"
+ "type": "string"
}
},
"scopes": [
@@ -349,17 +357,20 @@
"path": "v1alpha/apps/{appsId}/domainMappings/{domainMappingsId}"
},
"create": {
+ "flatPath": "v1alpha/apps/{appsId}/domainMappings",
+ "id": "appengine.apps.domainMappings.create",
+ "path": "v1alpha/apps/{appsId}/domainMappings",
"request": {
"$ref": "DomainMapping"
},
"description": "Maps a domain to an application. A user must be authorized to administer a domain in order to map it to an application. For a list of available authorized domains, see AuthorizedDomains.ListAuthorizedDomains.",
- "response": {
- "$ref": "Operation"
- },
+ "httpMethod": "POST",
"parameterOrder": [
"appsId"
],
- "httpMethod": "POST",
+ "response": {
+ "$ref": "Operation"
+ },
"parameters": {
"overrideStrategy": {
"enum": [
@@ -385,78 +396,14 @@
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1alpha/apps/{appsId}/domainMappings",
- "path": "v1alpha/apps/{appsId}/domainMappings",
- "id": "appengine.apps.domainMappings.create"
- },
- "delete": {
- "description": "Deletes the specified domain mapping. A user must be authorized to administer the associated domain in order to delete a DomainMapping resource.",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "appsId",
- "domainMappingsId"
- ],
- "httpMethod": "DELETE",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "appsId": {
- "location": "path",
- "description": "Part of `name`. Name of the resource to delete. Example: apps/myapp/domainMappings/example.com.",
- "required": true,
- "type": "string"
- },
- "domainMappingsId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "flatPath": "v1alpha/apps/{appsId}/domainMappings/{domainMappingsId}",
- "path": "v1alpha/apps/{appsId}/domainMappings/{domainMappingsId}",
- "id": "appengine.apps.domainMappings.delete"
+ ]
}
}
},
"authorizedCertificates": {
"methods": {
- "delete": {
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "appsId",
- "authorizedCertificatesId"
- ],
- "httpMethod": "DELETE",
- "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": {
- "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": {
+ "description": "Lists all SSL certificates the user is authorized to administer.",
"response": {
"$ref": "ListAuthorizedCertificatesResponse"
},
@@ -464,23 +411,28 @@
"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",
- "location": "path"
- },
- "pageToken": {
- "location": "query",
- "description": "Continuation token for fetching the next page of results.",
"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"
+ "type": "integer",
+ "location": "query"
},
"view": {
"description": "Controls the set of fields returned in the LIST response.",
@@ -492,26 +444,27 @@
]
}
},
+ "flatPath": "v1alpha/apps/{appsId}/authorizedCertificates",
+ "path": "v1alpha/apps/{appsId}/authorizedCertificates",
+ "id": "appengine.apps.authorizedCertificates.list"
+ },
+ "get": {
+ "path": "v1alpha/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}",
+ "id": "appengine.apps.authorizedCertificates.get",
+ "description": "Gets the specified SSL certificate.",
+ "response": {
+ "$ref": "AuthorizedCertificate"
+ },
+ "parameterOrder": [
+ "appsId",
+ "authorizedCertificatesId"
+ ],
+ "httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/appengine.admin",
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
],
- "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": {
- "description": "Gets the specified SSL certificate.",
- "httpMethod": "GET",
- "parameterOrder": [
- "appsId",
- "authorizedCertificatesId"
- ],
- "response": {
- "$ref": "AuthorizedCertificate"
- },
"parameters": {
"appsId": {
"location": "path",
@@ -535,40 +488,29 @@
"type": "string"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1alpha/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}",
- "id": "appengine.apps.authorizedCertificates.get",
- "path": "v1alpha/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}"
+ "flatPath": "v1alpha/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}"
},
"patch": {
- "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.",
+ "path": "v1alpha/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}",
"request": {
"$ref": "AuthorizedCertificate"
},
- "response": {
- "$ref": "AuthorizedCertificate"
- },
+ "description": "Updates the specified SSL certificate. To renew a certificate and maintain its existing domain mappings, update certificate_data with a new certificate. The new certificate must be applicable to the same domains as the original certificate. The certificate display_name may also be updated.",
+ "httpMethod": "PATCH",
"parameterOrder": [
"appsId",
"authorizedCertificatesId"
],
- "httpMethod": "PATCH",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
+ "response": {
+ "$ref": "AuthorizedCertificate"
+ },
"parameters": {
"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": {
"description": "Part of `name`. Name of the resource to update. Example: apps/myapp/authorizedCertificates/12345.",
@@ -582,13 +524,20 @@
"type": "string",
"location": "path"
}
- }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1alpha/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}"
},
"create": {
+ "flatPath": "v1alpha/apps/{appsId}/authorizedCertificates",
+ "path": "v1alpha/apps/{appsId}/authorizedCertificates",
+ "id": "appengine.apps.authorizedCertificates.create",
+ "description": "Uploads the specified SSL certificate.",
"request": {
"$ref": "AuthorizedCertificate"
},
- "description": "Uploads the specified SSL certificate.",
"response": {
"$ref": "AuthorizedCertificate"
},
@@ -596,6 +545,9 @@
"appsId"
],
"httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
"parameters": {
"appsId": {
"description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.",
@@ -603,13 +555,38 @@
"type": "string",
"location": "path"
}
+ }
+ },
+ "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": {
+ "appsId": {
+ "location": "path",
+ "description": "Part of `name`. Name of the resource to delete. Example: apps/myapp/authorizedCertificates/12345.",
+ "required": true,
+ "type": "string"
+ },
+ "authorizedCertificatesId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
- "flatPath": "v1alpha/apps/{appsId}/authorizedCertificates",
- "path": "v1alpha/apps/{appsId}/authorizedCertificates",
- "id": "appengine.apps.authorizedCertificates.create"
+ "flatPath": "v1alpha/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}"
}
}
}
@@ -617,75 +594,20 @@
}
},
"parameters": {
- "$.xgafv": {
- "enum": [
- "1",
- "2"
- ],
- "description": "V1 error format.",
- "type": "string",
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query"
- },
- "callback": {
+ "bearer_token": {
"location": "query",
- "description": "JSONP",
+ "description": "OAuth bearer token.",
"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": {
- "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",
- "location": "query"
- },
- "bearer_token": {
- "description": "OAuth bearer token.",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"upload_protocol": {
- "location": "query",
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"prettyPrint": {
"location": "query",
@@ -702,13 +624,167 @@
"location": "query",
"description": "Selector specifying which fields to include in a partial response.",
"type": "string"
+ },
+ "callback": {
+ "description": "JSONP",
+ "type": "string",
+ "location": "query"
+ },
+ "$.xgafv": {
+ "description": "V1 error format.",
+ "type": "string",
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query",
+ "enum": [
+ "1",
+ "2"
+ ]
+ },
+ "alt": {
+ "type": "string",
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query",
+ "description": "Data format for response.",
+ "default": "json",
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ]
+ },
+ "key": {
+ "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"
}
},
"schemas": {
- "CertificateRawData": {
- "description": "An SSL certificate obtained from a certificate authority.",
+ "ListAuthorizedCertificatesResponse": {
+ "description": "Response message for AuthorizedCertificates.ListAuthorizedCertificates.",
"type": "object",
"properties": {
+ "nextPageToken": {
+ "description": "Continuation token for fetching the next page of results.",
+ "type": "string"
+ },
+ "certificates": {
+ "description": "The SSL certificates the user is authorized to administer.",
+ "type": "array",
+ "items": {
+ "$ref": "AuthorizedCertificate"
+ }
+ }
+ },
+ "id": "ListAuthorizedCertificatesResponse"
+ },
+ "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"
+ },
+ "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"
+ },
+ "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 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"
+ ],
+ "description": "Status of certificate management. Refers to the most recent certificate acquisition or renewal attempt.@OutputOnly",
+ "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",
+ "format": "google-datetime",
+ "type": "string"
+ }
+ },
+ "id": "ManagedCertificate"
+ },
+ "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"
@@ -718,22 +794,14 @@
"type": "string"
}
},
- "id": "CertificateRawData"
+ "id": "CertificateRawData",
+ "description": "An SSL certificate obtained from a certificate authority.",
+ "type": "object"
},
"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"
- },
"target": {
"description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly",
"type": "string"
@@ -754,35 +822,41 @@
"description": "Time that this operation completed.@OutputOnly",
"format": "google-datetime",
"type": "string"
- }
- },
- "id": "OperationMetadataV1",
- "description": "Metadata for the given google.longrunning.Operation.",
- "type": "object"
- },
- "SslSettings": {
- "properties": {
- "isManagedCertificate": {
- "description": "Whether the mapped certificate is an App Engine managed certificate. Managed certificates are created by default with a domain mapping. To opt out, specify no_managed_certificate on a CREATE or UPDATE request.@OutputOnly",
- "type": "boolean"
},
- "certificateId": {
- "description": "ID of the AuthorizedCertificate resource configuring SSL for the application. Clearing this field will remove SSL support.By default, a managed certificate is automatically created for every domain mapping. To omit SSL support or to configure SSL manually, specify no_managed_certificate on a CREATE or UPDATE request. You must be authorized to administer the AuthorizedCertificate resource to manually map it to a DomainMapping resource. Example: 12345.",
+ "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": "SslSettings",
+ "id": "OperationMetadataV1"
+ },
+ "SslSettings": {
"description": "SSL configuration for a DomainMapping resource.",
- "type": "object"
+ "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"
},
"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.",
@@ -796,23 +870,25 @@
"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 contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.",
- "type": "object",
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
- }
+ },
+ "description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.",
+ "type": "object"
+ },
+ "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"
},
"ListDomainMappingsResponse": {
- "description": "Response message for DomainMappings.ListDomainMappings.",
- "type": "object",
"properties": {
"domainMappings": {
"description": "The domain mappings for the application.",
@@ -826,11 +902,11 @@
"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": {
"user": {
"description": "User who requested this operation.@OutputOnly",
@@ -866,9 +942,13 @@
"type": "string"
}
},
- "id": "OperationMetadataV1Alpha"
+ "id": "OperationMetadataV1Alpha",
+ "description": "Metadata for the given google.longrunning.Operation.",
+ "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.",
@@ -878,11 +958,11 @@
"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"
- }
+ },
+ "type": "object"
}
},
"code": {
@@ -891,9 +971,7 @@
"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"
+ "id": "Status"
},
"ListAuthorizedDomainsResponse": {
"description": "Response message for AuthorizedDomains.ListAuthorizedDomains.",
@@ -929,13 +1007,21 @@
"type": "object"
},
"Empty": {
- "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance:\nservice Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n}\nThe JSON representation for Empty is empty JSON object {}.",
- "type": "object",
"properties": {},
- "id": "Empty"
+ "id": "Empty",
+ "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance:\nservice Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n}\nThe JSON representation for Empty is empty JSON object {}.",
+ "type": "object"
},
"DomainMapping": {
"properties": {
+ "name": {
+ "description": "Full path to the DomainMapping resource in the API. Example: apps/myapp/domainMapping/example.com.@OutputOnly",
+ "type": "string"
+ },
+ "sslSettings": {
+ "$ref": "SslSettings",
+ "description": "SSL configuration for this domain. If unconfigured, this domain will not serve with SSL."
+ },
"id": {
"description": "Relative name of the domain serving the application. Example: example.com.",
"type": "string"
@@ -946,14 +1032,6 @@
"items": {
"$ref": "ResourceRecord"
}
- },
- "name": {
- "description": "Full path to the DomainMapping resource in the API. Example: apps/myapp/domainMapping/example.com.@OutputOnly",
- "type": "string"
- },
- "sslSettings": {
- "$ref": "SslSettings",
- "description": "SSL configuration for this domain. If unconfigured, this domain will not serve with SSL."
}
},
"id": "DomainMapping",
@@ -964,21 +1042,27 @@
"description": "Metadata for the given google.cloud.location.Location.",
"type": "object",
"properties": {
- "standardEnvironmentAvailable": {
- "description": "App Engine Standard Environment is available in the given location.@OutputOnly",
- "type": "boolean"
- },
"flexibleEnvironmentAvailable": {
"description": "App Engine Flexible Environment is available in the given location.@OutputOnly",
"type": "boolean"
+ },
+ "standardEnvironmentAvailable": {
+ "description": "App Engine Standard Environment is available in the given location.@OutputOnly",
+ "type": "boolean"
}
},
"id": "LocationMetadata"
},
"OperationMetadataV1Beta": {
+ "description": "Metadata for the given google.longrunning.Operation.",
+ "type": "object",
"properties": {
- "insertTime": {
- "description": "Time that this operation was created.@OutputOnly",
+ "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"
},
@@ -989,6 +1073,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"
@@ -1000,22 +1089,13 @@
"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"
},
"Location": {
+ "description": "A resource that represents Google Cloud Platform location.",
+ "type": "object",
"properties": {
"labels": {
"additionalProperties": {
@@ -1041,9 +1121,7 @@
"type": "object"
}
},
- "id": "Location",
- "description": "A resource that represents Google Cloud Platform location.",
- "type": "object"
+ "id": "Location"
},
"AuthorizedCertificate": {
"description": "An SSL certificate that a user has been authorized to administer. A user is authorized to administer any certificate that applies to one of their authorized domains.",
@@ -1086,8 +1164,8 @@
"type": "string"
},
"managedCertificate": {
- "$ref": "ManagedCertificate",
- "description": "Only applicable if this certificate is managed by App Engine. Managed certificates are tied to the lifecycle of a DomainMapping and cannot be updated or deleted via the AuthorizedCertificates API. If this certificate is manually administered by the user, this field will be empty.@OutputOnly"
+ "description": "Only applicable if this certificate is managed by App Engine. Managed certificates are tied to the lifecycle of a DomainMapping and cannot be updated or deleted via the AuthorizedCertificates API. If this certificate is manually administered by the user, this field will be empty.@OutputOnly",
+ "$ref": "ManagedCertificate"
},
"certificateRawData": {
"description": "The SSL certificate serving the AuthorizedCertificate resource. This must be obtained independently from a certificate authority.",
@@ -1097,8 +1175,6 @@
"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'.",
@@ -1123,20 +1199,22 @@
"type": "string"
}
},
- "id": "ResourceRecord"
+ "id": "ResourceRecord",
+ "description": "A DNS resource record.",
+ "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"
}
- },
- "nextPageToken": {
- "description": "The standard List next-page token.",
- "type": "string"
}
},
"id": "ListOperationsResponse",
@@ -1144,7 +1222,18 @@
"type": "object"
},
"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",
+ "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"
@@ -1161,121 +1250,9 @@
"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",
- "description": "Metadata for the given google.longrunning.Operation.",
- "type": "object"
- },
- "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"
- },
- "OperationMetadataV1Beta5": {
- "properties": {
- "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"
- },
- "method": {
- "description": "API method name that initiated this operation. Example: google.appengine.v1beta5.Version.CreateVersion.@OutputOnly",
- "type": "string"
- }
- },
- "id": "OperationMetadataV1Beta5",
- "description": "Metadata for the given google.longrunning.Operation.",
- "type": "object"
- },
- "ListLocationsResponse": {
- "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",
- "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": {
- "enum": [
- "UNSPECIFIED_STATUS",
- "OK",
- "PENDING",
- "FAILED_RETRYING_INTERNAL",
- "FAILED_RETRYING_NOT_VISIBLE",
- "FAILED_PERMANENTLY_NOT_VISIBLE",
- "FAILED_RETRYING_CAA_FORBIDDEN",
- "FAILED_RETRYING_CAA_CHECKING"
- ],
- "description": "Status of certificate management. Refers to the most recent certificate acquisition or renewal attempt.@OutputOnly",
- "type": "string",
- "enumDescriptions": [
- "",
- "Certificate was successfully obtained and inserted into the serving system.",
- "Certificate is under active attempts to acquire or renew.",
- "Most recent renewal failed due to a system failure and will be retried. System failure is likely transient, and subsequent renewal attempts may succeed. The last successfully provisioned certificate may still be serving.",
- "Most recent renewal failed due to an invalid DNS setup and will be retried. Renewal attempts will continue to fail until the certificate domain's DNS configuration is fixed. The last successfully provisioned certificate may still be serving.",
- "All renewal attempts have been exhausted. Most recent renewal failed due to an invalid DNS setup and will not be retried. The last successfully provisioned certificate may still be serving.",
- "Most recent renewal failed due to an explicit CAA record that does not include the in-use CA, Let's Encrypt. Renewals will continue to fail until the CAA is reconfigured. The last successfully provisioned certificate may still be serving.",
- "Most recent renewal failed due to a CAA retrieval failure. This means that the domain's DNS provider does not properly handle CAA records, failing requests for CAA records when no CAA records are defined. Renewals will continue to fail until the DNS provider is changed or a CAA record is added for the given domain. The last successfully provisioned certificate may still be serving."
- ]
- }
- },
- "id": "ManagedCertificate"
+ "id": "OperationMetadata"
}
},
"icons": {
@@ -1283,5 +1260,28 @@
"x16": "http://www.google.com/images/icons/product/search-16.gif"
},
"protocol": "rest",
- "version": "v1alpha"
+ "version": "v1alpha",
+ "baseUrl": "https://appengine.googleapis.com/",
+ "auth": {
+ "oauth2": {
+ "scopes": {
+ "https://www.googleapis.com/auth/cloud-platform.read-only": {
+ "description": "View your data across Google Cloud Platform services"
+ },
+ "https://www.googleapis.com/auth/cloud-platform": {
+ "description": "View and manage your data across Google Cloud Platform services"
+ },
+ "https://www.googleapis.com/auth/appengine.admin": {
+ "description": "View and manage your applications deployed on Google App Engine"
+ }
+ }
+ }
+ },
+ "kind": "discovery#restDescription",
+ "description": "The App Engine Admin API enables developers to provision and manage their App Engine applications.",
+ "servicePath": "",
+ "rootUrl": "https://appengine.googleapis.com/",
+ "basePath": "",
+ "ownerDomain": "google.com",
+ "name": "appengine"
}
diff --git a/appengine/v1beta/appengine-api.json b/appengine/v1beta/appengine-api.json
index 5261051..ed8ddcb 100644
--- a/appengine/v1beta/appengine-api.json
+++ b/appengine/v1beta/appengine-api.json
@@ -1,37 +1,36 @@
{
- "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:v1beta",
- "documentationLink": "https://cloud.google.com/appengine/docs/admin-api/",
- "revision": "20171213",
- "title": "Google App Engine Admin API",
- "ownerName": "Google",
"discoveryVersion": "v1",
+ "ownerName": "Google",
"resources": {
"apps": {
"methods": {
+ "repair": {
+ "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",
+ "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."
+ },
"get": {
"flatPath": "v1beta/apps/{appsId}",
"path": "v1beta/apps/{appsId}",
@@ -44,6 +43,11 @@
"appsId"
],
"httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
"parameters": {
"appsId": {
"description": "Part of `name`. Name of the Application resource to get. Example: apps/myapp.",
@@ -51,14 +55,13 @@
"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": {
+ "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.",
"httpMethod": "PATCH",
"parameterOrder": [
"appsId"
@@ -67,17 +70,17 @@
"$ref": "Operation"
},
"parameters": {
+ "appsId": {
+ "location": "path",
+ "description": "Part of `name`. Name of the Application resource to update. Example: apps/myapp.",
+ "required": true,
+ "type": "string"
+ },
"updateMask": {
"description": "Standard field mask for the set of fields to be updated.",
"format": "google-fieldmask",
"type": "string",
"location": "query"
- },
- "appsId": {
- "description": "Part of `name`. Name of the Application resource to update. Example: apps/myapp.",
- "required": true,
- "type": "string",
- "location": "path"
}
},
"scopes": [
@@ -85,572 +88,32 @@
],
"flatPath": "v1beta/apps/{appsId}",
"id": "appengine.apps.patch",
- "path": "v1beta/apps/{appsId}",
- "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."
+ "path": "v1beta/apps/{appsId}"
},
"create": {
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {},
+ "flatPath": "v1beta/apps",
+ "path": "v1beta/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"
- },
- "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": "v1beta/apps",
- "id": "appengine.apps.create",
- "path": "v1beta/apps"
- },
- "repair": {
- "request": {
- "$ref": "RepairApplicationRequest"
- },
- "description": "Recreates the required App Engine features for the specified App Engine application, for example a Cloud Storage bucket or App Engine service account. Use this method if you receive an error message about a missing feature, for example, Error retrieving the App Engine service account.",
- "httpMethod": "POST",
- "parameterOrder": [
- "appsId"
- ],
- "response": {
- "$ref": "Operation"
- },
- "parameters": {
- "appsId": {
- "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",
- "id": "appengine.apps.repair",
- "path": "v1beta/apps/{appsId}:repair"
+ }
}
},
"resources": {
- "authorizedDomains": {
- "methods": {
- "list": {
- "description": "Lists all domains the user is authorized to administer.",
- "response": {
- "$ref": "ListAuthorizedDomainsResponse"
- },
- "parameterOrder": [
- "appsId"
- ],
- "httpMethod": "GET",
- "parameters": {
- "appsId": {
- "location": "path",
- "description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.",
- "required": true,
- "type": "string"
- },
- "pageToken": {
- "description": "Continuation token for fetching the next page of results.",
- "type": "string",
- "location": "query"
- },
- "pageSize": {
- "description": "Maximum results to return per page.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1beta/apps/{appsId}/authorizedDomains",
- "path": "v1beta/apps/{appsId}/authorizedDomains",
- "id": "appengine.apps.authorizedDomains.list"
- }
- }
- },
- "operations": {
- "methods": {
- "list": {
- "flatPath": "v1beta/apps/{appsId}/operations",
- "id": "appengine.apps.operations.list",
- "path": "v1beta/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.",
- "httpMethod": "GET",
- "response": {
- "$ref": "ListOperationsResponse"
- },
- "parameterOrder": [
- "appsId"
- ],
- "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": {
- "description": "The standard list page token.",
- "type": "string",
- "location": "query"
- },
- "pageSize": {
- "location": "query",
- "description": "The standard list page size.",
- "format": "int32",
- "type": "integer"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ]
- },
- "get": {
- "flatPath": "v1beta/apps/{appsId}/operations/{operationsId}",
- "path": "v1beta/apps/{appsId}/operations/{operationsId}",
- "id": "appengine.apps.operations.get",
- "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "appsId",
- "operationsId"
- ],
- "httpMethod": "GET",
- "parameters": {
- "appsId": {
- "location": "path",
- "description": "Part of `name`. The name of the operation resource.",
- "required": true,
- "type": "string"
- },
- "operationsId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ]
- }
- }
- },
- "domainMappings": {
- "methods": {
- "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": {
- "location": "path",
- "description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.",
- "required": true,
- "type": "string"
- },
- "pageToken": {
- "description": "Continuation token for fetching the next page of results.",
- "type": "string",
- "location": "query"
- },
- "pageSize": {
- "location": "query",
- "description": "Maximum results to return per page.",
- "format": "int32",
- "type": "integer"
- }
- },
- "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": {
- "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/domainMappings/example.com.",
- "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}/domainMappings/{domainMappingsId}",
- "path": "v1beta/apps/{appsId}/domainMappings/{domainMappingsId}",
- "id": "appengine.apps.domainMappings.get"
- },
- "patch": {
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "appsId",
- "domainMappingsId"
- ],
- "httpMethod": "PATCH",
- "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 resource to update. Example: apps/myapp/domainMappings/example.com.",
- "required": true,
- "type": "string"
- },
- "domainMappingsId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta/apps/{appsId}/domainMappings/{domainMappingsId}",
- "path": "v1beta/apps/{appsId}/domainMappings/{domainMappingsId}",
- "id": "appengine.apps.domainMappings.patch",
- "request": {
- "$ref": "DomainMapping"
- },
- "description": "Updates the specified domain mapping. To map an SSL certificate to a domain mapping, update certificate_id to point to an AuthorizedCertificate resource. A user must be authorized to administer the associated domain in order to update a DomainMapping resource."
- },
- "create": {
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "appsId"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "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"
- },
- "appsId": {
- "description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "flatPath": "v1beta/apps/{appsId}/domainMappings",
- "path": "v1beta/apps/{appsId}/domainMappings",
- "id": "appengine.apps.domainMappings.create",
- "description": "Maps a domain to an application. A user must be authorized to administer a domain in order to map it to an application. For a list of available authorized domains, see AuthorizedDomains.ListAuthorizedDomains.",
- "request": {
- "$ref": "DomainMapping"
- }
- },
- "delete": {
- "id": "appengine.apps.domainMappings.delete",
- "path": "v1beta/apps/{appsId}/domainMappings/{domainMappingsId}",
- "description": "Deletes the specified domain mapping. A user must be authorized to administer the associated domain in order to delete a DomainMapping resource.",
- "httpMethod": "DELETE",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "appsId",
- "domainMappingsId"
- ],
- "parameters": {
- "appsId": {
- "location": "path",
- "description": "Part of `name`. Name of the resource to delete. Example: apps/myapp/domainMappings/example.com.",
- "required": true,
- "type": "string"
- },
- "domainMappingsId": {
- "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}/domainMappings/{domainMappingsId}"
- }
- }
- },
- "firewall": {
- "resources": {
- "ingressRules": {
- "methods": {
- "get": {
- "description": "Gets the specified firewall rule.",
- "httpMethod": "GET",
- "response": {
- "$ref": "FirewallRule"
- },
- "parameterOrder": [
- "appsId",
- "ingressRulesId"
- ],
- "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": {
- "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}/firewall/ingressRules/{ingressRulesId}",
- "id": "appengine.apps.firewall.ingressRules.get",
- "path": "v1beta/apps/{appsId}/firewall/ingressRules/{ingressRulesId}"
- },
- "patch": {
- "httpMethod": "PATCH",
- "parameterOrder": [
- "appsId",
- "ingressRulesId"
- ],
- "response": {
- "$ref": "FirewallRule"
- },
- "parameters": {
- "updateMask": {
- "description": "Standard field mask for the set of fields to be updated.",
- "format": "google-fieldmask",
- "type": "string",
- "location": "query"
- },
- "appsId": {
- "location": "path",
- "description": "Part of `name`. Name of the Firewall resource to update. Example: apps/myapp/firewall/ingressRules/100.",
- "required": true,
- "type": "string"
- },
- "ingressRulesId": {
- "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}/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."
- },
- "batchUpdate": {
- "response": {
- "$ref": "BatchUpdateIngressRulesResponse"
- },
- "parameterOrder": [
- "appsId"
- ],
- "httpMethod": "POST",
- "parameters": {
- "appsId": {
- "location": "path",
- "description": "Part of `name`. Name of the Firewall collection to set. Example: apps/myapp/firewall/ingressRules.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta/apps/{appsId}/firewall/ingressRules:batchUpdate",
- "path": "v1beta/apps/{appsId}/firewall/ingressRules:batchUpdate",
- "id": "appengine.apps.firewall.ingressRules.batchUpdate",
- "request": {
- "$ref": "BatchUpdateIngressRulesRequest"
- },
- "description": "Replaces the entire firewall ruleset in one bulk operation. This overrides and replaces the rules of an existing firewall with the new rules.If the final rule does not match traffic with the '*' wildcard IP range, then an \"allow all\" rule is explicitly added to the end of the list."
- },
- "delete": {
- "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": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string"
- }
- },
- "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."
- },
- "list": {
- "response": {
- "$ref": "ListIngressRulesResponse"
- },
- "parameterOrder": [
- "appsId"
- ],
- "httpMethod": "GET",
- "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": {
- "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",
- "description": "Lists the firewall rules of an application."
- },
- "create": {
- "response": {
- "$ref": "FirewallRule"
- },
- "parameterOrder": [
- "appsId"
- ],
- "httpMethod": "POST",
- "parameters": {
- "appsId": {
- "location": "path",
- "description": "Part of `parent`. Name of the parent Firewall collection in which to create a new rule. Example: apps/myapp/firewall/ingressRules.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta/apps/{appsId}/firewall/ingressRules",
- "path": "v1beta/apps/{appsId}/firewall/ingressRules",
- "id": "appengine.apps.firewall.ingressRules.create",
- "request": {
- "$ref": "FirewallRule"
- },
- "description": "Creates a firewall rule for the application."
- }
- }
- }
- }
- },
"locations": {
"methods": {
"list": {
+ "description": "Lists information about the supported locations for this service.",
"response": {
"$ref": "ListLocationsResponse"
},
@@ -659,11 +122,16 @@
],
"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",
- "location": "path"
+ "type": "string"
},
"pageToken": {
"location": "query",
@@ -671,15 +139,10 @@
"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": [
@@ -689,31 +152,29 @@
],
"flatPath": "v1beta/apps/{appsId}/locations",
"path": "v1beta/apps/{appsId}/locations",
- "id": "appengine.apps.locations.list",
- "description": "Lists information about the supported locations for this service."
+ "id": "appengine.apps.locations.list"
},
"get": {
- "description": "Get information about a location.",
- "response": {
- "$ref": "Location"
- },
+ "httpMethod": "GET",
"parameterOrder": [
"appsId",
"locationsId"
],
- "httpMethod": "GET",
+ "response": {
+ "$ref": "Location"
+ },
"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"
- },
- "appsId": {
- "location": "path",
- "description": "Part of `name`. Resource name for the location.",
- "required": true,
- "type": "string"
}
},
"scopes": [
@@ -722,46 +183,49 @@
"https://www.googleapis.com/auth/cloud-platform.read-only"
],
"flatPath": "v1beta/apps/{appsId}/locations/{locationsId}",
+ "id": "appengine.apps.locations.get",
"path": "v1beta/apps/{appsId}/locations/{locationsId}",
- "id": "appengine.apps.locations.get"
+ "description": "Get information about a location."
}
}
},
"authorizedCertificates": {
"methods": {
"list": {
+ "path": "v1beta/apps/{appsId}/authorizedCertificates",
+ "id": "appengine.apps.authorizedCertificates.list",
"description": "Lists all SSL certificates the user is authorized to administer.",
- "httpMethod": "GET",
"response": {
"$ref": "ListAuthorizedCertificatesResponse"
},
"parameterOrder": [
"appsId"
],
+ "httpMethod": "GET",
"parameters": {
- "appsId": {
- "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"
+ "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"
}
@@ -771,12 +235,9 @@
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
],
- "flatPath": "v1beta/apps/{appsId}/authorizedCertificates",
- "id": "appengine.apps.authorizedCertificates.list",
- "path": "v1beta/apps/{appsId}/authorizedCertificates"
+ "flatPath": "v1beta/apps/{appsId}/authorizedCertificates"
},
"get": {
- "description": "Gets the specified SSL certificate.",
"response": {
"$ref": "AuthorizedCertificate"
},
@@ -785,51 +246,55 @@
"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": {
+ "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}",
+ "path": "v1beta/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}",
+ "id": "appengine.apps.authorizedCertificates.get",
+ "description": "Gets the specified SSL certificate."
+ },
+ "patch": {
+ "httpMethod": "PATCH",
+ "parameterOrder": [
+ "appsId",
+ "authorizedCertificatesId"
+ ],
+ "response": {
+ "$ref": "AuthorizedCertificate"
+ },
"parameters": {
- "appsId": {
- "location": "path",
- "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/authorizedCertificates/12345.",
- "required": true,
- "type": "string"
- },
- "view": {
- "description": "Controls the set of fields returned in the GET response.",
- "type": "string",
- "location": "query",
- "enum": [
- "BASIC_CERTIFICATE",
- "FULL_CERTIFICATE"
- ]
- },
"authorizedCertificatesId": {
"location": "path",
"description": "Part of `name`. See documentation of `appsId`.",
"required": true,
"type": "string"
- }
- },
- "flatPath": "v1beta/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}",
- "path": "v1beta/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}",
- "id": "appengine.apps.authorizedCertificates.get"
- },
- "patch": {
- "response": {
- "$ref": "AuthorizedCertificate"
- },
- "parameterOrder": [
- "appsId",
- "authorizedCertificatesId"
- ],
- "httpMethod": "PATCH",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "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",
@@ -841,23 +306,24 @@
"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": "v1beta/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}",
- "path": "v1beta/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.",
+ "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."
},
"create": {
+ "request": {
+ "$ref": "AuthorizedCertificate"
+ },
+ "description": "Uploads the specified SSL certificate.",
"httpMethod": "POST",
"parameterOrder": [
"appsId"
@@ -878,13 +344,12 @@
],
"flatPath": "v1beta/apps/{appsId}/authorizedCertificates",
"id": "appengine.apps.authorizedCertificates.create",
- "path": "v1beta/apps/{appsId}/authorizedCertificates",
- "request": {
- "$ref": "AuthorizedCertificate"
- },
- "description": "Uploads the specified SSL certificate."
+ "path": "v1beta/apps/{appsId}/authorizedCertificates"
},
"delete": {
+ "flatPath": "v1beta/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}",
+ "id": "appengine.apps.authorizedCertificates.delete",
+ "path": "v1beta/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}",
"description": "Deletes the specified SSL certificate.",
"httpMethod": "DELETE",
"parameterOrder": [
@@ -910,24 +375,25 @@
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}",
- "id": "appengine.apps.authorizedCertificates.delete",
- "path": "v1beta/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}"
+ ]
}
}
},
"services": {
"methods": {
"delete": {
- "response": {
- "$ref": "Operation"
- },
+ "flatPath": "v1beta/apps/{appsId}/services/{servicesId}",
+ "id": "appengine.apps.services.delete",
+ "path": "v1beta/apps/{appsId}/services/{servicesId}",
+ "description": "Deletes the specified service and all enclosed versions.",
+ "httpMethod": "DELETE",
"parameterOrder": [
"appsId",
"servicesId"
],
- "httpMethod": "DELETE",
+ "response": {
+ "$ref": "Operation"
+ },
"parameters": {
"servicesId": {
"description": "Part of `name`. See documentation of `appsId`.",
@@ -936,35 +402,25 @@
"location": "path"
},
"appsId": {
- "location": "path",
"description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default.",
"required": true,
- "type": "string"
+ "type": "string",
+ "location": "path"
}
},
"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."
+ ]
},
"list": {
- "httpMethod": "GET",
"response": {
"$ref": "ListServicesResponse"
},
"parameterOrder": [
"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.",
@@ -975,6 +431,12 @@
"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"
}
},
"scopes": [
@@ -983,11 +445,12 @@
"https://www.googleapis.com/auth/cloud-platform.read-only"
],
"flatPath": "v1beta/apps/{appsId}/services",
- "id": "appengine.apps.services.list",
"path": "v1beta/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"
},
@@ -996,31 +459,37 @@
"servicesId"
],
"httpMethod": "GET",
+ "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/appengine.admin",
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
],
- "parameters": {
- "appsId": {
- "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "servicesId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string"
- }
- },
"flatPath": "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."
+ "id": "appengine.apps.services.get"
},
"patch": {
+ "flatPath": "v1beta/apps/{appsId}/services/{servicesId}",
+ "path": "v1beta/apps/{appsId}/services/{servicesId}",
+ "id": "appengine.apps.services.patch",
+ "request": {
+ "$ref": "Service"
+ },
+ "description": "Updates the configuration of the specified service.",
"response": {
"$ref": "Operation"
},
@@ -1030,11 +499,6 @@
],
"httpMethod": "PATCH",
"parameters": {
- "migrateTraffic": {
- "description": "Set to true to gradually shift traffic to one or more versions that you specify. By default, traffic is shifted immediately. For gradual traffic migration, the target versions must be located within instances that are configured for both warmup requests (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#inboundservicetype) and automatic scaling (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#automaticscaling). You must specify the shardBy (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services#shardby) field in the Service resource. Gradual traffic migration is not supported in the App Engine flexible environment. For examples, see Migrating and Splitting Traffic (https://cloud.google.com/appengine/docs/admin-api/migrating-splitting-traffic).",
- "type": "boolean",
- "location": "query"
- },
"updateMask": {
"location": "query",
"description": "Standard field mask for the set of fields to be updated.",
@@ -1052,26 +516,248 @@
"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"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta/apps/{appsId}/services/{servicesId}",
- "path": "v1beta/apps/{appsId}/services/{servicesId}",
- "id": "appengine.apps.services.patch",
- "request": {
- "$ref": "Service"
- },
- "description": "Updates the configuration of the specified service."
+ ]
}
},
"resources": {
"versions": {
+ "methods": {
+ "delete": {
+ "description": "Deletes an existing Version resource.",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "appsId",
+ "servicesId",
+ "versionsId"
+ ],
+ "httpMethod": "DELETE",
+ "parameters": {
+ "versionsId": {
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "required": true,
+ "type": "string"
+ },
+ "servicesId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "appsId": {
+ "location": "path",
+ "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1.",
+ "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": {
+ "flatPath": "v1beta/apps/{appsId}/services/{servicesId}/versions",
+ "id": "appengine.apps.services.versions.list",
+ "path": "v1beta/apps/{appsId}/services/{servicesId}/versions",
+ "description": "Lists the versions of a service.",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "ListVersionsResponse"
+ },
+ "parameterOrder": [
+ "appsId",
+ "servicesId"
+ ],
+ "parameters": {
+ "pageSize": {
+ "description": "Maximum results to return per page.",
+ "format": "int32",
+ "type": "integer",
+ "location": "query"
+ },
+ "view": {
+ "location": "query",
+ "enum": [
+ "BASIC",
+ "FULL"
+ ],
+ "description": "Controls the set of fields returned in the List response.",
+ "type": "string"
+ },
+ "servicesId": {
+ "location": "path",
+ "description": "Part of `parent`. See documentation of `appsId`.",
+ "required": true,
+ "type": "string"
+ },
+ "appsId": {
+ "location": "path",
+ "description": "Part of `parent`. Name of the parent 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"
+ }
+ },
+ "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": {
+ "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"
+ },
+ "parameterOrder": [
+ "appsId",
+ "servicesId",
+ "versionsId"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "versionsId": {
+ "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 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"
+ }
+ },
+ "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}"
+ },
+ "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": {
+ "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": {
+ "request": {
+ "$ref": "Version"
+ },
+ "description": "Deploys code and resource files to a new version.",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "appsId",
+ "servicesId"
+ ],
+ "httpMethod": "POST",
+ "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"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta/apps/{appsId}/services/{servicesId}/versions",
+ "path": "v1beta/apps/{appsId}/services/{servicesId}/versions",
+ "id": "appengine.apps.services.versions.create"
+ }
+ },
"resources": {
"instances": {
"methods": {
"delete": {
+ "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",
"description": "Stops a running instance.",
@@ -1085,7 +771,16 @@
"instancesId"
],
"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": {
"description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1/instances/instance-1.",
"required": true,
@@ -1103,49 +798,20 @@
"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/cloud-platform"
- ],
- "flatPath": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}"
+ }
},
"list": {
- "path": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances",
- "id": "appengine.apps.services.versions.instances.list",
- "description": "Lists the instances of a version.Tip: To aggregate details about instances over time, see the Stackdriver Monitoring API (https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.timeSeries/list).",
- "response": {
- "$ref": "ListInstancesResponse"
- },
+ "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": "ListInstancesResponse"
+ },
"parameters": {
- "appsId": {
- "description": "Part of `parent`. Name of the parent Version resource. Example: apps/myapp/services/default/versions/v1.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "pageToken": {
- "description": "Continuation token for fetching the next page of results.",
- "type": "string",
- "location": "query"
- },
"pageSize": {
"location": "query",
"description": "Maximum results to return per page.",
@@ -1163,14 +829,31 @@
"description": "Part of `parent`. See documentation of `appsId`.",
"required": true,
"type": "string"
+ },
+ "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": {
+ "description": "Continuation token for fetching the next page of results.",
+ "type": "string",
+ "location": "query"
}
},
- "flatPath": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances"
+ "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",
+ "id": "appengine.apps.services.versions.instances.list",
+ "path": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances",
+ "description": "Lists the instances of a version.Tip: To aggregate details about instances over time, see the Stackdriver Monitoring API (https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.timeSeries/list)."
},
"get": {
- "path": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}",
- "id": "appengine.apps.services.versions.instances.get",
- "description": "Gets instance information.",
+ "httpMethod": "GET",
"response": {
"$ref": "Instance"
},
@@ -1180,47 +863,43 @@
"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": {
- "servicesId": {
- "location": "path",
+ "versionsId": {
"description": "Part of `name`. See documentation of `appsId`.",
"required": true,
- "type": "string"
+ "type": "string",
+ "location": "path"
+ },
+ "servicesId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "required": true,
+ "type": "string",
+ "location": "path"
},
"appsId": {
- "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"
- },
- "versionsId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string",
- "location": "path"
}
},
- "flatPath": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}"
+ "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}",
+ "id": "appengine.apps.services.versions.instances.get",
+ "path": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}",
+ "description": "Gets instance information."
},
"debug": {
- "path": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}:debug",
- "id": "appengine.apps.services.versions.instances.debug",
- "description": "Enables debugging on a VM instance. This allows you to use the SSH command to connect to the virtual machine where the instance lives. While in \"debug mode\", the instance continues to serve live traffic. You should delete the instance when you are done debugging and then allow the system to take over and determine if another instance should be started.Only applicable for instances in App Engine flexible environment.",
- "request": {
- "$ref": "DebugInstanceRequest"
- },
"response": {
"$ref": "Operation"
},
@@ -1231,10 +910,13 @@
"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.",
@@ -1248,90 +930,486 @@
"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"
}
},
- "flatPath": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}:debug"
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}:debug",
+ "path": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}:debug",
+ "id": "appengine.apps.services.versions.instances.debug",
+ "request": {
+ "$ref": "DebugInstanceRequest"
+ },
+ "description": "Enables debugging on a VM instance. This allows you to use the SSH command to connect to the virtual machine where the instance lives. While in \"debug mode\", the instance continues to serve live traffic. You should delete the instance when you are done debugging and then allow the system to take over and determine if another instance should be started.Only applicable for instances in App Engine flexible environment."
}
}
}
+ }
+ }
+ }
+ },
+ "authorizedDomains": {
+ "methods": {
+ "list": {
+ "description": "Lists all domains the user is authorized to administer.",
+ "response": {
+ "$ref": "ListAuthorizedDomainsResponse"
},
+ "parameterOrder": [
+ "appsId"
+ ],
+ "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}/authorizedDomains",
+ "path": "v1beta/apps/{appsId}/authorizedDomains",
+ "id": "appengine.apps.authorizedDomains.list"
+ }
+ }
+ },
+ "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": {
+ "location": "path",
+ "description": "Part of `name`. The name of the operation's parent resource.",
+ "required": true,
+ "type": "string"
+ },
+ "pageToken": {
+ "description": "The standard list page token.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageSize": {
+ "location": "query",
+ "description": "The standard list page size.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "filter": {
+ "description": "The standard list filter.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "flatPath": "v1beta/apps/{appsId}/operations",
+ "path": "v1beta/apps/{appsId}/operations",
+ "id": "appengine.apps.operations.list"
+ },
+ "get": {
+ "flatPath": "v1beta/apps/{appsId}/operations/{operationsId}",
+ "path": "v1beta/apps/{appsId}/operations/{operationsId}",
+ "id": "appengine.apps.operations.get",
+ "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "appsId",
+ "operationsId"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "parameters": {
+ "appsId": {
+ "description": "Part of `name`. The name of the operation resource.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "operationsId": {
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "required": true,
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "domainMappings": {
+ "methods": {
+ "delete": {
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "appsId",
+ "domainMappingsId"
+ ],
+ "httpMethod": "DELETE",
+ "parameters": {
+ "appsId": {
+ "location": "path",
+ "description": "Part of `name`. Name of the resource to delete. Example: apps/myapp/domainMappings/example.com.",
+ "required": true,
+ "type": "string"
+ },
+ "domainMappingsId": {
+ "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}/domainMappings/{domainMappingsId}",
+ "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",
+ "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"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "flatPath": "v1beta/apps/{appsId}/domainMappings",
+ "path": "v1beta/apps/{appsId}/domainMappings",
+ "id": "appengine.apps.domainMappings.list"
+ },
+ "get": {
+ "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": {
+ "flatPath": "v1beta/apps/{appsId}/domainMappings/{domainMappingsId}",
+ "path": "v1beta/apps/{appsId}/domainMappings/{domainMappingsId}",
+ "id": "appengine.apps.domainMappings.patch",
+ "request": {
+ "$ref": "DomainMapping"
+ },
+ "description": "Updates the specified domain mapping. To map an SSL certificate to a domain mapping, update certificate_id to point to an AuthorizedCertificate resource. A user must be authorized to administer the associated domain in order to update a DomainMapping resource.",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "appsId",
+ "domainMappingsId"
+ ],
+ "httpMethod": "PATCH",
+ "parameters": {
+ "appsId": {
+ "location": "path",
+ "description": "Part of `name`. Name of the resource to update. Example: apps/myapp/domainMappings/example.com.",
+ "required": true,
+ "type": "string"
+ },
+ "domainMappingsId": {
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "required": true,
+ "type": "string"
+ },
+ "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"
+ ]
+ },
+ "create": {
+ "flatPath": "v1beta/apps/{appsId}/domainMappings",
+ "path": "v1beta/apps/{appsId}/domainMappings",
+ "id": "appengine.apps.domainMappings.create",
+ "description": "Maps a domain to an application. A user must be authorized to administer a domain in order to map it to an application. For a list of available authorized domains, see AuthorizedDomains.ListAuthorizedDomains.",
+ "request": {
+ "$ref": "DomainMapping"
+ },
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "appsId"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "appsId": {
+ "description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "overrideStrategy": {
+ "location": "query",
+ "enum": [
+ "UNSPECIFIED_DOMAIN_OVERRIDE_STRATEGY",
+ "STRICT",
+ "OVERRIDE"
+ ],
+ "description": "Whether the domain creation should override any existing mappings for this domain. By default, overrides are rejected.",
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "firewall": {
+ "resources": {
+ "ingressRules": {
"methods": {
- "delete": {
- "path": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
- "id": "appengine.apps.services.versions.delete",
- "description": "Deletes an existing Version resource.",
+ "get": {
"response": {
- "$ref": "Operation"
+ "$ref": "FirewallRule"
},
"parameterOrder": [
"appsId",
- "servicesId",
- "versionsId"
+ "ingressRulesId"
],
- "httpMethod": "DELETE",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
+ "httpMethod": "GET",
"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.",
+ "description": "Part of `name`. Name of the Firewall resource to retrieve. Example: apps/myapp/firewall/ingressRules/100.",
"required": true,
"type": "string"
},
- "versionsId": {
+ "ingressRulesId": {
"location": "path",
"description": "Part of `name`. See documentation of `appsId`.",
"required": true,
"type": "string"
}
},
- "flatPath": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}"
- },
- "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"
],
+ "flatPath": "v1beta/apps/{appsId}/firewall/ingressRules/{ingressRulesId}",
+ "path": "v1beta/apps/{appsId}/firewall/ingressRules/{ingressRulesId}",
+ "id": "appengine.apps.firewall.ingressRules.get",
+ "description": "Gets the specified firewall rule."
+ },
+ "patch": {
+ "path": "v1beta/apps/{appsId}/firewall/ingressRules/{ingressRulesId}",
+ "id": "appengine.apps.firewall.ingressRules.patch",
+ "request": {
+ "$ref": "FirewallRule"
+ },
+ "description": "Updates the specified firewall rule.",
+ "response": {
+ "$ref": "FirewallRule"
+ },
+ "parameterOrder": [
+ "appsId",
+ "ingressRulesId"
+ ],
+ "httpMethod": "PATCH",
"parameters": {
- "servicesId": {
- "location": "path",
- "description": "Part of `parent`. See documentation of `appsId`.",
- "required": true,
+ "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 Service resource. Example: apps/myapp/services/default.",
+ "description": "Part of `name`. Name of the Firewall resource to update. Example: apps/myapp/firewall/ingressRules/100.",
"required": true,
"type": "string",
"location": "path"
},
+ "ingressRulesId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta/apps/{appsId}/firewall/ingressRules/{ingressRulesId}"
+ },
+ "batchUpdate": {
+ "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.",
+ "request": {
+ "$ref": "BatchUpdateIngressRulesRequest"
+ },
+ "response": {
+ "$ref": "BatchUpdateIngressRulesResponse"
+ },
+ "parameterOrder": [
+ "appsId"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "appsId": {
+ "description": "Part of `name`. Name of the Firewall collection to set. Example: apps/myapp/firewall/ingressRules.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1beta/apps/{appsId}/firewall/ingressRules:batchUpdate",
+ "path": "v1beta/apps/{appsId}/firewall/ingressRules:batchUpdate",
+ "id": "appengine.apps.firewall.ingressRules.batchUpdate"
+ },
+ "delete": {
+ "httpMethod": "DELETE",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "appsId",
+ "ingressRulesId"
+ ],
+ "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"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta/apps/{appsId}/firewall/ingressRules/{ingressRulesId}",
+ "id": "appengine.apps.firewall.ingressRules.delete",
+ "path": "v1beta/apps/{appsId}/firewall/ingressRules/{ingressRulesId}",
+ "description": "Deletes the specified firewall rule."
+ },
+ "list": {
+ "response": {
+ "$ref": "ListIngressRulesResponse"
+ },
+ "parameterOrder": [
+ "appsId"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "matchingAddress": {
+ "description": "A valid IP Address. If set, only rules matching this address will be returned. The first returned rule will be the rule that fires on requests from this IP.",
+ "type": "string",
+ "location": "query"
+ },
+ "appsId": {
+ "location": "path",
+ "description": "Part of `parent`. Name of the Firewall collection to retrieve. Example: apps/myapp/firewall/ingressRules.",
+ "required": true,
+ "type": "string"
+ },
"pageToken": {
"description": "Continuation token for fetching the next page of results.",
"type": "string",
@@ -1342,150 +1420,44 @@
"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"
}
},
- "flatPath": "v1beta/apps/{appsId}/services/{servicesId}/versions",
- "path": "v1beta/apps/{appsId}/services/{servicesId}/versions",
- "id": "appengine.apps.services.versions.list"
- },
- "get": {
- "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"
- },
- "parameterOrder": [
- "appsId",
- "servicesId",
- "versionsId"
- ],
- "httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/appengine.admin",
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
],
- "parameters": {
- "servicesId": {
- "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"
- },
- "view": {
- "location": "query",
- "enum": [
- "BASIC",
- "FULL"
- ],
- "description": "Controls the set of fields returned in the Get response.",
- "type": "string"
- }
- },
- "flatPath": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}"
- },
- "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/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.",
- "request": {
- "$ref": "Version"
- },
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "appsId",
- "servicesId",
- "versionsId"
- ],
- "httpMethod": "PATCH",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "versionsId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string"
- },
- "updateMask": {
- "description": "Standard field mask for the set of fields to be updated.",
- "format": "google-fieldmask",
- "type": "string",
- "location": "query"
- },
- "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"
- }
- },
- "flatPath": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
- "path": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
- "id": "appengine.apps.services.versions.patch"
+ "flatPath": "v1beta/apps/{appsId}/firewall/ingressRules",
+ "path": "v1beta/apps/{appsId}/firewall/ingressRules",
+ "id": "appengine.apps.firewall.ingressRules.list",
+ "description": "Lists the firewall rules of an application."
},
"create": {
+ "request": {
+ "$ref": "FirewallRule"
+ },
+ "description": "Creates a firewall rule for the application.",
"response": {
- "$ref": "Operation"
+ "$ref": "FirewallRule"
},
"parameterOrder": [
- "appsId",
- "servicesId"
+ "appsId"
],
"httpMethod": "POST",
"parameters": {
"appsId": {
- "location": "path",
- "description": "Part of `parent`. Name of the parent resource to create this version under. Example: apps/myapp/services/default.",
+ "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"
- },
- "servicesId": {
- "location": "path",
- "description": "Part of `parent`. See documentation of `appsId`.",
- "required": true,
- "type": "string"
+ "type": "string",
+ "location": "path"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
- "flatPath": "v1beta/apps/{appsId}/services/{servicesId}/versions",
- "path": "v1beta/apps/{appsId}/services/{servicesId}/versions",
- "id": "appengine.apps.services.versions.create",
- "request": {
- "$ref": "Version"
- },
- "description": "Deploys code and resource files to a new version."
+ "flatPath": "v1beta/apps/{appsId}/firewall/ingressRules",
+ "path": "v1beta/apps/{appsId}/firewall/ingressRules",
+ "id": "appengine.apps.firewall.ingressRules.create"
}
}
}
@@ -1495,9 +1467,33 @@
}
},
"parameters": {
- "$.xgafv": {
- "description": "V1 error format.",
+ "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": {
+ "description": "JSONP",
+ "type": "string",
+ "location": "query"
+ },
+ "$.xgafv": {
"enumDescriptions": [
"v1 error format",
"v2 error format"
@@ -1506,16 +1502,11 @@
"enum": [
"1",
"2"
- ]
- },
- "callback": {
- "location": "query",
- "description": "JSONP",
+ ],
+ "description": "V1 error format.",
"type": "string"
},
"alt": {
- "description": "Data format for response.",
- "default": "json",
"enum": [
"json",
"media",
@@ -1527,7 +1518,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",
@@ -1535,9 +1528,9 @@
"type": "string"
},
"access_token": {
- "location": "query",
"description": "OAuth access token.",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"quotaUser": {
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
@@ -1545,142 +1538,23 @@
"location": "query"
},
"pp": {
+ "location": "query",
"description": "Pretty-print response.",
"type": "boolean",
- "default": "true",
- "location": "query"
- },
- "oauth_token": {
- "location": "query",
- "description": "OAuth 2.0 token for the current user.",
- "type": "string"
- },
- "bearer_token": {
- "description": "OAuth bearer token.",
- "type": "string",
- "location": "query"
- },
- "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": {
+ "bearer_token": {
"location": "query",
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "description": "OAuth bearer token.",
"type": "string"
},
- "fields": {
- "description": "Selector specifying which fields to include in a partial response.",
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
"type": "string",
"location": "query"
}
},
"schemas": {
- "UrlDispatchRule": {
- "description": "Rules to match an HTTP request and dispatch that request to a service.",
- "type": "object",
- "properties": {
- "domain": {
- "description": "Domain name to match against. The wildcard \"*\" is supported if specified before a period: \"*.\".Defaults to matching all domains: \"*\".",
- "type": "string"
- },
- "service": {
- "description": "Resource ID of a service in this application that should serve the matched request. The service must already exist. Example: default.",
- "type": "string"
- },
- "path": {
- "description": "Pathname within the host. Must start with a \"/\". A single \"*\" can be included at the end of the path.The sum of the lengths of the domain and path may not exceed 100 characters.",
- "type": "string"
- }
- },
- "id": "UrlDispatchRule"
- },
- "ListVersionsResponse": {
- "description": "Response message for Versions.ListVersions.",
- "type": "object",
- "properties": {
- "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"
- },
- "ListAuthorizedDomainsResponse": {
- "description": "Response message for AuthorizedDomains.ListAuthorizedDomains.",
- "type": "object",
- "properties": {
- "nextPageToken": {
- "description": "Continuation token for fetching the next page of results.",
- "type": "string"
- },
- "domains": {
- "description": "The authorized domains belonging to the user.",
- "type": "array",
- "items": {
- "$ref": "AuthorizedDomain"
- }
- }
- },
- "id": "ListAuthorizedDomainsResponse"
- },
- "ApiEndpointHandler": {
- "description": "Uses Google Cloud Endpoints to handle requests.",
- "type": "object",
- "properties": {
- "scriptPath": {
- "description": "Path to the script from the application root directory.",
- "type": "string"
- }
- },
- "id": "ApiEndpointHandler"
- },
- "Empty": {
- "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 {}.",
- "type": "object"
- },
- "DomainMapping": {
- "description": "A domain serving an App Engine application.",
- "type": "object",
- "properties": {
- "id": {
- "description": "Relative name of the domain serving the application. Example: example.com.",
- "type": "string"
- },
- "resourceRecords": {
- "description": "The resource records required to configure this domain mapping. These records must be added to the domain's DNS configuration in order to serve the application via this domain mapping.@OutputOnly",
- "type": "array",
- "items": {
- "$ref": "ResourceRecord"
- }
- },
- "name": {
- "description": "Full path to the DomainMapping resource in the API. Example: apps/myapp/domainMapping/example.com.@OutputOnly",
- "type": "string"
- },
- "sslSettings": {
- "description": "SSL configuration for this domain. If unconfigured, this domain will not serve with SSL.",
- "$ref": "SslSettings"
- }
- },
- "id": "DomainMapping"
- },
"ZipInfo": {
"description": "The zip file information for a zip deployment.",
"type": "object",
@@ -1698,16 +1572,9 @@
"id": "ZipInfo"
},
"AutomaticScaling": {
+ "description": "Automatic scaling is based on request rate, response latencies, and other application metrics.",
+ "type": "object",
"properties": {
- "minTotalInstances": {
- "description": "Minimum number of instances that should be maintained for this version.",
- "format": "int32",
- "type": "integer"
- },
- "networkUtilization": {
- "$ref": "NetworkUtilization",
- "description": "Target scaling by network usage."
- },
"coolDownPeriod": {
"description": "Amount of time that the Autoscaler (https://cloud.google.com/compute/docs/autoscaler/) should wait between changes to the number of virtual machines. Only applicable in the App Engine flexible environment.",
"format": "google-duration",
@@ -1724,8 +1591,8 @@
"type": "string"
},
"cpuUtilization": {
- "description": "Target scaling by CPU usage.",
- "$ref": "CpuUtilization"
+ "$ref": "CpuUtilization",
+ "description": "Target scaling by CPU usage."
},
"diskUtilization": {
"$ref": "DiskUtilization",
@@ -1746,8 +1613,8 @@
"type": "integer"
},
"requestUtilization": {
- "description": "Target scaling by request utilization.",
- "$ref": "RequestUtilization"
+ "$ref": "RequestUtilization",
+ "description": "Target scaling by request utilization."
},
"minIdleInstances": {
"description": "Minimum number of idle instances that should be maintained for this version. Only applicable for the default version of a service.",
@@ -1758,16 +1625,33 @@
"description": "Maximum number of instances that should be started to handle requests.",
"format": "int32",
"type": "integer"
+ },
+ "minTotalInstances": {
+ "description": "Minimum number of instances that should be maintained for this version.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "networkUtilization": {
+ "description": "Target scaling by network usage.",
+ "$ref": "NetworkUtilization"
}
},
- "id": "AutomaticScaling",
- "description": "Automatic scaling is based on request rate, response latencies, and other application metrics.",
- "type": "object"
+ "id": "AutomaticScaling"
},
"AuthorizedCertificate": {
- "description": "An SSL certificate that a user has been authorized to administer. A user is authorized to administer any certificate that applies to one of their authorized domains.",
- "type": "object",
"properties": {
+ "displayName": {
+ "description": "The user-specified display name of the certificate. This is not guaranteed to be unique. Example: My Certificate.",
+ "type": "string"
+ },
+ "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"
+ },
+ "certificateRawData": {
+ "description": "The SSL certificate serving the AuthorizedCertificate resource. This must be obtained independently from a certificate authority.",
+ "$ref": "CertificateRawData"
+ },
"visibleDomainMappings": {
"description": "The full paths to user visible Domain Mapping resources that have this certificate mapped. Example: apps/myapp/domainMappings/example.com.This may not represent the full list of mapped domain mappings if the user does not have VIEWER permissions on all of the applications that have this certificate mapped. See domain_mappings_count for a complete count.Only returned by GET or LIST requests when specifically requested by the view=FULL_CERTIFICATE option.@OutputOnly",
"type": "array",
@@ -1799,27 +1683,17 @@
"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"
}
},
- "id": "AuthorizedCertificate"
+ "id": "AuthorizedCertificate",
+ "description": "An SSL certificate that a user has been authorized to administer. A user is authorized to administer any certificate that applies to one of their authorized domains.",
+ "type": "object"
},
"ResourceRecord": {
- "description": "A DNS resource record.",
- "type": "object",
"properties": {
"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.",
@@ -1829,9 +1703,7 @@
"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).",
@@ -1842,7 +1714,9 @@
"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.",
@@ -1860,22 +1734,22 @@
"id": "Library"
},
"ListLocationsResponse": {
+ "description": "The response message for Locations.ListLocations.",
+ "type": "object",
"properties": {
+ "nextPageToken": {
+ "description": "The standard List next-page token.",
+ "type": "string"
+ },
"locations": {
"description": "A list of locations that matches the specified filter in the request.",
"type": "array",
"items": {
"$ref": "Location"
}
- },
- "nextPageToken": {
- "description": "The standard List next-page token.",
- "type": "string"
}
},
- "id": "ListLocationsResponse",
- "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.",
@@ -1889,26 +1763,71 @@
"id": "ContainerInfo"
},
"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.",
- "format": "int32",
- "type": "integer"
- },
"targetRequestCountPerSecond": {
"description": "Target requests per second.",
"format": "int32",
"type": "integer"
+ },
+ "targetConcurrentRequests": {
+ "description": "Target number of concurrent requests.",
+ "format": "int32",
+ "type": "integer"
}
},
- "id": "RequestUtilization",
- "description": "Target scaling by request utilization. Only applicable in the App Engine flexible environment.",
- "type": "object"
+ "id": "RequestUtilization"
},
- "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.",
+ "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": {
+ "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."
@@ -1934,12 +1853,12 @@
]
},
"apiEndpoint": {
- "description": "Uses API Endpoints to handle requests.",
- "$ref": "ApiEndpointHandler"
+ "$ref": "ApiEndpointHandler",
+ "description": "Uses API Endpoints to handle requests."
},
"staticFiles": {
- "description": "Returns the contents of a file, such as an image, as the response.",
- "$ref": "StaticFilesHandler"
+ "$ref": "StaticFilesHandler",
+ "description": "Returns the contents of a file, such as an image, as the response."
},
"redirectHttpResponseCode": {
"enumDescriptions": [
@@ -1958,94 +1877,36 @@
],
"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": {
- "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"
- ]
}
},
- "id": "UrlMap"
- },
- "EndpointsApiService": {
- "description": "Cloud Endpoints (https://cloud.google.com/endpoints) configuration. The Endpoints API Service provides tooling for serving Open API and gRPC endpoints via an NGINX proxy.The fields here refer to the name and configuration id of a \"service\" resource in the Service Management API (https://cloud.google.com/service-management/overview).",
- "type": "object",
- "properties": {
- "name": {
- "description": "Endpoints service name which is the name of the \"service\" resource in the Service Management API. For example \"myapi.endpoints.myproject.cloud.goog\"",
- "type": "string"
- },
- "configId": {
- "description": "Endpoints service configuration id as specified by the Service Management API. For example \"2016-09-19r1\"By default, the Endpoints service configuration id is fixed and config_id must be specified. To keep the Endpoints service configuration id updated with each rollout, specify RolloutStrategy.MANAGED and omit config_id.",
- "type": "string"
- }
- },
- "id": "EndpointsApiService"
- },
- "Operation": {
- "description": "This resource represents a long-running operation that is the result of a network API call.",
- "type": "object",
- "properties": {
- "done": {
- "description": "If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.",
- "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": {
- "description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.",
- "type": "object",
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- }
- }
- },
- "id": "Operation"
+ "id": "UrlMap",
+ "description": "URL pattern and description of how the URL should be handled. App Engine can handle URLs by executing application code or by serving static files uploaded with the version, such as images, CSS, or JavaScript.",
+ "type": "object"
},
"ApiConfigHandler": {
+ "description": "Google Cloud Endpoints (https://cloud.google.com/appengine/docs/python/endpoints/) configuration for API handlers.",
+ "type": "object",
"properties": {
+ "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"
@@ -2069,6 +1930,8 @@
"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.",
@@ -2078,48 +1941,50 @@
"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": {
- "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"
]
}
},
- "id": "ApiConfigHandler",
- "description": "Google Cloud Endpoints (https://cloud.google.com/appengine/docs/python/endpoints/) configuration for API handlers.",
- "type": "object"
+ "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": {
+ "description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.",
+ "type": "object",
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ }
+ }
+ },
+ "id": "Operation"
},
"StaticFilesHandler": {
"description": "Files served directly to the user for a given URL, such as images, CSS stylesheets, or JavaScript source files. Static file handlers describe which files in the application directory are static files, and which URLs serve them.",
"type": "object",
"properties": {
- "requireMatchingFile": {
- "description": "Whether this handler should match the request if the file referenced by the handler does not exist.",
- "type": "boolean"
- },
- "expiration": {
- "description": "Time a static file served by this handler should be cached by web proxies and browsers.",
- "format": "google-duration",
- "type": "string"
- },
"applicationReadable": {
"description": "Whether files should also be uploaded as code data. By default, files declared in static file handlers are uploaded as static data and are only served to end users; they cannot be read by the application. If enabled, uploads are charged against both your code and static data storage resource quotas.",
"type": "boolean"
@@ -2142,37 +2007,19 @@
"mimeType": {
"description": "MIME type used to serve all files served by this handler.Defaults to file-specific MIME types, which are derived from each file's filename extension.",
"type": "string"
+ },
+ "requireMatchingFile": {
+ "description": "Whether this handler should match the request if the file referenced by the handler does not exist.",
+ "type": "boolean"
+ },
+ "expiration": {
+ "description": "Time a static file served by this handler should be cached by web proxies and browsers.",
+ "format": "google-duration",
+ "type": "string"
}
},
"id": "StaticFilesHandler"
},
- "DiskUtilization": {
- "properties": {
- "targetWriteBytesPerSecond": {
- "description": "Target bytes written per second.",
- "format": "int32",
- "type": "integer"
- },
- "targetReadBytesPerSecond": {
- "description": "Target bytes read per second.",
- "format": "int32",
- "type": "integer"
- },
- "targetReadOpsPerSecond": {
- "description": "Target ops read per seconds.",
- "format": "int32",
- "type": "integer"
- },
- "targetWriteOpsPerSecond": {
- "description": "Target ops written per second.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "DiskUtilization",
- "description": "Target scaling by disk usage. Only applicable in the App Engine flexible environment.",
- "type": "object"
- },
"BasicScaling": {
"description": "A service with basic scaling will create an instance when the application receives a request. The instance will be turned down when the app becomes idle. Basic scaling is ideal for work that is intermittent or driven by user activity.",
"type": "object",
@@ -2190,9 +2037,34 @@
},
"id": "BasicScaling"
},
+ "DiskUtilization": {
+ "properties": {
+ "targetWriteOpsPerSecond": {
+ "description": "Target ops written per second.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "targetWriteBytesPerSecond": {
+ "description": "Target bytes written per second.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "targetReadBytesPerSecond": {
+ "description": "Target bytes read per second.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "targetReadOpsPerSecond": {
+ "description": "Target ops read per seconds.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "DiskUtilization",
+ "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.",
@@ -2205,11 +2077,38 @@
"type": "number"
}
},
- "id": "CpuUtilization"
+ "id": "CpuUtilization",
+ "description": "Target scaling by CPU usage.",
+ "type": "object"
+ },
+ "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": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "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"
},
"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",
@@ -2228,38 +2127,11 @@
"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",
- "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"
+ "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.",
@@ -2267,17 +2139,19 @@
"type": "integer"
}
},
- "id": "ManualScaling"
+ "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": {
"properties": {
- "standardEnvironmentAvailable": {
- "description": "App Engine Standard Environment is available in the given location.@OutputOnly",
- "type": "boolean"
- },
"flexibleEnvironmentAvailable": {
"description": "App Engine Flexible Environment is available in the given location.@OutputOnly",
"type": "boolean"
+ },
+ "standardEnvironmentAvailable": {
+ "description": "App Engine Standard Environment is available in the given location.@OutputOnly",
+ "type": "boolean"
}
},
"id": "LocationMetadata",
@@ -2288,42 +2162,40 @@
"description": "A Service resource is a logical component of an application that can share state and communicate in a secure fashion with other services. For example, an application that handles customer requests might include separate services to handle tasks such as backend data analysis or API requests from mobile devices. Each service has a collection of versions that define a specific set of code used to implement the functionality of that service.",
"type": "object",
"properties": {
+ "name": {
+ "description": "Full path to the Service resource in the API. Example: apps/myapp/services/default.@OutputOnly",
+ "type": "string"
+ },
"split": {
- "$ref": "TrafficSplit",
- "description": "Mapping that defines fractional HTTP traffic diversion to different versions within the service."
+ "description": "Mapping that defines fractional HTTP traffic diversion to different versions within the service.",
+ "$ref": "TrafficSplit"
},
"id": {
"description": "Relative name of the service within the application. Example: default.@OutputOnly",
"type": "string"
- },
- "name": {
- "description": "Full path to the Service resource in the API. Example: apps/myapp/services/default.@OutputOnly",
- "type": "string"
}
},
"id": "Service"
},
"ListOperationsResponse": {
+ "description": "The response message for Operations.ListOperations.",
+ "type": "object",
"properties": {
- "nextPageToken": {
- "description": "The standard List next-page token.",
- "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"
},
"FirewallRule": {
- "description": "A single firewall rule that is evaluated against incoming traffic and provides an action to take on matched requests.",
- "type": "object",
"properties": {
"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.",
@@ -2353,10 +2225,23 @@
"type": "string"
}
},
- "id": "FirewallRule"
+ "id": "FirewallRule",
+ "description": "A single firewall rule that is evaluated against incoming traffic and provides an action to take on matched requests.",
+ "type": "object"
},
"OperationMetadata": {
+ "description": "Metadata for the given google.longrunning.Operation.",
+ "type": "object",
"properties": {
+ "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"
@@ -2373,33 +2258,22 @@
"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",
- "description": "Metadata for the given google.longrunning.Operation.",
- "type": "object"
+ "id": "OperationMetadata"
},
"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"
}
+ },
+ "nextPageToken": {
+ "description": "Continuation token for fetching the next page of results.",
+ "type": "string"
}
},
"id": "ListAuthorizedCertificatesResponse",
@@ -2421,47 +2295,42 @@
"description": "The feature specific settings to be used in the application. These define behaviors that are user configurable.",
"type": "object"
},
- "OperationMetadataV1": {
- "description": "Metadata for the given google.longrunning.Operation.",
+ "ErrorHandler": {
+ "description": "Custom static error page to be served when an error occurs.",
"type": "object",
"properties": {
- "warning": {
- "description": "Durable messages that persist on every operation poll. @OutputOnly",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "insertTime": {
- "description": "Time that this operation was created.@OutputOnly",
- "format": "google-datetime",
+ "errorCode": {
+ "enumDescriptions": [
+ "Not specified. ERROR_CODE_DEFAULT is assumed.",
+ "All other error types.",
+ "Application has exceeded a resource quota.",
+ "Client blocked by the application's Denial of Service protection configuration.",
+ "Deadline reached before the application responds."
+ ],
+ "enum": [
+ "ERROR_CODE_UNSPECIFIED",
+ "ERROR_CODE_DEFAULT",
+ "ERROR_CODE_OVER_QUOTA",
+ "ERROR_CODE_DOS_API_DENIAL",
+ "ERROR_CODE_TIMEOUT"
+ ],
+ "description": "Error condition this handler applies to.",
"type": "string"
},
- "user": {
- "description": "User who requested this operation.@OutputOnly",
+ "mimeType": {
+ "description": "MIME type of file. Defaults to text/html.",
"type": "string"
},
- "target": {
- "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly",
- "type": "string"
- },
- "ephemeralMessage": {
- "description": "Ephemeral message that may change every time the operation is polled. @OutputOnly",
- "type": "string"
- },
- "method": {
- "description": "API method that initiated this operation. Example: google.appengine.v1.Versions.CreateVersion.@OutputOnly",
- "type": "string"
- },
- "endTime": {
- "description": "Time that this operation completed.@OutputOnly",
- "format": "google-datetime",
+ "staticFile": {
+ "description": "Static file content to be served for this error.",
"type": "string"
}
},
- "id": "OperationMetadataV1"
+ "id": "ErrorHandler"
},
"SslSettings": {
+ "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 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.",
@@ -2484,88 +2353,52 @@
"type": "string"
}
},
- "id": "SslSettings",
- "description": "SSL configuration for a DomainMapping resource.",
- "type": "object"
+ "id": "SslSettings"
},
- "ErrorHandler": {
- "description": "Custom static error page to be served when an error occurs.",
+ "OperationMetadataV1": {
+ "description": "Metadata for the given google.longrunning.Operation.",
"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": {
- "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.",
+ "warning": {
+ "description": "Durable messages that persist on every operation poll. @OutputOnly",
"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.",
+ "insertTime": {
+ "description": "Time that this operation was created.@OutputOnly",
+ "format": "google-datetime",
"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.",
+ "target": {
+ "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly",
"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.",
+ "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.v1.Versions.CreateVersion.@OutputOnly",
+ "type": "string"
+ },
+ "endTime": {
+ "description": "Time that this operation completed.@OutputOnly",
+ "format": "google-datetime",
"type": "string"
}
},
- "id": "Network"
+ "id": "OperationMetadataV1"
},
"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"
@@ -2617,16 +2450,60 @@
"defaultHostname": {
"description": "Hostname used to reach this application, as resolved by App Engine.@OutputOnly",
"type": "string"
+ },
+ "featureSettings": {
+ "description": "The feature specific settings to be used in the application.",
+ "$ref": "FeatureSettings"
+ },
+ "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"
}
},
"id": "Application"
},
- "Instance": {
+ "Network": {
+ "description": "Extra network settings. Only applicable in the App Engine flexible environment.",
+ "type": "object",
"properties": {
- "vmStatus": {
- "description": "Status of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment.@OutputOnly",
+ "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",
+ "properties": {
+ "errors": {
+ "description": "Number of errors since this instance was started.@OutputOnly",
+ "format": "int32",
+ "type": "integer"
+ },
"availability": {
"enumDescriptions": [
"",
@@ -2641,10 +2518,9 @@
"description": "Availability of the instance.@OutputOnly",
"type": "string"
},
- "errors": {
- "description": "Number of errors since this instance was started.@OutputOnly",
- "format": "int32",
- "type": "integer"
+ "vmStatus": {
+ "description": "Status of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment.@OutputOnly",
+ "type": "string"
},
"startTime": {
"description": "Time that this instance was started.@OutputOnly",
@@ -2668,28 +2544,32 @@
"description": "Name of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment.@OutputOnly",
"type": "string"
},
+ "vmId": {
+ "description": "Virtual machine ID of this instance. Only applicable for instances in App Engine flexible environment.@OutputOnly",
+ "type": "string"
+ },
"qps": {
"description": "Average queries per second (QPS) over the last minute.@OutputOnly",
"format": "float",
"type": "number"
},
- "vmId": {
- "description": "Virtual machine ID of this instance. Only applicable for instances in App Engine flexible environment.@OutputOnly",
+ "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"
},
- "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"
},
+ "id": {
+ "description": "Relative name of the instance within the version. Example: instance-1.@OutputOnly",
+ "type": "string"
+ },
"vmIp": {
"description": "The IP address of this instance. Only applicable for instances in App Engine flexible environment.@OutputOnly",
"type": "string"
@@ -2698,22 +2578,14 @@
"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"
}
},
- "id": "Instance",
- "description": "An Instance resource is the computing unit that App Engine uses to automatically scale an application.",
- "type": "object"
+ "id": "Instance"
},
"LivenessCheck": {
- "description": "Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances.",
- "type": "object",
"properties": {
- "host": {
- "description": "Host header to send when performing a HTTP Liveness check. Example: \"myapp.appspot.com\"",
+ "path": {
+ "description": "The request path.",
"type": "string"
},
"successThreshold": {
@@ -2721,36 +2593,36 @@
"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"
},
- "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"
}
},
- "id": "LivenessCheck"
+ "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.",
@@ -2760,10 +2632,21 @@
}
}
},
- "id": "BatchUpdateIngressRulesRequest"
+ "id": "BatchUpdateIngressRulesRequest",
+ "description": "Request message for Firewall.BatchUpdateIngressRules.",
+ "type": "object"
},
"Location": {
+ "description": "A resource that represents Google Cloud Platform location.",
+ "type": "object",
"properties": {
+ "labels": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Cross-service attributes for the location. For example\n{\"cloud.googleapis.com/region\": \"us-east1\"}\n",
+ "type": "object"
+ },
"name": {
"description": "Resource name for the location, which may vary between implementations. For example: \"projects/example-project/locations/us-east1\"",
"type": "string"
@@ -2779,21 +2662,19 @@
},
"description": "Service-specific metadata. For example the available capacity at the given location.",
"type": "object"
- },
- "labels": {
- "description": "Cross-service attributes for the location. For example\n{\"cloud.googleapis.com/region\": \"us-east1\"}\n",
- "type": "object",
- "additionalProperties": {
- "type": "string"
- }
}
},
- "id": "Location",
- "description": "A resource that represents Google Cloud Platform location.",
- "type": "object"
+ "id": "Location"
},
"NetworkUtilization": {
+ "description": "Target scaling by network usage. Only applicable in the App Engine flexible environment.",
+ "type": "object",
"properties": {
+ "targetSentBytesPerSecond": {
+ "description": "Target bytes sent per second.",
+ "format": "int32",
+ "type": "integer"
+ },
"targetSentPacketsPerSecond": {
"description": "Target packets sent per second.",
"format": "int32",
@@ -2808,19 +2689,24 @@
"description": "Target packets received per second.",
"format": "int32",
"type": "integer"
- },
- "targetSentBytesPerSecond": {
- "description": "Target bytes sent per second.",
- "format": "int32",
- "type": "integer"
}
},
- "id": "NetworkUtilization",
- "description": "Target scaling by network usage. Only applicable in the App Engine flexible environment.",
- "type": "object"
+ "id": "NetworkUtilization"
},
"HealthCheck": {
+ "description": "Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances. Only applicable for instances in App Engine flexible environment.",
+ "type": "object",
"properties": {
+ "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",
@@ -2834,35 +2720,26 @@
"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"
},
+ "restartThreshold": {
+ "description": "Number of consecutive failed health checks required before an instance is restarted.",
+ "format": "uint32",
+ "type": "integer"
+ }
+ },
+ "id": "HealthCheck"
+ },
+ "ReadinessCheck": {
+ "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"
- }
- },
- "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"
- },
- "ReadinessCheck": {
- "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",
@@ -2890,18 +2767,13 @@
"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"
+ "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": {
"targetThroughputUtilization": {
"description": "Target throughput utilization ratio to maintain when scaling",
@@ -2924,7 +2796,9 @@
"type": "number"
}
},
- "id": "StandardSchedulerSettings"
+ "id": "StandardSchedulerSettings",
+ "description": "Scheduler settings for standard environment.",
+ "type": "object"
},
"DebugInstanceRequest": {
"description": "Request message for Instances.DebugInstance.",
@@ -2938,7 +2812,13 @@
"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",
@@ -2956,50 +2836,19 @@
"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",
- "description": "Metadata for the given google.longrunning.Operation.",
- "type": "object"
+ "id": "OperationMetadataV1Beta5"
},
"Version": {
"properties": {
- "diskUsageBytes": {
- "description": "Total size in bytes of all the files that are included in this version and currently hosted on the App Engine disk.@OutputOnly",
- "format": "int64",
- "type": "string"
- },
- "healthCheck": {
- "$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": {
- "description": "Configures readiness health checking for VM instances. Unhealthy instances are not put into the backend traffic rotation.Only returned in GET requests if view=FULL is set.",
- "$ref": "ReadinessCheck"
- },
- "manualScaling": {
- "description": "A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time.",
- "$ref": "ManualScaling"
- },
- "name": {
- "description": "Full path to the Version resource in the API. Example: apps/myapp/services/default/versions/v1.@OutputOnly",
- "type": "string"
- },
"apiConfig": {
"description": "Serving configuration for Google Cloud Endpoints (https://cloud.google.com/appengine/docs/python/endpoints/).Only returned in GET requests if view=FULL is set.",
"$ref": "ApiConfigHandler"
},
"endpointsApiService": {
- "$ref": "EndpointsApiService",
- "description": "Cloud Endpoints configuration.If endpoints_api_service is set, the Cloud Endpoints Extensible Service Proxy will be provided to serve the API implemented by the app."
+ "description": "Cloud Endpoints configuration.If endpoints_api_service is set, the Cloud Endpoints Extensible Service Proxy will be provided to serve the API implemented by the app.",
+ "$ref": "EndpointsApiService"
},
"versionUrl": {
"description": "Serving URL for this version. Example: \"https://myversion-dot-myservice-dot-myapp.appspot.com\"@OutputOnly",
@@ -3014,6 +2863,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.",
@@ -3023,35 +2874,26 @@
"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.",
- "Allows an application to receive mail.",
- "Allows an application to receive email-bound notifications.",
- "Allows an application to receive error stanzas.",
- "Allows an application to receive instant messages.",
- "Allows an application to receive user subscription POSTs.",
- "Allows an application to receive a user's chat presence.",
- "Registers an application for notifications when a client connects or disconnects from a channel.",
- "Enables warmup requests."
- ],
"description": "Before an application can receive email or XMPP messages, the application must be configured to enable the service.",
"type": "array",
"items": {
@@ -3067,11 +2909,18 @@
"INBOUND_SERVICE_WARMUP"
],
"type": "string"
- }
- },
- "resources": {
- "description": "Machine resources for this version. Only applicable for VM runtimes.",
- "$ref": "Resources"
+ },
+ "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."
+ ]
},
"errorHandlers": {
"description": "Custom static error pages. Limited to 10KB per page.Only returned in GET requests if view=FULL is set.",
@@ -3097,42 +2946,42 @@
"type": "string"
},
"basicScaling": {
- "description": "A service with basic scaling will create an instance when the application receives a request. The instance will be turned down when the app becomes idle. Basic scaling is ideal for work that is intermittent or driven by user activity.",
- "$ref": "BasicScaling"
+ "$ref": "BasicScaling",
+ "description": "A service with basic scaling will create an instance when the application receives a request. The instance will be turned down when the app becomes idle. Basic scaling is ideal for work that is intermittent or driven by user activity."
},
"runtime": {
"description": "Desired runtime. Example: python27.",
"type": "string"
},
- "id": {
- "description": "Relative name of the version within the service. Example: v1. Version names can contain only lowercase letters, numbers, or hyphens. Reserved names: \"default\", \"latest\", and any name with the prefix \"ah-\".",
- "type": "string"
- },
"createdBy": {
"description": "Email address of the user who created this version.@OutputOnly",
"type": "string"
},
+ "id": {
+ "description": "Relative name of the version within the service. Example: v1. Version names can contain only lowercase letters, numbers, or hyphens. Reserved names: \"default\", \"latest\", and any name with the prefix \"ah-\".",
+ "type": "string"
+ },
"envVariables": {
- "description": "Environment variables available to the application.Only returned in GET requests if view=FULL is set.",
- "type": "object",
"additionalProperties": {
"type": "string"
- }
+ },
+ "description": "Environment variables available to the application.Only returned in GET requests if view=FULL is set.",
+ "type": "object"
},
"livenessCheck": {
- "$ref": "LivenessCheck",
- "description": "Configures liveness health checking for VM instances. Unhealthy instances are stopped and replaced with new instancesOnly returned in GET requests if view=FULL is set."
+ "description": "Configures liveness health checking for VM instances. Unhealthy instances are stopped and replaced with new instancesOnly returned in GET requests if view=FULL is set.",
+ "$ref": "LivenessCheck"
},
"network": {
"$ref": "Network",
"description": "Extra network settings. Only applicable in the App Engine flexible environment."
},
"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 for this version.Defaults to standard.",
@@ -3146,8 +2995,33 @@
}
},
"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",
+ "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": {
+ "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"
}
},
"id": "Version",
@@ -3155,10 +3029,10 @@
"type": "object"
},
"RepairApplicationRequest": {
- "properties": {},
- "id": "RepairApplicationRequest",
"description": "Request message for 'Applications.RepairApplication'.",
- "type": "object"
+ "type": "object",
+ "properties": {},
+ "id": "RepairApplicationRequest"
},
"CertificateRawData": {
"description": "An SSL certificate obtained from a certificate authority.",
@@ -3176,15 +3050,15 @@
"id": "CertificateRawData"
},
"BuildInfo": {
- "description": "Google Cloud Container Builder build information.",
- "type": "object",
"properties": {
"cloudBuildId": {
"description": "The Google Cloud Container Builder build id. Example: \"f966068f-08b2-42c8-bdfe-74137dff2bf9\"",
"type": "string"
}
},
- "id": "BuildInfo"
+ "id": "BuildInfo",
+ "description": "Google Cloud Container Builder build information.",
+ "type": "object"
},
"ScriptHandler": {
"description": "Executes a script to handle the request that matches the URL pattern.",
@@ -3198,7 +3072,13 @@
"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": {
+ "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"
@@ -3206,15 +3086,9 @@
"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",
- "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"
},
"AuthorizedDomain": {
"properties": {
@@ -3236,6 +3110,8 @@
"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.",
@@ -3247,9 +3123,7 @@
"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": {
@@ -3266,18 +3140,6 @@
"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"
@@ -3298,27 +3160,21 @@
"description": "Time that this operation completed.@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.",
+ },
+ "warning": {
+ "description": "Durable messages that persist on every operation poll. @OutputOnly",
"type": "array",
"items": {
- "$ref": "FirewallRule"
+ "type": "string"
}
},
- "nextPageToken": {
- "description": "Continuation token for fetching the next page of results.",
+ "insertTime": {
+ "description": "Time that this operation was created.@OutputOnly",
+ "format": "google-datetime",
"type": "string"
}
},
- "id": "ListIngressRulesResponse"
+ "id": "OperationMetadataV1Beta"
},
"ListServicesResponse": {
"description": "Response message for Services.ListServices.",
@@ -3338,44 +3194,28 @@
},
"id": "ListServicesResponse"
},
- "Deployment": {
- "description": "Code and application artifacts used to deploy a version to App Engine.",
- "type": "object",
+ "ListIngressRulesResponse": {
"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"
+ "nextPageToken": {
+ "description": "Continuation token for fetching the next page of results.",
+ "type": "string"
},
- "zip": {
- "description": "The zip file for this deployment, if this is a zip deployment.",
- "$ref": "ZipInfo"
- },
- "container": {
- "description": "The Docker image for the container that runs the version. Only applicable for instances running in the App Engine flexible environment.",
- "$ref": "ContainerInfo"
- },
- "build": {
- "description": "Google Cloud Container Builder build information.",
- "$ref": "BuildInfo"
+ "ingressRules": {
+ "description": "The ingress FirewallRules for this application.",
+ "type": "array",
+ "items": {
+ "$ref": "FirewallRule"
+ }
}
},
- "id": "Deployment"
+ "id": "ListIngressRulesResponse",
+ "description": "Response message for Firewall.ListIngressRules.",
+ "type": "object"
},
"Resources": {
+ "description": "Machine resources for a version.",
+ "type": "object",
"properties": {
- "cpu": {
- "description": "Number of CPU cores needed.",
- "format": "double",
- "type": "number"
- },
- "memoryGb": {
- "description": "Memory (GB) needed.",
- "format": "double",
- "type": "number"
- },
"volumes": {
"description": "User specified volumes.",
"type": "array",
@@ -3387,13 +3227,49 @@
"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": {
+ "zip": {
+ "$ref": "ZipInfo",
+ "description": "The zip file for this deployment, if this is a zip deployment."
+ },
+ "container": {
+ "description": "The Docker image for the container that runs the version. Only applicable for instances running in the App Engine flexible environment.",
+ "$ref": "ContainerInfo"
+ },
+ "build": {
+ "description": "Google Cloud Container Builder build information.",
+ "$ref": "BuildInfo"
+ },
+ "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"
},
"BatchUpdateIngressRulesResponse": {
+ "description": "Response message for Firewall.UpdateAllIngressRules.",
+ "type": "object",
"properties": {
"ingressRules": {
"description": "The full list of ingress FirewallRules for this application.",
@@ -3403,18 +3279,10 @@
}
}
},
- "id": "BatchUpdateIngressRulesResponse",
- "description": "Response message for Firewall.UpdateAllIngressRules.",
- "type": "object"
+ "id": "BatchUpdateIngressRulesResponse"
},
"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",
@@ -3423,14 +3291,25 @@
"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 in the App Engine flexible environment.",
+ "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": {
"enumDescriptions": [
"",
@@ -3452,27 +3331,22 @@
],
"description": "Status of certificate management. Refers to the most recent certificate acquisition or renewal attempt.@OutputOnly",
"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",
- "format": "google-datetime",
- "type": "string"
}
},
"id": "ManagedCertificate"
},
"ListInstancesResponse": {
"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",
@@ -3536,12 +3410,138 @@
}
},
"id": "OperationMetadataV1Alpha"
+ },
+ "UrlDispatchRule": {
+ "description": "Rules to match an HTTP request and dispatch that request to a service.",
+ "type": "object",
+ "properties": {
+ "path": {
+ "description": "Pathname within the host. Must start with a \"/\". A single \"*\" can be included at the end of the path.The sum of the lengths of the domain and path may not exceed 100 characters.",
+ "type": "string"
+ },
+ "domain": {
+ "description": "Domain name to match against. The wildcard \"*\" is supported if specified before a period: \"*.\".Defaults to matching all domains: \"*\".",
+ "type": "string"
+ },
+ "service": {
+ "description": "Resource ID of a service in this application that should serve the matched request. The service must already exist. Example: default.",
+ "type": "string"
+ }
+ },
+ "id": "UrlDispatchRule"
+ },
+ "ListVersionsResponse": {
+ "properties": {
+ "versions": {
+ "description": "The versions belonging to the requested service.",
+ "type": "array",
+ "items": {
+ "$ref": "Version"
+ }
+ },
+ "nextPageToken": {
+ "description": "Continuation token for fetching the next page of results.",
+ "type": "string"
+ }
+ },
+ "id": "ListVersionsResponse",
+ "description": "Response message for Versions.ListVersions.",
+ "type": "object"
+ },
+ "ListAuthorizedDomainsResponse": {
+ "properties": {
+ "nextPageToken": {
+ "description": "Continuation token for fetching the next page of results.",
+ "type": "string"
+ },
+ "domains": {
+ "description": "The authorized domains belonging to the user.",
+ "type": "array",
+ "items": {
+ "$ref": "AuthorizedDomain"
+ }
+ }
+ },
+ "id": "ListAuthorizedDomainsResponse",
+ "description": "Response message for AuthorizedDomains.ListAuthorizedDomains.",
+ "type": "object"
+ },
+ "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": {
+ "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"
+ }
+ }
+ },
+ "id": "DomainMapping",
+ "description": "A domain serving an App Engine application.",
+ "type": "object"
}
},
+ "protocol": "rest",
"icons": {
"x16": "http://www.google.com/images/icons/product/search-16.gif",
"x32": "http://www.google.com/images/icons/product/search-32.gif"
},
- "protocol": "rest",
- "version": "v1beta"
+ "version": "v1beta",
+ "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",
+ "documentationLink": "https://cloud.google.com/appengine/docs/admin-api/",
+ "id": "appengine:v1beta",
+ "title": "Google App Engine Admin API"
}
diff --git a/appengine/v1beta4/appengine-api.json b/appengine/v1beta4/appengine-api.json
index 769423b..413f793 100644
--- a/appengine/v1beta4/appengine-api.json
+++ b/appengine/v1beta4/appengine-api.json
@@ -1,24 +1,75 @@
{
+ "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",
+ "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": {
+ "create": {
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "parameters": {},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta4/apps",
+ "path": "v1beta4/apps",
+ "id": "appengine.apps.create",
+ "request": {
+ "$ref": "Application"
+ },
+ "description": "Creates an App Engine application for a Google Cloud Platform project. Required fields:\nid - The ID of the target Cloud Platform project.\nlocation - The region (https://cloud.google.com/appengine/docs/locations) where you want the App Engine application located.For more information about App Engine applications, see Managing Projects, Applications, and Billing (https://cloud.google.com/appengine/docs/python/console/)."
+ },
"get": {
+ "path": "v1beta4/apps/{appsId}",
+ "id": "appengine.apps.get",
"description": "Gets information about an application.",
- "httpMethod": "GET",
"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"
+ "type": "boolean",
+ "location": "query"
},
"appsId": {
"description": "Part of `name`. Name of the application to get. Example: apps/myapp.",
@@ -27,71 +78,77 @@
"location": "path"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta4/apps/{appsId}",
- "id": "appengine.apps.get",
- "path": "v1beta4/apps/{appsId}"
+ "flatPath": "v1beta4/apps/{appsId}"
},
"patch": {
- "flatPath": "v1beta4/apps/{appsId}",
- "id": "appengine.apps.patch",
- "path": "v1beta4/apps/{appsId}",
+ "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)",
"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"
},
+ "parameterOrder": [
+ "appsId"
+ ],
+ "httpMethod": "PATCH",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
"parameters": {
- "mask": {
- "description": "Standard field mask for the set of fields to be updated.",
- "format": "google-fieldmask",
- "type": "string",
- "location": "query"
- },
"appsId": {
"location": "path",
"description": "Part of `name`. Name of the Application resource to update. Example: apps/myapp.",
"required": true,
"type": "string"
+ },
+ "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"
- ]
- },
- "create": {
- "httpMethod": "POST",
- "parameterOrder": [],
- "response": {
- "$ref": "Operation"
- },
- "parameters": {},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta4/apps",
- "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/)."
+ "flatPath": "v1beta4/apps/{appsId}",
+ "path": "v1beta4/apps/{appsId}",
+ "id": "appengine.apps.patch"
}
},
"resources": {
"modules": {
"methods": {
+ "delete": {
+ "path": "v1beta4/apps/{appsId}/modules/{modulesId}",
+ "id": "appengine.apps.modules.delete",
+ "description": "Deletes the specified module and all enclosed versions.",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "appsId",
+ "modulesId"
+ ],
+ "httpMethod": "DELETE",
+ "parameters": {
+ "modulesId": {
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "required": true,
+ "type": "string"
+ },
+ "appsId": {
+ "location": "path",
+ "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/modules/default.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta4/apps/{appsId}/modules/{modulesId}"
+ },
"get": {
- "description": "Gets the current configuration of the specified module.",
- "httpMethod": "GET",
"response": {
"$ref": "Module"
},
@@ -99,6 +156,12 @@
"appsId",
"modulesId"
],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
"parameters": {
"appsId": {
"location": "path",
@@ -113,50 +176,46 @@
"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",
- "path": "v1beta4/apps/{appsId}/modules/{modulesId}"
+ "description": "Gets the current configuration of the specified module."
},
"list": {
+ "httpMethod": "GET",
"response": {
"$ref": "ListModulesResponse"
},
"parameterOrder": [
"appsId"
],
- "httpMethod": "GET",
+ "parameters": {
+ "pageSize": {
+ "description": "Maximum results to return per page.",
+ "format": "int32",
+ "type": "integer",
+ "location": "query"
+ },
+ "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"
+ }
+ },
"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": {
- "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",
+ "path": "v1beta4/apps/{appsId}/modules",
"description": "Lists all the modules in the application."
},
"patch": {
@@ -179,12 +238,6 @@
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
- "appsId": {
- "description": "Part of `name`. Name of the resource to update. Example: apps/myapp/modules/default.",
- "required": true,
- "type": "string",
- "location": "path"
- },
"migrateTraffic": {
"location": "query",
"description": "Set to true to gradually shift traffic to one or more versions that you specify. By default, traffic is shifted immediately. For gradual traffic migration, the target versions must be located within instances that are configured for both warmup requests (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta4/apps.modules.versions#inboundservicetype) and automatic scaling (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta4/apps.modules.versions#automaticscaling). You must specify the shardBy (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta4/apps.modules#shardby) field in the Module resource. Gradual traffic migration is not supported in the App Engine flexible environment. For examples, see Migrating and Splitting Traffic (https://cloud.google.com/appengine/docs/admin-api/migrating-splitting-traffic).",
@@ -201,34 +254,9 @@
"format": "google-fieldmask",
"type": "string",
"location": "query"
- }
- }
- },
- "delete": {
- "flatPath": "v1beta4/apps/{appsId}/modules/{modulesId}",
- "path": "v1beta4/apps/{appsId}/modules/{modulesId}",
- "id": "appengine.apps.modules.delete",
- "description": "Deletes the specified module and all enclosed versions.",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "appsId",
- "modulesId"
- ],
- "httpMethod": "DELETE",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "modulesId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string"
},
"appsId": {
- "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/modules/default.",
+ "description": "Part of `name`. Name of the resource to update. Example: apps/myapp/modules/default.",
"required": true,
"type": "string",
"location": "path"
@@ -239,10 +267,45 @@
"resources": {
"versions": {
"methods": {
- "get": {
+ "delete": {
+ "description": "Deletes an existing version.",
+ "httpMethod": "DELETE",
+ "parameterOrder": [
+ "appsId",
+ "modulesId",
+ "versionsId"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "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": {
+ "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}",
- "id": "appengine.apps.modules.versions.get",
- "path": "v1beta4/apps/{appsId}/modules/{modulesId}/versions/{versionsId}",
+ "id": "appengine.apps.modules.versions.delete",
+ "path": "v1beta4/apps/{appsId}/modules/{modulesId}/versions/{versionsId}"
+ },
+ "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": {
@@ -267,13 +330,13 @@
"type": "string"
},
"view": {
- "description": "Controls the set of fields returned in the Get response.",
- "type": "string",
"location": "query",
"enum": [
"BASIC",
"FULL"
- ]
+ ],
+ "description": "Controls the set of fields returned in the Get response.",
+ "type": "string"
},
"appsId": {
"location": "path",
@@ -286,10 +349,13 @@
"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}",
+ "id": "appengine.apps.modules.versions.get",
+ "path": "v1beta4/apps/{appsId}/modules/{modulesId}/versions/{versionsId}"
},
"list": {
- "httpMethod": "GET",
+ "description": "Lists the versions of a module.",
"response": {
"$ref": "ListVersionsResponse"
},
@@ -297,18 +363,35 @@
"appsId",
"modulesId"
],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
"parameters": {
+ "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": {
- "location": "query",
"description": "Maximum results to return per page.",
"format": "int32",
- "type": "integer"
+ "type": "integer",
+ "location": "query"
},
"modulesId": {
- "location": "path",
"description": "Part of `name`. See documentation of `appsId`.",
"required": true,
- "type": "string"
+ "type": "string",
+ "location": "path"
},
"view": {
"location": "query",
@@ -318,30 +401,17 @@
],
"description": "Controls the set of fields returned in the List response.",
"type": "string"
- },
- "appsId": {
- "location": "path",
- "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/modules/default.",
- "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": "v1beta4/apps/{appsId}/modules/{modulesId}/versions",
- "id": "appengine.apps.modules.versions.list",
"path": "v1beta4/apps/{appsId}/modules/{modulesId}/versions",
- "description": "Lists the versions of a module."
+ "id": "appengine.apps.modules.versions.list"
},
"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/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.",
+ "request": {
+ "$ref": "Version"
+ },
"response": {
"$ref": "Operation"
},
@@ -362,17 +432,17 @@
"location": "path"
},
"modulesId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string"
- },
- "versionsId": {
"description": "Part of `name`. See documentation of `appsId`.",
"required": true,
"type": "string",
"location": "path"
},
+ "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",
@@ -382,13 +452,12 @@
},
"flatPath": "v1beta4/apps/{appsId}/modules/{modulesId}/versions/{versionsId}",
"path": "v1beta4/apps/{appsId}/modules/{modulesId}/versions/{versionsId}",
- "id": "appengine.apps.modules.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/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.",
- "request": {
- "$ref": "Version"
- }
+ "id": "appengine.apps.modules.versions.patch"
},
"create": {
+ "flatPath": "v1beta4/apps/{appsId}/modules/{modulesId}/versions",
+ "path": "v1beta4/apps/{appsId}/modules/{modulesId}/versions",
+ "id": "appengine.apps.modules.versions.create",
"request": {
"$ref": "Version"
},
@@ -409,207 +478,20 @@
"type": "string"
},
"modulesId": {
- "location": "path",
"description": "Part of `name`. See documentation of `appsId`.",
"required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta4/apps/{appsId}/modules/{modulesId}/versions",
- "path": "v1beta4/apps/{appsId}/modules/{modulesId}/versions",
- "id": "appengine.apps.modules.versions.create"
- },
- "delete": {
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "appsId",
- "modulesId",
- "versionsId"
- ],
- "httpMethod": "DELETE",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "modulesId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string"
- },
- "versionsId": {
- "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}",
- "path": "v1beta4/apps/{appsId}/modules/{modulesId}/versions/{versionsId}",
- "id": "appengine.apps.modules.versions.delete",
- "description": "Deletes an existing version."
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
}
},
"resources": {
"instances": {
"methods": {
- "get": {
- "description": "Gets instance information.",
- "httpMethod": "GET",
- "response": {
- "$ref": "Instance"
- },
- "parameterOrder": [
- "appsId",
- "modulesId",
- "versionsId",
- "instancesId"
- ],
- "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"
- },
- "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": {
- "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}",
- "id": "appengine.apps.modules.versions.instances.get",
- "path": "v1beta4/apps/{appsId}/modules/{modulesId}/versions/{versionsId}/instances/{instancesId}"
- },
- "list": {
- "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).",
- "response": {
- "$ref": "ListInstancesResponse"
- },
- "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": {
- "appsId": {
- "location": "path",
- "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/modules/default/versions/v1.",
- "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"
- },
- "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"
- }
- }
- },
- "debug": {
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "appsId",
- "modulesId",
- "versionsId",
- "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/modules/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"
- },
- "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"
- }
- },
- "flatPath": "v1beta4/apps/{appsId}/modules/{modulesId}/versions/{versionsId}/instances/{instancesId}:debug",
- "path": "v1beta4/apps/{appsId}/modules/{modulesId}/versions/{versionsId}/instances/{instancesId}:debug",
- "id": "appengine.apps.modules.versions.instances.debug",
- "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"
- }
- },
"delete": {
"response": {
"$ref": "Operation"
@@ -621,12 +503,15 @@
"instancesId"
],
"httpMethod": "DELETE",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
"parameters": {
"modulesId": {
- "location": "path",
"description": "Part of `name`. See documentation of `appsId`.",
"required": true,
- "type": "string"
+ "type": "string",
+ "location": "path"
},
"versionsId": {
"location": "path",
@@ -635,10 +520,10 @@
"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"
+ "type": "string",
+ "location": "path"
},
"instancesId": {
"location": "path",
@@ -647,13 +532,156 @@
"type": "string"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
"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": {
+ "description": "Gets instance information.",
+ "response": {
+ "$ref": "Instance"
+ },
+ "parameterOrder": [
+ "appsId",
+ "modulesId",
+ "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/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"
+ }
+ },
+ "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"
+ },
+ "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",
+ "modulesId",
+ "versionsId"
+ ],
+ "response": {
+ "$ref": "ListInstancesResponse"
+ },
+ "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": {
+ "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",
+ "id": "appengine.apps.modules.versions.instances.list",
+ "path": "v1beta4/apps/{appsId}/modules/{modulesId}/versions/{versionsId}/instances"
+ },
+ "debug": {
+ "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": {
+ "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": {
+ "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}/instances/{instancesId}: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."
}
}
}
@@ -664,6 +692,9 @@
"operations": {
"methods": {
"list": {
+ "flatPath": "v1beta4/apps/{appsId}/operations",
+ "path": "v1beta4/apps/{appsId}/operations",
+ "id": "appengine.apps.operations.list",
"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.NOTE: the name binding allows API services to override the binding to use different resource name schemes, such as users/*/operations. To override the binding, API services can add a binding such as \"/v1/{name=users/*}/operations\" to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.",
"response": {
"$ref": "ListOperationsResponse"
@@ -672,17 +703,7 @@
"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": {
"description": "Part of `name`. The name of the operation's parent resource.",
"required": true,
@@ -690,20 +711,27 @@
"location": "path"
},
"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"
}
},
- "flatPath": "v1beta4/apps/{appsId}/operations",
- "path": "v1beta4/apps/{appsId}/operations",
- "id": "appengine.apps.operations.list"
+ "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 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.",
@@ -717,16 +745,16 @@
"httpMethod": "GET",
"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",
- "location": "path"
+ "type": "string"
}
},
"scopes": [
@@ -743,9 +771,6 @@
"locations": {
"methods": {
"list": {
- "flatPath": "v1beta4/apps/{appsId}/locations",
- "path": "v1beta4/apps/{appsId}/locations",
- "id": "appengine.apps.locations.list",
"description": "Lists information about the supported locations for this service.",
"response": {
"$ref": "ListLocationsResponse"
@@ -754,39 +779,41 @@
"appsId"
],
"httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
"parameters": {
- "pageSize": {
- "description": "The standard list page size.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- },
"filter": {
"location": "query",
"description": "The standard list filter.",
"type": "string"
},
"appsId": {
+ "location": "path",
"description": "Part of `name`. The resource that owns the locations collection, if applicable.",
"required": true,
- "type": "string",
- "location": "path"
+ "type": "string"
},
"pageToken": {
"description": "The standard list page token.",
"type": "string",
"location": "query"
+ },
+ "pageSize": {
+ "description": "The standard list page size.",
+ "format": "int32",
+ "type": "integer",
+ "location": "query"
}
- }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "flatPath": "v1beta4/apps/{appsId}/locations",
+ "path": "v1beta4/apps/{appsId}/locations",
+ "id": "appengine.apps.locations.list"
},
"get": {
"description": "Get information about a location.",
- "httpMethod": "GET",
"response": {
"$ref": "Location"
},
@@ -794,18 +821,19 @@
"appsId",
"locationsId"
],
+ "httpMethod": "GET",
"parameters": {
+ "appsId": {
+ "location": "path",
+ "description": "Part of `name`. Resource name for the location.",
+ "required": true,
+ "type": "string"
+ },
"locationsId": {
"description": "Part of `name`. See documentation of `appsId`.",
"required": true,
"type": "string",
"location": "path"
- },
- "appsId": {
- "description": "Part of `name`. Resource name for the location.",
- "required": true,
- "type": "string",
- "location": "path"
}
},
"scopes": [
@@ -814,8 +842,8 @@
"https://www.googleapis.com/auth/cloud-platform.read-only"
],
"flatPath": "v1beta4/apps/{appsId}/locations/{locationsId}",
- "id": "appengine.apps.locations.get",
- "path": "v1beta4/apps/{appsId}/locations/{locationsId}"
+ "path": "v1beta4/apps/{appsId}/locations/{locationsId}",
+ "id": "appengine.apps.locations.get"
}
}
}
@@ -823,78 +851,46 @@
}
},
"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": {
- "location": "query",
- "description": "OAuth bearer token.",
- "type": "string"
- },
"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",
- "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": {
+ "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"
- },
- "callback": {
- "location": "query",
- "description": "JSONP",
- "type": "string"
+ "type": "string",
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query"
},
"alt": {
- "type": "string",
"enumDescriptions": [
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
@@ -907,10 +903,348 @@
"json",
"media",
"proto"
- ]
+ ],
+ "type": "string"
+ },
+ "access_token": {
+ "location": "query",
+ "description": "OAuth access token.",
+ "type": "string"
+ },
+ "key": {
+ "location": "query",
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "type": "string"
+ },
+ "quotaUser": {
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "type": "string",
+ "location": "query"
+ },
+ "pp": {
+ "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"
}
},
"schemas": {
+ "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": {
+ "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"
+ },
+ "oauth2ClientSecretSha256": {
+ "description": "Hex-encoded SHA-256 hash of the client secret.@OutputOnly",
+ "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"
+ },
+ "TrafficSplit": {
+ "properties": {
+ "shardBy": {
+ "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"
+ ],
+ "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 module to fractional (0.000, 1] allocations of traffic for that version. Each version can be specified only once, but some versions in the module may not have any traffic allocation. Modules that have traffic allocated cannot be deleted until either the module is deleted or their traffic allocation is removed. Allocations must sum to 1. Up to two decimal place precision is supported for IP-based splits and up to three decimal places is supported for cookie-based splits.",
+ "type": "object"
+ }
+ },
+ "id": "TrafficSplit",
+ "description": "Traffic routing configuration for versions within a single module. Traffic splits define how traffic directed to the module is assigned to versions.",
+ "type": "object"
+ },
+ "ManualScaling": {
+ "properties": {
+ "instances": {
+ "description": "Number of instances to assign to the module at the start. This number can later be altered by using the Modules API (https://cloud.google.com/appengine/docs/python/modules/functions) set_num_instances() function.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "ManualScaling",
+ "description": "A module with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time.",
+ "type": "object"
+ },
+ "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"
+ },
+ "OperationMetadataV1Beta": {
+ "description": "Metadata for the given google.longrunning.Operation.",
+ "type": "object",
+ "properties": {
+ "ephemeralMessage": {
+ "description": "Ephemeral message that may change every time the operation is polled. @OutputOnly",
+ "type": "string"
+ },
+ "method": {
+ "description": "API method that initiated this operation. Example: google.appengine.v1beta.Versions.CreateVersion.@OutputOnly",
+ "type": "string"
+ },
+ "endTime": {
+ "description": "Time that this operation completed.@OutputOnly",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "warning": {
+ "description": "Durable messages that persist on every operation poll. @OutputOnly",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "insertTime": {
+ "description": "Time that this operation was created.@OutputOnly",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "user": {
+ "description": "User who requested this operation.@OutputOnly",
+ "type": "string"
+ },
+ "target": {
+ "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly",
+ "type": "string"
+ }
+ },
+ "id": "OperationMetadataV1Beta"
+ },
+ "ListModulesResponse": {
+ "description": "Response message for Modules.ListModules.",
+ "type": "object",
+ "properties": {
+ "nextPageToken": {
+ "description": "Continuation token for fetching the next page of results.",
+ "type": "string"
+ },
+ "modules": {
+ "description": "The modules belonging to the requested application.",
+ "type": "array",
+ "items": {
+ "$ref": "Module"
+ }
+ }
+ },
+ "id": "ListModulesResponse"
+ },
+ "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"
+ },
+ "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"
+ },
+ "sourceReferences": {
+ "description": "Origin of the source code for this deployment. There can be more than one source reference per version if source code is distributed among multiple repositories.",
+ "type": "array",
+ "items": {
+ "$ref": "SourceReference"
+ }
+ },
+ "files": {
+ "additionalProperties": {
+ "$ref": "FileInfo"
+ },
+ "description": "Manifest of the files stored in Google Cloud Storage that are included as part of this version. All files must be readable using the credentials supplied with this call.",
+ "type": "object"
+ }
+ },
+ "id": "Deployment"
+ },
+ "Volume": {
+ "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",
+ "description": "Volumes mounted within the app container. Only applicable for VM runtimes.",
+ "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": {
+ "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"
+ },
+ "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",
+ "description": "Metadata for the given google.longrunning.Operation.",
+ "type": "object"
+ },
"ListInstancesResponse": {
"description": "Response message for Instances.ListInstances.",
"type": "object",
@@ -929,6 +1263,46 @@
},
"id": "ListInstancesResponse"
},
+ "OperationMetadataV1": {
+ "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.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"
+ }
+ },
+ "id": "OperationMetadataV1"
+ },
"ErrorHandler": {
"description": "Custom static error page to be served when an error occurs.",
"type": "object",
@@ -962,46 +1336,6 @@
},
"id": "ErrorHandler"
},
- "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"
- },
"OperationMetadataV1Alpha": {
"description": "Metadata for the given google.longrunning.Operation.",
"type": "object",
@@ -1042,40 +1376,10 @@
},
"id": "OperationMetadataV1Alpha"
},
- "Network": {
- "description": "Extra network settings. Only applicable for VM runtimes.",
- "type": "object",
- "properties": {
- "forwardedPorts": {
- "description": "List of ports, or port pairs, to forward from the virtual machine to the application container.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "instanceTag": {
- "description": "Tag to apply to the VM instance during creation.",
- "type": "string"
- },
- "name": {
- "description": "Google Cloud Platform network where the virtual machines are created. Specify the short name, not the resource path.Defaults to default.",
- "type": "string"
- }
- },
- "id": "Network"
- },
"Application": {
"description": "An Application resource contains the top-level configuration of an App Engine application.",
"type": "object",
"properties": {
- "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"
},
@@ -1110,33 +1414,58 @@
"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"
}
},
"id": "Application"
},
- "UrlDispatchRule": {
- "description": "Rules to match an HTTP request and dispatch that request to a module.",
+ "Network": {
+ "description": "Extra network settings. Only applicable for VM runtimes.",
"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.",
+ "forwardedPorts": {
+ "description": "List of ports, or port pairs, to forward from the virtual machine to the application container.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "instanceTag": {
+ "description": "Tag to apply to the VM instance during creation.",
"type": "string"
},
- "domain": {
- "description": "Domain name to match against. The wildcard \"*\" is supported if specified before a period: \"*.\".Defaults to matching all domains: \"*\".",
- "type": "string"
- },
- "module": {
- "description": "Resource ID of a module in this application that should serve the matched request. The module must already exist. Example: default.",
+ "name": {
+ "description": "Google Cloud Platform network where the virtual machines are created. Specify the short name, not the resource path.Defaults to default.",
"type": "string"
}
},
- "id": "UrlDispatchRule"
+ "id": "Network"
},
"Instance": {
"description": "An Instance resource is the computing unit that App Engine uses to automatically scale an application.",
"type": "object",
"properties": {
+ "requests": {
+ "description": "Number of requests since this instance was started.@OutputOnly",
+ "format": "int32",
+ "type": "integer"
+ },
+ "appEngineRelease": {
+ "description": "App Engine release this instance is running on.@OutputOnly",
+ "type": "string"
+ },
+ "startTimestamp": {
+ "description": "Time that this instance was started.@OutputOnly",
+ "format": "google-datetime",
+ "type": "string"
+ },
"vmName": {
"description": "Name of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment.@OutputOnly",
"type": "string"
@@ -1150,10 +1479,6 @@
"format": "float",
"type": "number"
},
- "vmZoneName": {
- "description": "Zone where the virtual machine is located. 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"
@@ -1162,6 +1487,10 @@
"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",
+ "type": "string"
+ },
"averageLatency": {
"description": "Average latency (ms) over the last minute.@OutputOnly",
"format": "int32",
@@ -1186,6 +1515,8 @@
"type": "integer"
},
"availability": {
+ "description": "Availability of the instance.@OutputOnly",
+ "type": "string",
"enumDescriptions": [
"",
"",
@@ -1195,31 +1526,53 @@
"UNSPECIFIED",
"RESIDENT",
"DYNAMIC"
- ],
- "description": "Availability of the instance.@OutputOnly",
- "type": "string"
+ ]
},
"vmStatus": {
"description": "Status of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment.@OutputOnly",
"type": "string"
- },
- "requests": {
- "description": "Number of requests since this instance was started.@OutputOnly",
- "format": "int32",
- "type": "integer"
- },
- "appEngineRelease": {
- "description": "App Engine release this instance is running on.@OutputOnly",
- "type": "string"
- },
- "startTimestamp": {
- "description": "Time that this instance was started.@OutputOnly",
- "format": "google-datetime",
- "type": "string"
}
},
"id": "Instance"
},
+ "UrlDispatchRule": {
+ "properties": {
+ "domain": {
+ "description": "Domain name to match against. The wildcard \"*\" is supported if specified before a period: \"*.\".Defaults to matching all domains: \"*\".",
+ "type": "string"
+ },
+ "module": {
+ "description": "Resource ID of a module in this application that should serve the matched request. The module must already exist. Example: default.",
+ "type": "string"
+ },
+ "path": {
+ "description": "Pathname within the host. Must start with a \"/\". A single \"*\" can be included at the end of the path. The sum of the lengths of the domain and path may not exceed 100 characters.",
+ "type": "string"
+ }
+ },
+ "id": "UrlDispatchRule",
+ "description": "Rules to match an HTTP request and dispatch that request to a module.",
+ "type": "object"
+ },
+ "Module": {
+ "description": "A Module resource is a logical component of an application that can share state and communicate in a secure fashion with other modules. For example, an application that handles customer requests might include separate modules to handle tasks such as backend data analysis or API requests from mobile devices. Each module has a collection of versions that define a specific set of code used to implement the functionality of that module.",
+ "type": "object",
+ "properties": {
+ "split": {
+ "$ref": "TrafficSplit",
+ "description": "Mapping that defines fractional HTTP traffic diversion to different versions within the module."
+ },
+ "id": {
+ "description": "Relative name of the module within the application. Example: default.@OutputOnly",
+ "type": "string"
+ },
+ "name": {
+ "description": "Full path to the Module resource in the API. Example: apps/myapp/modules/default.@OutputOnly",
+ "type": "string"
+ }
+ },
+ "id": "Module"
+ },
"ListVersionsResponse": {
"description": "Response message for Versions.ListVersions.",
"type": "object",
@@ -1238,40 +1591,29 @@
},
"id": "ListVersionsResponse"
},
- "Module": {
- "description": "A Module resource is a logical component of an application that can share state and communicate in a secure fashion with other modules. For example, an application that handles customer requests might include separate modules to handle tasks such as backend data analysis or API requests from mobile devices. Each module has a collection of versions that define a specific set of code used to implement the functionality of that module.",
- "type": "object",
- "properties": {
- "name": {
- "description": "Full path to the Module resource in the API. Example: apps/myapp/modules/default.@OutputOnly",
- "type": "string"
- },
- "split": {
- "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",
- "type": "string"
- }
- },
- "id": "Module"
- },
"ApiEndpointHandler": {
- "description": "Uses Google Cloud Endpoints to handle requests.",
- "type": "object",
"properties": {
"scriptPath": {
"description": "Path to the script from the application root directory.",
"type": "string"
}
},
- "id": "ApiEndpointHandler"
+ "id": "ApiEndpointHandler",
+ "description": "Uses Google Cloud Endpoints to handle requests.",
+ "type": "object"
},
"StaticDirectoryHandler": {
"description": "Files served directly to the user for a given URL, such as images, CSS stylesheets, or JavaScript source files. Static directory handlers make it easy to serve the entire contents of a directory as static files.",
"type": "object",
"properties": {
+ "mimeType": {
+ "description": "MIME type used to serve all files served by this handler. Defaults to file-specific MIME types, which are direved from each file's filename extension.",
+ "type": "string"
+ },
+ "requireMatchingFile": {
+ "description": "Whether this handler should match the request if the file referenced by the handler does not exist.",
+ "type": "boolean"
+ },
"expiration": {
"description": "Time a static file served by this handler should be cached.",
"format": "google-duration",
@@ -1291,14 +1633,6 @@
"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"
- },
- "requireMatchingFile": {
- "description": "Whether this handler should match the request if the file referenced by the handler does not exist.",
- "type": "boolean"
}
},
"id": "StaticDirectoryHandler"
@@ -1307,47 +1641,20 @@
"description": "Automatic scaling is based on request rate, response latencies, and other application metrics.",
"type": "object",
"properties": {
- "networkUtilization": {
- "$ref": "NetworkUtilization",
- "description": "Target scaling by network usage."
- },
- "coolDownPeriod": {
- "description": "Amount of time that the Autoscaler (https://cloud.google.com/compute/docs/autoscaler/) should wait between changes to the number of virtual machines. Only applicable for VM runtimes.",
- "format": "google-duration",
- "type": "string"
- },
- "maxConcurrentRequests": {
- "description": "Number of concurrent requests an automatic scaling instance can accept before the scheduler spawns a new instance.Defaults to a runtime-specific value.",
- "format": "int32",
- "type": "integer"
- },
- "maxPendingLatency": {
- "description": "Maximum amount of time that a request should wait in the pending queue before starting a new instance to handle it.",
- "format": "google-duration",
- "type": "string"
- },
- "cpuUtilization": {
- "description": "Target scaling by CPU usage.",
- "$ref": "CpuUtilization"
- },
- "diskUtilization": {
- "$ref": "DiskUtilization",
- "description": "Target scaling by disk usage."
- },
"minPendingLatency": {
"description": "Minimum amount of time a request should wait in the pending queue before starting a new instance to handle it.",
"format": "google-duration",
"type": "string"
},
+ "requestUtilization": {
+ "$ref": "RequestUtilization",
+ "description": "Target scaling by request utilization."
+ },
"maxIdleInstances": {
"description": "Maximum number of idle instances that should be maintained for this version.",
"format": "int32",
"type": "integer"
},
- "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",
@@ -1362,13 +1669,38 @@
"description": "Minimum number of instances that should be maintained for this version.",
"format": "int32",
"type": "integer"
+ },
+ "networkUtilization": {
+ "description": "Target scaling by network usage.",
+ "$ref": "NetworkUtilization"
+ },
+ "maxConcurrentRequests": {
+ "description": "Number of concurrent requests an automatic scaling instance can accept before the scheduler spawns a new instance.Defaults to a runtime-specific value.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "coolDownPeriod": {
+ "description": "Amount of time that the Autoscaler (https://cloud.google.com/compute/docs/autoscaler/) should wait between changes to the number of virtual machines. Only applicable for VM runtimes.",
+ "format": "google-duration",
+ "type": "string"
+ },
+ "maxPendingLatency": {
+ "description": "Maximum amount of time that a request should wait in the pending queue before starting a new instance to handle it.",
+ "format": "google-duration",
+ "type": "string"
+ },
+ "cpuUtilization": {
+ "description": "Target scaling by CPU usage.",
+ "$ref": "CpuUtilization"
+ },
+ "diskUtilization": {
+ "$ref": "DiskUtilization",
+ "description": "Target scaling by disk usage."
}
},
"id": "AutomaticScaling"
},
"NetworkUtilization": {
- "description": "Target scaling by network usage. Only applicable for VM runtimes.",
- "type": "object",
"properties": {
"targetReceivedBytesPerSec": {
"description": "Target bytes received per second.",
@@ -1391,34 +1723,36 @@
"type": "integer"
}
},
- "id": "NetworkUtilization"
+ "id": "NetworkUtilization",
+ "description": "Target scaling by network usage. Only applicable for VM runtimes.",
+ "type": "object"
},
"Location": {
"description": "A resource that represents Google Cloud Platform location.",
"type": "object",
"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"
- }
- },
- "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"
+ },
+ "description": "Service-specific metadata. For example the available capacity at the given location.",
+ "type": "object"
}
},
"id": "Location"
@@ -1427,20 +1761,6 @@
"description": "Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances. Only applicable for instances in App Engine flexible environment.",
"type": "object",
"properties": {
- "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",
@@ -1459,10 +1779,39 @@
"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"
}
},
"id": "HealthCheck"
},
+ "SourceReference": {
+ "description": "Reference to a particular snapshot of the source tree used to build and deploy the application.",
+ "type": "object",
+ "properties": {
+ "revisionId": {
+ "description": "The canonical, persistent identifier of the deployed revision. Aliases that include tags or branch names are not allowed. Example (git): \"2198322f89e0bb2e25021667c2ed489d1fd34e6b\"",
+ "type": "string"
+ },
+ "repository": {
+ "description": "URI string identifying the repository. Example: \"https://source.developers.google.com/p/app-123/r/default\"",
+ "type": "string"
+ }
+ },
+ "id": "SourceReference"
+ },
"DebugInstanceRequest": {
"description": "Request message for Instances.DebugInstance.",
"type": "object",
@@ -1474,20 +1823,20 @@
},
"id": "DebugInstanceRequest"
},
- "SourceReference": {
- "description": "Reference to a particular snapshot of the source tree used to build and deploy the application.",
- "type": "object",
+ "Library": {
"properties": {
- "repository": {
- "description": "URI string identifying the repository. Example: \"https://source.developers.google.com/p/app-123/r/default\"",
+ "name": {
+ "description": "Name of the library. Example: \"django\".",
"type": "string"
},
- "revisionId": {
- "description": "The canonical, persistent identifier of the deployed revision. Aliases that include tags or branch names are not allowed. Example (git): \"2198322f89e0bb2e25021667c2ed489d1fd34e6b\"",
+ "version": {
+ "description": "Version of the library to select, or \"latest\".",
"type": "string"
}
},
- "id": "SourceReference"
+ "id": "Library",
+ "description": "Third-party Python runtime library that is required by the application.",
+ "type": "object"
},
"OperationMetadataV1Beta5": {
"description": "Metadata for the given google.longrunning.Operation.",
@@ -1518,35 +1867,20 @@
},
"id": "OperationMetadataV1Beta5"
},
- "Library": {
- "description": "Third-party Python runtime library that is required by the application.",
- "type": "object",
- "properties": {
- "name": {
- "description": "Name of the library. Example: \"django\".",
- "type": "string"
- },
- "version": {
- "description": "Version of the library to select, or \"latest\".",
- "type": "string"
- }
- },
- "id": "Library"
- },
"ListLocationsResponse": {
"description": "The response message for Locations.ListLocations.",
"type": "object",
"properties": {
+ "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"
@@ -1555,13 +1889,6 @@
"description": "A Version resource is a specific set of source code and configuration files that are deployed into a module.",
"type": "object",
"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",
@@ -1574,15 +1901,15 @@
"$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"
},
- "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 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"
@@ -1607,11 +1934,11 @@
"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.",
@@ -1641,8 +1968,8 @@
"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."
+ "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",
@@ -1653,8 +1980,8 @@
"$ref": "ApiConfigHandler"
},
"endpointsApiService": {
- "$ref": "EndpointsApiService",
- "description": "Cloud Endpoints configuration.If endpoints_api_service is set, the Cloud Endpoints Extensible Service Proxy will be provided to serve the API implemented by the app."
+ "description": "Cloud Endpoints configuration.If endpoints_api_service is set, the Cloud Endpoints Extensible Service Proxy will be provided to serve the API implemented by the app.",
+ "$ref": "EndpointsApiService"
},
"vm": {
"description": "Whether to deploy this version in a container on a virtual machine.",
@@ -1686,10 +2013,6 @@
"description": "Code and application artifacts that make up this version.Only returned in GET requests if view=FULL is set.",
"$ref": "Deployment"
},
- "resources": {
- "$ref": "Resources",
- "description": "Machine resources for this version. Only applicable for VM runtimes."
- },
"inboundServices": {
"enumDescriptions": [
"Not specified.",
@@ -1718,6 +2041,17 @@
"INBOUND_SERVICE_WARMUP"
]
}
+ },
+ "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"
+ }
}
},
"id": "Version"
@@ -1754,6 +2088,32 @@
"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": {
+ "description": "Serves the entire contents of a directory as static files.This attribute is deprecated. You can mimic the behavior of static directories using static files.",
+ "$ref": "StaticDirectoryHandler"
+ },
+ "staticFiles": {
+ "description": "Returns the contents of a file, such as an image, as the response.",
+ "$ref": "StaticFilesHandler"
+ },
+ "redirectHttpResponseCode": {
+ "enum": [
+ "REDIRECT_HTTP_RESPONSE_CODE_UNSPECIFIED",
+ "REDIRECT_HTTP_RESPONSE_CODE_301",
+ "REDIRECT_HTTP_RESPONSE_CODE_302",
+ "REDIRECT_HTTP_RESPONSE_CODE_303",
+ "REDIRECT_HTTP_RESPONSE_CODE_307"
+ ],
+ "description": "30x code to use when performing redirects for the secure field. Defaults to 302.",
+ "type": "string",
+ "enumDescriptions": [
+ "Not specified. 302 is assumed.",
+ "301 Moved Permanently code.",
+ "302 Moved Temporarily code.",
+ "303 See Other code.",
+ "307 Temporary Redirect code."
+ ]
+ },
"securityLevel": {
"enumDescriptions": [
"Not specified.",
@@ -1773,8 +2133,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.",
@@ -1784,23 +2142,19 @@
"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": "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",
@@ -1808,44 +2162,22 @@
"LOGIN_REQUIRED"
],
"description": "Level of login required to access this resource.",
- "type": "string"
+ "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"
- },
- "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": {
- "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"
+ "$ref": "ApiEndpointHandler",
+ "description": "Uses API Endpoints to handle requests."
}
},
"id": "UrlMap"
},
"EndpointsApiService": {
- "description": "Cloud Endpoints (https://cloud.google.com/endpoints) configuration. The Endpoints API Service provides tooling for serving Open API and gRPC endpoints via an NGINX proxy.The fields here refer to the name and configuration id of a \"service\" resource in the Service Management API (https://cloud.google.com/service-management/overview).",
- "type": "object",
"properties": {
"name": {
"description": "Endpoints service name which is the name of the \"service\" resource in the Service Management API. For example \"myapi.endpoints.myproject.cloud.goog\"",
@@ -1856,75 +2188,24 @@
"type": "string"
}
},
- "id": "EndpointsApiService"
- },
- "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 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"
- },
- "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"
+ "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"
},
"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"
@@ -1940,45 +2221,101 @@
"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"
},
- "FileInfo": {
- "description": "Single source file that is part of the version to be deployed. Each source file that is deployed must be specified separately.",
+ "ApiConfigHandler": {
+ "description": "Google Cloud Endpoints (https://cloud.google.com/appengine/docs/python/endpoints/) configuration for API handlers.",
"type": "object",
"properties": {
- "sha1Sum": {
- "description": "The SHA1 hash of the file, in hex.",
+ "script": {
+ "description": "Path to the script from the application root directory.",
"type": "string"
},
- "mimeType": {
- "description": "The MIME type of the file.Defaults to the value from Google Cloud Storage.",
+ "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"
},
- "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'.",
+ "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"
}
},
- "id": "FileInfo"
+ "id": "ApiConfigHandler"
+ },
+ "ScriptHandler": {
+ "properties": {
+ "scriptPath": {
+ "description": "Path to the script from the application root directory.",
+ "type": "string"
+ }
+ },
+ "id": "ScriptHandler",
+ "description": "Executes a script to handle the request that matches the URL pattern.",
+ "type": "object"
},
"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": {
+ "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"
@@ -1999,58 +2336,28 @@
"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"
}
},
"id": "StaticFilesHandler"
},
- "ScriptHandler": {
- "description": "Executes a script to handle the request that matches the URL pattern.",
+ "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": {
- "scriptPath": {
- "description": "Path to the script from the application root directory.",
+ "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": "ScriptHandler"
- },
- "DiskUtilization": {
- "description": "Target scaling by disk usage. Only applicable for VM runtimes.",
- "type": "object",
- "properties": {
- "targetWriteBytesPerSec": {
- "description": "Target bytes written per second.",
- "format": "int32",
- "type": "integer"
- },
- "targetReadOpsPerSec": {
- "description": "Target ops read per second.",
- "format": "int32",
- "type": "integer"
- },
- "targetReadBytesPerSec": {
- "description": "Target bytes read per second.",
- "format": "int32",
- "type": "integer"
- },
- "targetWriteOpsPerSec": {
- "description": "Target ops written per second.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "DiskUtilization"
+ "id": "FileInfo"
},
"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.",
@@ -2069,344 +2376,37 @@
},
"id": "BasicScaling"
},
- "CpuUtilization": {
- "description": "Target scaling by CPU usage.",
+ "DiskUtilization": {
+ "description": "Target scaling by disk usage. Only applicable for VM runtimes.",
"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": {
- "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"
- },
- "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": {
- "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.",
+ "targetReadBytesPerSec": {
+ "description": "Target bytes read per second.",
"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"
- },
- "TrafficSplit": {
- "description": "Traffic routing configuration for versions within a single module. Traffic splits define how traffic directed to the module 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.",
- "Diversion based on applying the modulus operation to a fingerprint of the IP address."
- ],
- "enum": [
- "UNSPECIFIED",
- "COOKIE",
- "IP"
- ]
+ "targetWriteOpsPerSec": {
+ "description": "Target ops written per second.",
+ "format": "int32",
+ "type": "integer"
},
- "allocations": {
- "additionalProperties": {
- "format": "double",
- "type": "number"
- },
- "description": "Mapping from version IDs within the module to fractional (0.000, 1] allocations of traffic for that version. Each version can be specified only once, but some versions in the module may not have any traffic allocation. Modules that have traffic allocated cannot be deleted until either the module is deleted or their traffic allocation is removed. Allocations must sum to 1. Up to two decimal place precision is supported for IP-based splits and up to three decimal places is supported for cookie-based splits.",
- "type": "object"
- }
- },
- "id": "TrafficSplit"
- },
- "ManualScaling": {
- "description": "A module with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time.",
- "type": "object",
- "properties": {
- "instances": {
- "description": "Number of instances to assign to the module at the start. This number can later be altered by using the Modules API (https://cloud.google.com/appengine/docs/python/modules/functions) set_num_instances() function.",
+ "targetWriteBytesPerSec": {
+ "description": "Target bytes written per second.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "targetReadOpsPerSec": {
+ "description": "Target ops read per second.",
"format": "int32",
"type": "integer"
}
},
- "id": "ManualScaling"
- },
- "LocationMetadata": {
- "description": "Metadata for the given google.cloud.location.Location.",
- "type": "object",
- "properties": {
- "flexibleEnvironmentAvailable": {
- "description": "App Engine Flexible Environment is available in the given location.@OutputOnly",
- "type": "boolean"
- },
- "standardEnvironmentAvailable": {
- "description": "App Engine Standard Environment is available in the given location.@OutputOnly",
- "type": "boolean"
- }
- },
- "id": "LocationMetadata"
- },
- "OperationMetadataV1Beta": {
- "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",
- "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.v1beta.Versions.CreateVersion.@OutputOnly",
- "type": "string"
- },
- "endTime": {
- "description": "Time that this operation completed.@OutputOnly",
- "format": "google-datetime",
- "type": "string"
- }
- },
- "id": "OperationMetadataV1Beta"
- },
- "ListModulesResponse": {
- "description": "Response message for Modules.ListModules.",
- "type": "object",
- "properties": {
- "nextPageToken": {
- "description": "Continuation token for fetching the next page of results.",
- "type": "string"
- },
- "modules": {
- "description": "The modules belonging to the requested application.",
- "type": "array",
- "items": {
- "$ref": "Module"
- }
- }
- },
- "id": "ListModulesResponse"
- },
- "Resources": {
- "description": "Machine resources for a version.",
- "type": "object",
- "properties": {
- "volumes": {
- "description": "User specified volumes.",
- "type": "array",
- "items": {
- "$ref": "Volume"
- }
- },
- "diskGb": {
- "description": "Disk size (GB) needed.",
- "format": "double",
- "type": "number"
- },
- "cpu": {
- "description": "Number of CPU cores needed.",
- "format": "double",
- "type": "number"
- },
- "memoryGb": {
- "description": "Memory (GB) needed.",
- "format": "double",
- "type": "number"
- }
- },
- "id": "Resources"
- },
- "Deployment": {
- "description": "Code and application artifacts used to deploy a version to App Engine.",
- "type": "object",
- "properties": {
- "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": {
- "description": "The Docker image for the container that runs the version. Only applicable for instances running in the App Engine flexible environment.",
- "$ref": "ContainerInfo"
- },
- "sourceReferences": {
- "description": "Origin of the source code for this deployment. There can be more than one source reference per version if source code is distributed among multiple repositories.",
- "type": "array",
- "items": {
- "$ref": "SourceReference"
- }
- }
- },
- "id": "Deployment"
- },
- "Volume": {
- "description": "Volumes mounted within the app container. Only applicable for VM runtimes.",
- "type": "object",
- "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"
- },
- "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"
- },
- "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"
- },
- "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"
+ "id": "DiskUtilization"
}
},
+ "protocol": "rest",
"icons": {
"x32": "http://www.google.com/images/icons/product/search-32.gif",
"x16": "http://www.google.com/images/icons/product/search-16.gif"
- },
- "protocol": "rest",
- "version": "v1beta4",
- "baseUrl": "https://appengine.googleapis.com/",
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/cloud-platform.read-only": {
- "description": "View your data across Google Cloud Platform services"
- },
- "https://www.googleapis.com/auth/cloud-platform": {
- "description": "View and manage your data across Google Cloud Platform services"
- },
- "https://www.googleapis.com/auth/appengine.admin": {
- "description": "View and manage your applications deployed on Google App Engine"
- }
- }
- }
- },
- "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"
+ }
}
diff --git a/appengine/v1beta5/appengine-api.json b/appengine/v1beta5/appengine-api.json
index 6d3d1f5..f91ffcc 100644
--- a/appengine/v1beta5/appengine-api.json
+++ b/appengine/v1beta5/appengine-api.json
@@ -1,10 +1,11 @@
{
- "ownerName": "Google",
- "discoveryVersion": "v1",
"resources": {
"apps": {
"methods": {
"get": {
+ "flatPath": "v1beta5/apps/{appsId}",
+ "path": "v1beta5/apps/{appsId}",
+ "id": "appengine.apps.get",
"description": "Gets information about an application.",
"response": {
"$ref": "Application"
@@ -15,31 +16,22 @@
"httpMethod": "GET",
"parameters": {
"ensureResourcesExist": {
- "location": "query",
"description": "Certain resources associated with an application are created on-demand. Controls whether these resources should be created when performing the GET operation. If specified and any resources could not be created, the request will fail with an error code. Additionally, this parameter can cause the request to take longer to complete. Note: This parameter will be deprecated in a future version of the API.",
- "type": "boolean"
+ "type": "boolean",
+ "location": "query"
},
"appsId": {
+ "location": "path",
"description": "Part of `name`. Name of the application to get. Example: apps/myapp.",
"required": true,
- "type": "string",
- "location": "path"
+ "type": "string"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta5/apps/{appsId}",
- "path": "v1beta5/apps/{appsId}",
- "id": "appengine.apps.get"
+ ]
},
"patch": {
- "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)",
"response": {
"$ref": "Operation"
},
@@ -47,24 +39,30 @@
"appsId"
],
"httpMethod": "PATCH",
- "parameters": {
- "appsId": {
- "description": "Part of `name`. Name of the Application resource to update. Example: apps/myapp.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "mask": {
- "description": "Standard field mask for the set of fields to be updated.",
- "format": "google-fieldmask",
- "type": "string",
- "location": "query"
- }
- },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
- "flatPath": "v1beta5/apps/{appsId}"
+ "parameters": {
+ "appsId": {
+ "location": "path",
+ "description": "Part of `name`. Name of the Application resource to update. Example: apps/myapp.",
+ "required": true,
+ "type": "string"
+ },
+ "mask": {
+ "location": "query",
+ "description": "Standard field mask for the set of fields to be updated.",
+ "format": "google-fieldmask",
+ "type": "string"
+ }
+ },
+ "flatPath": "v1beta5/apps/{appsId}",
+ "path": "v1beta5/apps/{appsId}",
+ "id": "appengine.apps.patch",
+ "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)",
+ "request": {
+ "$ref": "Application"
+ }
},
"create": {
"response": {
@@ -89,6 +87,7 @@
"locations": {
"methods": {
"list": {
+ "description": "Lists information about the supported locations for this service.",
"response": {
"$ref": "ListLocationsResponse"
},
@@ -96,6 +95,11 @@
"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.",
@@ -103,34 +107,31 @@
"location": "query"
},
"appsId": {
- "location": "path",
"description": "Part of `name`. The resource that owns the locations collection, if applicable.",
"required": true,
- "type": "string"
+ "type": "string",
+ "location": "path"
},
"pageToken": {
- "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",
- "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": "v1beta5/apps/{appsId}/locations",
"path": "v1beta5/apps/{appsId}/locations",
- "id": "appengine.apps.locations.list",
- "description": "Lists information about the supported locations for this service."
+ "id": "appengine.apps.locations.list"
},
"get": {
+ "path": "v1beta5/apps/{appsId}/locations/{locationsId}",
+ "id": "appengine.apps.locations.get",
+ "description": "Get information about a location.",
"response": {
"$ref": "Location"
},
@@ -147,10 +148,10 @@
"type": "string"
},
"appsId": {
+ "location": "path",
"description": "Part of `name`. Resource name for the location.",
"required": true,
- "type": "string",
- "location": "path"
+ "type": "string"
}
},
"scopes": [
@@ -158,10 +159,7 @@
"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."
+ "flatPath": "v1beta5/apps/{appsId}/locations/{locationsId}"
}
}
},
@@ -176,62 +174,63 @@
"servicesId"
],
"httpMethod": "DELETE",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
"parameters": {
+ "servicesId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
"appsId": {
"description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default.",
"required": true,
"type": "string",
"location": "path"
- },
- "servicesId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string"
}
},
+ "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": {
- "httpMethod": "GET",
+ "response": {
+ "$ref": "Service"
+ },
"parameterOrder": [
"appsId",
"servicesId"
],
- "response": {
- "$ref": "Service"
- },
- "parameters": {
- "appsId": {
- "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "servicesId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string"
- }
- },
+ "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}",
- "id": "appengine.apps.services.get",
"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"
},
@@ -239,6 +238,11 @@
"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",
@@ -247,9 +251,9 @@
"type": "string"
},
"pageToken": {
+ "location": "query",
"description": "Continuation token for fetching the next page of results.",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"pageSize": {
"location": "query",
@@ -258,25 +262,19 @@
"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": "v1beta5/apps/{appsId}/services",
"path": "v1beta5/apps/{appsId}/services",
- "id": "appengine.apps.services.list",
- "description": "Lists all the services in the application."
+ "id": "appengine.apps.services.list"
},
"patch": {
- "response": {
- "$ref": "Operation"
- },
+ "httpMethod": "PATCH",
"parameterOrder": [
"appsId",
"servicesId"
],
- "httpMethod": "PATCH",
+ "response": {
+ "$ref": "Operation"
+ },
"parameters": {
"appsId": {
"location": "path",
@@ -290,10 +288,10 @@
"type": "boolean"
},
"mask": {
- "location": "query",
"description": "Standard field mask for the set of fields to be updated.",
"format": "google-fieldmask",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"servicesId": {
"location": "path",
@@ -306,8 +304,8 @@
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v1beta5/apps/{appsId}/services/{servicesId}",
- "path": "v1beta5/apps/{appsId}/services/{servicesId}",
"id": "appengine.apps.services.patch",
+ "path": "v1beta5/apps/{appsId}/services/{servicesId}",
"request": {
"$ref": "Service"
},
@@ -320,6 +318,10 @@
"instances": {
"methods": {
"delete": {
+ "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.delete",
+ "description": "Stops a running instance.",
"response": {
"$ref": "Operation"
},
@@ -330,6 +332,9 @@
"instancesId"
],
"httpMethod": "DELETE",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
"parameters": {
"servicesId": {
"location": "path",
@@ -338,31 +343,24 @@
"type": "string"
},
"appsId": {
- "location": "path",
"description": "Part of `name`. Name of the resource requested. For example: \"apps/myapp/services/default/versions/v1/instances/instance-1\".",
"required": true,
- "type": "string"
- },
- "instancesId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
"type": "string",
"location": "path"
},
+ "instancesId": {
+ "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": "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.delete",
- "description": "Stops a running instance."
+ }
},
"get": {
"httpMethod": "GET",
@@ -376,6 +374,12 @@
"$ref": "Instance"
},
"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/instances/instance-1.",
"required": true,
@@ -383,18 +387,12 @@
"location": "path"
},
"instancesId": {
+ "location": "path",
"description": "Part of `name`. See documentation of `appsId`.",
"required": true,
- "type": "string",
- "location": "path"
+ "type": "string"
},
"versionsId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "servicesId": {
"location": "path",
"description": "Part of `name`. See documentation of `appsId`.",
"required": true,
@@ -423,34 +421,34 @@
],
"httpMethod": "GET",
"parameters": {
- "appsId": {
+ "servicesId": {
"location": "path",
- "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1.",
+ "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"
+ },
"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"
+ "type": "integer",
+ "location": "query"
},
"versionsId": {
+ "location": "path",
"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"
+ "type": "string"
}
},
"scopes": [
@@ -463,16 +461,16 @@
"id": "appengine.apps.services.versions.instances.list"
},
"debug": {
- "httpMethod": "POST",
+ "response": {
+ "$ref": "Operation"
+ },
"parameterOrder": [
"appsId",
"servicesId",
"versionsId",
"instancesId"
],
- "response": {
- "$ref": "Operation"
- },
+ "httpMethod": "POST",
"parameters": {
"servicesId": {
"description": "Part of `name`. See documentation of `appsId`.",
@@ -481,10 +479,10 @@
"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",
- "location": "path"
+ "type": "string"
},
"instancesId": {
"description": "Part of `name`. See documentation of `appsId`.",
@@ -503,8 +501,8 @@
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v1beta5/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}:debug",
- "id": "appengine.apps.services.versions.instances.debug",
"path": "v1beta5/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}:debug",
+ "id": "appengine.apps.services.versions.instances.debug",
"request": {
"$ref": "DebugInstanceRequest"
},
@@ -515,22 +513,19 @@
},
"methods": {
"delete": {
- "httpMethod": "DELETE",
+ "response": {
+ "$ref": "Operation"
+ },
"parameterOrder": [
"appsId",
"servicesId",
"versionsId"
],
- "response": {
- "$ref": "Operation"
- },
+ "httpMethod": "DELETE",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
"parameters": {
- "servicesId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string",
- "location": "path"
- },
"appsId": {
"description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1.",
"required": true,
@@ -538,44 +533,34 @@
"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/cloud-platform"
- ],
"flatPath": "v1beta5/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
- "id": "appengine.apps.services.versions.delete",
"path": "v1beta5/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
+ "id": "appengine.apps.services.versions.delete",
"description": "Deletes an existing version."
},
"get": {
- "description": "Gets the specified Version resource. By default, only a BASIC_VIEW will be returned. Specify the FULL_VIEW parameter to get the full resource.",
"httpMethod": "GET",
+ "response": {
+ "$ref": "Version"
+ },
"parameterOrder": [
"appsId",
"servicesId",
"versionsId"
],
- "response": {
- "$ref": "Version"
- },
"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`.",
@@ -583,13 +568,25 @@
"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": {
+ "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1.",
+ "required": true,
"type": "string",
- "location": "query"
+ "location": "path"
}
},
"scopes": [
@@ -599,23 +596,33 @@
],
"flatPath": "v1beta5/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
"id": "appengine.apps.services.versions.get",
- "path": "v1beta5/apps/{appsId}/services/{servicesId}/versions/{versionsId}"
+ "path": "v1beta5/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."
},
"list": {
- "httpMethod": "GET",
+ "flatPath": "v1beta5/apps/{appsId}/services/{servicesId}/versions",
+ "path": "v1beta5/apps/{appsId}/services/{servicesId}/versions",
+ "id": "appengine.apps.services.versions.list",
+ "description": "Lists the versions of a service.",
+ "response": {
+ "$ref": "ListVersionsResponse"
+ },
"parameterOrder": [
"appsId",
"servicesId"
],
- "response": {
- "$ref": "ListVersionsResponse"
- },
+ "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"
+ "type": "string",
+ "location": "path"
},
"appsId": {
"location": "path",
@@ -624,9 +631,9 @@
"type": "string"
},
"pageToken": {
+ "location": "query",
"description": "Continuation token for fetching the next page of results.",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"pageSize": {
"description": "Maximum results to return per page.",
@@ -635,39 +642,26 @@
"location": "query"
},
"view": {
+ "description": "Controls the set of fields returned in the List response.",
+ "type": "string",
"location": "query",
"enum": [
"BASIC",
"FULL"
- ],
- "description": "Controls the set of fields returned in the List response.",
- "type": "string"
+ ]
}
- },
- "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",
- "id": "appengine.apps.services.versions.list",
- "path": "v1beta5/apps/{appsId}/services/{servicesId}/versions",
- "description": "Lists the versions of a service."
+ }
},
"patch": {
- "request": {
- "$ref": "Version"
- },
- "description": "Updates the specified Version resource. You can specify the following fields depending on the App Engine environment and type of scaling that the version resource uses:\nserving_status (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta5/apps.services.versions#Version.FIELDS.serving_status): For Version resources that use basic scaling, manual scaling, or run in the App Engine flexible environment.\ninstance_class (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta5/apps.services.versions#Version.FIELDS.instance_class): For Version resources that run in the App Engine standard environment.\nautomatic_scaling.min_idle_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta5/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine standard environment.\nautomatic_scaling.max_idle_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta5/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine standard environment.",
- "response": {
- "$ref": "Operation"
- },
+ "httpMethod": "PATCH",
"parameterOrder": [
"appsId",
"servicesId",
"versionsId"
],
- "httpMethod": "PATCH",
+ "response": {
+ "$ref": "Operation"
+ },
"parameters": {
"servicesId": {
"location": "path",
@@ -698,38 +692,42 @@
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v1beta5/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
+ "id": "appengine.apps.services.versions.patch",
"path": "v1beta5/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/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": {
- "httpMethod": "POST",
+ "response": {
+ "$ref": "Operation"
+ },
"parameterOrder": [
"appsId",
"servicesId"
],
- "response": {
- "$ref": "Operation"
- },
+ "httpMethod": "POST",
"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"
+ "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",
- "id": "appengine.apps.services.versions.create",
"path": "v1beta5/apps/{appsId}/services/{servicesId}/versions",
+ "id": "appengine.apps.services.versions.create",
"request": {
"$ref": "Version"
},
@@ -754,20 +752,20 @@
"httpMethod": "GET",
"parameters": {
"filter": {
- "location": "query",
"description": "The standard list filter.",
- "type": "string"
+ "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",
"description": "The standard list page token.",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"pageSize": {
"location": "query",
@@ -784,9 +782,6 @@
"flatPath": "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"
},
@@ -795,26 +790,29 @@
"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": {
- "description": "Part of `name`. The name of the operation resource.",
- "required": true,
- "type": "string",
- "location": "path"
- },
"operationsId": {
"description": "Part of `name`. See documentation of `appsId`.",
"required": true,
"type": "string",
"location": "path"
+ },
+ "appsId": {
+ "description": "Part of `name`. The name of the operation resource.",
+ "required": true,
+ "type": "string",
+ "location": "path"
}
},
- "flatPath": "v1beta5/apps/{appsId}/operations/{operationsId}"
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "flatPath": "v1beta5/apps/{appsId}/operations/{operationsId}",
+ "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."
}
}
}
@@ -822,41 +820,35 @@
}
},
"parameters": {
- "fields": {
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string",
- "location": "query"
- },
"uploadType": {
"location": "query",
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"type": "string"
},
- "callback": {
- "description": "JSONP",
- "type": "string",
- "location": "query"
+ "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",
+ "enum": [
+ "1",
+ "2"
+ ]
+ },
+ "callback": {
+ "description": "JSONP",
+ "type": "string",
"location": "query"
},
"alt": {
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query",
"description": "Data format for response.",
"default": "json",
"enum": [
@@ -864,11 +856,12 @@
"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",
+ "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": {
@@ -876,32 +869,37 @@
"description": "OAuth access token.",
"type": "string"
},
- "quotaUser": {
+ "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": {
+ "description": "Available 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": {
+ "bearer_token": {
"location": "query",
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "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.",
@@ -910,394 +908,6 @@
}
},
"schemas": {
- "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"
- },
- "Resources": {
- "description": "Machine resources for a version.",
- "type": "object",
- "properties": {
- "volumes": {
- "description": "Volumes mounted within the app container.",
- "type": "array",
- "items": {
- "$ref": "Volume"
- }
- },
- "diskGb": {
- "description": "Disk size (GB) needed.",
- "format": "double",
- "type": "number"
- },
- "cpu": {
- "description": "Number of CPU cores needed.",
- "format": "double",
- "type": "number"
- },
- "memoryGb": {
- "description": "Memory (GB) needed.",
- "format": "double",
- "type": "number"
- }
- },
- "id": "Resources"
- },
- "Deployment": {
- "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"
- },
- "sourceReferences": {
- "description": "Origin of the source code for this deployment. There can be more than one source reference per version if source code is distributed among multiple repositories.",
- "type": "array",
- "items": {
- "$ref": "SourceReference"
- }
- },
- "files": {
- "additionalProperties": {
- "$ref": "FileInfo"
- },
- "description": "Manifest of the files stored in Google Cloud Storage that are included as part of this version. All files must be readable using the credentials supplied with this call.",
- "type": "object"
- }
- },
- "id": "Deployment",
- "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": {
- "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"
- },
- "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": {
- "$ref": "TrafficSplit",
- "description": "Mapping that defines fractional HTTP traffic diversion to different versions within the service."
- }
- },
- "id": "Service",
- "description": "A Service resource is a logical component of an application that can share state and communicate in a secure fashion with other services. For example, an application that handles customer requests might include separate services to handle other tasks such as API requests from mobile devices or backend data analysis. Each service has a collection of versions that define a specific set of code used to implement the functionality of that service.",
- "type": "object"
- },
- "ListOperationsResponse": {
- "description": "The response message for Operations.ListOperations.",
- "type": "object",
- "properties": {
- "nextPageToken": {
- "description": "The standard List next-page token.",
- "type": "string"
- },
- "operations": {
- "description": "A list of operations that matches the specified filter in the request.",
- "type": "array",
- "items": {
- "$ref": "Operation"
- }
- }
- },
- "id": "ListOperationsResponse"
- },
- "OperationMetadata": {
- "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",
- "description": "Metadata for the given google.longrunning.Operation.",
- "type": "object"
- },
- "ListInstancesResponse": {
- "properties": {
- "instances": {
- "description": "The instances belonging to the requested version.",
- "type": "array",
- "items": {
- "$ref": "Instance"
- }
- },
- "nextPageToken": {
- "description": "Continuation token for fetching the next page of results.",
- "type": "string"
- }
- },
- "id": "ListInstancesResponse",
- "description": "Response message for Instances.ListInstances.",
- "type": "object"
- },
- "ErrorHandler": {
- "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",
- "description": "Custom static error page to be served when an error occurs.",
- "type": "object"
- },
- "OperationMetadataV1": {
- "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.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"
- },
- "OperationMetadataV1Alpha": {
- "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",
- "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": "OperationMetadataV1Alpha",
- "description": "Metadata for the given google.longrunning.Operation.",
- "type": "object"
- },
- "Network": {
- "properties": {
- "forwardedPorts": {
- "description": "List of ports, or port pairs, to forward from the virtual machine to the application container.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "instanceTag": {
- "description": "Tag to apply to the VM instance during creation.",
- "type": "string"
- },
- "subnetworkName": {
- "description": "Google Cloud Platform sub-network where the virtual machines are created. Specify the short name, not the resource path.If a subnetwork name is specified, a network name will also be required unless it is for the default network.\nIf the network the VM instance is being created in is a Legacy network, then the IP address is allocated from the IPv4Range.\nIf the network the VM instance is being created in is an auto Subnet Mode Network, then only network name should be specified (not the subnetwork_name) and the IP address is created from the IPCidrRange of the subnetwork that exists in that zone for that network.\nIf the network the VM instance is being created in is a custom Subnet Mode Network, then the subnetwork_name must be specified and the IP address is created from the IPCidrRange of the subnetwork.If specified, the subnetwork must exist in the same region as the Flex app.",
- "type": "string"
- },
- "name": {
- "description": "Google Cloud Platform network where the virtual machines are created. Specify the short name, not the resource path.Defaults to default.",
- "type": "string"
- }
- },
- "id": "Network",
- "description": "Extra network settings. Only applicable for VM runtimes.",
- "type": "object"
- },
- "Application": {
- "description": "An Application resource contains the top-level configuration of an App Engine application.",
- "type": "object",
- "properties": {
- "defaultBucket": {
- "description": "A Google Cloud Storage bucket that can be used by the application to store content.@OutputOnly",
- "type": "string"
- },
- "dispatchRules": {
- "description": "HTTP path dispatch rules for requests to the application that do not explicitly target a service or version. Rules are order-dependent.@OutputOnly",
- "type": "array",
- "items": {
- "$ref": "UrlDispatchRule"
- }
- },
- "defaultHostname": {
- "description": "Hostname used to reach the application, as resolved by App Engine.@OutputOnly",
- "type": "string"
- },
- "name": {
- "description": "Full path to the Application resource in the API. Example: apps/myapp.@OutputOnly",
- "type": "string"
- },
- "iap": {
- "$ref": "IdentityAwareProxy"
- },
- "authDomain": {
- "description": "Google Apps authentication domain that controls which users can access this application.Defaults to open access for any Google Account.",
- "type": "string"
- },
- "id": {
- "description": "Identifier of the Application resource. This identifier is equivalent to the project ID of the Google Cloud Platform project where you want to deploy your application. Example: myapp.",
- "type": "string"
- },
- "defaultCookieExpiration": {
- "description": "Cookie expiration policy for this application.",
- "format": "google-duration",
- "type": "string"
- },
- "codeBucket": {
- "description": "A Google Cloud Storage bucket that can be used for storing files associated with this application. This bucket is associated with the application and can be used by the gcloud deployment commands.@OutputOnly",
- "type": "string"
- },
- "location": {
- "description": "Location from which this application will be run. Application instances will run out of data centers in the chosen location, which is also where all of the application's end user content is stored.Defaults to us-central.Options are:us-central - Central USeurope-west - Western Europeus-east1 - Eastern US",
- "type": "string"
- }
- },
- "id": "Application"
- },
- "UrlDispatchRule": {
- "description": "Rules to match an HTTP request and dispatch that request to a service.",
- "type": "object",
- "properties": {
- "domain": {
- "description": "Domain name to match against. The wildcard \"*\" is supported if specified before a period: \"*.\".Defaults to matching all domains: \"*\".",
- "type": "string"
- },
- "service": {
- "description": "Resource id of a service in this application that should serve the matched request. The service must already exist. Example: default.",
- "type": "string"
- },
- "path": {
- "description": "Pathname within the host. Must start with a \"/\". A single \"*\" can be included at the end of the path. The sum of the lengths of the domain and path may not exceed 100 characters.",
- "type": "string"
- }
- },
- "id": "UrlDispatchRule"
- },
"Instance": {
"description": "An Instance resource is the computing unit that App Engine uses to automatically scale an application.",
"type": "object",
@@ -1320,25 +930,25 @@
"description": "Name of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment.@OutputOnly",
"type": "string"
},
+ "vmId": {
+ "description": "Virtual machine ID of this instance. Only applicable for instances in App Engine flexible environment.@OutputOnly",
+ "type": "string"
+ },
"qps": {
"description": "Average queries per second (QPS) over the last minute.@OutputOnly",
"format": "float",
"type": "number"
},
- "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",
+ "vmZoneName": {
+ "description": "Zone where the virtual machine is located. 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",
+ "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": {
@@ -1346,8 +956,8 @@
"format": "int32",
"type": "integer"
},
- "vmIp": {
- "description": "The IP address of this instance. Only applicable for instances in App Engine flexible environment.@OutputOnly",
+ "id": {
+ "description": "Relative name of the instance within the version. Example: instance-1.@OutputOnly",
"type": "string"
},
"memoryUsage": {
@@ -1355,8 +965,8 @@
"format": "int64",
"type": "string"
},
- "id": {
- "description": "Relative name of the instance within the version. Example: instance-1.@OutputOnly",
+ "vmIp": {
+ "description": "The IP address of this instance. Only applicable for instances in App Engine flexible environment.@OutputOnly",
"type": "string"
},
"errors": {
@@ -1365,6 +975,8 @@
"type": "integer"
},
"availability": {
+ "description": "Availability of the instance.@OutputOnly",
+ "type": "string",
"enumDescriptions": [
"",
"",
@@ -1374,9 +986,7 @@
"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",
@@ -1385,18 +995,37 @@
},
"id": "Instance"
},
- "ListVersionsResponse": {
+ "UrlDispatchRule": {
+ "description": "Rules to match an HTTP request and dispatch that request to a service.",
+ "type": "object",
"properties": {
- "nextPageToken": {
- "description": "Continuation token for fetching the next page of results.",
+ "path": {
+ "description": "Pathname within the host. Must start with a \"/\". A single \"*\" can be included at the end of the path. The sum of the lengths of the domain and path may not exceed 100 characters.",
"type": "string"
},
+ "domain": {
+ "description": "Domain name to match against. The wildcard \"*\" is supported if specified before a period: \"*.\".Defaults to matching all domains: \"*\".",
+ "type": "string"
+ },
+ "service": {
+ "description": "Resource id of a service in this application that should serve the matched request. The service must already exist. Example: default.",
+ "type": "string"
+ }
+ },
+ "id": "UrlDispatchRule"
+ },
+ "ListVersionsResponse": {
+ "properties": {
"versions": {
"description": "The versions belonging to the requested service.",
"type": "array",
"items": {
"$ref": "Version"
}
+ },
+ "nextPageToken": {
+ "description": "Continuation token for fetching the next page of results.",
+ "type": "string"
}
},
"id": "ListVersionsResponse",
@@ -1418,15 +1047,6 @@
"description": "Automatic scaling is based on request rate, response latencies, and other application metrics.",
"type": "object",
"properties": {
- "diskUtilization": {
- "description": "Target scaling by disk usage.",
- "$ref": "DiskUtilization"
- },
- "minPendingLatency": {
- "description": "Minimum amount of time a request should wait in the pending queue before starting a new instance to handle it.",
- "format": "google-duration",
- "type": "string"
- },
"requestUtilization": {
"description": "Target scaling by request utilization.",
"$ref": "RequestUtilization"
@@ -1471,13 +1091,24 @@
"type": "string"
},
"cpuUtilization": {
- "$ref": "CpuUtilization",
- "description": "Target scaling by CPU usage."
+ "description": "Target scaling by CPU usage.",
+ "$ref": "CpuUtilization"
+ },
+ "diskUtilization": {
+ "$ref": "DiskUtilization",
+ "description": "Target scaling by disk usage."
+ },
+ "minPendingLatency": {
+ "description": "Minimum amount of time a request should wait in the pending queue before starting a new instance to handle it.",
+ "format": "google-duration",
+ "type": "string"
}
},
"id": "AutomaticScaling"
},
"NetworkUtilization": {
+ "description": "Target scaling by network usage. Only applicable for VM runtimes.",
+ "type": "object",
"properties": {
"targetSentBytesPerSec": {
"description": "Target bytes sent per second.",
@@ -1500,29 +1131,21 @@
"type": "integer"
}
},
- "id": "NetworkUtilization",
- "description": "Target scaling by network usage. Only applicable for VM runtimes.",
- "type": "object"
+ "id": "NetworkUtilization"
},
"Location": {
- "description": "A resource that represents Google Cloud Platform location.",
- "type": "object",
"properties": {
- "name": {
- "description": "Resource name for the location, which may vary between implementations. For example: \"projects/example-project/locations/us-east1\"",
- "type": "string"
- },
"locationId": {
"description": "The canonical id for this location. For example: \"us-east1\".",
"type": "string"
},
"metadata": {
+ "description": "Service-specific metadata. For example the available capacity at the given location.",
+ "type": "object",
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
- },
- "description": "Service-specific metadata. For example the available capacity at the given location.",
- "type": "object"
+ }
},
"labels": {
"additionalProperties": {
@@ -1530,11 +1153,19 @@
},
"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"
+ "id": "Location",
+ "description": "A resource that represents Google Cloud Platform location.",
+ "type": "object"
},
"HealthCheck": {
+ "description": "Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances. Only applicable for instances in App Engine flexible environment.",
+ "type": "object",
"properties": {
"disableHealthCheck": {
"description": "Whether to explicitly disable health checks for this instance.",
@@ -1570,9 +1201,22 @@
"type": "integer"
}
},
- "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"
+ "id": "HealthCheck"
+ },
+ "SourceReference": {
+ "description": "Reference to a particular snapshot of the source tree used to build and deploy the application.",
+ "type": "object",
+ "properties": {
+ "revisionId": {
+ "description": "The canonical, persistent identifier of the deployed revision. Aliases that include tags or branch names are not allowed. Example (git): \"2198322f89e0bb2e25021667c2ed489d1fd34e6b\"",
+ "type": "string"
+ },
+ "repository": {
+ "description": "URI string identifying the repository. Example: \"https://source.developers.google.com/p/app-123/r/default\"",
+ "type": "string"
+ }
+ },
+ "id": "SourceReference"
},
"DebugInstanceRequest": {
"description": "Request message for Instances.DebugInstance.",
@@ -1585,33 +1229,10 @@
},
"id": "DebugInstanceRequest"
},
- "SourceReference": {
- "description": "Reference to a particular snapshot of the source tree used to build and deploy the application.",
- "type": "object",
- "properties": {
- "repository": {
- "description": "URI string identifying the repository. Example: \"https://source.developers.google.com/p/app-123/r/default\"",
- "type": "string"
- },
- "revisionId": {
- "description": "The canonical, persistent identifier of the deployed revision. Aliases that include tags or branch names are not allowed. Example (git): \"2198322f89e0bb2e25021667c2ed489d1fd34e6b\"",
- "type": "string"
- }
- },
- "id": "SourceReference"
- },
"OperationMetadataV1Beta5": {
"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"
@@ -1625,11 +1246,21 @@
"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"
},
"Library": {
+ "description": "Third-party Python runtime library that is required by the application.",
+ "type": "object",
"properties": {
"name": {
"description": "Name of the library. Example: \"django\".",
@@ -1640,87 +1271,41 @@
"type": "string"
}
},
- "id": "Library",
- "description": "Third-party Python runtime library that is required by the application.",
- "type": "object"
+ "id": "Library"
},
"ListLocationsResponse": {
- "description": "The response message for Locations.ListLocations.",
- "type": "object",
"properties": {
- "nextPageToken": {
- "description": "The standard List next-page token.",
- "type": "string"
- },
"locations": {
"description": "A list of locations that matches the specified filter in the request.",
"type": "array",
"items": {
"$ref": "Location"
}
+ },
+ "nextPageToken": {
+ "description": "The standard List next-page token.",
+ "type": "string"
}
},
- "id": "ListLocationsResponse"
+ "id": "ListLocationsResponse",
+ "description": "The response message for Locations.ListLocations.",
+ "type": "object"
+ },
+ "ContainerInfo": {
+ "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",
+ "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"
},
"Version": {
"description": "A Version resource is a specific set of source code and configuration files that are deployed into a service.",
"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 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"
- },
- "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",
@@ -1750,8 +1335,8 @@
"type": "boolean"
},
"manualScaling": {
- "$ref": "ManualScaling",
- "description": "A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time."
+ "description": "A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time.",
+ "$ref": "ManualScaling"
},
"name": {
"description": "Full path to the Version resource in the API. Example: apps/myapp/services/default/versions/v1.@OutputOnly",
@@ -1762,8 +1347,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.",
@@ -1774,32 +1359,39 @@
"type": "string"
},
"servingStatus": {
+ "enumDescriptions": [
+ "Not specified.",
+ "Currently serving. Instances are created according to the scaling settings of the version.",
+ "Disabled from serving. No instances will be created and the scaling settings are ignored until the state of the version changes to SERVING."
+ ],
"enum": [
"SERVING_STATUS_UNSPECIFIED",
"SERVING",
"STOPPED"
],
"description": "Current serving status of this version. Only the versions with a SERVING status create instances and can be billed.SERVING_STATUS_UNSPECIFIED is an invalid value. Defaults to SERVING.",
- "type": "string",
- "enumDescriptions": [
- "Not specified.",
- "Currently serving. Instances are created according to the scaling settings of the version.",
- "Disabled from serving. No instances will be created and the scaling settings are ignored until the state of the version changes to SERVING."
- ]
- },
- "deployment": {
- "$ref": "Deployment",
- "description": "Code and application artifacts that make up this version.Only returned in GET requests if view=FULL is set."
+ "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"
},
- "resources": {
- "description": "Machine resources for this version. Only applicable for VM runtimes.",
- "$ref": "Resources"
+ "deployment": {
+ "description": "Code and application artifacts that make up this version.Only returned in GET requests if view=FULL is set.",
+ "$ref": "Deployment"
},
"inboundServices": {
+ "enumDescriptions": [
+ "Not specified.",
+ "Allows an application to receive mail.",
+ "Allows an application to receive email-bound notifications.",
+ "Allows an application to receive error stanzas.",
+ "Allows an application to receive instant messages.",
+ "Allows an application to receive user subscription POSTs.",
+ "Allows an application to receive a user's chat presence.",
+ "Registers an application for notifications when a client connects or disconnects from a channel.",
+ "Enables warmup requests."
+ ],
"description": "Before an application can receive email or XMPP messages, the application must be configured to enable the service.",
"type": "array",
"items": {
@@ -1815,18 +1407,11 @@
"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.",
@@ -1834,20 +1419,64 @@
"items": {
"$ref": "ErrorHandler"
}
- }
- },
- "id": "Version"
- },
- "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\"",
+ },
+ "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": {
+ "$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": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Environment variables made available to the application.Only returned in GET requests if view=FULL is set.",
+ "type": "object"
+ },
+ "network": {
+ "description": "Extra network settings. Only applicable for VM runtimes.",
+ "$ref": "Network"
+ },
+ "betaSettings": {
+ "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"
}
},
- "id": "ContainerInfo"
+ "id": "Version"
},
"RequestUtilization": {
"description": "Target scaling by request utilization. Only applicable for VM runtimes.",
@@ -1866,8 +1495,29 @@
},
"id": "RequestUtilization"
},
- "UrlMap": {
+ "EndpointsApiService": {
+ "description": "Cloud Endpoints (https://cloud.google.com/endpoints) configuration. The Endpoints API Service provides tooling for serving Open API and gRPC endpoints via an NGINX proxy.The fields here refer to the name and configuration id of a \"service\" resource in the Service Management API (https://cloud.google.com/service-management/overview).",
+ "type": "object",
"properties": {
+ "name": {
+ "description": "Endpoints service name which is the name of the \"service\" resource in the Service Management API. For example \"myapi.endpoints.myproject.cloud.goog\"",
+ "type": "string"
+ },
+ "configId": {
+ "description": "Endpoints service configuration id as specified by the Service Management API. For example \"2016-09-19r1\"By default, the Endpoints service configuration id is fixed and config_id must be specified. To keep the Endpoints service configuration id updated with each rollout, specify RolloutStrategy.MANAGED and omit config_id.",
+ "type": "string"
+ }
+ },
+ "id": "EndpointsApiService"
+ },
+ "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": {
+ "description": "Returns the contents of a file, such as an image, as the response.",
+ "$ref": "StaticFilesHandler"
+ },
"redirectHttpResponseCode": {
"enumDescriptions": [
"Not specified. 302 is assumed.",
@@ -1887,13 +1537,6 @@
"type": "string"
},
"securityLevel": {
- "enum": [
- "SECURE_UNSPECIFIED",
- "SECURE_DEFAULT",
- "SECURE_NEVER",
- "SECURE_OPTIONAL",
- "SECURE_ALWAYS"
- ],
"description": "Security (HTTPS) enforcement for this URL.",
"type": "string",
"enumDescriptions": [
@@ -1902,9 +1545,18 @@
"Requests for a URL that match this handler that use HTTPS are automatically redirected to the HTTP equivalent URL.",
"Both HTTP and HTTPS requests with URLs that match the handler succeed without redirects. The application can examine the request to determine which protocol was used and respond accordingly.",
"Requests for a URL that match this handler that do not use HTTPS are automatically redirected to the HTTPS URL with the same path. Query parameters are reserved for the redirect."
+ ],
+ "enum": [
+ "SECURE_UNSPECIFIED",
+ "SECURE_DEFAULT",
+ "SECURE_NEVER",
+ "SECURE_OPTIONAL",
+ "SECURE_ALWAYS"
]
},
"authFailAction": {
+ "description": "Action to take when users access resources that require authentication. Defaults to redirect.",
+ "type": "string",
"enumDescriptions": [
"Not specified. AUTH_FAIL_ACTION_REDIRECT is assumed.",
"Redirects user to \"accounts.google.com\". The user is redirected back to the application URL after signing in or creating an account.",
@@ -1914,19 +1566,23 @@
"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": "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 action given in auth_fail_action is taken."
+ ],
"enum": [
"LOGIN_UNSPECIFIED",
"LOGIN_OPTIONAL",
@@ -1934,46 +1590,51 @@
"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 action given in auth_fail_action is taken."
- ]
+ "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."
+ "description": "Uses API Endpoints to handle requests.",
+ "$ref": "ApiEndpointHandler"
}
},
- "id": "UrlMap",
- "description": "URL pattern and description of how the URL should be handled. App Engine can handle URLs by executing application code, or by serving static files uploaded with the version, such as images, CSS, or JavaScript.",
- "type": "object"
- },
- "EndpointsApiService": {
- "description": "Cloud Endpoints (https://cloud.google.com/endpoints) configuration. The Endpoints API Service provides tooling for serving Open API and gRPC endpoints via an NGINX proxy.The fields here refer to the name and configuration id of a \"service\" resource in the Service Management API (https://cloud.google.com/service-management/overview).",
- "type": "object",
- "properties": {
- "name": {
- "description": "Endpoints service name which is the name of the \"service\" resource in the Service Management API. For example \"myapi.endpoints.myproject.cloud.goog\"",
- "type": "string"
- },
- "configId": {
- "description": "Endpoints service configuration id as specified by the Service Management API. For example \"2016-09-19r1\"By default, the Endpoints service configuration id is fixed and config_id must be specified. To keep the Endpoints service configuration id updated with each rollout, specify RolloutStrategy.MANAGED and omit config_id.",
- "type": "string"
- }
- },
- "id": "EndpointsApiService"
+ "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": {
+ "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."
+ ],
+ "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"
@@ -1997,38 +1658,6 @@
"url": {
"description": "URL to serve the endpoint at.",
"type": "string"
- },
- "securityLevel": {
- "enum": [
- "SECURE_UNSPECIFIED",
- "SECURE_DEFAULT",
- "SECURE_NEVER",
- "SECURE_OPTIONAL",
- "SECURE_ALWAYS"
- ],
- "description": "Security (HTTPS) enforcement for this URL.",
- "type": "string",
- "enumDescriptions": [
- "Not specified.",
- "Both HTTP and HTTPS requests with URLs that match the handler succeed without redirects. The application can examine the request to determine which protocol was used, and respond accordingly.",
- "Requests for a URL that match this handler that use HTTPS are automatically redirected to the HTTP equivalent URL.",
- "Both HTTP and HTTPS requests with URLs that match the handler succeed without redirects. The application can examine the request to determine which protocol was used and respond accordingly.",
- "Requests for a URL that match this handler that do not use HTTPS are automatically redirected to the HTTPS URL with the same path. Query parameters are reserved for the redirect."
- ]
- },
- "authFailAction": {
- "enum": [
- "AUTH_FAIL_ACTION_UNSPECIFIED",
- "AUTH_FAIL_ACTION_REDIRECT",
- "AUTH_FAIL_ACTION_UNAUTHORIZED"
- ],
- "description": "Action to take when users access resources that require authentication. Defaults to redirect.",
- "type": "string",
- "enumDescriptions": [
- "Not specified. AUTH_FAIL_ACTION_REDIRECT is assumed.",
- "Redirects user to \"accounts.google.com\". The user is redirected back to the application URL after signing in or creating an account.",
- "Rejects request with an401 HTTP status code and an error message."
- ]
}
},
"id": "ApiConfigHandler"
@@ -2037,18 +1666,6 @@
"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"
@@ -2064,16 +1681,26 @@
"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"
},
"FileInfo": {
+ "description": "Single source file that is part of the version to be deployed. Each source file that is deployed must be specified separately.",
+ "type": "object",
"properties": {
- "sourceUrl": {
- "description": "URL source to use to fetch this file. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googleapis.com/\u003cbucket\u003e/\u003cobject\u003e'.",
- "type": "string"
- },
"sha1Sum": {
"description": "The SHA1 hash of the file, in hex.",
"type": "string"
@@ -2081,27 +1708,21 @@
"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",
- "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"
},
"StaticFilesHandler": {
"properties": {
- "requireMatchingFile": {
- "description": "Whether this handler should match the request if the file referenced by the handler does not exist.",
- "type": "boolean"
- },
"expiration": {
"description": "Time a static file served by this handler should be cached.",
"format": "google-duration",
"type": "string"
},
- "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"
@@ -2109,6 +1730,10 @@
"description": "HTTP headers to use for all responses from these URLs.",
"type": "object"
},
+ "applicationReadable": {
+ "description": "Whether files should also be uploaded as code data. By default, files declared in static file handlers are uploaded as static data and are only served to end users; they cannot be read by the application. If enabled, uploads are charged against both your code and static data storage resource quotas.",
+ "type": "boolean"
+ },
"uploadPathRegex": {
"description": "Regular expression that matches the file paths for all files that should be referenced by this handler.",
"type": "string"
@@ -2120,6 +1745,10 @@
"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",
@@ -2127,20 +1756,42 @@
"type": "object"
},
"ScriptHandler": {
- "description": "Executes a script to handle the request that matches the URL pattern.",
- "type": "object",
"properties": {
"scriptPath": {
"description": "Path to the script from the application root directory.",
"type": "string"
}
},
- "id": "ScriptHandler"
+ "id": "ScriptHandler",
+ "description": "Executes a script to handle the request that matches the URL pattern.",
+ "type": "object"
+ },
+ "BasicScaling": {
+ "description": "A service with basic scaling will create an instance when the application receives a request. The instance will be turned down when the app becomes idle. Basic scaling is ideal for work that is intermittent or driven by user activity.",
+ "type": "object",
+ "properties": {
+ "maxInstances": {
+ "description": "Maximum number of instances to create for this version.",
+ "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"
},
"DiskUtilization": {
"description": "Target scaling by disk usage. Only applicable for VM runtimes.",
"type": "object",
"properties": {
+ "targetWriteBytesPerSec": {
+ "description": "Target bytes written per second.",
+ "format": "int32",
+ "type": "integer"
+ },
"targetReadOpsPerSec": {
"description": "Target ops read per second.",
"format": "int32",
@@ -2155,35 +1806,11 @@
"description": "Target ops written per second.",
"format": "int32",
"type": "integer"
- },
- "targetWriteBytesPerSec": {
- "description": "Target bytes written per second.",
- "format": "int32",
- "type": "integer"
}
},
"id": "DiskUtilization"
},
- "BasicScaling": {
- "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",
- "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.",
@@ -2196,42 +1823,23 @@
"type": "number"
}
},
- "id": "CpuUtilization"
- },
- "IdentityAwareProxy": {
- "properties": {
- "oauth2ClientSecret": {
- "description": "For security reasons, this value cannot be retrieved via the API. Instead, the SHA-256 hash of the value is returned in the oauth2_client_secret_sha256 field.@InputOnly",
- "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",
+ "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": {
"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"
- },
- "type": "object"
+ }
}
},
"code": {
@@ -2244,26 +1852,59 @@
"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.",
+ "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": "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": {
+ "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.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "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": {
- "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": {
@@ -2277,35 +1918,283 @@
},
"id": "TrafficSplit"
},
- "ManualScaling": {
- "properties": {
- "instances": {
- "description": "Number of instances to assign to the service at the start. This number can later be altered by using the Modules API (https://cloud.google.com/appengine/docs/python/modules/functions) set_num_instances() function.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "ManualScaling",
- "description": "A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time.",
- "type": "object"
- },
"LocationMetadata": {
"description": "Metadata for the given google.cloud.location.Location.",
"type": "object",
"properties": {
- "flexibleEnvironmentAvailable": {
- "description": "App Engine Flexible Environment is available in the given location.@OutputOnly",
- "type": "boolean"
- },
"standardEnvironmentAvailable": {
"description": "App Engine Standard Environment is available in the given location.@OutputOnly",
"type": "boolean"
+ },
+ "flexibleEnvironmentAvailable": {
+ "description": "App Engine Flexible Environment is available in the given location.@OutputOnly",
+ "type": "boolean"
}
},
"id": "LocationMetadata"
},
"OperationMetadataV1Beta": {
+ "description": "Metadata for the given google.longrunning.Operation.",
+ "type": "object",
"properties": {
+ "ephemeralMessage": {
+ "description": "Ephemeral message that may change every time the operation is polled. @OutputOnly",
+ "type": "string"
+ },
+ "method": {
+ "description": "API method that initiated this operation. Example: google.appengine.v1beta.Versions.CreateVersion.@OutputOnly",
+ "type": "string"
+ },
+ "endTime": {
+ "description": "Time that this operation completed.@OutputOnly",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "warning": {
+ "description": "Durable messages that persist on every operation poll. @OutputOnly",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "insertTime": {
+ "description": "Time that this operation was created.@OutputOnly",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "user": {
+ "description": "User who requested this operation.@OutputOnly",
+ "type": "string"
+ },
+ "target": {
+ "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly",
+ "type": "string"
+ }
+ },
+ "id": "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"
+ },
+ "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",
+ "items": {
+ "$ref": "Volume"
+ }
+ },
+ "diskGb": {
+ "description": "Disk size (GB) needed.",
+ "format": "double",
+ "type": "number"
+ }
+ },
+ "id": "Resources"
+ },
+ "Deployment": {
+ "description": "Code and application artifacts used to deploy a version to App Engine.",
+ "type": "object",
+ "properties": {
+ "container": {
+ "$ref": "ContainerInfo",
+ "description": "The Docker image for the container that runs the version. Only applicable for instances running in the App Engine flexible environment."
+ },
+ "sourceReferences": {
+ "description": "Origin of the source code for this deployment. There can be more than one source reference per version if source code is distributed among multiple repositories.",
+ "type": "array",
+ "items": {
+ "$ref": "SourceReference"
+ }
+ },
+ "files": {
+ "additionalProperties": {
+ "$ref": "FileInfo"
+ },
+ "description": "Manifest of the files stored in Google Cloud Storage that are included as part of this version. All files must be readable using the credentials supplied with this call.",
+ "type": "object"
+ }
+ },
+ "id": "Deployment"
+ },
+ "Volume": {
+ "description": "Volumes mounted within the app container. Only applicable for VM runtimes.",
+ "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"
+ },
+ "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": {
+ "$ref": "TrafficSplit",
+ "description": "Mapping that defines fractional HTTP traffic diversion to different versions within the service."
+ }
+ },
+ "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": "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"
+ },
+ "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"
+ },
+ "ListInstancesResponse": {
+ "description": "Response message for Instances.ListInstances.",
+ "type": "object",
+ "properties": {
+ "instances": {
+ "description": "The instances belonging to the requested version.",
+ "type": "array",
+ "items": {
+ "$ref": "Instance"
+ }
+ },
+ "nextPageToken": {
+ "description": "Continuation token for fetching the next page of results.",
+ "type": "string"
+ }
+ },
+ "id": "ListInstancesResponse"
+ },
+ "ErrorHandler": {
+ "description": "Custom static error page to be served when an error occurs.",
+ "type": "object",
+ "properties": {
+ "errorCode": {
+ "enumDescriptions": [
+ "Not specified. ERROR_CODE_DEFAULT is assumed.",
+ "All other error types.",
+ "Application has exceeded a resource quota.",
+ "Client blocked by the application's Denial of Service protection configuration.",
+ "Deadline reached before the application responds."
+ ],
+ "enum": [
+ "ERROR_CODE_UNSPECIFIED",
+ "ERROR_CODE_DEFAULT",
+ "ERROR_CODE_OVER_QUOTA",
+ "ERROR_CODE_DOS_API_DENIAL",
+ "ERROR_CODE_TIMEOUT"
+ ],
+ "description": "Error condition this handler applies to.",
+ "type": "string"
+ },
+ "mimeType": {
+ "description": "MIME type of file. Defaults to text/html.",
+ "type": "string"
+ },
+ "staticFile": {
+ "description": "Static file content to be served for this error.",
+ "type": "string"
+ }
+ },
+ "id": "ErrorHandler"
+ },
+ "OperationMetadataV1": {
+ "description": "Metadata for the given google.longrunning.Operation.",
+ "type": "object",
+ "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",
@@ -2331,7 +2220,42 @@
"type": "string"
},
"method": {
- "description": "API method that initiated this operation. Example: google.appengine.v1beta.Versions.CreateVersion.@OutputOnly",
+ "description": "API method that initiated this operation. Example: google.appengine.v1.Versions.CreateVersion.@OutputOnly",
+ "type": "string"
+ }
+ },
+ "id": "OperationMetadataV1"
+ },
+ "OperationMetadataV1Alpha": {
+ "description": "Metadata for the given google.longrunning.Operation.",
+ "type": "object",
+ "properties": {
+ "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.v1alpha.Versions.CreateVersion.@OutputOnly",
"type": "string"
},
"endTime": {
@@ -2340,29 +2264,103 @@
"type": "string"
}
},
- "id": "OperationMetadataV1Beta",
- "description": "Metadata for the given google.longrunning.Operation.",
- "type": "object"
+ "id": "OperationMetadataV1Alpha"
+ },
+ "Network": {
+ "description": "Extra network settings. Only applicable for VM runtimes.",
+ "type": "object",
+ "properties": {
+ "forwardedPorts": {
+ "description": "List of ports, or port pairs, to forward from the virtual machine to the application container.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "instanceTag": {
+ "description": "Tag to apply to the VM instance during creation.",
+ "type": "string"
+ },
+ "subnetworkName": {
+ "description": "Google Cloud Platform sub-network where the virtual machines are created. Specify the short name, not the resource path.If a subnetwork name is specified, a network name will also be required unless it is for the default network.\nIf the network the VM instance is being created in is a Legacy network, then the IP address is allocated from the IPv4Range.\nIf the network the VM instance is being created in is an auto Subnet Mode Network, then only network name should be specified (not the subnetwork_name) and the IP address is created from the IPCidrRange of the subnetwork that exists in that zone for that network.\nIf the network the VM instance is being created in is a custom Subnet Mode Network, then the subnetwork_name must be specified and the IP address is created from the IPCidrRange of the subnetwork.If specified, the subnetwork must exist in the same region as the Flex app.",
+ "type": "string"
+ },
+ "name": {
+ "description": "Google Cloud Platform network where the virtual machines are created. Specify the short name, not the resource path.Defaults to default.",
+ "type": "string"
+ }
+ },
+ "id": "Network"
+ },
+ "Application": {
+ "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"
+ },
+ "name": {
+ "description": "Full path to the Application resource in the API. Example: apps/myapp.@OutputOnly",
+ "type": "string"
+ },
+ "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"
+ },
+ "defaultCookieExpiration": {
+ "description": "Cookie expiration policy for this application.",
+ "format": "google-duration",
+ "type": "string"
+ },
+ "codeBucket": {
+ "description": "A Google Cloud Storage bucket that can be used for storing files associated with this application. This bucket is associated with the application and can be used by the gcloud deployment commands.@OutputOnly",
+ "type": "string"
+ },
+ "location": {
+ "description": "Location from which this application will be run. Application instances will run out of data centers in the chosen location, which is also where all of the application's end user content is stored.Defaults to us-central.Options are:us-central - Central USeurope-west - Western Europeus-east1 - Eastern US",
+ "type": "string"
+ },
+ "defaultBucket": {
+ "description": "A Google Cloud Storage bucket that can be used by the application to store content.@OutputOnly",
+ "type": "string"
+ }
+ },
+ "id": "Application"
}
},
+ "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": "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"
}
}
}
@@ -2375,8 +2373,10 @@
"ownerDomain": "google.com",
"name": "appengine",
"batchPath": "batch",
- "id": "appengine:v1beta5",
- "documentationLink": "https://cloud.google.com/appengine/docs/admin-api/",
"revision": "20171213",
- "title": "Google App Engine Admin API"
+ "documentationLink": "https://cloud.google.com/appengine/docs/admin-api/",
+ "id": "appengine:v1beta5",
+ "title": "Google App Engine Admin API",
+ "discoveryVersion": "v1",
+ "ownerName": "Google"
}
diff --git a/bigquerydatatransfer/v1/bigquerydatatransfer-api.json b/bigquerydatatransfer/v1/bigquerydatatransfer-api.json
index 0bf19a5..5ecb154 100644
--- a/bigquerydatatransfer/v1/bigquerydatatransfer-api.json
+++ b/bigquerydatatransfer/v1/bigquerydatatransfer-api.json
@@ -1,21 +1,4 @@
{
- "canonicalName": "BigQuery Data Transfer",
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/bigquery": {
- "description": "View and manage your data in Google BigQuery"
- },
- "https://www.googleapis.com/auth/cloud-platform.read-only": {
- "description": "View your data across Google Cloud Platform services"
- },
- "https://www.googleapis.com/auth/cloud-platform": {
- "description": "View and manage your data across Google Cloud Platform services"
- }
- }
- }
- },
- "rootUrl": "https://bigquerydatatransfer.googleapis.com/",
"ownerDomain": "google.com",
"name": "bigquerydatatransfer",
"batchPath": "batch",
@@ -28,35 +11,33 @@
"locations": {
"methods": {
"list": {
+ "id": "bigquerydatatransfer.projects.locations.list",
+ "path": "v1/{+name}/locations",
+ "description": "Lists information about the supported locations for this service.",
+ "httpMethod": "GET",
"response": {
"$ref": "ListLocationsResponse"
},
"parameterOrder": [
"name"
],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/bigquery",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
"parameters": {
"filter": {
- "location": "query",
"description": "The standard list filter.",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"name": {
+ "pattern": "^projects/[^/]+$",
+ "location": "path",
"description": "The resource that owns the locations collection, if applicable.",
"required": true,
- "type": "string",
- "pattern": "^projects/[^/]+$",
- "location": "path"
+ "type": "string"
},
"pageToken": {
- "location": "query",
"description": "The standard list page token.",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"pageSize": {
"description": "The standard list page size.",
@@ -65,37 +46,39 @@
"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": {
- "description": "Get information about a location.",
- "httpMethod": "GET",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Location"
- },
- "parameters": {
- "name": {
- "description": "Resource name for the location.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+$",
- "location": "path"
- }
- },
"scopes": [
"https://www.googleapis.com/auth/bigquery",
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
],
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}",
+ "flatPath": "v1/projects/{projectsId}/locations"
+ },
+ "get": {
+ "path": "v1/{+name}",
"id": "bigquerydatatransfer.projects.locations.get",
- "path": "v1/{+name}"
+ "description": "Get information about a location.",
+ "response": {
+ "$ref": "Location"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/bigquery",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+/locations/[^/]+$",
+ "location": "path",
+ "description": "Resource name for the location.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}"
}
},
"resources": {
@@ -109,11 +92,6 @@
"name"
],
"httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/bigquery",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
"parameters": {
"name": {
"description": "The field will contain name of the resource requested, for example:\n`projects/{project_id}/dataSources/{data_source_id}`",
@@ -123,22 +101,25 @@
"location": "path"
}
},
+ "scopes": [
+ "https://www.googleapis.com/auth/bigquery",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataSources/{dataSourcesId}",
"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."
},
"list": {
- "id": "bigquerydatatransfer.projects.locations.dataSources.list",
- "path": "v1/{+parent}/dataSources",
"description": "Lists supported data sources and returns their settings,\nwhich can be used for UI rendering.",
"httpMethod": "GET",
- "parameterOrder": [
- "parent"
- ],
"response": {
"$ref": "ListDataSourcesResponse"
},
+ "parameterOrder": [
+ "parent"
+ ],
"parameters": {
"pageToken": {
"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.",
@@ -152,11 +133,11 @@
"type": "integer"
},
"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",
- "pattern": "^projects/[^/]+/locations/[^/]+$"
+ "type": "string"
}
},
"scopes": [
@@ -164,27 +145,25 @@
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
],
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataSources"
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataSources",
+ "id": "bigquerydatatransfer.projects.locations.dataSources.list",
+ "path": "v1/{+parent}/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.",
- "httpMethod": "POST",
- "parameterOrder": [
- "name"
- ],
"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"
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+/dataSources/[^/]+$",
+ "location": "path"
}
},
"scopes": [
@@ -193,252 +172,84 @@
"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",
- "path": "v1/{+name}: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": {
- "delete": {
- "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.",
- "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"
- }
- }
- },
- "list": {
- "httpMethod": "GET",
- "parameterOrder": [
- "parent"
- ],
- "response": {
- "$ref": "ListTransferConfigsResponse"
- },
- "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": {
- "location": "path",
- "description": "The BigQuery project id for which data sources\nshould be returned: `projects/{project_id}`.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+$"
- },
- "dataSourceIds": {
- "repeated": true,
- "location": "query",
- "description": "When specified, only configurations of requested data sources are returned.",
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/bigquery",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/transferConfigs",
- "id": "bigquerydatatransfer.projects.locations.transferConfigs.list",
- "path": "v1/{+parent}/transferConfigs",
- "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",
- "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": {
- "updateMask": {
- "location": "query",
- "description": "Required list of fields to be updated in this request.",
- "format": "google-fieldmask",
- "type": "string"
- },
- "name": {
- "location": "path",
- "description": "The resource name of the transfer config.\nTransfer config names have the form\n`projects/{project_id}/transferConfigs/{config_id}`.\nWhere `config_id` is usually a uuid, even though it is not\nguaranteed or required. The name is ignored when creating a transfer\nconfig.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+$"
- },
- "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}/locations/{locationsId}/transferConfigs/{transferConfigsId}"
- },
- "get": {
- "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.",
- "response": {
- "$ref": "TransferConfig"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "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",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ]
- }
- },
"resources": {
"runs": {
+ "resources": {
+ "transferLogs": {
+ "methods": {
+ "list": {
+ "description": "Returns user facing log messages for the data transfer run.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "parent"
+ ],
+ "response": {
+ "$ref": "ListTransferLogsResponse"
+ },
+ "parameters": {
+ "pageToken": {
+ "description": "Pagination token, which can be used to request a specific page\nof `ListTransferLogsRequest` list results. For multiple-page\nresults, `ListTransferLogsResponse` outputs\na `next_page` token, which can be used as the\n`page_token` value to request the next page of list results.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageSize": {
+ "location": "query",
+ "description": "Page size. The default page size is the maximum value of 1000 results.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "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"
+ },
+ "parent": {
+ "pattern": "^projects/[^/]+/locations/[^/]+/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"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/bigquery",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}/runs/{runsId}/transferLogs",
+ "id": "bigquerydatatransfer.projects.locations.transferConfigs.runs.transferLogs.list",
+ "path": "v1/{+parent}/transferLogs"
+ }
+ }
+ }
+ },
"methods": {
"delete": {
+ "description": "Deletes the specified transfer run.",
"httpMethod": "DELETE",
- "parameterOrder": [
- "name"
- ],
"response": {
"$ref": "Empty"
},
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+/runs/[^/]+$",
- "location": "path",
- "description": "The field will contain name of the resource requested, for example:\n`projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}`",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/bigquery",
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}/runs/{runsId}",
- "id": "bigquerydatatransfer.projects.locations.transferConfigs.runs.delete",
- "path": "v1/{+name}",
- "description": "Deletes the specified transfer run."
- },
- "get": {
- "description": "Returns information about the particular transfer run.",
- "response": {
- "$ref": "TransferRun"
- },
"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}/runs/{run_id}`",
@@ -450,14 +261,43 @@
},
"scopes": [
"https://www.googleapis.com/auth/bigquery",
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}/runs/{runsId}",
+ "id": "bigquerydatatransfer.projects.locations.transferConfigs.runs.delete",
+ "path": "v1/{+name}"
+ },
+ "get": {
+ "path": "v1/{+name}",
+ "id": "bigquerydatatransfer.projects.locations.transferConfigs.runs.get",
+ "description": "Returns information about the particular transfer run.",
+ "response": {
+ "$ref": "TransferRun"
+ },
+ "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"
],
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}/runs/{runsId}",
- "path": "v1/{+name}",
- "id": "bigquerydatatransfer.projects.locations.transferConfigs.runs.get"
+ "parameters": {
+ "name": {
+ "description": "The field will contain name of the resource requested, for example:\n`projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}`",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+/runs/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}/runs/{runsId}"
},
"list": {
+ "id": "bigquerydatatransfer.projects.locations.transferConfigs.runs.list",
+ "path": "v1/{+parent}/runs",
+ "description": "Returns information about running and completed jobs.",
"httpMethod": "GET",
"parameterOrder": [
"parent"
@@ -467,13 +307,11 @@
},
"parameters": {
"pageToken": {
+ "location": "query",
"description": "Pagination token, which can be used to request a specific page\nof `ListTransferRunsRequest` list results. For multiple-page\nresults, `ListTransferRunsResponse` outputs\na `next_page` token, which can be used as the\n`page_token` value to request the next page of list results.",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"states": {
- "repeated": true,
- "location": "query",
"enum": [
"TRANSFER_STATE_UNSPECIFIED",
"PENDING",
@@ -483,13 +321,15 @@
"CANCELLED"
],
"description": "When specified, only transfer runs with requested states are returned.",
- "type": "string"
+ "type": "string",
+ "repeated": true,
+ "location": "query"
},
"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"
},
"runAttempt": {
"location": "query",
@@ -501,11 +341,11 @@
"type": "string"
},
"parent": {
- "pattern": "^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+$",
- "location": "path",
"description": "Name of transfer configuration for which transfer runs should be retrieved.\nFormat of transfer configuration resource name is:\n`projects/{project_id}/transferConfigs/{config_id}`.",
"required": true,
- "type": "string"
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+$",
+ "location": "path"
}
},
"scopes": [
@@ -513,110 +353,219 @@
"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",
- "id": "bigquerydatatransfer.projects.locations.transferConfigs.runs.list",
- "path": "v1/{+parent}/runs",
- "description": "Returns information about running and completed jobs."
- }
- },
- "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": {
- "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": {
- "description": "Message types to return. If not populated - INFO, WARNING and ERROR\nmessages are returned.",
- "type": "string",
- "repeated": true,
- "location": "query",
- "enum": [
- "MESSAGE_SEVERITY_UNSPECIFIED",
- "INFO",
- "WARNING",
- "ERROR"
- ]
- },
- "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"
- }
- },
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}/runs/{runsId}/transferLogs",
- "path": "v1/{+parent}/transferLogs",
- "id": "bigquerydatatransfer.projects.locations.transferConfigs.runs.transferLogs.list",
- "description": "Returns user facing log messages for the data transfer run."
- }
- }
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}/runs"
}
}
}
+ },
+ "methods": {
+ "delete": {
+ "path": "v1/{+name}",
+ "id": "bigquerydatatransfer.projects.locations.transferConfigs.delete",
+ "description": "Deletes a data transfer configuration,\nincluding any associated transfer runs and logs.",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "DELETE",
+ "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": {
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "parent"
+ ],
+ "response": {
+ "$ref": "ListTransferConfigsResponse"
+ },
+ "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 `ListTransfersRequest` list results. For multiple-page\nresults, `ListTransfersResponse` outputs\na `next_page` token, which can be used as the\n`page_token` value to request the next page of list results.",
+ "type": "string"
+ },
+ "pageSize": {
+ "location": "query",
+ "description": "Page size. The default page size is the maximum value of 1000 results.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "parent": {
+ "pattern": "^projects/[^/]+/locations/[^/]+$",
+ "location": "path",
+ "description": "The BigQuery project id for which data sources\nshould be returned: `projects/{project_id}`.",
+ "required": true,
+ "type": "string"
+ },
+ "dataSourceIds": {
+ "repeated": true,
+ "location": "query",
+ "description": "When specified, only configurations of requested data sources are returned.",
+ "type": "string"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/transferConfigs",
+ "id": "bigquerydatatransfer.projects.locations.transferConfigs.list",
+ "path": "v1/{+parent}/transferConfigs",
+ "description": "Returns information about all data transfers in the project."
+ },
+ "create": {
+ "response": {
+ "$ref": "TransferConfig"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "POST",
+ "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": {
+ "pattern": "^projects/[^/]+/locations/[^/]+$",
+ "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"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/bigquery",
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/transferConfigs",
+ "path": "v1/{+parent}/transferConfigs",
+ "id": "bigquerydatatransfer.projects.locations.transferConfigs.create",
+ "request": {
+ "$ref": "TransferConfig"
+ },
+ "description": "Creates a new data transfer configuration."
+ },
+ "scheduleRuns": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "parent"
+ ],
+ "response": {
+ "$ref": "ScheduleTransferRunsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/bigquery",
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "parent": {
+ "description": "Transfer configuration name in the form:\n`projects/{project_id}/transferConfigs/{config_id}`.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}:scheduleRuns",
+ "id": "bigquerydatatransfer.projects.locations.transferConfigs.scheduleRuns",
+ "path": "v1/{+parent}:scheduleRuns",
+ "description": "Creates transfer runs for a time range [start_time, end_time].\nFor each date - or whatever granularity the data source supports - in the\nrange, one transfer run is created.\nNote that runs are created per UTC time in the time range.",
+ "request": {
+ "$ref": "ScheduleTransferRunsRequest"
+ }
+ },
+ "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": {
+ "pattern": "^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+$",
+ "location": "path",
+ "description": "The resource name of the transfer config.\nTransfer config names have the form\n`projects/{project_id}/transferConfigs/{config_id}`.\nWhere `config_id` is usually a uuid, even though it is not\nguaranteed or required. The name is ignored when creating a transfer\nconfig.",
+ "required": true,
+ "type": "string"
+ },
+ "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}",
+ "id": "bigquerydatatransfer.projects.locations.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."
+ },
+ "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": {
+ "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"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}",
+ "path": "v1/{+name}",
+ "id": "bigquerydatatransfer.projects.locations.transferConfigs.get"
+ }
}
}
}
},
"dataSources": {
"methods": {
- "checkValidCreds": {
- "flatPath": "v1/projects/{projectsId}/dataSources/{dataSourcesId}:checkValidCreds",
- "path": "v1/{+name}:checkValidCreds",
- "id": "bigquerydatatransfer.projects.dataSources.checkValidCreds",
- "description": "Returns true if valid credentials exist for the given data source and\nrequesting user.\nSome data sources doesn't support service account, so we need to talk to\nthem on behalf of the end user. This API just checks whether we have OAuth\ntoken for the particular user, which is a pre-requisite before user can\ncreate a transfer config.",
- "request": {
- "$ref": "CheckValidCredsRequest"
- },
- "response": {
- "$ref": "CheckValidCredsResponse"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/bigquery",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {
- "name": {
- "description": "The data source in the form:\n`projects/{project_id}/dataSources/{data_source_id}`",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/dataSources/[^/]+$",
- "location": "path"
- }
- }
- },
"get": {
- "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.",
"response": {
"$ref": "DataSource"
},
@@ -631,19 +580,19 @@
],
"parameters": {
"name": {
+ "pattern": "^projects/[^/]+/dataSources/[^/]+$",
+ "location": "path",
"description": "The field will contain name of the resource requested, for example:\n`projects/{project_id}/dataSources/{data_source_id}`",
"required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/dataSources/[^/]+$",
- "location": "path"
+ "type": "string"
}
- }
+ },
+ "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": {
- "flatPath": "v1/projects/{projectsId}/dataSources",
- "id": "bigquerydatatransfer.projects.dataSources.list",
- "path": "v1/{+parent}/dataSources",
- "description": "Lists supported data sources and returns their settings,\nwhich can be used for UI rendering.",
"httpMethod": "GET",
"parameterOrder": [
"parent"
@@ -651,13 +600,12 @@
"response": {
"$ref": "ListDataSourcesResponse"
},
+ "scopes": [
+ "https://www.googleapis.com/auth/bigquery",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
"parameters": {
- "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 should be returned.\nMust be in the form: `projects/{project_id}`",
"required": true,
@@ -669,127 +617,264 @@
"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",
"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"
- ]
- }
- }
- },
- "transferConfigs": {
- "methods": {
- "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": {
- "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": {
- "location": "query",
- "description": "Required list of fields to be updated in this request.",
- "format": "google-fieldmask",
- "type": "string"
- },
- "name": {
- "pattern": "^projects/[^/]+/transferConfigs/[^/]+$",
- "location": "path",
- "description": "The resource name of the transfer config.\nTransfer config names have the form\n`projects/{project_id}/transferConfigs/{config_id}`.\nWhere `config_id` is usually a uuid, even though it is not\nguaranteed or required. The name is ignored when creating a transfer\nconfig.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1/projects/{projectsId}/transferConfigs/{transferConfigsId}",
- "path": "v1/{+name}",
- "id": "bigquerydatatransfer.projects.transferConfigs.patch"
- },
- "get": {
- "description": "Returns information about a data transfer config.",
- "response": {
- "$ref": "TransferConfig"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "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/[^/]+$"
- }
- },
- "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}",
- "path": "v1/{+name}",
- "id": "bigquerydatatransfer.projects.transferConfigs.get"
- },
- "delete": {
- "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",
- "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/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/bigquery",
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/transferConfigs/{transferConfigsId}"
- },
- "list": {
- "description": "Returns information about all data transfers in the project.",
- "httpMethod": "GET",
- "parameterOrder": [
- "parent"
- ],
- "response": {
- "$ref": "ListTransferConfigsResponse"
- },
- "parameters": {
"pageSize": {
"location": "query",
"description": "Page size. The default page size is the maximum value of 1000 results.",
"format": "int32",
"type": "integer"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/dataSources",
+ "id": "bigquerydatatransfer.projects.dataSources.list",
+ "path": "v1/{+parent}/dataSources",
+ "description": "Lists supported data sources and returns their settings,\nwhich can be used for UI rendering."
+ },
+ "checkValidCreds": {
+ "path": "v1/{+name}: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.",
+ "response": {
+ "$ref": "CheckValidCredsResponse"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "name": {
+ "description": "The data source in the form:\n`projects/{project_id}/dataSources/{data_source_id}`",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/dataSources/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/bigquery",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "flatPath": "v1/projects/{projectsId}/dataSources/{dataSourcesId}:checkValidCreds"
+ }
+ }
+ },
+ "transferConfigs": {
+ "resources": {
+ "runs": {
+ "methods": {
+ "delete": {
+ "id": "bigquerydatatransfer.projects.transferConfigs.runs.delete",
+ "path": "v1/{+name}",
+ "description": "Deletes the specified transfer run.",
+ "httpMethod": "DELETE",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+/transferConfigs/[^/]+/runs/[^/]+$",
+ "location": "path",
+ "description": "The field will contain name of the resource requested, for example:\n`projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}`",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/bigquery",
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectsId}/transferConfigs/{transferConfigsId}/runs/{runsId}"
},
+ "get": {
+ "path": "v1/{+name}",
+ "id": "bigquerydatatransfer.projects.transferConfigs.runs.get",
+ "description": "Returns information about the particular transfer run.",
+ "response": {
+ "$ref": "TransferRun"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+/transferConfigs/[^/]+/runs/[^/]+$",
+ "location": "path",
+ "description": "The field will contain name of the resource requested, for example:\n`projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}`",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/bigquery",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "flatPath": "v1/projects/{projectsId}/transferConfigs/{transferConfigsId}/runs/{runsId}"
+ },
+ "list": {
+ "path": "v1/{+parent}/runs",
+ "id": "bigquerydatatransfer.projects.transferConfigs.runs.list",
+ "description": "Returns information about running and completed jobs.",
+ "response": {
+ "$ref": "ListTransferRunsResponse"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "pageToken": {
+ "description": "Pagination token, which can be used to request a specific page\nof `ListTransferRunsRequest` list results. For multiple-page\nresults, `ListTransferRunsResponse` outputs\na `next_page` token, which can be used as the\n`page_token` value to request the next page of list results.",
+ "type": "string",
+ "location": "query"
+ },
+ "states": {
+ "repeated": true,
+ "location": "query",
+ "enum": [
+ "TRANSFER_STATE_UNSPECIFIED",
+ "PENDING",
+ "RUNNING",
+ "SUCCEEDED",
+ "FAILED",
+ "CANCELLED"
+ ],
+ "description": "When specified, only transfer runs with requested states are returned.",
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "Page size. The default page size is the maximum value of 1000 results.",
+ "format": "int32",
+ "type": "integer",
+ "location": "query"
+ },
+ "runAttempt": {
+ "enum": [
+ "RUN_ATTEMPT_UNSPECIFIED",
+ "LATEST"
+ ],
+ "description": "Indicates how run attempts are to be pulled.",
+ "type": "string",
+ "location": "query"
+ },
+ "parent": {
+ "description": "Name of transfer configuration for which transfer runs should be retrieved.\nFormat of transfer configuration resource name is:\n`projects/{project_id}/transferConfigs/{config_id}`.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/transferConfigs/[^/]+$",
+ "location": "path"
+ }
+ },
+ "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"
+ }
+ },
+ "resources": {
+ "transferLogs": {
+ "methods": {
+ "list": {
+ "response": {
+ "$ref": "ListTransferLogsResponse"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "GET",
+ "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": {
+ "location": "query",
+ "description": "Pagination token, which can be used to request a specific page\nof `ListTransferLogsRequest` list results. For multiple-page\nresults, `ListTransferLogsResponse` outputs\na `next_page` token, which can be used as the\n`page_token` value to request the next page of list results.",
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "Page size. The default page size is the maximum value of 1000 results.",
+ "format": "int32",
+ "type": "integer",
+ "location": "query"
+ },
+ "messageTypes": {
+ "enum": [
+ "MESSAGE_SEVERITY_UNSPECIFIED",
+ "INFO",
+ "WARNING",
+ "ERROR"
+ ],
+ "description": "Message types to return. If not populated - INFO, WARNING and ERROR\nmessages are returned.",
+ "type": "string",
+ "repeated": true,
+ "location": "query"
+ }
+ },
+ "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",
+ "path": "v1/{+parent}/transferLogs",
+ "id": "bigquerydatatransfer.projects.transferConfigs.runs.transferLogs.list",
+ "description": "Returns user facing log messages for the data transfer run."
+ }
+ }
+ }
+ }
+ }
+ },
+ "methods": {
+ "delete": {
+ "id": "bigquerydatatransfer.projects.transferConfigs.delete",
+ "path": "v1/{+name}",
+ "description": "Deletes a data transfer configuration,\nincluding any associated transfer runs and logs.",
+ "httpMethod": "DELETE",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Empty"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/bigquery",
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+/transferConfigs/[^/]+$",
+ "location": "path",
+ "description": "The field will contain name of the resource requested, for example:\n`projects/{project_id}/transferConfigs/{config_id}`",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/transferConfigs/{transferConfigsId}"
+ },
+ "list": {
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "ListTransferConfigsResponse"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "parameters": {
"parent": {
"description": "The BigQuery project id for which data sources\nshould be returned: `projects/{project_id}`.",
"required": true,
@@ -807,6 +892,12 @@
"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"
}
},
"scopes": [
@@ -816,13 +907,16 @@
],
"flatPath": "v1/projects/{projectsId}/transferConfigs",
"id": "bigquerydatatransfer.projects.transferConfigs.list",
- "path": "v1/{+parent}/transferConfigs"
+ "path": "v1/{+parent}/transferConfigs",
+ "description": "Returns information about all data transfers in the project."
},
"create": {
- "description": "Creates a new data transfer configuration.",
+ "path": "v1/{+parent}/transferConfigs",
+ "id": "bigquerydatatransfer.projects.transferConfigs.create",
"request": {
"$ref": "TransferConfig"
},
+ "description": "Creates a new data transfer configuration.",
"response": {
"$ref": "TransferConfig"
},
@@ -830,27 +924,25 @@
"parent"
],
"httpMethod": "POST",
+ "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"
],
- "parameters": {
- "parent": {
- "pattern": "^projects/[^/]+$",
- "location": "path",
- "description": "The BigQuery project id where the transfer configuration should be created.\nMust be in the format /projects/{project_id}/locations/{location_id}\nIf specified location and location of the destination bigquery dataset\ndo not match - the request will fail.",
- "required": true,
- "type": "string"
- },
- "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"
- }
- },
- "flatPath": "v1/projects/{projectsId}/transferConfigs",
- "path": "v1/{+parent}/transferConfigs",
- "id": "bigquerydatatransfer.projects.transferConfigs.create"
+ "flatPath": "v1/projects/{projectsId}/transferConfigs"
},
"scheduleRuns": {
"response": {
@@ -866,11 +958,11 @@
],
"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",
- "pattern": "^projects/[^/]+/transferConfigs/[^/]+$"
+ "type": "string"
}
},
"flatPath": "v1/projects/{projectsId}/transferConfigs/{transferConfigsId}:scheduleRuns",
@@ -880,182 +972,73 @@
"request": {
"$ref": "ScheduleTransferRunsRequest"
}
- }
- },
- "resources": {
- "runs": {
- "resources": {
- "transferLogs": {
- "methods": {
- "list": {
- "description": "Returns user facing log messages for the data transfer run.",
- "response": {
- "$ref": "ListTransferLogsResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "GET",
- "parameters": {
- "pageSize": {
- "description": "Page size. The default page size is the maximum value of 1000 results.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- },
- "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": {
- "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": {
- "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"
- }
- },
- "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",
- "path": "v1/{+parent}/transferLogs",
- "id": "bigquerydatatransfer.projects.transferConfigs.runs.transferLogs.list"
- }
- }
+ },
+ "get": {
+ "description": "Returns information about a data transfer config.",
+ "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/[^/]+/transferConfigs/[^/]+$",
+ "location": "path"
}
},
- "methods": {
- "delete": {
- "description": "Deletes the specified transfer run.",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "DELETE",
- "scopes": [
- "https://www.googleapis.com/auth/bigquery",
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "description": "The field will contain name of the resource requested, for example:\n`projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}`",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/transferConfigs/[^/]+/runs/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1/projects/{projectsId}/transferConfigs/{transferConfigsId}/runs/{runsId}",
- "path": "v1/{+name}",
- "id": "bigquerydatatransfer.projects.transferConfigs.runs.delete"
+ "scopes": [
+ "https://www.googleapis.com/auth/bigquery",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "flatPath": "v1/projects/{projectsId}/transferConfigs/{transferConfigsId}",
+ "id": "bigquerydatatransfer.projects.transferConfigs.get",
+ "path": "v1/{+name}"
+ },
+ "patch": {
+ "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"
+ },
+ "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/[^/]+/transferConfigs/[^/]+$",
+ "location": "path"
},
- "get": {
- "description": "Returns information about the particular transfer run.",
- "response": {
- "$ref": "TransferRun"
- },
- "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}/runs/{run_id}`",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/transferConfigs/[^/]+/runs/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/bigquery",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1/projects/{projectsId}/transferConfigs/{transferConfigsId}/runs/{runsId}",
- "path": "v1/{+name}",
- "id": "bigquerydatatransfer.projects.transferConfigs.runs.get"
+ "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"
},
- "list": {
- "description": "Returns information about running and completed jobs.",
- "httpMethod": "GET",
- "parameterOrder": [
- "parent"
- ],
- "response": {
- "$ref": "ListTransferRunsResponse"
- },
- "parameters": {
- "states": {
- "location": "query",
- "enum": [
- "TRANSFER_STATE_UNSPECIFIED",
- "PENDING",
- "RUNNING",
- "SUCCEEDED",
- "FAILED",
- "CANCELLED"
- ],
- "description": "When specified, only transfer runs with requested states are returned.",
- "type": "string",
- "repeated": true
- },
- "pageSize": {
- "location": "query",
- "description": "Page size. The default page size is the maximum value of 1000 results.",
- "format": "int32",
- "type": "integer"
- },
- "runAttempt": {
- "enum": [
- "RUN_ATTEMPT_UNSPECIFIED",
- "LATEST"
- ],
- "description": "Indicates how run attempts are to be pulled.",
- "type": "string",
- "location": "query"
- },
- "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"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/bigquery",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1/projects/{projectsId}/transferConfigs/{transferConfigsId}/runs",
- "id": "bigquerydatatransfer.projects.transferConfigs.runs.list",
- "path": "v1/{+parent}/runs"
+ "updateMask": {
+ "description": "Required list of fields to be updated in this request.",
+ "format": "google-fieldmask",
+ "type": "string",
+ "location": "query"
}
- }
+ },
+ "flatPath": "v1/projects/{projectsId}/transferConfigs/{transferConfigsId}"
}
}
}
@@ -1063,24 +1046,38 @@
}
},
"parameters": {
- "fields": {
- "description": "Selector specifying which fields to include in a partial response.",
+ "oauth_token": {
+ "location": "query",
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string"
+ },
+ "bearer_token": {
+ "description": "OAuth bearer token.",
"type": "string",
"location": "query"
},
+ "upload_protocol": {
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "type": "string",
+ "location": "query"
+ },
+ "prettyPrint": {
+ "location": "query",
+ "description": "Returns response with indentations and line breaks.",
+ "type": "boolean",
+ "default": "true"
+ },
"uploadType": {
"location": "query",
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"type": "string"
},
- "callback": {
+ "fields": {
"location": "query",
- "description": "JSONP",
+ "description": "Selector specifying which fields to include in a partial response.",
"type": "string"
},
"$.xgafv": {
- "description": "V1 error format.",
- "type": "string",
"enumDescriptions": [
"v1 error format",
"v2 error format"
@@ -1089,9 +1086,22 @@
"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",
@@ -1099,23 +1109,17 @@
],
"location": "query",
"description": "Data format for response.",
- "default": "json",
- "enum": [
- "json",
- "media",
- "proto"
- ],
- "type": "string"
+ "default": "json"
},
"key": {
+ "location": "query",
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"access_token": {
- "location": "query",
"description": "OAuth access token.",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"quotaUser": {
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
@@ -1127,42 +1131,159 @@
"description": "Pretty-print response.",
"type": "boolean",
"default": "true"
- },
- "bearer_token": {
- "description": "OAuth bearer token.",
- "type": "string",
- "location": "query"
- },
- "oauth_token": {
- "description": "OAuth 2.0 token for the current user.",
- "type": "string",
- "location": "query"
- },
- "upload_protocol": {
- "location": "query",
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string"
- },
- "prettyPrint": {
- "description": "Returns response with indentations and line breaks.",
- "type": "boolean",
- "default": "true",
- "location": "query"
}
},
"version": "v1",
"baseUrl": "https://bigquerydatatransfer.googleapis.com/",
- "servicePath": "",
"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": "20171219",
+ "revision": "20180101",
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
+ "ListTransferConfigsResponse": {
+ "properties": {
+ "transferConfigs": {
+ "description": "Output only. The stored pipeline transfer configurations.",
+ "type": "array",
+ "items": {
+ "$ref": "TransferConfig"
+ }
+ },
+ "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"
+ }
+ },
+ "id": "ListTransferConfigsResponse",
+ "description": "The returned list of pipelines in the project.",
+ "type": "object"
+ },
+ "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": {
+ "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": {
+ "enumDescriptions": [
+ "Type unspecified.",
+ "Use OAuth 2 authorization codes that can be exchanged\nfor a refresh token on the backend.",
+ "Return an authorization code for a given Google+ page that can then be\nexchanged for a refresh token on the backend."
+ ],
+ "enum": [
+ "AUTHORIZATION_TYPE_UNSPECIFIED",
+ "AUTHORIZATION_CODE",
+ "GOOGLE_PLUS_AUTHORIZATION_CODE"
+ ],
+ "description": "Indicates the type of authorization.",
+ "type": "string"
+ },
+ "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": {
+ "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",
+ "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."
+ ]
+ },
+ "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": {
+ "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.",
@@ -1172,11 +1293,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": {
@@ -1185,26 +1306,24 @@
"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"
},
"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"
+ },
+ "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"
}
},
- "id": "ScheduleTransferRunsRequest"
+ "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 `{}`.",
@@ -1213,8 +1332,6 @@
"id": "Empty"
},
"Location": {
- "description": "A resource that represents Google Cloud Platform location.",
- "type": "object",
"properties": {
"labels": {
"additionalProperties": {
@@ -1232,20 +1349,32 @@
"type": "string"
},
"metadata": {
- "description": "Service-specific metadata. For example the available capacity at the given\nlocation.",
- "type": "object",
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
- }
+ },
+ "description": "Service-specific metadata. For example the available capacity at the given\nlocation.",
+ "type": "object"
}
},
- "id": "Location"
+ "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": {
+ "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"
@@ -1278,6 +1407,14 @@
"type": "string"
},
"state": {
+ "enum": [
+ "TRANSFER_STATE_UNSPECIFIED",
+ "PENDING",
+ "RUNNING",
+ "SUCCEEDED",
+ "FAILED",
+ "CANCELLED"
+ ],
"description": "Output only. State of the most recently updated transfer run.",
"type": "string",
"enumDescriptions": [
@@ -1287,20 +1424,8 @@
"Data transfer completed successsfully.",
"Data transfer failed.",
"Data transfer is cancelled."
- ],
- "enum": [
- "TRANSFER_STATE_UNSPECIFIED",
- "PENDING",
- "RUNNING",
- "SUCCEEDED",
- "FAILED",
- "CANCELLED"
]
},
- "name": {
- "description": "The resource name of the transfer config.\nTransfer config names have the form\n`projects/{project_id}/transferConfigs/{config_id}`.\nWhere `config_id` is usually a uuid, even though it is not\nguaranteed or required. The name is ignored when creating a transfer\nconfig.",
- "type": "string"
- },
"destinationDatasetId": {
"description": "The BigQuery target dataset id.",
"type": "string"
@@ -1310,29 +1435,19 @@
"format": "int64",
"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.",
+ "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"
}
},
- "id": "TransferConfig"
+ "id": "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"
},
"TransferRun": {
"description": "Represents a data transfer run.\nNext id: 27",
"type": "object",
"properties": {
- "dataSourceId": {
- "description": "Output only. Data source id.",
- "type": "string"
- },
"state": {
"enumDescriptions": [
"State placeholder.",
@@ -1357,21 +1472,21 @@
"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"
},
- "destinationDatasetId": {
- "description": "The BigQuery target dataset id.",
- "type": "string"
- },
"userId": {
"description": "Output only. Unique ID of the user on whose behalf transfer is done.\nApplicable only to data sources that do not support service accounts.\nWhen set to 0, the data source service account credentials are used.\nMay be negative. Note, that this identifier is not stable.\nIt may change over time even for the same user.",
"format": "int64",
"type": "string"
},
+ "destinationDatasetId": {
+ "description": "Output only. The BigQuery target dataset id.",
+ "type": "string"
+ },
"params": {
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
},
- "description": "Data transfer specific parameters.",
+ "description": "Output only. Data transfer specific parameters.",
"type": "object"
},
"endTime": {
@@ -1406,6 +1521,10 @@
"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"
@@ -1441,6 +1560,38 @@
},
"id": "ScheduleTransferRunsResponse"
},
+ "TransferMessage": {
+ "description": "Represents a user facing message for a particular data transfer run.",
+ "type": "object",
+ "properties": {
+ "messageTime": {
+ "description": "Time when message was logged.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "severity": {
+ "enum": [
+ "MESSAGE_SEVERITY_UNSPECIFIED",
+ "INFO",
+ "WARNING",
+ "ERROR"
+ ],
+ "description": "Message severity.",
+ "type": "string",
+ "enumDescriptions": [
+ "No severity specified.",
+ "Informational message.",
+ "Warning message.",
+ "Error message."
+ ]
+ },
+ "messageText": {
+ "description": "Message text.",
+ "type": "string"
+ }
+ },
+ "id": "TransferMessage"
+ },
"ListTransferLogsResponse": {
"description": "The returned list transfer run messages.",
"type": "object",
@@ -1459,41 +1610,7 @@
},
"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": {
"dataSources": {
"description": "List of supported data sources and their transfer settings.",
@@ -1507,12 +1624,18 @@
"type": "string"
}
},
- "id": "ListDataSourcesResponse"
+ "id": "ListDataSourcesResponse",
+ "description": "Returns list of supported data sources and their metadata.",
+ "type": "object"
},
"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": {
+ "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"
@@ -1553,14 +1676,14 @@
"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"
},
+ "immutable": {
+ "description": "Cannot be changed after initial creation.",
+ "type": "boolean"
+ },
"fields": {
"description": "When parameter is a record, describes child fields.",
"type": "array",
@@ -1574,15 +1697,6 @@
"type": "number"
},
"type": {
- "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",
@@ -1593,32 +1707,37 @@
"PLUS_PAGE"
],
"description": "Parameter type.",
- "type": "string"
- },
- "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"
+ "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."
+ ]
}
},
"id": "DataSourceParameter"
},
"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"
}
- },
- "nextPageToken": {
- "description": "Output only. The next-pagination token. For multiple-page list results,\nthis token can be used as the\n`ListTransferRunsRequest.page_token`\nto request the next page of list results.",
- "type": "string"
}
},
- "id": "ListTransferRunsResponse",
- "description": "The returned list of pipelines in the project.",
- "type": "object"
+ "id": "ListTransferRunsResponse"
},
"ListLocationsResponse": {
"description": "The response message for Locations.ListLocations.",
@@ -1637,147 +1756,28 @@
}
},
"id": "ListLocationsResponse"
- },
- "ListTransferConfigsResponse": {
- "description": "The returned list of pipelines in the project.",
- "type": "object",
- "properties": {
- "transferConfigs": {
- "description": "Output only. The stored pipeline transfer configurations.",
- "type": "array",
- "items": {
- "$ref": "TransferConfig"
- }
- },
- "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"
- }
- },
- "id": "ListTransferConfigsResponse"
- },
- "DataSource": {
- "description": "Represents data source metadata. Metadata is sufficient to\nrender UI and request proper OAuth tokens.",
- "type": "object",
- "properties": {
- "manualRunsDisabled": {
- "description": "Disables backfilling and manual run scheduling\nfor the data source.",
- "type": "boolean"
- },
- "defaultDataRefreshWindowDays": {
- "description": "Default data refresh window on days.\nOnly meaningful when `data_refresh_type` = `SLIDING_WINDOW`.",
- "format": "int32",
- "type": "integer"
- },
- "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 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"
- },
- "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"
- }
- },
- "id": "DataSource"
}
},
"icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
+ "x32": "http://www.google.com/images/icons/product/search-32.gif",
+ "x16": "http://www.google.com/images/icons/product/search-16.gif"
},
- "protocol": "rest"
+ "protocol": "rest",
+ "canonicalName": "BigQuery Data Transfer",
+ "auth": {
+ "oauth2": {
+ "scopes": {
+ "https://www.googleapis.com/auth/cloud-platform": {
+ "description": "View and manage your data across Google Cloud Platform services"
+ },
+ "https://www.googleapis.com/auth/bigquery": {
+ "description": "View and manage your data in Google BigQuery"
+ },
+ "https://www.googleapis.com/auth/cloud-platform.read-only": {
+ "description": "View your data across Google Cloud Platform services"
+ }
+ }
+ }
+ },
+ "rootUrl": "https://bigquerydatatransfer.googleapis.com/"
}
diff --git a/bigquerydatatransfer/v1/bigquerydatatransfer-gen.go b/bigquerydatatransfer/v1/bigquerydatatransfer-gen.go
index d5a581b..908c508 100644
--- a/bigquerydatatransfer/v1/bigquerydatatransfer-gen.go
+++ b/bigquerydatatransfer/v1/bigquerydatatransfer-gen.go
@@ -1139,7 +1139,7 @@
// DataSourceId: Output only. Data source id.
DataSourceId string `json:"dataSourceId,omitempty"`
- // DestinationDatasetId: The BigQuery target dataset id.
+ // DestinationDatasetId: Output only. The BigQuery target dataset id.
DestinationDatasetId string `json:"destinationDatasetId,omitempty"`
// EndTime: Output only. Time when transfer run ended.
@@ -1157,7 +1157,7 @@
// The name is ignored when creating a transfer run.
Name string `json:"name,omitempty"`
- // Params: Data transfer specific parameters.
+ // Params: Output only. Data transfer specific parameters.
Params googleapi.RawMessage `json:"params,omitempty"`
// RunTime: For batch transfer runs, specifies the date and time
diff --git a/books/v1/books-api.json b/books/v1/books-api.json
index 1e26675..b23b592 100644
--- a/books/v1/books-api.json
+++ b/books/v1/books-api.json
@@ -1,11 +1,11 @@
{
"kind": "discovery#restDescription",
- "etag": "\"YWOzh2SDasdU84ArJnpYek-OMdg/q1aPzEOdugLS9_Y8FK61EmJhEHg\"",
+ "etag": "\"YWOzh2SDasdU84ArJnpYek-OMdg/grKqkiLaDaBaqW7ezJtDaKmrU78\"",
"discoveryVersion": "v1",
"id": "books:v1",
"name": "books",
"version": "v1",
- "revision": "20170313",
+ "revision": "20171127",
"title": "Books API",
"description": "Searches for books and manages your Google Books library.",
"ownerDomain": "google.com",
@@ -890,6 +890,42 @@
}
}
},
+ "FamilyInfo": {
+ "id": "FamilyInfo",
+ "type": "object",
+ "properties": {
+ "kind": {
+ "type": "string",
+ "description": "Resource type.",
+ "default": "books#familyInfo"
+ },
+ "membership": {
+ "type": "object",
+ "description": "Family membership info of the user that made the request.",
+ "properties": {
+ "acquirePermission": {
+ "type": "string",
+ "description": "Restrictions on user buying and acquiring content."
+ },
+ "ageGroup": {
+ "type": "string",
+ "description": "The age group of the user."
+ },
+ "allowedMaturityRating": {
+ "type": "string",
+ "description": "The maximum allowed maturity rating for the user."
+ },
+ "isInFamily": {
+ "type": "boolean"
+ },
+ "role": {
+ "type": "string",
+ "description": "The role of the user in the family."
+ }
+ }
+ }
+ }
+ },
"Geolayerdata": {
"id": "Geolayerdata",
"type": "object",
@@ -1444,6 +1480,14 @@
"notification": {
"type": "object",
"properties": {
+ "matchMyInterests": {
+ "type": "object",
+ "properties": {
+ "opted_state": {
+ "type": "string"
+ }
+ }
+ },
"moreFromAuthors": {
"type": "object",
"properties": {
@@ -1460,6 +1504,14 @@
}
}
},
+ "priceDrop": {
+ "type": "object",
+ "properties": {
+ "opted_state": {
+ "type": "string"
+ }
+ }
+ },
"rewardExpirations": {
"type": "object",
"properties": {
@@ -2507,6 +2559,81 @@
}
}
},
+ "familysharing": {
+ "methods": {
+ "getFamilyInfo": {
+ "id": "books.familysharing.getFamilyInfo",
+ "path": "familysharing/getFamilyInfo",
+ "httpMethod": "GET",
+ "description": "Gets information regarding the family that the user is part of.",
+ "parameters": {
+ "source": {
+ "type": "string",
+ "description": "String to identify the originator of this request.",
+ "location": "query"
+ }
+ },
+ "response": {
+ "$ref": "FamilyInfo"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/books"
+ ]
+ },
+ "share": {
+ "id": "books.familysharing.share",
+ "path": "familysharing/share",
+ "httpMethod": "POST",
+ "description": "Initiates sharing of the content with the user's family. Empty response indicates success.",
+ "parameters": {
+ "docId": {
+ "type": "string",
+ "description": "The docid to share.",
+ "location": "query"
+ },
+ "source": {
+ "type": "string",
+ "description": "String to identify the originator of this request.",
+ "location": "query"
+ },
+ "volumeId": {
+ "type": "string",
+ "description": "The volume to share.",
+ "location": "query"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/books"
+ ]
+ },
+ "unshare": {
+ "id": "books.familysharing.unshare",
+ "path": "familysharing/unshare",
+ "httpMethod": "POST",
+ "description": "Initiates revoking content that has already been shared with the user's family. Empty response indicates success.",
+ "parameters": {
+ "docId": {
+ "type": "string",
+ "description": "The docid to unshare.",
+ "location": "query"
+ },
+ "source": {
+ "type": "string",
+ "description": "String to identify the originator of this request.",
+ "location": "query"
+ },
+ "volumeId": {
+ "type": "string",
+ "description": "The volume to unshare.",
+ "location": "query"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/books"
+ ]
+ }
+ }
+ },
"layers": {
"methods": {
"get": {
diff --git a/books/v1/books-gen.go b/books/v1/books-gen.go
index c6b039a..f914fca 100644
--- a/books/v1/books-gen.go
+++ b/books/v1/books-gen.go
@@ -59,6 +59,7 @@
s.Bookshelves = NewBookshelvesService(s)
s.Cloudloading = NewCloudloadingService(s)
s.Dictionary = NewDictionaryService(s)
+ s.Familysharing = NewFamilysharingService(s)
s.Layers = NewLayersService(s)
s.Myconfig = NewMyconfigService(s)
s.Mylibrary = NewMylibraryService(s)
@@ -82,6 +83,8 @@
Dictionary *DictionaryService
+ Familysharing *FamilysharingService
+
Layers *LayersService
Myconfig *MyconfigService
@@ -147,6 +150,15 @@
s *Service
}
+func NewFamilysharingService(s *Service) *FamilysharingService {
+ rs := &FamilysharingService{s: s}
+ return rs
+}
+
+type FamilysharingService struct {
+ s *Service
+}
+
func NewLayersService(s *Service) *LayersService {
rs := &LayersService{s: s}
rs.AnnotationData = NewLayersAnnotationDataService(s)
@@ -1843,6 +1855,82 @@
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
+type FamilyInfo struct {
+ // Kind: Resource type.
+ Kind string `json:"kind,omitempty"`
+
+ // Membership: Family membership info of the user that made the request.
+ Membership *FamilyInfoMembership `json:"membership,omitempty"`
+
+ // ServerResponse contains the HTTP response code and headers from the
+ // server.
+ googleapi.ServerResponse `json:"-"`
+
+ // ForceSendFields is a list of field names (e.g. "Kind") to
+ // unconditionally include in API requests. By default, fields with
+ // empty values are omitted from API requests. However, any non-pointer,
+ // non-interface field appearing in ForceSendFields will be sent to the
+ // server regardless of whether the field is empty or not. This may be
+ // used to include empty fields in Patch requests.
+ ForceSendFields []string `json:"-"`
+
+ // NullFields is a list of field names (e.g. "Kind") to include in API
+ // requests with the JSON null value. By default, fields with empty
+ // values are omitted from API requests. However, any field with an
+ // empty value appearing in NullFields will be sent to the server as
+ // null. It is an error if a field in this list has a non-empty value.
+ // This may be used to include null fields in Patch requests.
+ NullFields []string `json:"-"`
+}
+
+func (s *FamilyInfo) MarshalJSON() ([]byte, error) {
+ type NoMethod FamilyInfo
+ raw := NoMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+// FamilyInfoMembership: Family membership info of the user that made
+// the request.
+type FamilyInfoMembership struct {
+ // AcquirePermission: Restrictions on user buying and acquiring content.
+ AcquirePermission string `json:"acquirePermission,omitempty"`
+
+ // AgeGroup: The age group of the user.
+ AgeGroup string `json:"ageGroup,omitempty"`
+
+ // AllowedMaturityRating: The maximum allowed maturity rating for the
+ // user.
+ AllowedMaturityRating string `json:"allowedMaturityRating,omitempty"`
+
+ IsInFamily bool `json:"isInFamily,omitempty"`
+
+ // Role: The role of the user in the family.
+ Role string `json:"role,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "AcquirePermission")
+ // to unconditionally include in API requests. By default, fields with
+ // empty values are omitted from API requests. However, any non-pointer,
+ // non-interface field appearing in ForceSendFields will be sent to the
+ // server regardless of whether the field is empty or not. This may be
+ // used to include empty fields in Patch requests.
+ ForceSendFields []string `json:"-"`
+
+ // NullFields is a list of field names (e.g. "AcquirePermission") to
+ // include in API requests with the JSON null value. By default, fields
+ // with empty values are omitted from API requests. However, any field
+ // with an empty value appearing in NullFields will be sent to the
+ // server as null. It is an error if a field in this list has a
+ // non-empty value. This may be used to include null fields in Patch
+ // requests.
+ NullFields []string `json:"-"`
+}
+
+func (s *FamilyInfoMembership) MarshalJSON() ([]byte, error) {
+ type NoMethod FamilyInfoMembership
+ raw := NoMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
type Geolayerdata struct {
Common *GeolayerdataCommon `json:"common,omitempty"`
@@ -2850,13 +2938,17 @@
}
type UsersettingsNotification struct {
+ MatchMyInterests *UsersettingsNotificationMatchMyInterests `json:"matchMyInterests,omitempty"`
+
MoreFromAuthors *UsersettingsNotificationMoreFromAuthors `json:"moreFromAuthors,omitempty"`
MoreFromSeries *UsersettingsNotificationMoreFromSeries `json:"moreFromSeries,omitempty"`
+ PriceDrop *UsersettingsNotificationPriceDrop `json:"priceDrop,omitempty"`
+
RewardExpirations *UsersettingsNotificationRewardExpirations `json:"rewardExpirations,omitempty"`
- // ForceSendFields is a list of field names (e.g. "MoreFromAuthors") to
+ // ForceSendFields is a list of field names (e.g. "MatchMyInterests") to
// unconditionally include in API requests. By default, fields with
// empty values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
@@ -2864,7 +2956,7 @@
// used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
- // NullFields is a list of field names (e.g. "MoreFromAuthors") to
+ // NullFields is a list of field names (e.g. "MatchMyInterests") to
// include in API requests with the JSON null value. By default, fields
// with empty values are omitted from API requests. However, any field
// with an empty value appearing in NullFields will be sent to the
@@ -2880,6 +2972,32 @@
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
+type UsersettingsNotificationMatchMyInterests struct {
+ OptedState string `json:"opted_state,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "OptedState") to
+ // unconditionally include in API requests. By default, fields with
+ // empty values are omitted from API requests. However, any non-pointer,
+ // non-interface field appearing in ForceSendFields will be sent to the
+ // server regardless of whether the field is empty or not. This may be
+ // used to include empty fields in Patch requests.
+ ForceSendFields []string `json:"-"`
+
+ // NullFields is a list of field names (e.g. "OptedState") to include in
+ // API requests with the JSON null value. By default, fields with empty
+ // values are omitted from API requests. However, any field with an
+ // empty value appearing in NullFields will be sent to the server as
+ // null. It is an error if a field in this list has a non-empty value.
+ // This may be used to include null fields in Patch requests.
+ NullFields []string `json:"-"`
+}
+
+func (s *UsersettingsNotificationMatchMyInterests) MarshalJSON() ([]byte, error) {
+ type NoMethod UsersettingsNotificationMatchMyInterests
+ raw := NoMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
type UsersettingsNotificationMoreFromAuthors struct {
OptedState string `json:"opted_state,omitempty"`
@@ -2932,6 +3050,32 @@
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
+type UsersettingsNotificationPriceDrop struct {
+ OptedState string `json:"opted_state,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "OptedState") to
+ // unconditionally include in API requests. By default, fields with
+ // empty values are omitted from API requests. However, any non-pointer,
+ // non-interface field appearing in ForceSendFields will be sent to the
+ // server regardless of whether the field is empty or not. This may be
+ // used to include empty fields in Patch requests.
+ ForceSendFields []string `json:"-"`
+
+ // NullFields is a list of field names (e.g. "OptedState") to include in
+ // API requests with the JSON null value. By default, fields with empty
+ // values are omitted from API requests. However, any field with an
+ // empty value appearing in NullFields will be sent to the server as
+ // null. It is an error if a field in this list has a non-empty value.
+ // This may be used to include null fields in Patch requests.
+ NullFields []string `json:"-"`
+}
+
+func (s *UsersettingsNotificationPriceDrop) MarshalJSON() ([]byte, error) {
+ type NoMethod UsersettingsNotificationPriceDrop
+ raw := NoMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
type UsersettingsNotificationRewardExpirations struct {
OptedState string `json:"opted_state,omitempty"`
@@ -5495,6 +5639,375 @@
}
+// method id "books.familysharing.getFamilyInfo":
+
+type FamilysharingGetFamilyInfoCall struct {
+ s *Service
+ urlParams_ gensupport.URLParams
+ ifNoneMatch_ string
+ ctx_ context.Context
+ header_ http.Header
+}
+
+// GetFamilyInfo: Gets information regarding the family that the user is
+// part of.
+func (r *FamilysharingService) GetFamilyInfo() *FamilysharingGetFamilyInfoCall {
+ c := &FamilysharingGetFamilyInfoCall{s: r.s, urlParams_: make(gensupport.URLParams)}
+ return c
+}
+
+// Source sets the optional parameter "source": String to identify the
+// originator of this request.
+func (c *FamilysharingGetFamilyInfoCall) Source(source string) *FamilysharingGetFamilyInfoCall {
+ c.urlParams_.Set("source", source)
+ return c
+}
+
+// Fields allows partial responses to be retrieved. See
+// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
+// for more information.
+func (c *FamilysharingGetFamilyInfoCall) Fields(s ...googleapi.Field) *FamilysharingGetFamilyInfoCall {
+ c.urlParams_.Set("fields", googleapi.CombineFields(s))
+ return c
+}
+
+// IfNoneMatch sets the optional parameter which makes the operation
+// fail if the object's ETag matches the given value. This is useful for
+// getting updates only after the object has changed since the last
+// request. Use googleapi.IsNotModified to check whether the response
+// error from Do is the result of In-None-Match.
+func (c *FamilysharingGetFamilyInfoCall) IfNoneMatch(entityTag string) *FamilysharingGetFamilyInfoCall {
+ c.ifNoneMatch_ = entityTag
+ return c
+}
+
+// Context sets the context to be used in this call's Do method. Any
+// pending HTTP request will be aborted if the provided context is
+// canceled.
+func (c *FamilysharingGetFamilyInfoCall) Context(ctx context.Context) *FamilysharingGetFamilyInfoCall {
+ c.ctx_ = ctx
+ return c
+}
+
+// Header returns an http.Header that can be modified by the caller to
+// add HTTP headers to the request.
+func (c *FamilysharingGetFamilyInfoCall) Header() http.Header {
+ if c.header_ == nil {
+ c.header_ = make(http.Header)
+ }
+ return c.header_
+}
+
+func (c *FamilysharingGetFamilyInfoCall) doRequest(alt string) (*http.Response, error) {
+ reqHeaders := make(http.Header)
+ for k, v := range c.header_ {
+ reqHeaders[k] = v
+ }
+ reqHeaders.Set("User-Agent", c.s.userAgent())
+ if c.ifNoneMatch_ != "" {
+ reqHeaders.Set("If-None-Match", c.ifNoneMatch_)
+ }
+ var body io.Reader = nil
+ c.urlParams_.Set("alt", alt)
+ urls := googleapi.ResolveRelative(c.s.BasePath, "familysharing/getFamilyInfo")
+ urls += "?" + c.urlParams_.Encode()
+ req, _ := http.NewRequest("GET", urls, body)
+ req.Header = reqHeaders
+ return gensupport.SendRequest(c.ctx_, c.s.client, req)
+}
+
+// Do executes the "books.familysharing.getFamilyInfo" call.
+// Exactly one of *FamilyInfo or error will be non-nil. Any non-2xx
+// status code is an error. Response headers are in either
+// *FamilyInfo.ServerResponse.Header or (if a response was returned at
+// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified
+// to check whether the returned error was because
+// http.StatusNotModified was returned.
+func (c *FamilysharingGetFamilyInfoCall) Do(opts ...googleapi.CallOption) (*FamilyInfo, error) {
+ gensupport.SetOptions(c.urlParams_, opts...)
+ res, err := c.doRequest("json")
+ if res != nil && res.StatusCode == http.StatusNotModified {
+ if res.Body != nil {
+ res.Body.Close()
+ }
+ return nil, &googleapi.Error{
+ Code: res.StatusCode,
+ Header: res.Header,
+ }
+ }
+ if err != nil {
+ return nil, err
+ }
+ defer googleapi.CloseBody(res)
+ if err := googleapi.CheckResponse(res); err != nil {
+ return nil, err
+ }
+ ret := &FamilyInfo{
+ ServerResponse: googleapi.ServerResponse{
+ Header: res.Header,
+ HTTPStatusCode: res.StatusCode,
+ },
+ }
+ target := &ret
+ if err := gensupport.DecodeResponse(target, res); err != nil {
+ return nil, err
+ }
+ return ret, nil
+ // {
+ // "description": "Gets information regarding the family that the user is part of.",
+ // "httpMethod": "GET",
+ // "id": "books.familysharing.getFamilyInfo",
+ // "parameters": {
+ // "source": {
+ // "description": "String to identify the originator of this request.",
+ // "location": "query",
+ // "type": "string"
+ // }
+ // },
+ // "path": "familysharing/getFamilyInfo",
+ // "response": {
+ // "$ref": "FamilyInfo"
+ // },
+ // "scopes": [
+ // "https://www.googleapis.com/auth/books"
+ // ]
+ // }
+
+}
+
+// method id "books.familysharing.share":
+
+type FamilysharingShareCall struct {
+ s *Service
+ urlParams_ gensupport.URLParams
+ ctx_ context.Context
+ header_ http.Header
+}
+
+// Share: Initiates sharing of the content with the user's family. Empty
+// response indicates success.
+func (r *FamilysharingService) Share() *FamilysharingShareCall {
+ c := &FamilysharingShareCall{s: r.s, urlParams_: make(gensupport.URLParams)}
+ return c
+}
+
+// DocId sets the optional parameter "docId": The docid to share.
+func (c *FamilysharingShareCall) DocId(docId string) *FamilysharingShareCall {
+ c.urlParams_.Set("docId", docId)
+ return c
+}
+
+// Source sets the optional parameter "source": String to identify the
+// originator of this request.
+func (c *FamilysharingShareCall) Source(source string) *FamilysharingShareCall {
+ c.urlParams_.Set("source", source)
+ return c
+}
+
+// VolumeId sets the optional parameter "volumeId": The volume to share.
+func (c *FamilysharingShareCall) VolumeId(volumeId string) *FamilysharingShareCall {
+ c.urlParams_.Set("volumeId", volumeId)
+ return c
+}
+
+// Fields allows partial responses to be retrieved. See
+// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
+// for more information.
+func (c *FamilysharingShareCall) Fields(s ...googleapi.Field) *FamilysharingShareCall {
+ c.urlParams_.Set("fields", googleapi.CombineFields(s))
+ return c
+}
+
+// Context sets the context to be used in this call's Do method. Any
+// pending HTTP request will be aborted if the provided context is
+// canceled.
+func (c *FamilysharingShareCall) Context(ctx context.Context) *FamilysharingShareCall {
+ c.ctx_ = ctx
+ return c
+}
+
+// Header returns an http.Header that can be modified by the caller to
+// add HTTP headers to the request.
+func (c *FamilysharingShareCall) Header() http.Header {
+ if c.header_ == nil {
+ c.header_ = make(http.Header)
+ }
+ return c.header_
+}
+
+func (c *FamilysharingShareCall) doRequest(alt string) (*http.Response, error) {
+ reqHeaders := make(http.Header)
+ for k, v := range c.header_ {
+ reqHeaders[k] = v
+ }
+ reqHeaders.Set("User-Agent", c.s.userAgent())
+ var body io.Reader = nil
+ c.urlParams_.Set("alt", alt)
+ urls := googleapi.ResolveRelative(c.s.BasePath, "familysharing/share")
+ urls += "?" + c.urlParams_.Encode()
+ req, _ := http.NewRequest("POST", urls, body)
+ req.Header = reqHeaders
+ return gensupport.SendRequest(c.ctx_, c.s.client, req)
+}
+
+// Do executes the "books.familysharing.share" call.
+func (c *FamilysharingShareCall) Do(opts ...googleapi.CallOption) error {
+ gensupport.SetOptions(c.urlParams_, opts...)
+ res, err := c.doRequest("json")
+ if err != nil {
+ return err
+ }
+ defer googleapi.CloseBody(res)
+ if err := googleapi.CheckResponse(res); err != nil {
+ return err
+ }
+ return nil
+ // {
+ // "description": "Initiates sharing of the content with the user's family. Empty response indicates success.",
+ // "httpMethod": "POST",
+ // "id": "books.familysharing.share",
+ // "parameters": {
+ // "docId": {
+ // "description": "The docid to share.",
+ // "location": "query",
+ // "type": "string"
+ // },
+ // "source": {
+ // "description": "String to identify the originator of this request.",
+ // "location": "query",
+ // "type": "string"
+ // },
+ // "volumeId": {
+ // "description": "The volume to share.",
+ // "location": "query",
+ // "type": "string"
+ // }
+ // },
+ // "path": "familysharing/share",
+ // "scopes": [
+ // "https://www.googleapis.com/auth/books"
+ // ]
+ // }
+
+}
+
+// method id "books.familysharing.unshare":
+
+type FamilysharingUnshareCall struct {
+ s *Service
+ urlParams_ gensupport.URLParams
+ ctx_ context.Context
+ header_ http.Header
+}
+
+// Unshare: Initiates revoking content that has already been shared with
+// the user's family. Empty response indicates success.
+func (r *FamilysharingService) Unshare() *FamilysharingUnshareCall {
+ c := &FamilysharingUnshareCall{s: r.s, urlParams_: make(gensupport.URLParams)}
+ return c
+}
+
+// DocId sets the optional parameter "docId": The docid to unshare.
+func (c *FamilysharingUnshareCall) DocId(docId string) *FamilysharingUnshareCall {
+ c.urlParams_.Set("docId", docId)
+ return c
+}
+
+// Source sets the optional parameter "source": String to identify the
+// originator of this request.
+func (c *FamilysharingUnshareCall) Source(source string) *FamilysharingUnshareCall {
+ c.urlParams_.Set("source", source)
+ return c
+}
+
+// VolumeId sets the optional parameter "volumeId": The volume to
+// unshare.
+func (c *FamilysharingUnshareCall) VolumeId(volumeId string) *FamilysharingUnshareCall {
+ c.urlParams_.Set("volumeId", volumeId)
+ return c
+}
+
+// Fields allows partial responses to be retrieved. See
+// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
+// for more information.
+func (c *FamilysharingUnshareCall) Fields(s ...googleapi.Field) *FamilysharingUnshareCall {
+ c.urlParams_.Set("fields", googleapi.CombineFields(s))
+ return c
+}
+
+// Context sets the context to be used in this call's Do method. Any
+// pending HTTP request will be aborted if the provided context is
+// canceled.
+func (c *FamilysharingUnshareCall) Context(ctx context.Context) *FamilysharingUnshareCall {
+ c.ctx_ = ctx
+ return c
+}
+
+// Header returns an http.Header that can be modified by the caller to
+// add HTTP headers to the request.
+func (c *FamilysharingUnshareCall) Header() http.Header {
+ if c.header_ == nil {
+ c.header_ = make(http.Header)
+ }
+ return c.header_
+}
+
+func (c *FamilysharingUnshareCall) doRequest(alt string) (*http.Response, error) {
+ reqHeaders := make(http.Header)
+ for k, v := range c.header_ {
+ reqHeaders[k] = v
+ }
+ reqHeaders.Set("User-Agent", c.s.userAgent())
+ var body io.Reader = nil
+ c.urlParams_.Set("alt", alt)
+ urls := googleapi.ResolveRelative(c.s.BasePath, "familysharing/unshare")
+ urls += "?" + c.urlParams_.Encode()
+ req, _ := http.NewRequest("POST", urls, body)
+ req.Header = reqHeaders
+ return gensupport.SendRequest(c.ctx_, c.s.client, req)
+}
+
+// Do executes the "books.familysharing.unshare" call.
+func (c *FamilysharingUnshareCall) Do(opts ...googleapi.CallOption) error {
+ gensupport.SetOptions(c.urlParams_, opts...)
+ res, err := c.doRequest("json")
+ if err != nil {
+ return err
+ }
+ defer googleapi.CloseBody(res)
+ if err := googleapi.CheckResponse(res); err != nil {
+ return err
+ }
+ return nil
+ // {
+ // "description": "Initiates revoking content that has already been shared with the user's family. Empty response indicates success.",
+ // "httpMethod": "POST",
+ // "id": "books.familysharing.unshare",
+ // "parameters": {
+ // "docId": {
+ // "description": "The docid to unshare.",
+ // "location": "query",
+ // "type": "string"
+ // },
+ // "source": {
+ // "description": "String to identify the originator of this request.",
+ // "location": "query",
+ // "type": "string"
+ // },
+ // "volumeId": {
+ // "description": "The volume to unshare.",
+ // "location": "query",
+ // "type": "string"
+ // }
+ // },
+ // "path": "familysharing/unshare",
+ // "scopes": [
+ // "https://www.googleapis.com/auth/books"
+ // ]
+ // }
+
+}
+
// method id "books.layers.get":
type LayersGetCall struct {
diff --git a/classroom/v1/classroom-api.json b/classroom/v1/classroom-api.json
index 2461441..bb7392c 100644
--- a/classroom/v1/classroom-api.json
+++ b/classroom/v1/classroom-api.json
@@ -1,9 +1,1915 @@
{
+ "title": "Google Classroom API",
+ "ownerName": "Google",
+ "discoveryVersion": "v1",
+ "resources": {
+ "courses": {
+ "methods": {
+ "list": {
+ "response": {
+ "$ref": "ListCoursesResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.courses",
+ "https://www.googleapis.com/auth/classroom.courses.readonly"
+ ],
+ "parameters": {
+ "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"
+ },
+ "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": {
+ "description": "Maximum number of items to return. Zero or unspecified indicates that the\nserver may assign a maximum.\n\nThe server may return fewer than the specified number of results.",
+ "format": "int32",
+ "type": "integer",
+ "location": "query"
+ },
+ "teacherId": {
+ "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"
+ },
+ "courseStates": {
+ "location": "query",
+ "enum": [
+ "COURSE_STATE_UNSPECIFIED",
+ "ACTIVE",
+ "ARCHIVED",
+ "PROVISIONED",
+ "DECLINED",
+ "SUSPENDED"
+ ],
+ "description": "Restricts returned courses to those in one of the specified states\nThe default value is ACTIVE, ARCHIVED, PROVISIONED, DECLINED.",
+ "type": "string",
+ "repeated": true
+ }
+ },
+ "flatPath": "v1/courses",
+ "path": "v1/courses",
+ "id": "classroom.courses.list",
+ "description": "Returns a list of courses that the requesting user is permitted to view,\nrestricted to those that match the request. Returned courses are ordered by\ncreation time, with the most recently created coming first.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` for access errors.\n* `INVALID_ARGUMENT` if the query argument is malformed.\n* `NOT_FOUND` if any users specified in the query arguments do not exist."
+ },
+ "create": {
+ "description": "Creates a course.\n\nThe user specified in `ownerId` is the owner of the created course\nand added as a teacher.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to create\ncourses or for access errors.\n* `NOT_FOUND` if the primary teacher is not a valid user.\n* `FAILED_PRECONDITION` if the course owner's account is disabled or for\nthe following request errors:\n * UserGroupsMembershipLimitReached\n* `ALREADY_EXISTS` if an alias was specified in the `id` and\nalready exists.",
+ "request": {
+ "$ref": "Course"
+ },
+ "response": {
+ "$ref": "Course"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.courses"
+ ],
+ "parameters": {},
+ "flatPath": "v1/courses",
+ "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.",
+ "response": {
+ "$ref": "Course"
+ },
+ "parameterOrder": [
+ "id"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.courses",
+ "https://www.googleapis.com/auth/classroom.courses.readonly"
+ ],
+ "parameters": {
+ "id": {
+ "location": "path",
+ "description": "Identifier of the course to return.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1/courses/{id}",
+ "path": "v1/courses/{id}",
+ "id": "classroom.courses.get"
+ },
+ "patch": {
+ "flatPath": "v1/courses/{id}",
+ "path": "v1/courses/{id}",
+ "id": "classroom.courses.patch",
+ "description": "Updates one or more fields in a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to modify the\nrequested course or for access errors.\n* `NOT_FOUND` if no course exists with the requested ID.\n* `INVALID_ARGUMENT` if invalid fields are specified in the update mask or\nif no update mask is supplied.\n* `FAILED_PRECONDITION` for the following request errors:\n * CourseNotModifiable",
+ "request": {
+ "$ref": "Course"
+ },
+ "response": {
+ "$ref": "Course"
+ },
+ "parameterOrder": [
+ "id"
+ ],
+ "httpMethod": "PATCH",
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.courses"
+ ],
+ "parameters": {
+ "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"
+ },
+ "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"
+ }
+ }
+ },
+ "update": {
+ "flatPath": "v1/courses/{id}",
+ "id": "classroom.courses.update",
+ "path": "v1/courses/{id}",
+ "request": {
+ "$ref": "Course"
+ },
+ "description": "Updates a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to modify the\nrequested course or for access errors.\n* `NOT_FOUND` if no course exists with the requested ID.\n* `FAILED_PRECONDITION` for the following request errors:\n * CourseNotModifiable",
+ "httpMethod": "PUT",
+ "parameterOrder": [
+ "id"
+ ],
+ "response": {
+ "$ref": "Course"
+ },
+ "parameters": {
+ "id": {
+ "location": "path",
+ "description": "Identifier of the course to update.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.courses"
+ ]
+ },
+ "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"
+ },
+ "parameterOrder": [
+ "id"
+ ],
+ "httpMethod": "DELETE",
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.courses"
+ ],
+ "parameters": {
+ "id": {
+ "location": "path",
+ "description": "Identifier of the course to delete.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1/courses/{id}",
+ "path": "v1/courses/{id}",
+ "id": "classroom.courses.delete"
+ }
+ },
+ "resources": {
+ "teachers": {
+ "methods": {
+ "delete": {
+ "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.",
+ "httpMethod": "DELETE",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "courseId",
+ "userId"
+ ],
+ "parameters": {
+ "userId": {
+ "description": "Identifier of the teacher to delete. The identifier can be one of the\nfollowing:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "courseId": {
+ "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.rosters"
+ ]
+ },
+ "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",
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.profile.emails",
+ "https://www.googleapis.com/auth/classroom.profile.photos",
+ "https://www.googleapis.com/auth/classroom.rosters",
+ "https://www.googleapis.com/auth/classroom.rosters.readonly"
+ ],
+ "parameters": {
+ "userId": {
+ "location": "path",
+ "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": {
+ "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ }
+ },
+ "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": {
+ "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"
+ },
+ "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"
+ }
+ },
+ "flatPath": "v1/courses/{courseId}/teachers",
+ "path": "v1/courses/{courseId}/teachers",
+ "id": "classroom.courses.teachers.list"
+ },
+ "create": {
+ "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",
+ "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"
+ }
+ }
+ }
+ },
+ "announcements": {
+ "methods": {
+ "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.",
+ "response": {
+ "$ref": "ListAnnouncementsResponse"
+ },
+ "parameterOrder": [
+ "courseId"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.announcements",
+ "https://www.googleapis.com/auth/classroom.announcements.readonly"
+ ],
+ "parameters": {
+ "announcementStates": {
+ "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",
+ "repeated": true
+ },
+ "orderBy": {
+ "location": "query",
+ "description": "Optional sort ordering for results. A comma-separated list of fields with\nan optional sort direction keyword. Supported field is `updateTime`.\nSupported direction keywords are `asc` and `desc`.\nIf not specified, `updateTime desc` is the default behavior.\nExamples: `updateTime asc`, `updateTime`",
+ "type": "string"
+ },
+ "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": {
+ "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}/announcements",
+ "path": "v1/courses/{courseId}/announcements",
+ "id": "classroom.courses.announcements.list"
+ },
+ "create": {
+ "description": "Creates an announcement.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\nrequested course, create announcements in the requested course, share a\nDrive attachment, or for access errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course does not exist.\n* `FAILED_PRECONDITION` for the following request error:\n * AttachmentNotVisible",
+ "request": {
+ "$ref": "Announcement"
+ },
+ "response": {
+ "$ref": "Announcement"
+ },
+ "parameterOrder": [
+ "courseId"
+ ],
+ "httpMethod": "POST",
+ "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"
+ }
+ },
+ "flatPath": "v1/courses/{courseId}/announcements",
+ "path": "v1/courses/{courseId}/announcements",
+ "id": "classroom.courses.announcements.create"
+ },
+ "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.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "courseId",
+ "id"
+ ],
+ "response": {
+ "$ref": "Announcement"
+ },
+ "parameters": {
+ "courseId": {
+ "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "id": {
+ "description": "Identifier of the announcement.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.announcements"
+ ],
+ "flatPath": "v1/courses/{courseId}/announcements/{id}:modifyAssignees",
+ "id": "classroom.courses.announcements.modifyAssignees",
+ "path": "v1/courses/{courseId}/announcements/{id}:modifyAssignees"
+ },
+ "patch": {
+ "flatPath": "v1/courses/{courseId}/announcements/{id}",
+ "path": "v1/courses/{courseId}/announcements/{id}",
+ "id": "classroom.courses.announcements.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",
+ "response": {
+ "$ref": "Announcement"
+ },
+ "parameterOrder": [
+ "courseId",
+ "id"
+ ],
+ "httpMethod": "PATCH",
+ "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"
+ },
+ "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"
+ ]
+ },
+ "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": {
+ "description": "Identifier of the announcement.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ }
+ },
+ "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": {
+ "location": "path",
+ "description": "Identifier of the announcement to delete.\nThis identifier is a Classroom-assigned identifier.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "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."
+ }
+ }
+ },
+ "students": {
+ "methods": {
+ "delete": {
+ "flatPath": "v1/courses/{courseId}/students/{userId}",
+ "id": "classroom.courses.students.delete",
+ "path": "v1/courses/{courseId}/students/{userId}",
+ "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",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "courseId",
+ "userId"
+ ],
+ "parameters": {
+ "courseId": {
+ "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "userId": {
+ "location": "path",
+ "description": "Identifier of the student to delete. The identifier can be one of the\nfollowing:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.rosters"
+ ]
+ },
+ "get": {
+ "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.",
+ "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": {
+ "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "userId": {
+ "location": "path",
+ "description": "Identifier of the student to 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"
+ }
+ }
+ },
+ "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": {
+ "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": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "nextPageToken\nvalue returned from a previous\nlist call, 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"
+ }
+ },
+ "flatPath": "v1/courses/{courseId}/students",
+ "path": "v1/courses/{courseId}/students",
+ "id": "classroom.courses.students.list"
+ },
+ "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.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "courseId"
+ ],
+ "response": {
+ "$ref": "Student"
+ },
+ "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": {
+ "location": "query",
+ "description": "Enrollment code of the course to create the student in.\nThis code is required if userId\ncorresponds to the requesting user; it may be omitted if the requesting\nuser has administrative permissions to create students for any user.",
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.profile.emails",
+ "https://www.googleapis.com/auth/classroom.profile.photos",
+ "https://www.googleapis.com/auth/classroom.rosters"
+ ],
+ "flatPath": "v1/courses/{courseId}/students",
+ "id": "classroom.courses.students.create",
+ "path": "v1/courses/{courseId}/students"
+ }
+ }
+ },
+ "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.",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "Topic"
+ },
+ "parameterOrder": [
+ "courseId",
+ "id"
+ ],
+ "parameters": {
+ "courseId": {
+ "description": "Identifier of the course.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "id": {
+ "description": "Identifier of the topic.",
+ "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}/topics/{id}",
+ "id": "classroom.courses.topics.get",
+ "path": "v1/courses/{courseId}/topics/{id}"
+ },
+ "list": {
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "ListTopicResponse"
+ },
+ "parameterOrder": [
+ "courseId"
+ ],
+ "parameters": {
+ "pageSize": {
+ "description": "Maximum number of items to return. Zero or unspecified indicates that the\nserver may assign a maximum.\n\nThe server may return fewer than the specified number of results.",
+ "format": "int32",
+ "type": "integer",
+ "location": "query"
+ },
+ "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,\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"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.coursework.me",
+ "https://www.googleapis.com/auth/classroom.coursework.me.readonly",
+ "https://www.googleapis.com/auth/classroom.coursework.students",
+ "https://www.googleapis.com/auth/classroom.coursework.students.readonly"
+ ],
+ "flatPath": "v1/courses/{courseId}/topics",
+ "id": "classroom.courses.topics.list",
+ "path": "v1/courses/{courseId}/topics",
+ "description": "Returns the list of topics that the requester is permitted to view.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access\nthe requested course or for access errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course does not exist."
+ }
+ }
+ },
+ "aliases": {
+ "methods": {
+ "delete": {
+ "description": "Deletes an alias of a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to remove the\nalias or for access errors.\n* `NOT_FOUND` if the alias does not exist.\n* `FAILED_PRECONDITION` if the alias requested does not make sense for the\n requesting user or course (for example, if a user not in a domain\n attempts to delete a domain-scoped alias).",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "courseId",
+ "alias"
+ ],
+ "httpMethod": "DELETE",
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.courses"
+ ],
+ "parameters": {
+ "courseId": {
+ "location": "path",
+ "description": "Identifier of the course whose alias should be deleted.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
+ "required": true,
+ "type": "string"
+ },
+ "alias": {
+ "description": "Alias to delete.\nThis may not be the Classroom-assigned identifier.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/courses/{courseId}/aliases/{alias}",
+ "path": "v1/courses/{courseId}/aliases/{alias}",
+ "id": "classroom.courses.aliases.delete"
+ },
+ "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": {
+ "location": "path",
+ "description": "The identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1/courses/{courseId}/aliases",
+ "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": {
+ "flatPath": "v1/courses/{courseId}/aliases",
+ "id": "classroom.courses.aliases.create",
+ "path": "v1/courses/{courseId}/aliases",
+ "request": {
+ "$ref": "CourseAlias"
+ },
+ "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).",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "courseId"
+ ],
+ "response": {
+ "$ref": "CourseAlias"
+ },
+ "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"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.courses"
+ ]
+ }
+ }
+ },
+ "courseWork": {
+ "methods": {
+ "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",
+ "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": {
+ "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": {
+ "description": "nextPageToken\nvalue returned from a previous\nlist call,\nindicating that the subsequent page of results should be returned.\n\nThe list request\nmust be otherwise identical to the one that resulted in this token.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageSize": {
+ "location": "query",
+ "description": "Maximum number of items to return. Zero or unspecified indicates that the\nserver may assign a maximum.\n\nThe server may return fewer than the specified number of results.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "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
+ },
+ "courseId": {
+ "location": "path",
+ "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
+ "required": true,
+ "type": "string"
+ }
+ }
+ },
+ "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": {
+ "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/courses/{courseId}/courseWork",
+ "path": "v1/courses/{courseId}/courseWork",
+ "id": "classroom.courses.courseWork.create"
+ },
+ "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": {
+ "location": "path",
+ "description": "Identifier of the coursework.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "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": {
+ "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",
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.coursework.me",
+ "https://www.googleapis.com/auth/classroom.coursework.me.readonly",
+ "https://www.googleapis.com/auth/classroom.coursework.students",
+ "https://www.googleapis.com/auth/classroom.coursework.students.readonly"
+ ],
+ "parameters": {
+ "courseId": {
+ "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "id": {
+ "location": "path",
+ "description": "Identifier of the course work.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1/courses/{courseId}/courseWork/{id}",
+ "path": "v1/courses/{courseId}/courseWork/{id}",
+ "id": "classroom.courses.courseWork.get"
+ },
+ "patch": {
+ "description": "Updates one or more fields of a course work.\n\nSee google.classroom.v1.CourseWork for details\nof which fields may be updated and who may change them.\n\nThis request must be made by the Developer Console project of the\n[OAuth client ID](https://support.google.com/cloud/answer/6158849) used to\ncreate the corresponding course work item.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting developer project did not create\nthe corresponding course work, if the user is not permitted to make the\nrequested modification to the student submission, or for\naccess errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `FAILED_PRECONDITION` if the requested course work has already been\ndeleted.\n* `NOT_FOUND` if the requested course, course work, or student submission\ndoes not exist.",
+ "request": {
+ "$ref": "CourseWork"
+ },
+ "response": {
+ "$ref": "CourseWork"
+ },
+ "parameterOrder": [
+ "courseId",
+ "id"
+ ],
+ "httpMethod": "PATCH",
+ "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 course work.",
+ "required": true,
+ "type": "string"
+ },
+ "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"
+ }
+ },
+ "flatPath": "v1/courses/{courseId}/courseWork/{id}",
+ "path": "v1/courses/{courseId}/courseWork/{id}",
+ "id": "classroom.courses.courseWork.patch"
+ },
+ "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.",
+ "httpMethod": "DELETE",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "courseId",
+ "id"
+ ],
+ "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 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}",
+ "id": "classroom.courses.courseWork.delete",
+ "path": "v1/courses/{courseId}/courseWork/{id}"
+ }
+ },
+ "resources": {
+ "studentSubmissions": {
+ "methods": {
+ "reclaim": {
+ "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.",
+ "request": {
+ "$ref": "ReclaimStudentSubmissionRequest"
+ },
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "courseId",
+ "courseWorkId",
+ "id"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.coursework.me"
+ ],
+ "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}:reclaim",
+ "path": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:reclaim",
+ "id": "classroom.courses.courseWork.studentSubmissions.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": {
+ "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"
+ }
+ }
+ },
+ "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.",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "ListStudentSubmissionsResponse"
+ },
+ "parameterOrder": [
+ "courseId",
+ "courseWorkId"
+ ],
+ "parameters": {
+ "userId": {
+ "description": "Optional argument to restrict returned student work to those owned by the\nstudent with the specified identifier. The identifier can be one of the\nfollowing:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user",
+ "type": "string",
+ "location": "query"
+ },
+ "courseWorkId": {
+ "description": "Identifier of the student work to request.\nThis may be set to the string literal `\"-\"` to request student work for\nall course work in the specified course.",
+ "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"
+ },
+ "late": {
+ "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",
+ "enum": [
+ "LATE_VALUES_UNSPECIFIED",
+ "LATE_ONLY",
+ "NOT_LATE_ONLY"
+ ]
+ },
+ "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"
+ },
+ "states": {
+ "location": "query",
+ "enum": [
+ "SUBMISSION_STATE_UNSPECIFIED",
+ "NEW",
+ "CREATED",
+ "TURNED_IN",
+ "RETURNED",
+ "RECLAIMED_BY_STUDENT"
+ ],
+ "description": "Requested submission states. If specified, returned student submissions\nmatch one of the specified submission states.",
+ "type": "string",
+ "repeated": true
+ }
+ },
+ "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": "classroom.courses.courseWork.studentSubmissions.list",
+ "path": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions"
+ },
+ "modifyAttachments": {
+ "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"
+ },
+ "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": {
+ "location": "path",
+ "description": "Identifier of the course work.",
+ "required": true,
+ "type": "string"
+ },
+ "courseId": {
+ "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "id": {
+ "location": "path",
+ "description": "Identifier of the student submission.",
+ "required": true,
+ "type": "string"
+ }
+ }
+ },
+ "get": {
+ "response": {
+ "$ref": "StudentSubmission"
+ },
+ "parameterOrder": [
+ "courseId",
+ "courseWorkId",
+ "id"
+ ],
+ "httpMethod": "GET",
+ "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": {
+ "description": "Identifier of the student submission.",
+ "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",
+ "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."
+ },
+ "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": {
+ "updateMask": {
+ "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",
+ "type": "string"
+ },
+ "courseWorkId": {
+ "location": "path",
+ "description": "Identifier of the course work.",
+ "required": true,
+ "type": "string"
+ },
+ "courseId": {
+ "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "id": {
+ "location": "path",
+ "description": "Identifier of the student submission.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}",
+ "path": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}",
+ "id": "classroom.courses.courseWork.studentSubmissions.patch",
+ "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"
+ }
+ },
+ "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": {
+ "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": {
+ "description": "Identifier of the student submission.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "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"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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.",
+ "response": {
+ "$ref": "UserProfile"
+ },
+ "parameterOrder": [
+ "userId"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.profile.emails",
+ "https://www.googleapis.com/auth/classroom.profile.photos",
+ "https://www.googleapis.com/auth/classroom.rosters",
+ "https://www.googleapis.com/auth/classroom.rosters.readonly"
+ ],
+ "parameters": {
+ "userId": {
+ "location": "path",
+ "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"
+ }
+ }
+ }
+ },
+ "resources": {
+ "guardianInvitations": {
+ "methods": {
+ "list": {
+ "description": "Returns a list of guardian invitations that the requesting user is\npermitted to view, filtered by the parameters provided.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if a `student_id` is specified, and the requesting\n user is not permitted to view guardian invitations for that student, if\n `\"-\"` is specified as the `student_id` and the user is not a domain\n administrator, if guardians are not enabled for the domain in question,\n or for other access errors.\n* `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot\n be recognized (it is not an email address, nor a `student_id` from the\n API, nor the literal string `me`). May also be returned if an invalid\n `page_token` or `state` is provided.\n* `NOT_FOUND` if a `student_id` is specified, and its format can be\n recognized, but Classroom has no record of that student.",
+ "response": {
+ "$ref": "ListGuardianInvitationsResponse"
+ },
+ "parameterOrder": [
+ "studentId"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.guardianlinks.students",
+ "https://www.googleapis.com/auth/classroom.guardianlinks.students.readonly"
+ ],
+ "parameters": {
+ "studentId": {
+ "location": "path",
+ "description": "The ID of the student whose guardian invitations are to be returned.\nThe identifier can be one of the following:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user\n* the string literal `\"-\"`, indicating that results should be returned for\n all students that the requesting user is permitted to view guardian\n invitations.",
+ "required": true,
+ "type": "string"
+ },
+ "pageToken": {
+ "description": "nextPageToken\nvalue returned from a previous\nlist call,\nindicating that the subsequent page of results should be returned.\n\nThe list request\nmust be otherwise identical to the one that resulted in this token.",
+ "type": "string",
+ "location": "query"
+ },
+ "invitedEmailAddress": {
+ "description": "If specified, only results with the specified `invited_email_address`\nwill be returned.",
+ "type": "string",
+ "location": "query"
+ },
+ "states": {
+ "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",
+ "repeated": true
+ },
+ "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"
+ }
+ },
+ "flatPath": "v1/userProfiles/{studentId}/guardianInvitations",
+ "path": "v1/userProfiles/{studentId}/guardianInvitations",
+ "id": "classroom.userProfiles.guardianInvitations.list"
+ },
+ "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",
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.guardianlinks.students",
+ "https://www.googleapis.com/auth/classroom.guardianlinks.students.readonly"
+ ],
+ "parameters": {
+ "invitationId": {
+ "description": "The `id` field of the `GuardianInvitation` being requested.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "studentId": {
+ "description": "The ID of the student whose guardian invitation is being requested.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/userProfiles/{studentId}/guardianInvitations/{invitationId}",
+ "path": "v1/userProfiles/{studentId}/guardianInvitations/{invitationId}",
+ "id": "classroom.userProfiles.guardianInvitations.get"
+ },
+ "patch": {
+ "request": {
+ "$ref": "GuardianInvitation"
+ },
+ "description": "Modifies a guardian invitation.\n\nCurrently, the only valid modification is to change the `state` from\n`PENDING` to `COMPLETE`. This has the effect of withdrawing the invitation.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the current user does not have permission to\n manage guardians, if guardians are not enabled for the domain in question\n or for other access errors.\n* `FAILED_PRECONDITION` if the guardian link is not in the `PENDING` state.\n* `INVALID_ARGUMENT` if the format of the student ID provided\n cannot be recognized (it is not an email address, nor a `user_id` from\n this API), or if the passed `GuardianInvitation` has a `state` other than\n `COMPLETE`, or if it modifies fields other than `state`.\n* `NOT_FOUND` if the student ID provided is a valid student ID, but\n Classroom has no record of that student, or if the `id` field does not\n refer to a guardian invitation known to Classroom.",
+ "response": {
+ "$ref": "GuardianInvitation"
+ },
+ "parameterOrder": [
+ "studentId",
+ "invitationId"
+ ],
+ "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": {
+ "location": "path",
+ "description": "The ID of the student whose guardian invitation is to be modified.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.guardianlinks.students"
+ ],
+ "flatPath": "v1/userProfiles/{studentId}/guardianInvitations/{invitationId}",
+ "path": "v1/userProfiles/{studentId}/guardianInvitations/{invitationId}",
+ "id": "classroom.userProfiles.guardianInvitations.patch"
+ },
+ "create": {
+ "request": {
+ "$ref": "GuardianInvitation"
+ },
+ "description": "Creates a guardian invitation, and sends an email to the guardian asking\nthem to confirm that they are the student's guardian.\n\nOnce the guardian accepts the invitation, their `state` will change to\n`COMPLETED` and they will start receiving guardian notifications. A\n`Guardian` resource will also be created to represent the active guardian.\n\nThe request object must have the `student_id` and\n`invited_email_address` fields set. Failing to set these fields, or\nsetting any other fields in the request, will result in an error.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the current user does not have permission to\n manage guardians, if the guardian in question has already rejected\n too many requests for that student, if guardians are not enabled for the\n domain in question, or for other access errors.\n* `RESOURCE_EXHAUSTED` if the student or guardian has exceeded the guardian\n link limit.\n* `INVALID_ARGUMENT` if the guardian email address is not valid (for\n example, if it is too long), or if the format of the student ID provided\n cannot be recognized (it is not an email address, nor a `user_id` from\n this API). This error will also be returned if read-only fields are set,\n or if the `state` field is set to to a value other than `PENDING`.\n* `NOT_FOUND` if the student ID provided is a valid student ID, but\n Classroom has no record of that student.\n* `ALREADY_EXISTS` if there is already a pending guardian invitation for\n the student and `invited_email_address` provided, or if the provided\n `invited_email_address` matches the Google account of an existing\n `Guardian` for this user.",
+ "response": {
+ "$ref": "GuardianInvitation"
+ },
+ "parameterOrder": [
+ "studentId"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "studentId": {
+ "location": "path",
+ "description": "ID of the student (in standard format)",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.guardianlinks.students"
+ ],
+ "flatPath": "v1/userProfiles/{studentId}/guardianInvitations",
+ "path": "v1/userProfiles/{studentId}/guardianInvitations",
+ "id": "classroom.userProfiles.guardianInvitations.create"
+ }
+ }
+ },
+ "guardians": {
+ "methods": {
+ "delete": {
+ "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`.",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "studentId",
+ "guardianId"
+ ],
+ "httpMethod": "DELETE",
+ "parameters": {
+ "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"
+ },
+ "guardianId": {
+ "location": "path",
+ "description": "The `id` field from a `Guardian`.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.guardianlinks.students"
+ ]
+ },
+ "list": {
+ "description": "Returns a list of guardians that the requesting user is permitted to\nview, restricted to those that match the request.\n\nTo list guardians for any student that the requesting user may view\nguardians for, use the literal character `-` for the student ID.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if a `student_id` is specified, and the requesting\n user is not permitted to view guardian information for that student, if\n `\"-\"` is specified as the `student_id` and the user is not a domain\n administrator, if guardians are not enabled for the domain in question,\n if the `invited_email_address` filter is set by a user who is not a\n domain administrator, or for other access errors.\n* `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot\n be recognized (it is not an email address, nor a `student_id` from the\n API, nor the literal string `me`). May also be returned if an invalid\n `page_token` is provided.\n* `NOT_FOUND` if a `student_id` is specified, and its format can be\n recognized, but Classroom has no record of that student.",
+ "response": {
+ "$ref": "ListGuardiansResponse"
+ },
+ "parameterOrder": [
+ "studentId"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.guardianlinks.me.readonly",
+ "https://www.googleapis.com/auth/classroom.guardianlinks.students",
+ "https://www.googleapis.com/auth/classroom.guardianlinks.students.readonly"
+ ],
+ "parameters": {
+ "invitedEmailAddress": {
+ "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",
+ "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"
+ },
+ "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,
+ "type": "string",
+ "location": "path"
+ },
+ "pageToken": {
+ "description": "nextPageToken\nvalue returned from a previous\nlist call,\nindicating that the subsequent page of results should be returned.\n\nThe list request\nmust be otherwise identical to the one that resulted in this token.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "flatPath": "v1/userProfiles/{studentId}/guardians",
+ "path": "v1/userProfiles/{studentId}/guardians",
+ "id": "classroom.userProfiles.guardians.list"
+ },
+ "get": {
+ "description": "Returns a specific guardian.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if no user that matches the provided `student_id`\n is visible to the requesting user, if the requesting user is not\n permitted to view guardian information for the student identified by the\n `student_id`, if guardians are not enabled for the domain in question,\n or for other access errors.\n* `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot\n be recognized (it is not an email address, nor a `student_id` from the\n API, nor the literal string `me`).\n* `NOT_FOUND` if the requesting user is permitted to view guardians for\n the requested `student_id`, but no `Guardian` record exists for that\n student that matches the provided `guardian_id`.",
+ "response": {
+ "$ref": "Guardian"
+ },
+ "parameterOrder": [
+ "studentId",
+ "guardianId"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.guardianlinks.me.readonly",
+ "https://www.googleapis.com/auth/classroom.guardianlinks.students",
+ "https://www.googleapis.com/auth/classroom.guardianlinks.students.readonly"
+ ],
+ "parameters": {
+ "guardianId": {
+ "location": "path",
+ "description": "The `id` field from a `Guardian`.",
+ "required": true,
+ "type": "string"
+ },
+ "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"
+ }
+ },
+ "flatPath": "v1/userProfiles/{studentId}/guardians/{guardianId}",
+ "path": "v1/userProfiles/{studentId}/guardians/{guardianId}",
+ "id": "classroom.userProfiles.guardians.get"
+ }
+ }
+ }
+ }
+ },
+ "registrations": {
+ "methods": {
+ "create": {
+ "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"
+ },
+ "response": {
+ "$ref": "Registration"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "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": {}
+ },
+ "delete": {
+ "httpMethod": "DELETE",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "registrationId"
+ ],
+ "parameters": {
+ "registrationId": {
+ "description": "The `registration_id` of the `Registration` to be deleted.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "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}",
+ "id": "classroom.registrations.delete",
+ "path": "v1/registrations/{registrationId}",
+ "description": "Deletes a `Registration`, causing Classroom to stop sending notifications\nfor that `Registration`."
+ }
+ }
+ },
+ "invitations": {
+ "methods": {
+ "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"
+ },
+ "parameterOrder": [
+ "id"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.rosters"
+ ],
+ "parameters": {
+ "id": {
+ "description": "Identifier of the invitation to accept.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/invitations/{id}:accept",
+ "path": "v1/invitations/{id}:accept",
+ "id": "classroom.invitations.accept"
+ },
+ "delete": {
+ "flatPath": "v1/invitations/{id}",
+ "id": "classroom.invitations.delete",
+ "path": "v1/invitations/{id}",
+ "description": "Deletes an invitation.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to delete the\nrequested invitation or for access errors.\n* `NOT_FOUND` if no invitation exists with the requested ID.",
+ "httpMethod": "DELETE",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "Identifier of the invitation to delete.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.rosters"
+ ]
+ },
+ "get": {
+ "description": "Returns an invitation.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to view the\nrequested invitation or for access errors.\n* `NOT_FOUND` if no invitation exists with the requested ID.",
+ "response": {
+ "$ref": "Invitation"
+ },
+ "parameterOrder": [
+ "id"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "id": {
+ "location": "path",
+ "description": "Identifier of the invitation to return.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.rosters",
+ "https://www.googleapis.com/auth/classroom.rosters.readonly"
+ ],
+ "flatPath": "v1/invitations/{id}",
+ "path": "v1/invitations/{id}",
+ "id": "classroom.invitations.get"
+ },
+ "list": {
+ "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"
+ },
+ "parameterOrder": [],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.rosters",
+ "https://www.googleapis.com/auth/classroom.rosters.readonly"
+ ],
+ "parameters": {
+ "pageSize": {
+ "location": "query",
+ "description": "Maximum number of items to return. Zero means no maximum.\n\nThe server may return fewer than the specified number of results.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "courseId": {
+ "description": "Restricts returned invitations to those for a course with the specified\nidentifier.",
+ "type": "string",
+ "location": "query"
+ },
+ "userId": {
+ "location": "query",
+ "description": "Restricts returned invitations to those for a specific user. The identifier\ncan be one of the following:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user",
+ "type": "string"
+ },
+ "pageToken": {
+ "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",
+ "location": "query"
+ }
+ },
+ "flatPath": "v1/invitations",
+ "path": "v1/invitations",
+ "id": "classroom.invitations.list"
+ },
+ "create": {
+ "flatPath": "v1/invitations",
+ "path": "v1/invitations",
+ "id": "classroom.invitations.create",
+ "description": "Creates an invitation. Only one invitation for a user and course may exist\nat a time. Delete and re-create an invitation to make changes.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to create\ninvitations for this course or for access errors.\n* `NOT_FOUND` if the course or the user does not exist.\n* `FAILED_PRECONDITION` if the requested user's account is disabled or if\nthe user already has this role or a role with greater permissions.\n* `ALREADY_EXISTS` if an invitation for the specified user and course\nalready exists.",
+ "request": {
+ "$ref": "Invitation"
+ },
+ "response": {
+ "$ref": "Invitation"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.rosters"
+ ],
+ "parameters": {}
+ }
+ }
+ }
+ },
"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",
- "location": "query"
+ "type": "string"
},
"pp": {
"location": "query",
@@ -11,30 +1917,25 @@
"type": "boolean",
"default": "true"
},
- "oauth_token": {
- "type": "string",
- "location": "query",
- "description": "OAuth 2.0 token for the current user."
- },
"bearer_token": {
- "location": "query",
"description": "OAuth bearer token.",
- "type": "string"
- },
- "upload_protocol": {
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"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": {
+ "description": "Returns response with indentations and line breaks.",
"type": "boolean",
"default": "true",
- "location": "query",
- "description": "Returns response with indentations and line breaks."
- },
- "fields": {
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string",
"location": "query"
},
"uploadType": {
@@ -42,9 +1943,17 @@
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"type": "string"
},
+ "fields": {
+ "location": "query",
+ "description": "Selector specifying which fields to include in a partial response.",
+ "type": "string"
+ },
+ "callback": {
+ "location": "query",
+ "description": "JSONP",
+ "type": "string"
+ },
"$.xgafv": {
- "description": "V1 error format.",
- "type": "string",
"enumDescriptions": [
"v1 error format",
"v2 error format"
@@ -53,19 +1962,11 @@
"enum": [
"1",
"2"
- ]
- },
- "callback": {
- "description": "JSONP",
- "type": "string",
- "location": "query"
+ ],
+ "description": "V1 error format.",
+ "type": "string"
},
"alt": {
- "enum": [
- "json",
- "media",
- "proto"
- ],
"type": "string",
"enumDescriptions": [
"Responses with Content-Type of application/json",
@@ -74,20 +1975,293 @@
],
"location": "query",
"description": "Data format for response.",
- "default": "json"
- },
- "access_token": {
- "description": "OAuth access token.",
- "type": "string",
- "location": "query"
+ "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"
}
},
"schemas": {
+ "CourseAlias": {
+ "description": "Alternative identifier for a course.\n\nAn alias uniquely identifies a course. It must be unique within one of the\nfollowing scopes:\n\n* domain: A domain-scoped alias is visible to all users within the alias\ncreator's domain and can be created only by a domain admin. A domain-scoped\nalias is often used when a course has an identifier external to Classroom.\n\n* project: A project-scoped alias is visible to any request from an\napplication using the Developer Console project ID that created the alias\nand can be created by any project. A project-scoped alias is often used when\nan application has alternative identifiers. A random value can also be used\nto avoid duplicate courses in the event of transmission failures, as retrying\na request will return `ALREADY_EXISTS` if a previous one has succeeded.",
+ "type": "object",
+ "properties": {
+ "alias": {
+ "description": "Alias string. The format of the string indicates the desired alias scoping.\n\n* `d:\u003cname\u003e` indicates a domain-scoped alias.\n Example: `d:math_101`\n* `p:\u003cname\u003e` indicates a project-scoped alias.\n Example: `p:abc123`\n\nThis field has a maximum length of 256 characters.",
+ "type": "string"
+ }
+ },
+ "id": "CourseAlias"
+ },
+ "ListCourseAliasesResponse": {
+ "description": "Response when listing course aliases.",
+ "type": "object",
+ "properties": {
+ "aliases": {
+ "description": "The course aliases.",
+ "type": "array",
+ "items": {
+ "$ref": "CourseAlias"
+ }
+ },
+ "nextPageToken": {
+ "description": "Token identifying the next page of results to return. If empty, no further\nresults are available.",
+ "type": "string"
+ }
+ },
+ "id": "ListCourseAliasesResponse"
+ },
+ "ListGuardianInvitationsResponse": {
+ "description": "Response when listing guardian invitations.",
+ "type": "object",
+ "properties": {
+ "nextPageToken": {
+ "description": "Token identifying the next page of results to return. If empty, no further\nresults are available.",
+ "type": "string"
+ },
+ "guardianInvitations": {
+ "description": "Guardian invitations that matched the list request.",
+ "type": "array",
+ "items": {
+ "$ref": "GuardianInvitation"
+ }
+ }
+ },
+ "id": "ListGuardianInvitationsResponse"
+ },
+ "IndividualStudentsOptions": {
+ "description": "Assignee details about a coursework/announcement.\nThis field is set if and only if `assigneeMode` is `INDIVIDUAL_STUDENTS`.",
+ "type": "object",
+ "properties": {
+ "studentIds": {
+ "description": "Identifiers for the students that have access to the\ncoursework/announcement.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "id": "IndividualStudentsOptions"
+ },
+ "MultipleChoiceSubmission": {
+ "description": "Student work for a multiple-choice question.",
+ "type": "object",
+ "properties": {
+ "answer": {
+ "description": "Student's select choice.",
+ "type": "string"
+ }
+ },
+ "id": "MultipleChoiceSubmission"
+ },
+ "Registration": {
+ "description": "An instruction to Classroom to send notifications from the `feed` to the\nprovided `destination`.",
+ "type": "object",
+ "properties": {
+ "feed": {
+ "description": "Specification for the class of notifications that Classroom should deliver\nto the `destination`.",
+ "$ref": "Feed"
+ },
+ "registrationId": {
+ "description": "A server-generated unique identifier for this `Registration`.\n\nRead-only.",
+ "type": "string"
+ },
+ "cloudPubsubTopic": {
+ "description": "The Cloud Pub/Sub topic that notifications are to be sent to.",
+ "$ref": "CloudPubsubTopic"
+ },
+ "expiryTime": {
+ "description": "The time until which the `Registration` is effective.\n\nThis is a read-only field assigned by the server.",
+ "format": "google-datetime",
+ "type": "string"
+ }
+ },
+ "id": "Registration"
+ },
+ "CourseMaterial": {
+ "description": "A material attached to a course as part of a material set.",
+ "type": "object",
+ "properties": {
+ "driveFile": {
+ "$ref": "DriveFile",
+ "description": "Google Drive file attachment."
+ },
+ "youTubeVideo": {
+ "$ref": "YouTubeVideo",
+ "description": "Youtube video attachment."
+ },
+ "form": {
+ "$ref": "Form",
+ "description": "Google Forms attachment."
+ },
+ "link": {
+ "$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": {
+ "description": "A Course in Classroom.",
+ "type": "object",
+ "properties": {
+ "description": {
+ "description": "Optional description.\nFor example, \"We'll be learning about the structure of living\ncreatures from a combination of textbooks, guest lectures, and lab work.\nExpect to be excited!\"\nIf set, this field must be a valid UTF-8 string and no longer than 30,000\ncharacters.",
+ "type": "string"
+ },
+ "teacherGroupEmail": {
+ "description": "The email address of a Google group containing all teachers of the course.\nThis group does not accept email and can only be used for permissions.\n\nRead-only.",
+ "type": "string"
+ },
+ "creationTime": {
+ "description": "Creation time of the course.\nSpecifying this field in a course update mask results in an error.\n\nRead-only.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of the course.\nFor example, \"10th Grade Biology\".\nThe name is required. It must be between 1 and 750 characters and a valid\nUTF-8 string.",
+ "type": "string"
+ },
+ "teacherFolder": {
+ "description": "Information about a Drive Folder that is shared with all teachers of the\ncourse.\n\nThis field will only be set for teachers of the course and domain administrators.\n\nRead-only.",
+ "$ref": "DriveFolder"
+ },
+ "section": {
+ "description": "Section of the course.\nFor example, \"Period 2\".\nIf set, this field must be a valid UTF-8 string and no longer than 2800\ncharacters.",
+ "type": "string"
+ },
+ "id": {
+ "description": "Identifier for this course assigned by Classroom.\n\nWhen\ncreating a course,\nyou may optionally set this identifier to an\nalias string in the\nrequest to create a corresponding alias. The `id` is still assigned by\nClassroom and cannot be updated after the course is created.\n\nSpecifying this field in a course update mask results in an error.",
+ "type": "string"
+ },
+ "room": {
+ "description": "Optional room location.\nFor example, \"301\".\nIf set, this field must be a valid UTF-8 string and no longer than 650\ncharacters.",
+ "type": "string"
+ },
+ "courseGroupEmail": {
+ "description": "The email address of a Google group containing all members of the course.\nThis group does not accept email and can only be used for permissions.\n\nRead-only.",
+ "type": "string"
+ },
+ "enrollmentCode": {
+ "description": "Enrollment code to use when joining this course.\nSpecifying this field in a course update mask results in an error.\n\nRead-only.",
+ "type": "string"
+ },
+ "courseMaterialSets": {
+ "description": "Sets of materials that appear on the \"about\" page of this course.\n\nRead-only.",
+ "type": "array",
+ "items": {
+ "$ref": "CourseMaterialSet"
+ }
+ },
+ "descriptionHeading": {
+ "description": "Optional heading for the description.\nFor example, \"Welcome to 10th Grade Biology.\"\nIf set, this field must be a valid UTF-8 string and no longer than 3600\ncharacters.",
+ "type": "string"
+ },
+ "updateTime": {
+ "description": "Time of the most recent update to this course.\nSpecifying this field in a course update mask results in an error.\n\nRead-only.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "calendarId": {
+ "description": "The Calendar ID for a calendar that all course members can see, to which\nClassroom adds events for course work and announcements in the course.\n\nRead-only.",
+ "type": "string"
+ },
+ "alternateLink": {
+ "description": "Absolute link to this course in the Classroom web UI.\n\nRead-only.",
+ "type": "string"
+ },
+ "guardiansEnabled": {
+ "description": "Whether or not guardian notifications are enabled for this course.\n\nRead-only.",
+ "type": "boolean"
+ },
+ "ownerId": {
+ "description": "The identifier of the owner of a course.\n\nWhen specified as a parameter of a\ncreate course request, this\nfield is required.\nThe identifier can be one of the following:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user\n\nThis must be set in a create request. Admins can also specify this field\nin a patch course request to\ntransfer ownership. In other contexts, it is read-only.",
+ "type": "string"
+ },
+ "courseState": {
+ "enumDescriptions": [
+ "No course state. No returned Course message will use this value.",
+ "The course is active.",
+ "The course has been archived. You cannot modify it except to change it\nto a different state.",
+ "The course has been created, but not yet activated. It is accessible by\nthe primary teacher and domain administrators, who may modify it or\nchange it to the `ACTIVE` or `DECLINED` states.\nA course may only be changed to `PROVISIONED` if it is in the `DECLINED`\nstate.",
+ "The course has been created, but declined. It is accessible by the\ncourse owner and domain administrators, though it will not be\ndisplayed in the web UI. You cannot modify the course except to change it\nto the `PROVISIONED` state.\nA course may only be changed to `DECLINED` if it is in the `PROVISIONED`\nstate.",
+ "The course has been suspended. You cannot modify the course, and only the\nuser identified by the `owner_id` can view the course.\nA course may be placed in this state if it potentially violates the\nTerms of Service."
+ ],
+ "enum": [
+ "COURSE_STATE_UNSPECIFIED",
+ "ACTIVE",
+ "ARCHIVED",
+ "PROVISIONED",
+ "DECLINED",
+ "SUSPENDED"
+ ],
+ "description": "State of the course.\nIf unspecified, the default state is `PROVISIONED`.",
+ "type": "string"
+ }
+ },
+ "id": "Course"
+ },
+ "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": {
+ "description": "URL of a thumbnail image of the Drive item.\n\nRead-only.",
+ "type": "string"
+ },
+ "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",
@@ -124,6 +2298,8 @@
"id": "Topic"
},
"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.",
@@ -137,42 +2313,35 @@
"type": "boolean"
},
"updateTime": {
- "type": "string",
"description": "Timestamp of the most recent change to this course work.\n\nRead-only.",
- "format": "google-datetime"
+ "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": {
+ "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",
- "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."
- ]
+ "type": "string"
},
"maxPoints": {
- "type": "number",
"description": "Maximum grade for this course work.\nIf zero or unspecified, this assignment is considered ungraded.\nThis must be a non-negative integer value.",
- "format": "double"
- },
- "multipleChoiceQuestion": {
- "$ref": "MultipleChoiceQuestion",
- "description": "Multiple choice question details.\nFor read operations, this field is populated only when `work_type` is\n`MULTIPLE_CHOICE_QUESTION`.\nFor write operations, this field must be specified when creating course\nwork with a `work_type` of `MULTIPLE_CHOICE_QUESTION`, and it must not be\nset otherwise."
- },
- "assignment": {
- "description": "Assignment details.\nThis is populated only when `work_type` is `ASSIGNMENT`.\n\nRead-only.",
- "$ref": "Assignment"
+ "format": "double",
+ "type": "number"
},
"workType": {
+ "description": "Type of this course work.\n\nThe type is set when the course work is created and cannot be changed.",
"type": "string",
"enumDescriptions": [
"No work type specified. This is never returned.",
@@ -185,18 +2354,25 @@
"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": {
+ "description": "Multiple choice question details.\nFor read operations, this field is populated only when `work_type` is\n`MULTIPLE_CHOICE_QUESTION`.\nFor write operations, this field must be specified when creating course\nwork with a `work_type` of `MULTIPLE_CHOICE_QUESTION`, and it must not be\nset otherwise.",
+ "$ref": "MultipleChoiceQuestion"
+ },
+ "description": {
+ "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"
},
- "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",
@@ -214,7 +2390,22 @@
"description": "Identifier for the user that created the coursework.\n\nRead-only.",
"type": "string"
},
+ "submissionModificationMode": {
+ "description": "Setting to determine when students are allowed to modify submissions.\nIf unspecified, the default value is `MODIFIABLE_UNTIL_TURNED_IN`.",
+ "type": "string",
+ "enumDescriptions": [
+ "No modification mode specified. This is never returned.",
+ "Submisisons can be modified before being turned in.",
+ "Submisisons can be modified at any time."
+ ],
+ "enum": [
+ "SUBMISSION_MODIFICATION_MODE_UNSPECIFIED",
+ "MODIFIABLE_UNTIL_TURNED_IN",
+ "MODIFIABLE"
+ ]
+ },
"state": {
+ "description": "Status of this course work.\nIf unspecified, the default state is `DRAFT`.",
"type": "string",
"enumDescriptions": [
"No state specified. This is never returned.",
@@ -227,21 +2418,6 @@
"PUBLISHED",
"DRAFT",
"DELETED"
- ],
- "description": "Status of this course work.\nIf unspecified, the default state is `DRAFT`."
- },
- "submissionModificationMode": {
- "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",
- "enumDescriptions": [
- "No modification mode specified. This is never returned.",
- "Submisisons can be modified before being turned in.",
- "Submisisons can be modified at any time."
]
},
"courseId": {
@@ -261,17 +2437,12 @@
"type": "string"
}
},
- "id": "CourseWork",
- "description": "Course work created by a teacher for students of the course.",
- "type": "object"
+ "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": {
- "guardianProfile": {
- "$ref": "UserProfile",
- "description": "User profile for the guardian."
- },
"studentId": {
"description": "Identifier for the student to whom the guardian relationship applies.",
"type": "string"
@@ -283,12 +2454,17 @@
"invitedEmailAddress": {
"description": "The email address to which the initial guardian invitation was sent.\nThis field is only visible to domain administrators.",
"type": "string"
+ },
+ "guardianProfile": {
+ "description": "User profile for the guardian.",
+ "$ref": "UserProfile"
}
},
- "id": "Guardian",
- "description": "Association between a student and a guardian of that student. The guardian\nmay receive information about the student's course work."
+ "id": "Guardian"
},
"ListStudentsResponse": {
+ "description": "Response when listing students.",
+ "type": "object",
"properties": {
"students": {
"description": "Students who match the list request.",
@@ -302,19 +2478,19 @@
"type": "string"
}
},
- "id": "ListStudentsResponse",
- "description": "Response when listing students.",
- "type": "object"
+ "id": "ListStudentsResponse"
},
"UserProfile": {
+ "description": "Global information for a user.",
+ "type": "object",
"properties": {
"emailAddress": {
"description": "Email address of the user.\n\nRead-only.",
"type": "string"
},
"photoUrl": {
- "type": "string",
- "description": "URL of user's profile photo.\n\nRead-only."
+ "description": "URL of user's profile photo.\n\nRead-only.",
+ "type": "string"
},
"permissions": {
"description": "Global permissions of the user.\n\nRead-only.",
@@ -336,22 +2512,53 @@
"type": "boolean"
}
},
- "id": "UserProfile",
- "description": "Global information for a user.",
- "type": "object"
+ "id": "UserProfile"
},
"Announcement": {
- "id": "Announcement",
"description": "Announcement created by a teacher for students of the course",
"type": "object",
"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"
+ },
+ "creatorUserId": {
+ "description": "Identifier for the user that created the announcement.\n\nRead-only.",
+ "type": "string"
+ },
+ "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": {
- "type": "string",
- "description": "Identifier of the course.\n\nRead-only."
+ "description": "Identifier of the course.\n\nRead-only.",
+ "type": "string"
},
"id": {
"description": "Classroom-assigned identifier of this announcement, unique per course.\n\nRead-only.",
@@ -370,72 +2577,39 @@
"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."
+ ],
+ "enum": [
+ "ASSIGNEE_MODE_UNSPECIFIED",
+ "ALL_STUDENTS",
+ "INDIVIDUAL_STUDENTS"
]
},
"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": {
- "description": "Identifier for the user that created the announcement.\n\nRead-only.",
- "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"
- },
- "state": {
- "type": "string",
- "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`."
}
- }
+ },
+ "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": {
- "removeStudentIds": {
- "description": "Ids of students to be removed from having access to this\ncoursework/announcement.",
+ "addStudentIds": {
+ "description": "Ids of students to be added as having access to this\ncoursework/announcement.",
"type": "array",
"items": {
"type": "string"
}
},
- "addStudentIds": {
- "description": "Ids of students to be added as having access to this\ncoursework/announcement.",
+ "removeStudentIds": {
+ "description": "Ids of students to be removed from having access to this\ncoursework/announcement.",
"type": "array",
"items": {
"type": "string"
@@ -453,30 +2627,30 @@
"type": "string"
},
"title": {
- "type": "string",
- "description": "Title of the Drive folder.\n\nRead-only."
+ "description": "Title of the Drive folder.\n\nRead-only.",
+ "type": "string"
},
"alternateLink": {
- "type": "string",
- "description": "URL that can be used to access the Drive folder.\n\nRead-only."
+ "description": "URL that can be used to access the Drive folder.\n\nRead-only.",
+ "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": {
"description": "The grade history information of the submission, if present.",
"$ref": "GradeHistory"
+ },
+ "stateHistory": {
+ "description": "The state history information of the submission, if present.",
+ "$ref": "StateHistory"
}
- }
+ },
+ "id": "SubmissionHistory"
},
"ShortAnswerSubmission": {
"description": "Student work for a short answer question.",
@@ -493,33 +2667,22 @@
"description": "Student submission for course work.\n\nStudentSubmission items are generated when a CourseWork item is created.\n\nStudentSubmissions that have never been accessed (i.e. with `state` = NEW)\nmay not have a creation time or update time.",
"type": "object",
"properties": {
- "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": {
- "type": "string",
- "description": "Absolute link to the submission in the Classroom web UI.\n\nRead-only."
- },
- "late": {
- "description": "Whether this submission is late.\n\nRead-only.",
- "type": "boolean"
- },
"draftGrade": {
"description": "Optional pending grade. If unset, no grade was set.\nThis value must be non-negative. Decimal (i.e. non-integer) values are\nallowed, but will be rounded to two decimal places.\n\nThis is only visible to and modifiable by course teachers.",
"format": "double",
"type": "number"
},
+ "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",
@@ -527,13 +2690,7 @@
"MULTIPLE_CHOICE_QUESTION"
],
"description": "Type of course work this submission is for.\n\nRead-only.",
- "type": "string",
- "enumDescriptions": [
- "No work type specified. This is never returned.",
- "An assignment.",
- "A short answer question.",
- "A multiple-choice question."
- ]
+ "type": "string"
},
"creationTime": {
"description": "Creation time of this submission.\nThis may be unset if the student has not accessed this item.\n\nRead-only.",
@@ -541,6 +2698,8 @@
"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.",
@@ -556,9 +2715,7 @@
"TURNED_IN",
"RETURNED",
"RECLAIMED_BY_STUDENT"
- ],
- "description": "State of this submission.\n\nRead-only.",
- "type": "string"
+ ]
},
"userId": {
"description": "Identifier for the student that owns this submission.\n\nRead-only.",
@@ -593,8 +2750,25 @@
"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."
+ "description": "Submission content when course_work_type is ASSIGNMENT.\n\nStudents can modify this content using\ngoogle.classroom.Work.ModifyAttachments.",
+ "$ref": "AssignmentSubmission"
+ },
+ "shortAnswerSubmission": {
+ "$ref": "ShortAnswerSubmission",
+ "description": "Submission content when course_work_type is SHORT_ANSWER_QUESTION."
+ },
+ "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"
+ },
+ "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"
@@ -603,21 +2777,22 @@
"description": "Response when listing student submissions.",
"type": "object",
"properties": {
- "studentSubmissions": {
- "type": "array",
- "items": {
- "$ref": "StudentSubmission"
- },
- "description": "Student work that matches the request."
- },
"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": {
@@ -628,11 +2803,16 @@
}
}
},
- "id": "ModifyAttachmentsRequest",
- "description": "Request to modify the attachments of a student submission."
+ "id": "ModifyAttachmentsRequest"
},
"YouTubeVideo": {
+ "description": "YouTube video item.",
+ "type": "object",
"properties": {
+ "thumbnailUrl": {
+ "description": "URL of a thumbnail image of the YouTube video.\n\nRead-only.",
+ "type": "string"
+ },
"id": {
"description": "YouTube API resource ID.",
"type": "string"
@@ -642,25 +2822,19 @@
"type": "string"
},
"alternateLink": {
- "type": "string",
- "description": "URL that can be used to view the YouTube video.\n\nRead-only."
- },
- "thumbnailUrl": {
- "description": "URL of a thumbnail image of the YouTube video.\n\nRead-only.",
+ "description": "URL that can be used to view the YouTube video.\n\nRead-only.",
"type": "string"
}
},
- "id": "YouTubeVideo",
- "description": "YouTube video item.",
- "type": "object"
+ "id": "YouTubeVideo"
},
"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."
+ "description": "Token identifying the next page of results to return. If empty, no further\nresults are available.",
+ "type": "string"
},
"invitations": {
"description": "Invitations that match the list request.",
@@ -687,6 +2861,15 @@
"description": "An invitation to become the guardian of a specified user, sent to a specified\nemail address.",
"type": "object",
"properties": {
+ "invitedEmailAddress": {
+ "description": "Email address that the invitation was sent to.\nThis field is only visible to domain administrators.",
+ "type": "string"
+ },
+ "creationTime": {
+ "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"
@@ -696,27 +2879,18 @@
"type": "string"
},
"state": {
- "enum": [
- "GUARDIAN_INVITATION_STATE_UNSPECIFIED",
- "PENDING",
- "COMPLETE"
- ],
"description": "The state that this invitation is in.",
"type": "string",
"enumDescriptions": [
"Should never be returned.",
"The invitation is active and awaiting a response.",
"The invitation is no longer active. It may have been accepted, declined,\nwithdrawn or it may have expired."
+ ],
+ "enum": [
+ "GUARDIAN_INVITATION_STATE_UNSPECIFIED",
+ "PENDING",
+ "COMPLETE"
]
- },
- "invitedEmailAddress": {
- "description": "Email address that the invitation was sent to.\nThis field is only visible to domain administrators.",
- "type": "string"
- },
- "creationTime": {
- "description": "The time that this invitation was created.\n\nRead-only.",
- "format": "google-datetime",
- "type": "string"
}
},
"id": "GuardianInvitation"
@@ -725,7 +2899,18 @@
"description": "The history of each state this submission has been in.",
"type": "object",
"properties": {
+ "stateTimestamp": {
+ "description": "When the submission entered this state.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "actorUserId": {
+ "description": "The teacher or student who made the change",
+ "type": "string"
+ },
"state": {
+ "description": "The workflow pipeline stage.",
+ "type": "string",
"enumDescriptions": [
"No state specified. This should never be returned.",
"The Submission has been created.",
@@ -741,18 +2926,7 @@
"RETURNED",
"RECLAIMED_BY_STUDENT",
"STUDENT_EDITED_AFTER_TURN_IN"
- ],
- "description": "The workflow pipeline stage.",
- "type": "string"
- },
- "stateTimestamp": {
- "type": "string",
- "description": "When the submission entered this state.",
- "format": "google-datetime"
- },
- "actorUserId": {
- "description": "The teacher or student who made the change",
- "type": "string"
+ ]
}
},
"id": "StateHistory"
@@ -762,8 +2936,8 @@
"type": "object",
"properties": {
"title": {
- "type": "string",
- "description": "Title for this set."
+ "description": "Title for this set.",
+ "type": "string"
},
"materials": {
"description": "Materials attached to this set.",
@@ -779,26 +2953,24 @@
"description": "Response when listing teachers.",
"type": "object",
"properties": {
- "nextPageToken": {
- "description": "Token identifying the next page of results to return. If empty, no further\nresults are available.",
- "type": "string"
- },
"teachers": {
"description": "Teachers who match the list request.",
"type": "array",
"items": {
"$ref": "Teacher"
}
+ },
+ "nextPageToken": {
+ "description": "Token identifying the next page of results to return. If empty, no further\nresults are available.",
+ "type": "string"
}
},
"id": "ListTeachersResponse"
},
"Link": {
+ "description": "URL item.",
+ "type": "object",
"properties": {
- "title": {
- "description": "Title of the target of the URL.\n\nRead-only.",
- "type": "string"
- },
"thumbnailUrl": {
"description": "URL of a thumbnail image of the target URL.\n\nRead-only.",
"type": "string"
@@ -806,13 +2978,17 @@
"url": {
"description": "URL to link to.\nThis must be a valid UTF-8 string containing between 1 and 2024 characters.",
"type": "string"
+ },
+ "title": {
+ "description": "Title of the target of the URL.\n\nRead-only.",
+ "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": {
"year": {
"description": "Year of date. Must be from 1 to 9999, or 0 if specifying a date without\na year.",
@@ -830,11 +3006,10 @@
"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"
},
"Name": {
+ "description": "Details of the user's name.",
"type": "object",
"properties": {
"givenName": {
@@ -842,18 +3017,18 @@
"type": "string"
},
"familyName": {
- "type": "string",
- "description": "The user's last name.\n\nRead-only."
+ "description": "The user's last name.\n\nRead-only.",
+ "type": "string"
},
"fullName": {
"description": "The user's full name formed by concatenating the first and last name\nvalues.\n\nRead-only.",
"type": "string"
}
},
- "id": "Name",
- "description": "Details of the user's name."
+ "id": "Name"
},
"Assignment": {
+ "description": "Additional details for assignments.",
"type": "object",
"properties": {
"studentWorkFolder": {
@@ -861,8 +3036,7 @@
"$ref": "DriveFolder"
}
},
- "id": "Assignment",
- "description": "Additional details for assignments."
+ "id": "Assignment"
},
"SharedDriveFile": {
"description": "Drive file that is used as material for course work.",
@@ -898,8 +3072,12 @@
"id": "Empty"
},
"GlobalPermission": {
+ "description": "Global user permission description.",
+ "type": "object",
"properties": {
"permission": {
+ "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."
@@ -907,21 +3085,18 @@
"enum": [
"PERMISSION_UNSPECIFIED",
"CREATE_COURSE"
- ],
- "description": "Permission value.",
- "type": "string"
+ ]
}
},
- "id": "GlobalPermission",
- "description": "Global user permission description.",
- "type": "object"
+ "id": "GlobalPermission"
},
"ModifyAnnouncementAssigneesRequest": {
- "id": "ModifyAnnouncementAssigneesRequest",
"description": "Request to modify assignee mode and options of an announcement.",
"type": "object",
"properties": {
"assigneeMode": {
+ "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.",
@@ -931,24 +3106,19 @@
"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"
+ ]
},
"modifyIndividualStudentsOptions": {
- "description": "Set which students can view or cannot view the announcement.\nMust be specified only when `assigneeMode` is `INDIVIDUAL_STUDENTS`.",
- "$ref": "ModifyIndividualStudentsOptions"
+ "$ref": "ModifyIndividualStudentsOptions",
+ "description": "Set which students can view or cannot view the announcement.\nMust be specified only when `assigneeMode` is `INDIVIDUAL_STUDENTS`."
}
- }
+ },
+ "id": "ModifyAnnouncementAssigneesRequest"
},
"Teacher": {
"description": "Teacher of a course.",
"type": "object",
"properties": {
- "courseId": {
- "description": "Identifier of the course.\n\nRead-only.",
- "type": "string"
- },
"profile": {
"description": "Global user information for the teacher.\n\nRead-only.",
"$ref": "UserProfile"
@@ -956,6 +3126,10 @@
"userId": {
"description": "Identifier of the user.\n\nWhen specified as a parameter of a request, this identifier can be one of\nthe following:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user",
"type": "string"
+ },
+ "courseId": {
+ "description": "Identifier of the course.\n\nRead-only.",
+ "type": "string"
}
},
"id": "Teacher"
@@ -964,12 +3138,22 @@
"description": "The history of each grade on this submission.",
"type": "object",
"properties": {
+ "pointsEarned": {
+ "description": "The numerator of the grade at this time in the submission grade history.",
+ "format": "double",
+ "type": "number"
+ },
+ "actorUserId": {
+ "description": "The teacher who made the grade change.",
+ "type": "string"
+ },
"gradeTimestamp": {
"description": "When the grade of the submission was changed.",
"format": "google-datetime",
"type": "string"
},
"gradeChangeType": {
+ "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.",
@@ -982,27 +3166,19 @@
"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": {
"description": "The denominator of the grade at this time in the submission grade\nhistory.",
"format": "double",
"type": "number"
- },
- "pointsEarned": {
- "description": "The numerator of the grade at this time in the submission grade history.",
- "format": "double",
- "type": "number"
- },
- "actorUserId": {
- "description": "The teacher who made the grade change.",
- "type": "string"
}
},
"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.",
@@ -1012,32 +3188,30 @@
}
}
},
- "id": "AssignmentSubmission",
- "description": "Student work for an assignment.",
- "type": "object"
+ "id": "AssignmentSubmission"
},
"Material": {
- "id": "Material",
"description": "Material attached to course work.\n\nWhen creating attachments, setting the `form` field is not supported.",
"type": "object",
"properties": {
"youtubeVideo": {
- "description": "YouTube video material.",
- "$ref": "YouTubeVideo"
+ "$ref": "YouTubeVideo",
+ "description": "YouTube video material."
},
"driveFile": {
- "$ref": "SharedDriveFile",
- "description": "Google Drive file material."
+ "description": "Google Drive file material.",
+ "$ref": "SharedDriveFile"
},
"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"
+ "$ref": "Link",
+ "description": "Link material. On creation, will be upgraded to a more appropriate type\nif possible, and this will be reflected in the response."
}
- }
+ },
+ "id": "Material"
},
"Feed": {
"description": "A class of notifications that an application can register to receive.\nFor example: \"all roster changes for a domain\".",
@@ -1065,32 +3239,48 @@
"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."
+ "description": "Global user information for the student.\n\nRead-only.",
+ "$ref": "UserProfile"
},
"studentWorkFolder": {
- "description": "Information about a Drive Folder for this student's work in this course.\nOnly visible to the student and domain administrators.\n\nRead-only.",
- "$ref": "DriveFolder"
+ "$ref": "DriveFolder",
+ "description": "Information about a Drive Folder for this student's work in this course.\nOnly visible to the student and domain administrators.\n\nRead-only."
},
"userId": {
"description": "Identifier of the user.\n\nWhen specified as a parameter of a request, this identifier can be one of\nthe following:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user",
"type": "string"
- },
- "courseId": {
- "description": "Identifier of the course.\n\nRead-only.",
- "type": "string"
}
},
- "id": "Student",
- "description": "Student in a course."
+ "id": "Student"
},
"Invitation": {
"description": "An invitation to join a course.",
"type": "object",
"properties": {
+ "role": {
+ "enumDescriptions": [
+ "No course role.",
+ "Student in the course.",
+ "Teacher of the course.",
+ "Owner of the course."
+ ],
+ "enum": [
+ "COURSE_ROLE_UNSPECIFIED",
+ "STUDENT",
+ "TEACHER",
+ "OWNER"
+ ],
+ "description": "Role to invite the user to have.\nMust not be `COURSE_ROLE_UNSPECIFIED`.",
+ "type": "string"
+ },
"userId": {
"description": "Identifier of the invited user.\n\nWhen specified as a parameter of a request, this identifier can be set to\none of the following:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user",
"type": "string"
@@ -1100,24 +3290,8 @@
"type": "string"
},
"id": {
- "type": "string",
- "description": "Identifier assigned by Classroom.\n\nRead-only."
- },
- "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."
- ]
+ "description": "Identifier assigned by Classroom.\n\nRead-only.",
+ "type": "string"
}
},
"id": "Invitation"
@@ -1147,18 +3321,9 @@
"id": "ListCourseWorkResponse"
},
"Attachment": {
- "id": "Attachment",
"description": "Attachment added to student assignment work.\n\nWhen creating attachments, setting the `form` field is not supported.",
"type": "object",
"properties": {
- "form": {
- "description": "Google Forms attachment.",
- "$ref": "Form"
- },
- "link": {
- "$ref": "Link",
- "description": "Link attachment."
- },
"driveFile": {
"$ref": "DriveFile",
"description": "Google Drive file attachment."
@@ -1166,10 +3331,20 @@
"youTubeVideo": {
"description": "Youtube video attachment.",
"$ref": "YouTubeVideo"
+ },
+ "form": {
+ "$ref": "Form",
+ "description": "Google Forms attachment."
+ },
+ "link": {
+ "description": "Link attachment.",
+ "$ref": "Link"
}
- }
+ },
+ "id": "Attachment"
},
"ListTopicResponse": {
+ "description": "Response when listing topics.",
"type": "object",
"properties": {
"topic": {
@@ -1184,8 +3359,7 @@
"type": "string"
}
},
- "id": "ListTopicResponse",
- "description": "Response when listing topics."
+ "id": "ListTopicResponse"
},
"ListAnnouncementsResponse": {
"description": "Response when listing course work.",
@@ -1209,11 +3383,6 @@
"description": "Represents a time of day. The date and time zone are either not significant\nor are specified elsewhere. An API may choose to allow leap seconds. Related\ntypes are google.type.Date and `google.protobuf.Timestamp`.",
"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",
@@ -1228,6 +3397,11 @@
"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"
@@ -1236,16 +3410,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"
@@ -1254,29 +3428,36 @@
"description": "Google Forms item.",
"type": "object",
"properties": {
+ "title": {
+ "description": "Title of the Form.\n\nRead-only.",
+ "type": "string"
+ },
"thumbnailUrl": {
"description": "URL of a thumbnail image of the Form.\n\nRead-only.",
"type": "string"
},
"responseUrl": {
- "type": "string",
- "description": "URL of the form responses document.\nOnly set if respsonses have been recorded and only when the\nrequesting user is an editor of the form.\n\nRead-only."
+ "description": "URL of the form responses document.\nOnly set if respsonses have been recorded and only when the\nrequesting user is an editor of the form.\n\nRead-only.",
+ "type": "string"
},
"formUrl": {
- "type": "string",
- "description": "URL of the form."
- },
- "title": {
- "description": "Title of the Form.\n\nRead-only.",
+ "description": "URL of the form.",
"type": "string"
}
},
"id": "Form"
},
"ModifyCourseWorkAssigneesRequest": {
+ "description": "Request to modify assignee mode and options of a coursework.",
"type": "object",
"properties": {
+ "modifyIndividualStudentsOptions": {
+ "description": "Set which students are assigned or not assigned to the coursework.\nMust be specified only when `assigneeMode` is `INDIVIDUAL_STUDENTS`.",
+ "$ref": "ModifyIndividualStudentsOptions"
+ },
"assigneeMode": {
+ "description": "Mode of the coursework describing whether it will be assigned to all\nstudents or specified individual students.",
+ "type": "string",
"enumDescriptions": [
"No mode specified. This is never returned.",
"All students can see the item.\nThis is the default state.",
@@ -1286,308 +3467,33 @@
"ASSIGNEE_MODE_UNSPECIFIED",
"ALL_STUDENTS",
"INDIVIDUAL_STUDENTS"
- ],
- "description": "Mode of the coursework describing whether it will be assigned to all\nstudents or specified individual students.",
- "type": "string"
- },
- "modifyIndividualStudentsOptions": {
- "$ref": "ModifyIndividualStudentsOptions",
- "description": "Set which students are assigned or not assigned to the coursework.\nMust be specified only when `assigneeMode` is `INDIVIDUAL_STUDENTS`."
+ ]
}
},
- "id": "ModifyCourseWorkAssigneesRequest",
- "description": "Request to modify assignee mode and options of a coursework."
+ "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."
- },
- "CourseAlias": {
- "description": "Alternative identifier for a course.\n\nAn alias uniquely identifies a course. It must be unique within one of the\nfollowing scopes:\n\n* domain: A domain-scoped alias is visible to all users within the alias\ncreator's domain and can be created only by a domain admin. A domain-scoped\nalias is often used when a course has an identifier external to Classroom.\n\n* project: A project-scoped alias is visible to any request from an\napplication using the Developer Console project ID that created the alias\nand can be created by any project. A project-scoped alias is often used when\nan application has alternative identifiers. A random value can also be used\nto avoid duplicate courses in the event of transmission failures, as retrying\na request will return `ALREADY_EXISTS` if a previous one has succeeded.",
- "type": "object",
- "properties": {
- "alias": {
- "description": "Alias string. The format of the string indicates the desired alias scoping.\n\n* `d:\u003cname\u003e` indicates a domain-scoped alias.\n Example: `d:math_101`\n* `p:\u003cname\u003e` indicates a project-scoped alias.\n Example: `p:abc123`\n\nThis field has a maximum length of 256 characters.",
- "type": "string"
- }
- },
- "id": "CourseAlias"
- },
- "ListCourseAliasesResponse": {
- "id": "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"
- }
- }
- }
- },
- "ListGuardianInvitationsResponse": {
- "description": "Response when listing guardian invitations.",
- "type": "object",
- "properties": {
- "guardianInvitations": {
- "description": "Guardian invitations that matched the list request.",
- "type": "array",
- "items": {
- "$ref": "GuardianInvitation"
- }
},
"nextPageToken": {
"description": "Token identifying the next page of results to return. If empty, no further\nresults are available.",
"type": "string"
}
},
- "id": "ListGuardianInvitationsResponse"
- },
- "IndividualStudentsOptions": {
- "type": "object",
- "properties": {
- "studentIds": {
- "description": "Identifiers for the students that have access to the\ncoursework/announcement.",
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "id": "IndividualStudentsOptions",
- "description": "Assignee details about a coursework/announcement.\nThis field is set if and only if `assigneeMode` is `INDIVIDUAL_STUDENTS`."
- },
- "MultipleChoiceSubmission": {
- "description": "Student work for a multiple-choice question.",
- "type": "object",
- "properties": {
- "answer": {
- "description": "Student's select choice.",
- "type": "string"
- }
- },
- "id": "MultipleChoiceSubmission"
- },
- "Registration": {
- "description": "An instruction to Classroom to send notifications from the `feed` to the\nprovided `destination`.",
- "type": "object",
- "properties": {
- "registrationId": {
- "type": "string",
- "description": "A server-generated unique identifier for this `Registration`.\n\nRead-only."
- },
- "cloudPubsubTopic": {
- "$ref": "CloudPubsubTopic",
- "description": "The Cloud Pub/Sub topic that notifications are to be sent to."
- },
- "expiryTime": {
- "description": "The time until which the `Registration` is effective.\n\nThis is a read-only field assigned by the server.",
- "format": "google-datetime",
- "type": "string"
- },
- "feed": {
- "description": "Specification for the class of notifications that Classroom should deliver\nto the `destination`.",
- "$ref": "Feed"
- }
- },
- "id": "Registration"
- },
- "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"
- },
- "youTubeVideo": {
- "description": "Youtube video attachment.",
- "$ref": "YouTubeVideo"
- },
- "form": {
- "$ref": "Form",
- "description": "Google Forms attachment."
- },
- "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": {
- "type": "object",
- "properties": {
- "descriptionHeading": {
- "description": "Optional heading for the description.\nFor example, \"Welcome to 10th Grade Biology.\"\nIf set, this field must be a valid UTF-8 string and no longer than 3600\ncharacters.",
- "type": "string"
- },
- "updateTime": {
- "description": "Time of the most recent update to this course.\nSpecifying this field in a course update mask results in an error.\n\nRead-only.",
- "format": "google-datetime",
- "type": "string"
- },
- "calendarId": {
- "description": "The Calendar ID for a calendar that all course members can see, to which\nClassroom adds events for course work and announcements in the course.\n\nRead-only.",
- "type": "string"
- },
- "alternateLink": {
- "description": "Absolute link to this course in the Classroom web UI.\n\nRead-only.",
- "type": "string"
- },
- "guardiansEnabled": {
- "description": "Whether or not guardian notifications are enabled for this course.\n\nRead-only.",
- "type": "boolean"
- },
- "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": {
- "type": "string",
- "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."
- },
- "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": {
- "type": "string",
- "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."
- },
- "teacherFolder": {
- "description": "Information about a Drive Folder that is shared with all teachers of the\ncourse.\n\nThis field will only be set for teachers of the course and domain administrators.\n\nRead-only.",
- "$ref": "DriveFolder"
- },
- "section": {
- "description": "Section of the course.\nFor example, \"Period 2\".\nIf set, this field must be a valid UTF-8 string and no longer than 2800\ncharacters.",
- "type": "string"
- },
- "id": {
- "description": "Identifier for this course assigned by Classroom.\n\nWhen\ncreating a course,\nyou may optionally set this identifier to an\nalias string in the\nrequest to create a corresponding alias. The `id` is still assigned by\nClassroom and cannot be updated after the course is created.\n\nSpecifying this field in a course update mask results in an error.",
- "type": "string"
- },
- "room": {
- "description": "Optional room location.\nFor example, \"301\".\nIf set, this field must be a valid UTF-8 string and no longer than 650\ncharacters.",
- "type": "string"
- },
- "courseGroupEmail": {
- "description": "The email address of a Google group containing all members of the course.\nThis group does not accept email and can only be used for permissions.\n\nRead-only.",
- "type": "string"
- },
- "courseMaterialSets": {
- "description": "Sets of materials that appear on the \"about\" page of this course.\n\nRead-only.",
- "type": "array",
- "items": {
- "$ref": "CourseMaterialSet"
- }
- },
- "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."
- }
- },
- "id": "Course",
- "description": "A Course in Classroom."
- },
- "DriveFile": {
- "description": "Representation of a Google Drive file.",
- "type": "object",
- "properties": {
- "alternateLink": {
- "description": "URL that can be used to access the Drive item.\n\nRead-only.",
- "type": "string"
- },
- "thumbnailUrl": {
- "type": "string",
- "description": "URL of a thumbnail image of the Drive item.\n\nRead-only."
- },
- "id": {
- "description": "Drive API resource ID.",
- "type": "string"
- },
- "title": {
- "description": "Title of the Drive item.\n\nRead-only.",
- "type": "string"
- }
- },
- "id": "DriveFile"
- },
- "ReturnStudentSubmissionRequest": {
- "description": "Request to return a student submission.",
- "type": "object",
- "properties": {},
- "id": "ReturnStudentSubmissionRequest"
- },
- "ReclaimStudentSubmissionRequest": {
- "description": "Request to reclaim a student submission.",
- "type": "object",
- "properties": {},
- "id": "ReclaimStudentSubmissionRequest"
+ "id": "ListGuardiansResponse"
}
},
"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",
@@ -1595,36 +3501,6 @@
"auth": {
"oauth2": {
"scopes": {
- "https://www.googleapis.com/auth/classroom.profile.photos": {
- "description": "View the profile photos of people in your classes"
- },
- "https://www.googleapis.com/auth/classroom.rosters.readonly": {
- "description": "View your Google Classroom class rosters"
- },
- "https://www.googleapis.com/auth/classroom.guardianlinks.students": {
- "description": "View and manage guardians for students in your Google Classroom classes"
- },
- "https://www.googleapis.com/auth/classroom.announcements.readonly": {
- "description": "View announcements in Google Classroom"
- },
- "https://www.googleapis.com/auth/classroom.student-submissions.me.readonly": {
- "description": "View your course work and grades in Google Classroom"
- },
- "https://www.googleapis.com/auth/classroom.guardianlinks.me.readonly": {
- "description": "View your Google Classroom guardians"
- },
- "https://www.googleapis.com/auth/classroom.coursework.students.readonly": {
- "description": "View course work and grades for students in the Google Classroom classes you teach or administer"
- },
- "https://www.googleapis.com/auth/classroom.coursework.students": {
- "description": "Manage course work and grades for students in the Google Classroom classes you teach and view the course work and grades for classes you administer"
- },
- "https://www.googleapis.com/auth/classroom.coursework.me.readonly": {
- "description": "View your course work and grades in Google Classroom"
- },
- "https://www.googleapis.com/auth/classroom.profile.emails": {
- "description": "View the email addresses of people in your classes"
- },
"https://www.googleapis.com/auth/classroom.coursework.me": {
"description": "Manage your course work and view your grades in Google Classroom"
},
@@ -1648,6 +3524,36 @@
},
"https://www.googleapis.com/auth/classroom.announcements": {
"description": "View and manage announcements in Google Classroom"
+ },
+ "https://www.googleapis.com/auth/classroom.profile.photos": {
+ "description": "View the profile photos of people in your classes"
+ },
+ "https://www.googleapis.com/auth/classroom.rosters.readonly": {
+ "description": "View your Google Classroom class rosters"
+ },
+ "https://www.googleapis.com/auth/classroom.guardianlinks.students": {
+ "description": "View and manage guardians for students in your Google Classroom classes"
+ },
+ "https://www.googleapis.com/auth/classroom.announcements.readonly": {
+ "description": "View announcements in Google Classroom"
+ },
+ "https://www.googleapis.com/auth/classroom.student-submissions.me.readonly": {
+ "description": "View your course work and grades in Google Classroom"
+ },
+ "https://www.googleapis.com/auth/classroom.coursework.students.readonly": {
+ "description": "View course work and grades for students in the Google Classroom classes you teach or administer"
+ },
+ "https://www.googleapis.com/auth/classroom.coursework.students": {
+ "description": "Manage course work and grades for students in the Google Classroom classes you teach and view the course work and grades for classes you administer"
+ },
+ "https://www.googleapis.com/auth/classroom.guardianlinks.me.readonly": {
+ "description": "View your Google Classroom guardians"
+ },
+ "https://www.googleapis.com/auth/classroom.coursework.me.readonly": {
+ "description": "View your course work and grades in Google Classroom"
+ },
+ "https://www.googleapis.com/auth/classroom.profile.emails": {
+ "description": "View the email addresses of people in your classes"
}
}
}
@@ -1662,1899 +3568,5 @@
"batchPath": "batch",
"id": "classroom:v1",
"documentationLink": "https://developers.google.com/classroom/",
- "revision": "20171220",
- "title": "Google Classroom API",
- "discoveryVersion": "v1",
- "ownerName": "Google",
- "resources": {
- "invitations": {
- "methods": {
- "delete": {
- "description": "Deletes an invitation.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to delete the\nrequested invitation or for access errors.\n* `NOT_FOUND` if no invitation exists with the requested ID.",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "id"
- ],
- "httpMethod": "DELETE",
- "scopes": [
- "https://www.googleapis.com/auth/classroom.rosters"
- ],
- "parameters": {
- "id": {
- "description": "Identifier of the invitation to delete.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "flatPath": "v1/invitations/{id}",
- "path": "v1/invitations/{id}",
- "id": "classroom.invitations.delete"
- },
- "get": {
- "description": "Returns an invitation.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to view the\nrequested invitation or for access errors.\n* `NOT_FOUND` if no invitation exists with the requested ID.",
- "response": {
- "$ref": "Invitation"
- },
- "parameterOrder": [
- "id"
- ],
- "httpMethod": "GET",
- "parameters": {
- "id": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "Identifier of the invitation to return."
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/classroom.rosters",
- "https://www.googleapis.com/auth/classroom.rosters.readonly"
- ],
- "flatPath": "v1/invitations/{id}",
- "path": "v1/invitations/{id}",
- "id": "classroom.invitations.get"
- },
- "list": {
- "parameters": {
- "courseId": {
- "location": "query",
- "description": "Restricts returned invitations to those for a course with the specified\nidentifier.",
- "type": "string"
- },
- "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"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/classroom.rosters",
- "https://www.googleapis.com/auth/classroom.rosters.readonly"
- ],
- "flatPath": "v1/invitations",
- "id": "classroom.invitations.list",
- "path": "v1/invitations",
- "description": "Returns a list of invitations that the requesting user is permitted to\nview, restricted to those that match the list request.\n\n*Note:* At least one of `user_id` or `course_id` must be supplied. Both\nfields can be supplied.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` for access errors.",
- "httpMethod": "GET",
- "parameterOrder": [],
- "response": {
- "$ref": "ListInvitationsResponse"
- }
- },
- "create": {
- "flatPath": "v1/invitations",
- "path": "v1/invitations",
- "id": "classroom.invitations.create",
- "description": "Creates an invitation. Only one invitation for a user and course may exist\nat a time. Delete and re-create an invitation to make changes.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to create\ninvitations for this course or for access errors.\n* `NOT_FOUND` if the course or the user does not exist.\n* `FAILED_PRECONDITION` if the requested user's account is disabled or if\nthe user already has this role or a role with greater permissions.\n* `ALREADY_EXISTS` if an invitation for the specified user and course\nalready exists.",
- "request": {
- "$ref": "Invitation"
- },
- "response": {
- "$ref": "Invitation"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/classroom.rosters"
- ],
- "parameters": {}
- },
- "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"
- },
- "parameterOrder": [
- "id"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/classroom.rosters"
- ],
- "parameters": {
- "id": {
- "location": "path",
- "description": "Identifier of the invitation to accept.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1/invitations/{id}:accept",
- "path": "v1/invitations/{id}:accept",
- "id": "classroom.invitations.accept"
- }
- }
- },
- "courses": {
- "methods": {
- "delete": {
- "description": "Deletes a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to delete the\nrequested course or for access errors.\n* `NOT_FOUND` if no course exists with the requested ID.",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "id"
- ],
- "httpMethod": "DELETE",
- "scopes": [
- "https://www.googleapis.com/auth/classroom.courses"
- ],
- "parameters": {
- "id": {
- "description": "Identifier of the course to delete.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "flatPath": "v1/courses/{id}",
- "path": "v1/courses/{id}",
- "id": "classroom.courses.delete"
- },
- "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": {
- "description": "nextPageToken\nvalue returned from a previous\nlist call,\nindicating that the subsequent page of results should be returned.\n\nThe list request must be\notherwise identical to the one that resulted in this token.",
- "type": "string",
- "location": "query"
- },
- "pageSize": {
- "location": "query",
- "description": "Maximum number of items to return. Zero or unspecified indicates that the\nserver may assign a maximum.\n\nThe server may return fewer than the specified number of results.",
- "format": "int32",
- "type": "integer"
- },
- "teacherId": {
- "location": "query",
- "description": "Restricts returned courses to those having a teacher with the specified\nidentifier. The identifier can be one of the following:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user",
- "type": "string"
- },
- "courseStates": {
- "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"
- ]
- }
- },
- "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."
- },
- "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": {
- "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.",
- "httpMethod": "GET",
- "parameterOrder": [
- "id"
- ],
- "response": {
- "$ref": "Course"
- },
- "scopes": [
- "https://www.googleapis.com/auth/classroom.courses",
- "https://www.googleapis.com/auth/classroom.courses.readonly"
- ],
- "parameters": {
- "id": {
- "location": "path",
- "description": "Identifier of the course to return.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
- "required": true,
- "type": "string"
- }
- }
- },
- "patch": {
- "description": "Updates one or more fields in a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to modify the\nrequested course or for access errors.\n* `NOT_FOUND` if no course exists with the requested ID.\n* `INVALID_ARGUMENT` if invalid fields are specified in the update mask or\nif no update mask is supplied.\n* `FAILED_PRECONDITION` for the following request errors:\n * CourseNotModifiable",
- "request": {
- "$ref": "Course"
- },
- "response": {
- "$ref": "Course"
- },
- "parameterOrder": [
- "id"
- ],
- "httpMethod": "PATCH",
- "scopes": [
- "https://www.googleapis.com/auth/classroom.courses"
- ],
- "parameters": {
- "id": {
- "location": "path",
- "description": "Identifier of the course to update.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
- "required": true,
- "type": "string"
- },
- "updateMask": {
- "location": "query",
- "description": "Mask that identifies which fields on the course to update.\nThis field is required to do an update. The update will fail if invalid\nfields are specified. The following fields are valid:\n\n* `name`\n* `section`\n* `descriptionHeading`\n* `description`\n* `room`\n* `courseState`\n* `ownerId`\n\nNote: patches to ownerId are treated as being effective immediately, but in\npractice it may take some time for the ownership transfer of all affected\nresources to complete.\n\nWhen set in a query parameter, this field should be specified as\n\n`updateMask=\u003cfield1\u003e,\u003cfield2\u003e,...`",
- "format": "google-fieldmask",
- "type": "string"
- }
- },
- "flatPath": "v1/courses/{id}",
- "path": "v1/courses/{id}",
- "id": "classroom.courses.patch"
- },
- "update": {
- "response": {
- "$ref": "Course"
- },
- "parameterOrder": [
- "id"
- ],
- "httpMethod": "PUT",
- "scopes": [
- "https://www.googleapis.com/auth/classroom.courses"
- ],
- "parameters": {
- "id": {
- "location": "path",
- "description": "Identifier of the course to update.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1/courses/{id}",
- "path": "v1/courses/{id}",
- "id": "classroom.courses.update",
- "description": "Updates a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to modify the\nrequested course or for access errors.\n* `NOT_FOUND` if no course exists with the requested ID.\n* `FAILED_PRECONDITION` for the following request errors:\n * CourseNotModifiable",
- "request": {
- "$ref": "Course"
- }
- }
- },
- "resources": {
- "aliases": {
- "methods": {
- "delete": {
- "flatPath": "v1/courses/{courseId}/aliases/{alias}",
- "id": "classroom.courses.aliases.delete",
- "path": "v1/courses/{courseId}/aliases/{alias}",
- "description": "Deletes an alias of a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to remove the\nalias or for access errors.\n* `NOT_FOUND` if the alias does not exist.\n* `FAILED_PRECONDITION` if the alias requested does not make sense for the\n requesting user or course (for example, if a user not in a domain\n attempts to delete a domain-scoped alias).",
- "httpMethod": "DELETE",
- "parameterOrder": [
- "courseId",
- "alias"
- ],
- "response": {
- "$ref": "Empty"
- },
- "parameters": {
- "courseId": {
- "description": "Identifier of the course whose alias should be deleted.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "alias": {
- "description": "Alias to delete.\nThis may not be the Classroom-assigned identifier.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/classroom.courses"
- ]
- },
- "list": {
- "description": "Returns a list of aliases for a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\ncourse or for access errors.\n* `NOT_FOUND` if the course does not exist.",
- "response": {
- "$ref": "ListCourseAliasesResponse"
- },
- "parameterOrder": [
- "courseId"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/classroom.courses",
- "https://www.googleapis.com/auth/classroom.courses.readonly"
- ],
- "parameters": {
- "pageToken": {
- "description": "nextPageToken\nvalue returned from a previous\nlist call,\nindicating that the subsequent page of results should be returned.\n\nThe list request\nmust be otherwise identical to the one that resulted in this token.",
- "type": "string",
- "location": "query"
- },
- "pageSize": {
- "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": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "The identifier of the course.\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.list"
- },
- "create": {
- "path": "v1/courses/{courseId}/aliases",
- "id": "classroom.courses.aliases.create",
- "request": {
- "$ref": "CourseAlias"
- },
- "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).",
- "response": {
- "$ref": "CourseAlias"
- },
- "parameterOrder": [
- "courseId"
- ],
- "httpMethod": "POST",
- "parameters": {
- "courseId": {
- "description": "Identifier of the course to alias.\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/{courseId}/aliases"
- }
- }
- },
- "courseWork": {
- "methods": {
- "create": {
- "request": {
- "$ref": "CourseWork"
- },
- "description": "Creates course work.\n\nThe resulting course work (and corresponding student submissions) are\nassociated with the Developer Console project of the\n[OAuth client ID](https://support.google.com/cloud/answer/6158849) used to\nmake the request. Classroom API requests to modify course work and student\nsubmissions must be made with an OAuth client ID from the associated\nDeveloper Console project.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\nrequested course, create course work in the requested course, share a\nDrive attachment, or for access errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course does not exist.\n* `FAILED_PRECONDITION` for the following request error:\n * AttachmentNotVisible",
- "response": {
- "$ref": "CourseWork"
- },
- "parameterOrder": [
- "courseId"
- ],
- "httpMethod": "POST",
- "parameters": {
- "courseId": {
- "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/classroom.coursework.students"
- ],
- "flatPath": "v1/courses/{courseId}/courseWork",
- "path": "v1/courses/{courseId}/courseWork",
- "id": "classroom.courses.courseWork.create"
- },
- "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"
- },
- "httpMethod": "POST",
- "parameterOrder": [
- "courseId",
- "id"
- ],
- "response": {
- "$ref": "CourseWork"
- },
- "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": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "Identifier of the coursework."
- }
- },
- "flatPath": "v1/courses/{courseId}/courseWork/{id}:modifyAssignees",
- "id": "classroom.courses.courseWork.modifyAssignees",
- "path": "v1/courses/{courseId}/courseWork/{id}:modifyAssignees"
- },
- "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"
- ],
- "flatPath": "v1/courses/{courseId}/courseWork/{id}",
- "path": "v1/courses/{courseId}/courseWork/{id}",
- "id": "classroom.courses.courseWork.get"
- },
- "patch": {
- "httpMethod": "PATCH",
- "parameterOrder": [
- "courseId",
- "id"
- ],
- "response": {
- "$ref": "CourseWork"
- },
- "parameters": {
- "courseId": {
- "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "id": {
- "location": "path",
- "description": "Identifier of the course work.",
- "required": true,
- "type": "string"
- },
- "updateMask": {
- "location": "query",
- "description": "Mask that identifies which fields on the course work to update.\nThis field is required to do an update. The update fails if invalid\nfields are specified. If a field supports empty values, it can be cleared\nby specifying it in the update mask and not in the CourseWork object. If a\nfield that does not support empty values is included in the update mask and\nnot set in the CourseWork object, an `INVALID_ARGUMENT` error will be\nreturned.\n\nThe following fields may be specified by teachers:\n\n* `title`\n* `description`\n* `state`\n* `due_date`\n* `due_time`\n* `max_points`\n* `scheduled_time`\n* `submission_modification_mode`",
- "format": "google-fieldmask",
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/classroom.coursework.students"
- ],
- "flatPath": "v1/courses/{courseId}/courseWork/{id}",
- "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."
- },
- "delete": {
- "description": "Deletes a course work.\n\nThis request must be made by the Developer Console project of the\n[OAuth client ID](https://support.google.com/cloud/answer/6158849) used to\ncreate the corresponding course work item.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting developer project did not create\nthe corresponding course work, if the requesting user is not permitted\nto delete the requested course or for access errors.\n* `FAILED_PRECONDITION` if the requested course work has already been\ndeleted.\n* `NOT_FOUND` if no course exists with the requested ID.",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "courseId",
- "id"
- ],
- "httpMethod": "DELETE",
- "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": {
- "location": "path",
- "description": "Identifier of the course work to delete.\nThis identifier is a Classroom-assigned identifier.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1/courses/{courseId}/courseWork/{id}",
- "path": "v1/courses/{courseId}/courseWork/{id}",
- "id": "classroom.courses.courseWork.delete"
- },
- "list": {
- "description": "Returns a list of course work that the requester is permitted to view.\n\nCourse students may only view `PUBLISHED` course work. Course teachers\nand domain administrators may view all course work.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access\nthe requested course or for access errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course does not exist.",
- "httpMethod": "GET",
- "parameterOrder": [
- "courseId"
- ],
- "response": {
- "$ref": "ListCourseWorkResponse"
- },
- "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": {
- "orderBy": {
- "description": "Optional sort ordering for results. A comma-separated list of fields with\nan optional sort direction keyword. Supported fields are `updateTime`\nand `dueDate`. Supported direction keywords are `asc` and `desc`.\nIf not specified, `updateTime desc` is the default behavior.\nExamples: `dueDate asc,updateTime desc`, `updateTime,dueDate desc`",
- "type": "string",
- "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": {
- "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": {
- "repeated": true,
- "location": "query",
- "enum": [
- "COURSE_WORK_STATE_UNSPECIFIED",
- "PUBLISHED",
- "DRAFT",
- "DELETED"
- ],
- "description": "Restriction on the work status to return. Only courseWork that matches\nis returned. If unspecified, items with a work status of `PUBLISHED`\nis returned.",
- "type": "string"
- },
- "courseId": {
- "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "flatPath": "v1/courses/{courseId}/courseWork",
- "id": "classroom.courses.courseWork.list",
- "path": "v1/courses/{courseId}/courseWork"
- }
- },
- "resources": {
- "studentSubmissions": {
- "methods": {
- "get": {
- "response": {
- "$ref": "StudentSubmission"
- },
- "parameterOrder": [
- "courseId",
- "courseWorkId",
- "id"
- ],
- "httpMethod": "GET",
- "parameters": {
- "courseWorkId": {
- "location": "path",
- "description": "Identifier of the course work.",
- "required": true,
- "type": "string"
- },
- "courseId": {
- "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "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."
- },
- "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": {
- "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"
- },
- "updateMask": {
- "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",
- "type": "string"
- }
- },
- "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"
- }
- },
- "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"
- },
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "courseId",
- "courseWorkId",
- "id"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/classroom.coursework.students"
- ],
- "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}:return"
- },
- "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.",
- "httpMethod": "POST",
- "parameterOrder": [
- "courseId",
- "courseWorkId",
- "id"
- ],
- "response": {
- "$ref": "Empty"
- },
- "parameters": {
- "courseWorkId": {
- "location": "path",
- "description": "Identifier of the course work.",
- "required": true,
- "type": "string"
- },
- "courseId": {
- "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "id": {
- "description": "Identifier of the student submission.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/classroom.coursework.me"
- ],
- "flatPath": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:reclaim",
- "id": "classroom.courses.courseWork.studentSubmissions.reclaim",
- "path": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:reclaim"
- },
- "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": {
- "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"
- }
- },
- "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",
- "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",
- "path": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:modifyAttachments",
- "id": "classroom.courses.courseWork.studentSubmissions.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."
- },
- "list": {
- "httpMethod": "GET",
- "parameterOrder": [
- "courseId",
- "courseWorkId"
- ],
- "response": {
- "$ref": "ListStudentSubmissionsResponse"
- },
- "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": {
- "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",
- "type": "string"
- },
- "courseWorkId": {
- "required": true,
- "type": "string",
- "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."
- },
- "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": {
- "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": {
- "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"
- },
- "states": {
- "enum": [
- "SUBMISSION_STATE_UNSPECIFIED",
- "NEW",
- "CREATED",
- "TURNED_IN",
- "RETURNED",
- "RECLAIMED_BY_STUDENT"
- ],
- "description": "Requested submission states. If specified, returned student submissions\nmatch one of the specified submission states.",
- "type": "string",
- "repeated": true,
- "location": "query"
- }
- },
- "flatPath": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions",
- "id": "classroom.courses.courseWork.studentSubmissions.list",
- "path": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions",
- "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."
- }
- }
- }
- }
- },
- "teachers": {
- "methods": {
- "delete": {
- "description": "Deletes a teacher of a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to delete\nteachers of this course or for access errors.\n* `NOT_FOUND` if no teacher of this course has the requested ID or if the\ncourse does not exist.\n* `FAILED_PRECONDITION` if the requested ID belongs to the primary teacher\nof this course.",
- "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": {
- "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"
- ],
- "flatPath": "v1/courses/{courseId}/teachers/{userId}",
- "id": "classroom.courses.teachers.delete",
- "path": "v1/courses/{courseId}/teachers/{userId}"
- },
- "get": {
- "description": "Returns a teacher of a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to view\nteachers of this course or for access errors.\n* `NOT_FOUND` if no teacher of this course has the requested ID or if the\ncourse does not exist.",
- "httpMethod": "GET",
- "parameterOrder": [
- "courseId",
- "userId"
- ],
- "response": {
- "$ref": "Teacher"
- },
- "parameters": {
- "courseId": {
- "location": "path",
- "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
- "required": true,
- "type": "string"
- },
- "userId": {
- "location": "path",
- "description": "Identifier of the teacher to return. The identifier can be one of the\nfollowing:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/classroom.profile.emails",
- "https://www.googleapis.com/auth/classroom.profile.photos",
- "https://www.googleapis.com/auth/classroom.rosters",
- "https://www.googleapis.com/auth/classroom.rosters.readonly"
- ],
- "flatPath": "v1/courses/{courseId}/teachers/{userId}",
- "id": "classroom.courses.teachers.get",
- "path": "v1/courses/{courseId}/teachers/{userId}"
- },
- "list": {
- "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.",
- "httpMethod": "GET",
- "parameterOrder": [
- "courseId"
- ],
- "response": {
- "$ref": "ListTeachersResponse"
- },
- "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."
- },
- "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"
- }
- },
- "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"
- ]
- },
- "create": {
- "request": {
- "$ref": "Teacher"
- },
- "description": "Creates a teacher of a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to create\nteachers in this course or for access errors.\n* `NOT_FOUND` if the requested course ID does not exist.\n* `FAILED_PRECONDITION` if the requested user's account is disabled,\nfor the following request errors:\n * CourseMemberLimitReached\n * CourseNotModifiable\n * CourseTeacherLimitReached\n * UserGroupsMembershipLimitReached\n* `ALREADY_EXISTS` if the user is already a teacher or student in the\ncourse.",
- "httpMethod": "POST",
- "parameterOrder": [
- "courseId"
- ],
- "response": {
- "$ref": "Teacher"
- },
- "parameters": {
- "courseId": {
- "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/classroom.profile.emails",
- "https://www.googleapis.com/auth/classroom.profile.photos",
- "https://www.googleapis.com/auth/classroom.rosters"
- ],
- "flatPath": "v1/courses/{courseId}/teachers",
- "id": "classroom.courses.teachers.create",
- "path": "v1/courses/{courseId}/teachers"
- }
- }
- },
- "announcements": {
- "methods": {
- "create": {
- "path": "v1/courses/{courseId}/announcements",
- "id": "classroom.courses.announcements.create",
- "request": {
- "$ref": "Announcement"
- },
- "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",
- "response": {
- "$ref": "Announcement"
- },
- "parameterOrder": [
- "courseId"
- ],
- "httpMethod": "POST",
- "parameters": {
- "courseId": {
- "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/classroom.announcements"
- ],
- "flatPath": "v1/courses/{courseId}/announcements"
- },
- "modifyAssignees": {
- "response": {
- "$ref": "Announcement"
- },
- "parameterOrder": [
- "courseId",
- "id"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/classroom.announcements"
- ],
- "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": {
- "description": "Identifier of the announcement.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "flatPath": "v1/courses/{courseId}/announcements/{id}:modifyAssignees",
- "path": "v1/courses/{courseId}/announcements/{id}:modifyAssignees",
- "id": "classroom.courses.announcements.modifyAssignees",
- "description": "Modifies assignee mode and options of an announcement.\n\nOnly a teacher of the course that contains the announcement may\ncall this method.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\nrequested course or course work or for access errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course or course work does not exist.",
- "request": {
- "$ref": "ModifyAnnouncementAssigneesRequest"
- }
- },
- "patch": {
- "response": {
- "$ref": "Announcement"
- },
- "parameterOrder": [
- "courseId",
- "id"
- ],
- "httpMethod": "PATCH",
- "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"
- },
- "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}",
- "path": "v1/courses/{courseId}/announcements/{id}",
- "id": "classroom.courses.announcements.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"
- },
- "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"
- }
- },
- "flatPath": "v1/courses/{courseId}/announcements/{id}",
- "path": "v1/courses/{courseId}/announcements/{id}",
- "id": "classroom.courses.announcements.get"
- },
- "delete": {
- "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.",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "courseId",
- "id"
- ],
- "httpMethod": "DELETE",
- "parameters": {
- "courseId": {
- "location": "path",
- "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
- "required": true,
- "type": "string"
- },
- "id": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "Identifier of the announcement to delete.\nThis identifier is a Classroom-assigned identifier."
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/classroom.announcements"
- ]
- },
- "list": {
- "response": {
- "$ref": "ListAnnouncementsResponse"
- },
- "parameterOrder": [
- "courseId"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/classroom.announcements",
- "https://www.googleapis.com/auth/classroom.announcements.readonly"
- ],
- "parameters": {
- "courseId": {
- "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "announcementStates": {
- "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",
- "repeated": true
- },
- "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": {
- "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"
- }
- },
- "flatPath": "v1/courses/{courseId}/announcements",
- "path": "v1/courses/{courseId}/announcements",
- "id": "classroom.courses.announcements.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."
- }
- }
- },
- "students": {
- "methods": {
- "delete": {
- "scopes": [
- "https://www.googleapis.com/auth/classroom.rosters"
- ],
- "parameters": {
- "courseId": {
- "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "userId": {
- "location": "path",
- "description": "Identifier of the student to delete. The identifier can be one of the\nfollowing:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1/courses/{courseId}/students/{userId}",
- "path": "v1/courses/{courseId}/students/{userId}",
- "id": "classroom.courses.students.delete",
- "description": "Deletes a student of a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to delete\nstudents of this course or for access errors.\n* `NOT_FOUND` if no student of this course has the requested ID or if the\ncourse does not exist.",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "courseId",
- "userId"
- ],
- "httpMethod": "DELETE"
- },
- "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": {
- "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"
- },
- "courseId": {
- "location": "path",
- "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1/courses/{courseId}/students/{userId}",
- "path": "v1/courses/{courseId}/students/{userId}",
- "id": "classroom.courses.students.get",
- "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": {
- "response": {
- "$ref": "ListStudentsResponse"
- },
- "parameterOrder": [
- "courseId"
- ],
- "httpMethod": "GET",
- "parameters": {
- "pageToken": {
- "location": "query",
- "description": "nextPageToken\nvalue returned from a previous\nlist call, indicating that\nthe subsequent page of results should be returned.\n\nThe list request must be\notherwise identical to the one that resulted in this token.",
- "type": "string"
- },
- "pageSize": {
- "type": "integer",
- "location": "query",
- "description": "Maximum number of items to return. Zero means no maximum.\n\nThe server may return fewer than the specified number of results.",
- "format": "int32"
- },
- "courseId": {
- "location": "path",
- "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/classroom.profile.emails",
- "https://www.googleapis.com/auth/classroom.profile.photos",
- "https://www.googleapis.com/auth/classroom.rosters",
- "https://www.googleapis.com/auth/classroom.rosters.readonly"
- ],
- "flatPath": "v1/courses/{courseId}/students",
- "path": "v1/courses/{courseId}/students",
- "id": "classroom.courses.students.list",
- "description": "Returns a list of students of this course that the requester\nis permitted to view.\n\nThis method returns the following error codes:\n\n* `NOT_FOUND` if the course does not exist.\n* `PERMISSION_DENIED` for access errors."
- },
- "create": {
- "httpMethod": "POST",
- "parameterOrder": [
- "courseId"
- ],
- "response": {
- "$ref": "Student"
- },
- "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": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "Identifier of the course to create the student in.\nThis identifier can be either the Classroom-assigned identifier or an\nalias."
- },
- "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"
- }
- },
- "flatPath": "v1/courses/{courseId}/students",
- "id": "classroom.courses.students.create",
- "path": "v1/courses/{courseId}/students",
- "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"
- }
- }
- }
- },
- "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"
- },
- "parameterOrder": [
- "courseId",
- "id"
- ],
- "httpMethod": "GET",
- "parameters": {
- "courseId": {
- "location": "path",
- "description": "Identifier of the course.",
- "required": true,
- "type": "string"
- },
- "id": {
- "location": "path",
- "description": "Identifier of the topic.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1/courses/{courseId}/topics/{id}",
- "path": "v1/courses/{courseId}/topics/{id}",
- "id": "classroom.courses.topics.get"
- },
- "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"
- },
- "parameterOrder": [
- "courseId"
- ],
- "httpMethod": "GET",
- "parameters": {
- "pageSize": {
- "description": "Maximum number of items to return. Zero or unspecified indicates that the\nserver may assign a maximum.\n\nThe server may return fewer than the specified number of results.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- },
- "courseId": {
- "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "pageToken": {
- "description": "nextPageToken\nvalue returned from a previous\nlist call,\nindicating that the subsequent page of results should be returned.\n\nThe list request\nmust be otherwise identical to the one that resulted in this token.",
- "type": "string",
- "location": "query"
- }
- },
- "flatPath": "v1/courses/{courseId}/topics",
- "path": "v1/courses/{courseId}/topics",
- "id": "classroom.courses.topics.list"
- }
- }
- }
- }
- },
- "userProfiles": {
- "methods": {
- "get": {
- "description": "Returns a user profile.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access\nthis user profile, if no profile exists with the requested ID, or for\naccess errors.",
- "response": {
- "$ref": "UserProfile"
- },
- "parameterOrder": [
- "userId"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/classroom.profile.emails",
- "https://www.googleapis.com/auth/classroom.profile.photos",
- "https://www.googleapis.com/auth/classroom.rosters",
- "https://www.googleapis.com/auth/classroom.rosters.readonly"
- ],
- "parameters": {
- "userId": {
- "location": "path",
- "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"
- }
- },
- "flatPath": "v1/userProfiles/{userId}",
- "path": "v1/userProfiles/{userId}",
- "id": "classroom.userProfiles.get"
- }
- },
- "resources": {
- "guardianInvitations": {
- "methods": {
- "list": {
- "response": {
- "$ref": "ListGuardianInvitationsResponse"
- },
- "parameterOrder": [
- "studentId"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/classroom.guardianlinks.students",
- "https://www.googleapis.com/auth/classroom.guardianlinks.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"
- },
- "invitedEmailAddress": {
- "location": "query",
- "description": "If specified, only results with the specified `invited_email_address`\nwill be returned.",
- "type": "string"
- },
- "states": {
- "description": "If specified, only results with the specified `state` values will be\nreturned. Otherwise, results with a `state` of `PENDING` will be returned.",
- "type": "string",
- "repeated": true,
- "location": "query",
- "enum": [
- "GUARDIAN_INVITATION_STATE_UNSPECIFIED",
- "PENDING",
- "COMPLETE"
- ]
- },
- "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": "The ID of the student whose guardian invitations are to be returned.\nThe identifier can be one of the following:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user\n* the string literal `\"-\"`, indicating that results should be returned for\n all students that the requesting user is permitted to view guardian\n invitations.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "flatPath": "v1/userProfiles/{studentId}/guardianInvitations",
- "path": "v1/userProfiles/{studentId}/guardianInvitations",
- "id": "classroom.userProfiles.guardianInvitations.list",
- "description": "Returns a list of guardian invitations that the requesting user is\npermitted to view, filtered by the parameters provided.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if a `student_id` is specified, and the requesting\n user is not permitted to view guardian invitations for that student, if\n `\"-\"` is specified as the `student_id` and the user is not a domain\n administrator, if guardians are not enabled for the domain in question,\n or for other access errors.\n* `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot\n be recognized (it is not an email address, nor a `student_id` from the\n API, nor the literal string `me`). May also be returned if an invalid\n `page_token` or `state` is provided.\n* `NOT_FOUND` if a `student_id` is specified, and its format can be\n recognized, but Classroom has no record of that student."
- },
- "get": {
- "id": "classroom.userProfiles.guardianInvitations.get",
- "path": "v1/userProfiles/{studentId}/guardianInvitations/{invitationId}",
- "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.",
- "httpMethod": "GET",
- "response": {
- "$ref": "GuardianInvitation"
- },
- "parameterOrder": [
- "studentId",
- "invitationId"
- ],
- "parameters": {
- "invitationId": {
- "location": "path",
- "description": "The `id` field of the `GuardianInvitation` being requested.",
- "required": true,
- "type": "string"
- },
- "studentId": {
- "description": "The ID of the student whose guardian invitation is being requested.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/classroom.guardianlinks.students",
- "https://www.googleapis.com/auth/classroom.guardianlinks.students.readonly"
- ],
- "flatPath": "v1/userProfiles/{studentId}/guardianInvitations/{invitationId}"
- },
- "patch": {
- "flatPath": "v1/userProfiles/{studentId}/guardianInvitations/{invitationId}",
- "path": "v1/userProfiles/{studentId}/guardianInvitations/{invitationId}",
- "id": "classroom.userProfiles.guardianInvitations.patch",
- "request": {
- "$ref": "GuardianInvitation"
- },
- "description": "Modifies a guardian invitation.\n\nCurrently, the only valid modification is to change the `state` from\n`PENDING` to `COMPLETE`. This has the effect of withdrawing the invitation.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the current user does not have permission to\n manage guardians, if guardians are not enabled for the domain in question\n or for other access errors.\n* `FAILED_PRECONDITION` if the guardian link is not in the `PENDING` state.\n* `INVALID_ARGUMENT` if the format of the student ID provided\n cannot be recognized (it is not an email address, nor a `user_id` from\n this API), or if the passed `GuardianInvitation` has a `state` other than\n `COMPLETE`, or if it modifies fields other than `state`.\n* `NOT_FOUND` if the student ID provided is a valid student ID, but\n Classroom has no record of that student, or if the `id` field does not\n refer to a guardian invitation known to Classroom.",
- "response": {
- "$ref": "GuardianInvitation"
- },
- "parameterOrder": [
- "studentId",
- "invitationId"
- ],
- "httpMethod": "PATCH",
- "parameters": {
- "invitationId": {
- "location": "path",
- "description": "The `id` field of the `GuardianInvitation` to be modified.",
- "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* `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": [
- "https://www.googleapis.com/auth/classroom.guardianlinks.students"
- ]
- },
- "create": {
- "flatPath": "v1/userProfiles/{studentId}/guardianInvitations",
- "path": "v1/userProfiles/{studentId}/guardianInvitations",
- "id": "classroom.userProfiles.guardianInvitations.create",
- "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.",
- "request": {
- "$ref": "GuardianInvitation"
- },
- "response": {
- "$ref": "GuardianInvitation"
- },
- "parameterOrder": [
- "studentId"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/classroom.guardianlinks.students"
- ],
- "parameters": {
- "studentId": {
- "location": "path",
- "description": "ID of the student (in standard format)",
- "required": true,
- "type": "string"
- }
- }
- }
- }
- },
- "guardians": {
- "methods": {
- "delete": {
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "studentId",
- "guardianId"
- ],
- "httpMethod": "DELETE",
- "scopes": [
- "https://www.googleapis.com/auth/classroom.guardianlinks.students"
- ],
- "parameters": {
- "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"
- },
- "guardianId": {
- "description": "The `id` field from a `Guardian`.",
- "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`."
- },
- "list": {
- "response": {
- "$ref": "ListGuardiansResponse"
- },
- "parameterOrder": [
- "studentId"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/classroom.guardianlinks.me.readonly",
- "https://www.googleapis.com/auth/classroom.guardianlinks.students",
- "https://www.googleapis.com/auth/classroom.guardianlinks.students.readonly"
- ],
- "parameters": {
- "studentId": {
- "location": "path",
- "description": "Filter results by the student who the guardian is linked to.\nThe identifier can be one of the following:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user\n* the string literal `\"-\"`, indicating that results should be returned for\n all students that the requesting user has access to view.",
- "required": true,
- "type": "string"
- },
- "pageToken": {
- "description": "nextPageToken\nvalue returned from a previous\nlist call,\nindicating that the subsequent page of results should be returned.\n\nThe list request\nmust be otherwise identical to the one that resulted in this token.",
- "type": "string",
- "location": "query"
- },
- "invitedEmailAddress": {
- "location": "query",
- "description": "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"
- }
- },
- "flatPath": "v1/userProfiles/{studentId}/guardians",
- "path": "v1/userProfiles/{studentId}/guardians",
- "id": "classroom.userProfiles.guardians.list",
- "description": "Returns a list of guardians that the requesting user is permitted to\nview, restricted to those that match the request.\n\nTo list guardians for any student that the requesting user may view\nguardians for, use the literal character `-` for the student ID.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if a `student_id` is specified, and the requesting\n user is not permitted to view guardian information for that student, if\n `\"-\"` is specified as the `student_id` and the user is not a domain\n administrator, if guardians are not enabled for the domain in question,\n if the `invited_email_address` filter is set by a user who is not a\n domain administrator, or for other access errors.\n* `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot\n be recognized (it is not an email address, nor a `student_id` from the\n API, nor the literal string `me`). May also be returned if an invalid\n `page_token` is provided.\n* `NOT_FOUND` if a `student_id` is specified, and its format can be\n recognized, but Classroom has no record of that student."
- },
- "get": {
- "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",
- "response": {
- "$ref": "Guardian"
- },
- "parameterOrder": [
- "studentId",
- "guardianId"
- ],
- "parameters": {
- "studentId": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "The student whose guardian is being requested. One of the following:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user"
- },
- "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"
- ],
- "flatPath": "v1/userProfiles/{studentId}/guardians/{guardianId}"
- }
- }
- }
- }
- },
- "registrations": {
- "methods": {
- "create": {
- "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"
- },
- "response": {
- "$ref": "Registration"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "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"
- },
- "delete": {
- "httpMethod": "DELETE",
- "parameterOrder": [
- "registrationId"
- ],
- "response": {
- "$ref": "Empty"
- },
- "parameters": {
- "registrationId": {
- "description": "The `registration_id` of the `Registration` to be deleted.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "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}",
- "id": "classroom.registrations.delete",
- "path": "v1/registrations/{registrationId}",
- "description": "Deletes a `Registration`, causing Classroom to stop sending notifications\nfor that `Registration`."
- }
- }
- }
- }
+ "revision": "20171229"
}
diff --git a/classroom/v1/classroom-gen.go b/classroom/v1/classroom-gen.go
index 843a686..23082cd 100644
--- a/classroom/v1/classroom-gen.go
+++ b/classroom/v1/classroom-gen.go
@@ -9658,7 +9658,13 @@
// "path": "v1/courses/{courseId}/topics/{id}",
// "response": {
// "$ref": "Topic"
- // }
+ // },
+ // "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"
+ // ]
// }
}
@@ -9837,7 +9843,13 @@
// "path": "v1/courses/{courseId}/topics",
// "response": {
// "$ref": "ListTopicResponse"
- // }
+ // },
+ // "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"
+ // ]
// }
}
diff --git a/cloudbuild/v1/cloudbuild-api.json b/cloudbuild/v1/cloudbuild-api.json
index e5a56af..c80b3e0 100644
--- a/cloudbuild/v1/cloudbuild-api.json
+++ b/cloudbuild/v1/cloudbuild-api.json
@@ -1,12 +1,201 @@
{
- "basePath": "",
- "revision": "20180102",
"documentationLink": "https://cloud.google.com/container-builder/docs/",
+ "revision": "20180103",
"id": "cloudbuild:v1",
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
+ "Source": {
+ "description": "Source describes the location of the source in a supported storage\nservice.",
+ "type": "object",
+ "properties": {
+ "storageSource": {
+ "description": "If provided, get the source from this location in Google Cloud Storage.",
+ "$ref": "StorageSource"
+ },
+ "repoSource": {
+ "$ref": "RepoSource",
+ "description": "If provided, get source from this location in a Cloud Repo."
+ }
+ },
+ "id": "Source"
+ },
+ "RetryBuildRequest": {
+ "description": "RetryBuildRequest specifies a build to retry.",
+ "type": "object",
+ "properties": {},
+ "id": "RetryBuildRequest"
+ },
+ "BuildOperationMetadata": {
+ "properties": {
+ "build": {
+ "$ref": "Build",
+ "description": "The build that the operation is tracking."
+ }
+ },
+ "id": "BuildOperationMetadata",
+ "description": "Metadata for build operations.",
+ "type": "object"
+ },
+ "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": {
+ "resolvedStorageSource": {
+ "description": "A copy of the build's source.storage_source, if exists, with any\ngenerations resolved.",
+ "$ref": "StorageSource"
+ },
+ "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."
+ }
+ },
+ "id": "SourceProvenance"
+ },
+ "CancelOperationRequest": {
+ "description": "The request message for Operations.CancelOperation.",
+ "type": "object",
+ "properties": {},
+ "id": "CancelOperationRequest"
+ },
+ "Operation": {
+ "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
+ "type": "object",
+ "properties": {
+ "done": {
+ "description": "If the value is `false`, it means the operation is still in progress.\nIf `true`, the operation is completed, and either `error` or `response` is\navailable.",
+ "type": "boolean"
+ },
+ "response": {
+ "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": "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"
+ },
+ "timing": {
+ "$ref": "TimeSpan",
+ "description": "Stores timing information for executing this build step."
+ },
+ "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"
+ },
+ "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"
+ }
+ }
+ },
+ "id": "BuildStep"
+ },
+ "RepoSource": {
+ "properties": {
+ "commitSha": {
+ "description": "Explicit commit SHA to build.",
+ "type": "string"
+ },
+ "dir": {
+ "description": "Directory, relative to the source root, in which to run the build.",
+ "type": "string"
+ },
+ "branchName": {
+ "description": "Name of the branch to build.",
+ "type": "string"
+ },
+ "tagName": {
+ "description": "Name of the tag to build.",
+ "type": "string"
+ },
+ "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"
+ }
+ },
+ "id": "RepoSource",
+ "description": "RepoSource describes the location of the source in a Google Cloud Source\nRepository.",
+ "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.",
@@ -16,14 +205,17 @@
}
}
},
- "id": "FileHashes",
- "description": "Container message for hashes of byte content of files, used in\nSourceProvenance messages to verify integrity of source input to the build.",
- "type": "object"
+ "id": "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": {
+ "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"
@@ -38,11 +230,6 @@
},
"type": "object"
}
- },
- "code": {
- "description": "The status code, which should be an enum value of google.rpc.Code.",
- "format": "int32",
- "type": "integer"
}
},
"id": "Status"
@@ -56,8 +243,8 @@
"type": "string"
},
"triggerTemplate": {
- "description": "Template describing the types of source changes to trigger a build.\n\nBranch and tag names in trigger templates are interpreted as regular\nexpressions. Any branch or tag change that matches that regular expression\nwill trigger a build.",
- "$ref": "RepoSource"
+ "$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."
},
"id": {
"description": "Unique identifier of the trigger.\n\n@OutputOnly",
@@ -78,42 +265,87 @@
"description": "Human-readable description of this trigger.",
"type": "string"
},
+ "disabled": {
+ "description": "If true, the trigger will never result in a build.",
+ "type": "boolean"
+ },
"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"
},
"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": {
- "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",
+ "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"
+ },
"logUrl": {
"description": "URL to logs for this build in Google Cloud Logging.\n@OutputOnly",
"type": "string"
},
- "source": {
- "$ref": "Source",
- "description": "Describes where to find the source files to build."
+ "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"
},
"options": {
"description": "Special options for this build.",
"$ref": "BuildOptions"
},
+ "source": {
+ "$ref": "Source",
+ "description": "Describes where to find the source files to 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"
},
+ "statusDetail": {
+ "description": "Customer-readable message about the current status.\n@OutputOnly",
+ "type": "string"
+ },
"status": {
"enumDescriptions": [
"Status of the build is unknown.",
@@ -138,10 +370,6 @@
"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",
@@ -149,14 +377,14 @@
"$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": {
"description": "Results of the build.\n@OutputOnly",
"$ref": "Results"
},
+ "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"
+ },
"steps": {
"description": "Describes the operations to be performed on the workspace.",
"type": "array",
@@ -178,50 +406,9 @@
"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": {
- "$ref": "SourceProvenance",
- "description": "A permanent fixed identifier for source.\n@OutputOnly"
- },
- "images": {
- "description": "A list of images to be pushed upon the successful completion of all build\nsteps.\n\nThe images will be pushed using the builder service account's credentials.\n\nThe digests of the pushed images will be stored in the Build resource's\nresults field.\n\nIf any of the images fail to be pushed, the build is marked FAILURE.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "projectId": {
- "description": "ID of the project.\n@OutputOnly.",
- "type": "string"
}
},
- "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.",
- "type": "object"
+ "id": "Build"
},
"CancelBuildRequest": {
"description": "Request to cancel an ongoing build.",
@@ -230,6 +417,8 @@
"id": "CancelBuildRequest"
},
"Volume": {
+ "description": "Volume describes a Docker container volume which is mounted into build steps\nin order to persist files across build step execution.",
+ "type": "object",
"properties": {
"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.",
@@ -240,11 +429,11 @@
"type": "string"
}
},
- "id": "Volume",
- "description": "Volume describes a Docker container volume which is mounted into build steps\nin order to persist files across build step execution.",
- "type": "object"
+ "id": "Volume"
},
"ListBuildsResponse": {
+ "description": "Response including listed builds.",
+ "type": "object",
"properties": {
"nextPageToken": {
"description": "Token to receive the next page of results.",
@@ -258,11 +447,11 @@
}
}
},
- "id": "ListBuildsResponse",
- "description": "Response including listed builds.",
- "type": "object"
+ "id": "ListBuildsResponse"
},
"ListOperationsResponse": {
+ "description": "The response message for Operations.ListOperations.",
+ "type": "object",
"properties": {
"nextPageToken": {
"description": "The standard List next-page token.",
@@ -276,9 +465,7 @@
}
}
},
- "id": "ListOperationsResponse",
- "description": "The response message for Operations.ListOperations.",
- "type": "object"
+ "id": "ListOperationsResponse"
},
"TimeSpan": {
"description": "Stores start and end times for a build execution phase.",
@@ -320,18 +507,18 @@
]
},
"machineType": {
+ "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.",
- "type": "string",
- "enumDescriptions": [
- "Standard machine type.",
- "Highcpu machine with 8 CPUs.",
- "Highcpu machine with 32 CPUs."
- ]
+ "type": "string"
},
"logStreamingOption": {
"enum": [
@@ -348,18 +535,20 @@
]
},
"requestedVerifyOption": {
+ "enumDescriptions": [
+ "Not a verifiable build. (default)",
+ "Verified build."
+ ],
"enum": [
"NOT_VERIFIED",
"VERIFIED"
],
"description": "Requested verifiability options.",
- "type": "string",
- "enumDescriptions": [
- "Not a verifiable build. (default)",
- "Verified build."
- ]
+ "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."
@@ -367,9 +556,7 @@
"enum": [
"MUST_MATCH",
"ALLOW_LOOSE"
- ],
- "description": "SubstitutionOption to allow unmatch substitutions.",
- "type": "string"
+ ]
}
},
"id": "BuildOptions",
@@ -377,6 +564,8 @@
"type": "object"
},
"StorageSource": {
+ "description": "StorageSource describes the location of the source in an archive file in\nGoogle Cloud Storage.",
+ "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)).",
@@ -392,9 +581,7 @@
"type": "string"
}
},
- "id": "StorageSource",
- "description": "StorageSource describes the location of the source in an archive file in\nGoogle Cloud Storage.",
- "type": "object"
+ "id": "StorageSource"
},
"Results": {
"description": "Results describes the artifacts created by the build pipeline.",
@@ -418,6 +605,8 @@
"id": "Results"
},
"ListBuildTriggersResponse": {
+ "description": "Response containing existing BuildTriggers.",
+ "type": "object",
"properties": {
"triggers": {
"description": "BuildTriggers for the project, sorted by create_time descending.",
@@ -427,16 +616,12 @@
}
}
},
- "id": "ListBuildTriggersResponse",
- "description": "Response containing existing BuildTriggers.",
- "type": "object"
+ "id": "ListBuildTriggersResponse"
},
"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"
@@ -444,15 +629,26 @@
"digest": {
"description": "Docker Registry 2.0 digest.",
"type": "string"
+ },
+ "pushTiming": {
+ "description": "Stores timing information for pushing the specified image.",
+ "$ref": "TimeSpan"
}
},
- "id": "BuiltImage",
- "description": "BuiltImage describes an image built by the pipeline.",
- "type": "object"
+ "id": "BuiltImage"
},
"Hash": {
+ "description": "Container message for hash values.",
+ "type": "object",
"properties": {
+ "value": {
+ "description": "The hash value.",
+ "format": "byte",
+ "type": "string"
+ },
"type": {
+ "description": "The type of hash that was performed.",
+ "type": "string",
"enumDescriptions": [
"No hash requested.",
"Use a sha256 hash."
@@ -460,23 +656,12 @@
"enum": [
"NONE",
"SHA256"
- ],
- "description": "The type of hash that was performed.",
- "type": "string"
- },
- "value": {
- "description": "The hash value.",
- "format": "byte",
- "type": "string"
+ ]
}
},
- "id": "Hash",
- "description": "Container message for hash values.",
- "type": "object"
+ "id": "Hash"
},
"Secret": {
- "description": "Secret pairs a set of secret environment variables containing encrypted\nvalues with the Cloud KMS key to use to decrypt the value.",
- "type": "object",
"properties": {
"kmsKeyName": {
"description": "Cloud KMS key name to use to decrypt these envs.",
@@ -491,208 +676,22 @@
"type": "object"
}
},
- "id": "Secret"
+ "id": "Secret",
+ "description": "Secret pairs a set of secret environment variables containing encrypted\nvalues with the Cloud KMS key to use to decrypt the value.",
+ "type": "object"
},
"Empty": {
"description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
"type": "object",
"properties": {},
"id": "Empty"
- },
- "Source": {
- "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": {
- "properties": {
- "build": {
- "description": "The build that the operation is tracking.",
- "$ref": "Build"
- }
- },
- "id": "BuildOperationMetadata",
- "description": "Metadata for build operations.",
- "type": "object"
- },
- "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": {
- "resolvedStorageSource": {
- "description": "A copy of the build's source.storage_source, if exists, with any\ngenerations resolved.",
- "$ref": "StorageSource"
- },
- "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": {
- "description": "A copy of the build's source.repo_source, if exists, with any\nrevisions resolved.",
- "$ref": "RepoSource"
- }
- },
- "id": "SourceProvenance"
- },
- "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": {
- "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"
- },
- "BuildStep": {
- "description": "BuildStep describes a step to perform in the build pipeline.",
- "type": "object",
- "properties": {
- "entrypoint": {
- "description": "Optional entrypoint to be used instead of the build step image's default\nIf unset, the image's default will be used.",
- "type": "string"
- },
- "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"
- },
- "RepoSource": {
- "properties": {
- "tagName": {
- "description": "Name of the tag to build.",
- "type": "string"
- },
- "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": {
- "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"
}
},
- "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 Build",
"auth": {
"oauth2": {
@@ -710,15 +709,109 @@
"title": "Google Cloud Container Builder API",
"ownerName": "Google",
"resources": {
+ "operations": {
+ "methods": {
+ "cancel": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameters": {
+ "name": {
+ "description": "The name of the operation resource to be cancelled.",
+ "required": true,
+ "type": "string",
+ "pattern": "^operations/.+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/operations/{operationsId}:cancel",
+ "id": "cloudbuild.operations.cancel",
+ "path": "v1/{+name}:cancel",
+ "request": {
+ "$ref": "CancelOperationRequest"
+ },
+ "description": "Starts asynchronous cancellation on a long-running operation. The server\nmakes a best effort to cancel the operation, but success is not\nguaranteed. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`. Clients can use\nOperations.GetOperation or\nother methods to check whether the cancellation succeeded or whether the\noperation completed despite cancellation. On successful cancellation,\nthe operation is not deleted; instead, it becomes an operation with\nan Operation.error value with a google.rpc.Status.code of 1,\ncorresponding to `Code.CANCELLED`."
+ },
+ "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": {
+ "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 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/operations",
+ "id": "cloudbuild.operations.list",
+ "path": "v1/{+name}"
+ },
+ "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/.+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/operations/{operationsId}",
+ "path": "v1/{+name}",
+ "id": "cloudbuild.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": {
"builds": {
"methods": {
"cancel": {
- "request": {
- "$ref": "CancelBuildRequest"
- },
- "description": "Cancels a requested build in progress.",
"httpMethod": "POST",
"parameterOrder": [
"projectId",
@@ -728,14 +821,14 @@
"$ref": "Build"
},
"parameters": {
- "projectId": {
+ "id": {
"location": "path",
- "description": "ID of the project.",
+ "description": "ID of the build.",
"required": true,
"type": "string"
},
- "id": {
- "description": "ID of the build.",
+ "projectId": {
+ "description": "ID of the project.",
"required": true,
"type": "string",
"location": "path"
@@ -746,7 +839,11 @@
],
"flatPath": "v1/projects/{projectId}/builds/{id}:cancel",
"id": "cloudbuild.projects.builds.cancel",
- "path": "v1/projects/{projectId}/builds/{id}:cancel"
+ "path": "v1/projects/{projectId}/builds/{id}:cancel",
+ "request": {
+ "$ref": "CancelBuildRequest"
+ },
+ "description": "Cancels a requested build in progress."
},
"retry": {
"response": {
@@ -783,24 +880,25 @@
}
},
"get": {
- "response": {
- "$ref": "Build"
- },
+ "description": "Returns information about a previously requested build.\n\nThe Build that is returned includes its status (e.g., success or failure,\nor in-progress), and timing information.",
+ "httpMethod": "GET",
"parameterOrder": [
"projectId",
"id"
],
- "httpMethod": "GET",
+ "response": {
+ "$ref": "Build"
+ },
"parameters": {
- "id": {
- "description": "ID of the build.",
+ "projectId": {
+ "description": "ID of the project.",
"required": true,
"type": "string",
"location": "path"
},
- "projectId": {
+ "id": {
"location": "path",
- "description": "ID of the project.",
+ "description": "ID of the build.",
"required": true,
"type": "string"
}
@@ -809,26 +907,26 @@
"https://www.googleapis.com/auth/cloud-platform"
],
"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."
+ "path": "v1/projects/{projectId}/builds/{id}"
},
"list": {
- "httpMethod": "GET",
- "parameterOrder": [
- "projectId"
- ],
+ "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": {
"filter": {
+ "location": "query",
"description": "The raw filter text to constrain the results.",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"pageToken": {
"description": "Token to provide to skip to a particular spot in the list.",
@@ -842,22 +940,17 @@
"type": "integer"
},
"projectId": {
- "location": "path",
"description": "ID of the project.",
"required": true,
- "type": "string"
+ "type": "string",
+ "location": "path"
}
},
"flatPath": "v1/projects/{projectId}/builds",
- "id": "cloudbuild.projects.builds.list",
"path": "v1/projects/{projectId}/builds",
- "description": "Lists previously requested builds.\n\nPreviously requested builds may still be in-progress, or may have finished\nsuccessfully or unsuccessfully."
+ "id": "cloudbuild.projects.builds.list"
},
"create": {
- "request": {
- "$ref": "Build"
- },
- "description": "Starts a build with the specified configuration.\n\nThe long-running Operation returned by this method will include the ID of\nthe build, which can be passed to GetBuild to determine its status (e.g.,\nsuccess or failure).",
"response": {
"$ref": "Operation"
},
@@ -865,6 +958,9 @@
"projectId"
],
"httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
"parameters": {
"projectId": {
"location": "path",
@@ -873,18 +969,57 @@
"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"
+ "id": "cloudbuild.projects.builds.create",
+ "description": "Starts a build with the specified configuration.\n\nThe long-running Operation returned by this method will include the ID of\nthe build, which can be passed to GetBuild to determine its status (e.g.,\nsuccess or failure).",
+ "request": {
+ "$ref": "Build"
+ }
}
}
},
"triggers": {
"methods": {
+ "patch": {
+ "request": {
+ "$ref": "BuildTrigger"
+ },
+ "description": "Updates an BuildTrigger by its project ID and trigger ID.\n\nThis API is experimental.",
+ "response": {
+ "$ref": "BuildTrigger"
+ },
+ "parameterOrder": [
+ "projectId",
+ "triggerId"
+ ],
+ "httpMethod": "PATCH",
+ "parameters": {
+ "triggerId": {
+ "description": "ID of the BuildTrigger to update.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "projectId": {
+ "location": "path",
+ "description": "ID of the project that owns the trigger.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectId}/triggers/{triggerId}",
+ "path": "v1/projects/{projectId}/triggers/{triggerId}",
+ "id": "cloudbuild.projects.triggers.patch"
+ },
"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"
},
@@ -909,49 +1044,9 @@
"type": "string",
"location": "path"
}
- },
- "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."
- },
- "patch": {
- "path": "v1/projects/{projectId}/triggers/{triggerId}",
- "id": "cloudbuild.projects.triggers.patch",
- "description": "Updates an BuildTrigger by its project ID and trigger ID.\n\nThis API is experimental.",
- "request": {
- "$ref": "BuildTrigger"
- },
- "response": {
- "$ref": "BuildTrigger"
- },
- "parameterOrder": [
- "projectId",
- "triggerId"
- ],
- "httpMethod": "PATCH",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "triggerId": {
- "description": "ID of the BuildTrigger to update.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "projectId": {
- "description": "ID of the project that owns the trigger.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "flatPath": "v1/projects/{projectId}/triggers/{triggerId}"
+ }
},
"delete": {
- "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.",
"response": {
"$ref": "Empty"
@@ -961,9 +1056,6 @@
"triggerId"
],
"httpMethod": "DELETE",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
"parameters": {
"triggerId": {
"description": "ID of the BuildTrigger to delete.",
@@ -978,7 +1070,12 @@
"type": "string"
}
},
- "flatPath": "v1/projects/{projectId}/triggers/{triggerId}"
+ "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": {
"response": {
@@ -988,9 +1085,6 @@
"projectId"
],
"httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
"parameters": {
"projectId": {
"location": "path",
@@ -999,12 +1093,19 @@
"type": "string"
}
},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
"flatPath": "v1/projects/{projectId}/triggers",
"path": "v1/projects/{projectId}/triggers",
"id": "cloudbuild.projects.triggers.list",
"description": "Lists existing BuildTrigger.\n\nThis API is experimental."
},
"create": {
+ "request": {
+ "$ref": "BuildTrigger"
+ },
+ "description": "Creates a new BuildTrigger.\n\nThis API is experimental.",
"response": {
"$ref": "BuildTrigger"
},
@@ -1025,160 +1126,100 @@
],
"flatPath": "v1/projects/{projectId}/triggers",
"path": "v1/projects/{projectId}/triggers",
- "id": "cloudbuild.projects.triggers.create",
- "request": {
- "$ref": "BuildTrigger"
- },
- "description": "Creates a new BuildTrigger.\n\nThis API is experimental."
+ "id": "cloudbuild.projects.triggers.create"
},
"run": {
- "id": "cloudbuild.projects.triggers.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"
},
- "description": "Runs a BuildTrigger at a particular source revision.",
- "httpMethod": "POST",
+ "response": {
+ "$ref": "Operation"
+ },
"parameterOrder": [
"projectId",
"triggerId"
],
- "response": {
- "$ref": "Operation"
- },
- "parameters": {
- "triggerId": {
- "location": "path",
- "description": "ID of the trigger.",
- "required": true,
- "type": "string"
- },
- "projectId": {
- "description": "ID of the project.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
+ "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"
}
}
}
}
- },
- "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"
- },
- "httpMethod": "POST",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Empty"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "pattern": "^operations/.+$",
- "location": "path",
- "description": "The name of the operation resource to be cancelled.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1/operations/{operationsId}:cancel",
- "id": "cloudbuild.operations.cancel",
- "path": "v1/{+name}:cancel"
- },
- "list": {
- "response": {
- "$ref": "ListOperationsResponse"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "parameters": {
- "name": {
- "pattern": "^operations$",
- "location": "path",
- "description": "The name of the operation's parent resource.",
- "required": true,
- "type": "string"
- },
- "pageToken": {
- "description": "The standard list page token.",
- "type": "string",
- "location": "query"
- },
- "pageSize": {
- "description": "The standard list page size.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- },
- "filter": {
- "description": "The standard list filter.",
- "type": "string",
- "location": "query"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/operations",
- "path": "v1/{+name}",
- "id": "cloudbuild.operations.list",
- "description": "Lists operations that match the specified filter in the request. If the\nserver doesn't support this method, it returns `UNIMPLEMENTED`.\n\nNOTE: the `name` binding allows API services to override the binding\nto use different resource name schemes, such as `users/*/operations`. To\noverride the binding, API services can add a binding such as\n`\"/v1/{name=users/*}/operations\"` to their service configuration.\nFor backwards compatibility, the default name includes the operations\ncollection id, however overriding users must ensure the name binding\nis the parent resource, without the operations collection id."
- },
- "get": {
- "description": "Gets the latest state of a long-running operation. Clients can use this\nmethod to poll the operation result at intervals as recommended by the API\nservice.",
- "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"
- ],
- "flatPath": "v1/operations/{operationsId}",
- "id": "cloudbuild.operations.get",
- "path": "v1/{+name}"
- }
- }
}
},
"parameters": {
- "fields": {
- "description": "Selector specifying which fields to include in a partial response.",
+ "access_token": {
+ "description": "OAuth access token.",
"type": "string",
"location": "query"
},
- "uploadType": {
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "key": {
+ "location": "query",
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "type": "string"
+ },
+ "quotaUser": {
+ "location": "query",
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "type": "string"
+ },
+ "pp": {
+ "description": "Pretty-print response.",
+ "type": "boolean",
+ "default": "true",
+ "location": "query"
+ },
+ "oauth_token": {
+ "location": "query",
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string"
+ },
+ "bearer_token": {
+ "description": "OAuth bearer token.",
"type": "string",
"location": "query"
},
+ "upload_protocol": {
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "type": "string",
+ "location": "query"
+ },
+ "prettyPrint": {
+ "description": "Returns response with indentations and line breaks.",
+ "type": "boolean",
+ "default": "true",
+ "location": "query"
+ },
+ "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",
@@ -1198,8 +1239,6 @@
"location": "query"
},
"alt": {
- "description": "Data format for response.",
- "default": "json",
"enum": [
"json",
"media",
@@ -1211,54 +1250,15 @@
"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": {
- "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"
+ "description": "Data format for response.",
+ "default": "json"
}
},
"version": "v1",
"baseUrl": "https://cloudbuild.googleapis.com/",
- "kind": "discovery#restDescription",
+ "servicePath": "",
"description": "Builds container images in the cloud.",
- "servicePath": ""
+ "kind": "discovery#restDescription",
+ "basePath": ""
}
diff --git a/clouddebugger/v2/clouddebugger-api.json b/clouddebugger/v2/clouddebugger-api.json
index 302a8dc..9ac2a77 100644
--- a/clouddebugger/v2/clouddebugger-api.json
+++ b/clouddebugger/v2/clouddebugger-api.json
@@ -1,133 +1,454 @@
{
- "revision": "20171016",
+ "auth": {
+ "oauth2": {
+ "scopes": {
+ "https://www.googleapis.com/auth/cloud_debugger": {
+ "description": "Manage cloud debugger"
+ },
+ "https://www.googleapis.com/auth/cloud-platform": {
+ "description": "View and manage your data across Google Cloud Platform services"
+ }
+ }
+ }
+ },
+ "rootUrl": "https://clouddebugger.googleapis.com/",
+ "ownerDomain": "google.com",
+ "name": "clouddebugger",
+ "batchPath": "batch",
+ "title": "Stackdriver Debugger API",
+ "ownerName": "Google",
+ "resources": {
+ "debugger": {
+ "resources": {
+ "debuggees": {
+ "methods": {
+ "list": {
+ "id": "clouddebugger.debugger.debuggees.list",
+ "path": "v2/debugger/debuggees",
+ "description": "Lists all the debuggees that the user has access to.",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "ListDebuggeesResponse"
+ },
+ "parameterOrder": [],
+ "parameters": {
+ "includeInactive": {
+ "description": "When set to `true`, the result includes all debuggees. Otherwise, the\nresult includes only debuggees that are active.",
+ "type": "boolean",
+ "location": "query"
+ },
+ "project": {
+ "location": "query",
+ "description": "Project number of a Google Cloud project whose debuggees to list.",
+ "type": "string"
+ },
+ "clientVersion": {
+ "location": "query",
+ "description": "The client version making the call.\nSchema: `domain/type/version` (e.g., `google.com/intellij/v1`).",
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud_debugger"
+ ],
+ "flatPath": "v2/debugger/debuggees"
+ }
+ },
+ "resources": {
+ "breakpoints": {
+ "methods": {
+ "set": {
+ "response": {
+ "$ref": "SetBreakpointResponse"
+ },
+ "parameterOrder": [
+ "debuggeeId"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "clientVersion": {
+ "location": "query",
+ "description": "The client version making the call.\nSchema: `domain/type/version` (e.g., `google.com/intellij/v1`).",
+ "type": "string"
+ },
+ "debuggeeId": {
+ "location": "path",
+ "description": "ID of the debuggee where the breakpoint is to be set.",
+ "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/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": {
+ "path": "v2/debugger/debuggees/{debuggeeId}/breakpoints/{breakpointId}",
+ "id": "clouddebugger.debugger.debuggees.breakpoints.delete",
+ "description": "Deletes the breakpoint from the debuggee.",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "debuggeeId",
+ "breakpointId"
+ ],
+ "httpMethod": "DELETE",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud_debugger"
+ ],
+ "parameters": {
+ "breakpointId": {
+ "location": "path",
+ "description": "ID of the breakpoint to delete.",
+ "required": true,
+ "type": "string"
+ },
+ "debuggeeId": {
+ "description": "ID of the debuggee whose breakpoint to delete.",
+ "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/{breakpointId}"
+ },
+ "get": {
+ "path": "v2/debugger/debuggees/{debuggeeId}/breakpoints/{breakpointId}",
+ "id": "clouddebugger.debugger.debuggees.breakpoints.get",
+ "description": "Gets breakpoint information.",
+ "response": {
+ "$ref": "GetBreakpointResponse"
+ },
+ "parameterOrder": [
+ "debuggeeId",
+ "breakpointId"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud_debugger"
+ ],
+ "parameters": {
+ "breakpointId": {
+ "description": "ID of the breakpoint to get.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "debuggeeId": {
+ "description": "ID of the debuggee whose breakpoint to get.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "clientVersion": {
+ "description": "The client version making the call.\nSchema: `domain/type/version` (e.g., `google.com/intellij/v1`).",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "flatPath": "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": {
+ "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"
+ },
+ "includeInactive": {
+ "description": "When set to `true`, the response includes active and inactive\nbreakpoints. Otherwise, it includes only active breakpoints.",
+ "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"
+ },
+ "debuggeeId": {
+ "description": "ID of the debuggee whose breakpoints to list.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "waitToken": {
+ "description": "A wait token that, if specified, blocks the call until the breakpoints\nlist has changed, or a server selected timeout has expired. The value\nshould be set from the last response. The error code\n`google.rpc.Code.ABORTED` (RPC) is returned on wait timeout, which\nshould be called again with the same `wait_token`.",
+ "type": "string",
+ "location": "query"
+ },
+ "action.value": {
+ "location": "query",
+ "enum": [
+ "CAPTURE",
+ "LOG"
+ ],
+ "description": "Only breakpoints with the specified action will pass the filter.",
+ "type": "string"
+ },
+ "clientVersion": {
+ "location": "query",
+ "description": "The client version making the call.\nSchema: `domain/type/version` (e.g., `google.com/intellij/v1`).",
+ "type": "string"
+ }
+ },
+ "flatPath": "v2/debugger/debuggees/{debuggeeId}/breakpoints",
+ "path": "v2/debugger/debuggees/{debuggeeId}/breakpoints",
+ "id": "clouddebugger.debugger.debuggees.breakpoints.list"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "controller": {
+ "resources": {
+ "debuggees": {
+ "methods": {
+ "register": {
+ "id": "clouddebugger.controller.debuggees.register",
+ "path": "v2/controller/debuggees/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"
+ }
+ },
+ "resources": {
+ "breakpoints": {
+ "methods": {
+ "list": {
+ "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.",
+ "response": {
+ "$ref": "ListActiveBreakpointsResponse"
+ },
+ "parameterOrder": [
+ "debuggeeId"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud_debugger"
+ ],
+ "parameters": {
+ "debuggeeId": {
+ "location": "path",
+ "description": "Identifies the debuggee.",
+ "required": true,
+ "type": "string"
+ },
+ "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"
+ },
+ "update": {
+ "path": "v2/controller/debuggees/{debuggeeId}/breakpoints/{id}",
+ "id": "clouddebugger.controller.debuggees.breakpoints.update",
+ "description": "Updates the breakpoint state or mutable fields.\nThe entire Breakpoint message must be sent back to the controller service.\n\nUpdates to active breakpoint fields are only allowed if the new value\ndoes not change the breakpoint specification. Updates to the `location`,\n`condition` and `expressions` fields should not alter the breakpoint\nsemantics. These may only make changes such as canonicalizing a value\nor snapping the location to the correct line of code.",
+ "request": {
+ "$ref": "UpdateActiveBreakpointRequest"
+ },
+ "response": {
+ "$ref": "UpdateActiveBreakpointResponse"
+ },
+ "parameterOrder": [
+ "debuggeeId",
+ "id"
+ ],
+ "httpMethod": "PUT",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud_debugger"
+ ],
+ "parameters": {
+ "debuggeeId": {
+ "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"
+ }
+ },
+ "flatPath": "v2/controller/debuggees/{debuggeeId}/breakpoints/{id}"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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": {
+ "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": {
+ "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"
+ }
+ },
+ "version": "v2",
+ "baseUrl": "https://clouddebugger.googleapis.com/",
+ "servicePath": "",
+ "description": "Examines the call stack and variables of a running application without stopping or slowing it down.\n",
+ "kind": "discovery#restDescription",
+ "basePath": "",
"documentationLink": "http://cloud.google.com/debugger",
+ "revision": "20180102",
"id": "clouddebugger:v2",
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
- "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": {
- "labels": {
- "description": "A set of custom debuggee properties, populated by the agent, to be\ndisplayed to the user.",
- "type": "object",
- "additionalProperties": {
- "type": "string"
- }
- },
- "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": {
- "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"
- },
- "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": {
- "description": "Human readable description of the debuggee.\nIncluding a human-readable project name, environment name and version\ninformation is recommended.",
- "type": "string"
- },
- "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"
- },
- "sourceContexts": {
- "description": "References to the locations and revisions of the source code used in the\ndeployed application.",
- "type": "array",
- "items": {
- "$ref": "SourceContext"
- }
- },
- "extSourceContexts": {
- "description": "References to the locations and revisions of the source code used in the\ndeployed application.\n\nNOTE: this field is experimental and can be ignored.",
- "type": "array",
- "items": {
- "$ref": "ExtendedSourceContext"
- }
- }
- },
- "id": "Debuggee"
- },
- "ProjectRepoId": {
- "description": "Selects a repo using a Google Cloud Platform project ID\n(e.g. winged-cargo-31) and a repo name within that project.",
- "type": "object",
- "properties": {
- "projectId": {
- "description": "The ID of the project.",
- "type": "string"
- },
- "repoName": {
- "description": "The name of the repo. Leave empty for the default repo.",
- "type": "string"
- }
- },
- "id": "ProjectRepoId"
- },
- "ListActiveBreakpointsResponse": {
- "description": "Response for listing active breakpoints.",
- "type": "object",
- "properties": {
- "nextWaitToken": {
- "description": "A token that can be used in the next method call to block until\nthe list of breakpoints changes.",
- "type": "string"
- },
- "breakpoints": {
- "description": "List of all active breakpoints.\nThe fields `id` and `location` are guaranteed to be set on each breakpoint.",
- "type": "array",
- "items": {
- "$ref": "Breakpoint"
- }
- },
- "waitExpired": {
- "description": "If set to `true`, indicates that there is no change to the\nlist of active breakpoints and the server-selected timeout has expired.\nThe `breakpoints` field would be empty and should be ignored.",
- "type": "boolean"
- }
- },
- "id": "ListActiveBreakpointsResponse"
- },
- "CloudWorkspaceSourceContext": {
- "description": "A CloudWorkspaceSourceContext denotes a workspace at a particular snapshot.",
- "type": "object",
- "properties": {
- "snapshotId": {
- "description": "The ID of the snapshot.\nAn empty snapshot_id refers to the most recent snapshot.",
- "type": "string"
- },
- "workspaceId": {
- "$ref": "CloudWorkspaceId",
- "description": "The ID of the workspace."
- }
- },
- "id": "CloudWorkspaceSourceContext"
- },
"GerritSourceContext": {
"description": "A SourceContext referring to a Gerrit project.",
"type": "object",
"properties": {
+ "aliasName": {
+ "description": "The name of an alias (branch, tag, etc.).",
+ "type": "string"
+ },
"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."
+ "description": "An alias, which may be a branch or tag.",
+ "$ref": "AliasContext"
},
"hostUri": {
"description": "The URI of a running Gerrit instance.",
@@ -136,10 +457,6 @@
"revisionId": {
"description": "A revision (commit) ID.",
"type": "string"
- },
- "aliasName": {
- "description": "The name of an alias (branch, tag, etc.).",
- "type": "string"
}
},
"id": "GerritSourceContext"
@@ -187,9 +504,13 @@
"description": "Represents the breakpoint specification, status and results.",
"type": "object",
"properties": {
+ "id": {
+ "description": "Breakpoint identifier, unique in the scope of the debuggee.",
+ "type": "string"
+ },
"location": {
- "$ref": "SourceLocation",
- "description": "Breakpoint source location."
+ "description": "Breakpoint source location.",
+ "$ref": "SourceLocation"
},
"finalTime": {
"description": "Time this breakpoint was finalized as seen by the server in seconds\nresolution.",
@@ -249,14 +570,16 @@
"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"
+ "$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": {
+ "description": "Action that the agent should perform when the code at the\nbreakpoint location is hit.",
+ "type": "string",
"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."
@@ -264,9 +587,7 @@
"enum": [
"CAPTURE",
"LOG"
- ],
- "description": "Action that the agent should perform when the code at the\nbreakpoint location is hit.",
- "type": "string"
+ ]
},
"logLevel": {
"description": "Indicates the severity of the log. Only relevant when action is `LOG`.",
@@ -281,14 +602,21 @@
"WARNING",
"ERROR"
]
- },
- "id": {
- "description": "Breakpoint identifier, unique in the scope of the debuggee.",
- "type": "string"
}
},
"id": "Breakpoint"
},
+ "UpdateActiveBreakpointRequest": {
+ "id": "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"
+ }
+ }
+ },
"SetBreakpointResponse": {
"description": "Response for setting a breakpoint.",
"type": "object",
@@ -300,74 +628,52 @@
},
"id": "SetBreakpointResponse"
},
- "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"
- },
"SourceContext": {
+ "id": "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": {
"description": "A SourceContext referring to a Gerrit project.",
"$ref": "GerritSourceContext"
},
"cloudRepo": {
- "description": "A SourceContext referring to a revision in a cloud repo.",
- "$ref": "CloudRepoSourceContext"
+ "$ref": "CloudRepoSourceContext",
+ "description": "A SourceContext referring to a revision in a cloud repo."
},
"cloudWorkspace": {
- "description": "A SourceContext referring to a snapshot in a cloud workspace.",
- "$ref": "CloudWorkspaceSourceContext"
+ "$ref": "CloudWorkspaceSourceContext",
+ "description": "A SourceContext referring to a snapshot in a cloud workspace."
+ },
+ "git": {
+ "description": "A SourceContext referring to any third party Git repo (e.g. GitHub).",
+ "$ref": "GitSourceContext"
}
- },
- "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": {
- "revisionId": {
- "description": "A revision ID.",
- "type": "string"
- },
"aliasName": {
"description": "The name of an alias (branch, tag, etc.).",
"type": "string"
},
"repoId": {
- "$ref": "RepoId",
- "description": "The ID of the repo."
+ "description": "The ID of the repo.",
+ "$ref": "RepoId"
},
"aliasContext": {
"$ref": "AliasContext",
"description": "An alias, which may be a branch or tag."
+ },
+ "revisionId": {
+ "description": "A revision ID.",
+ "type": "string"
}
},
"id": "CloudRepoSourceContext"
},
- "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"
- },
"RegisterDebuggeeResponse": {
"description": "Response for registering a debuggee.",
"type": "object",
@@ -379,7 +685,19 @@
},
"id": "RegisterDebuggeeResponse"
},
+ "RegisterDebuggeeRequest": {
+ "description": "Request to register a debuggee.",
+ "type": "object",
+ "properties": {
+ "debuggee": {
+ "$ref": "Debuggee",
+ "description": "Debuggee information to register.\nThe fields `project`, `uniquifier`, `description` and `agent_version`\nof the debuggee must be set."
+ }
+ },
+ "id": "RegisterDebuggeeRequest"
+ },
"GetBreakpointResponse": {
+ "id": "GetBreakpointResponse",
"description": "Response for getting breakpoint information.",
"type": "object",
"properties": {
@@ -387,8 +705,7 @@
"description": "Complete breakpoint state.\nThe fields `id` and `location` are guaranteed to be set.",
"$ref": "Breakpoint"
}
- },
- "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`.",
@@ -399,8 +716,8 @@
"type": "boolean"
},
"description": {
- "$ref": "FormatMessage",
- "description": "Status message text."
+ "description": "Status message text.",
+ "$ref": "FormatMessage"
},
"refersTo": {
"enumDescriptions": [
@@ -428,24 +745,42 @@
"id": "StatusMessage"
},
"GitSourceContext": {
+ "id": "GitSourceContext",
"description": "A GitSourceContext denotes a particular revision in a third party Git\nrepository (e.g. GitHub).",
"type": "object",
"properties": {
- "revisionId": {
- "description": "Git commit hash.\nrequired.",
- "type": "string"
- },
"url": {
"description": "Git repository URL.",
"type": "string"
+ },
+ "revisionId": {
+ "description": "Git commit hash.\nrequired.",
+ "type": "string"
}
- },
- "id": "GitSourceContext"
+ }
},
"Variable": {
+ "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",
"properties": {
+ "name": {
+ "description": "Name of the variable, if any.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Variable type (e.g. `MyClass`). If the variable is split with\n`var_table_index`, `type` goes next to `value`. The interpretation of\na type is agent specific. It is recommended to include the dynamic type\nrather than a static type of an object.",
+ "type": "string"
+ },
+ "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"
+ },
"members": {
"description": "Members contained or pointed to by the variable.",
"type": "array",
@@ -456,28 +791,11 @@
"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"
- },
- "name": {
- "description": "Name of the variable, if any.",
- "type": "string"
- },
- "type": {
- "description": "Variable type (e.g. `MyClass`). If the variable is split with\n`var_table_index`, `type` goes next to `value`. The interpretation of\na type is agent specific. It is recommended to include the dynamic type\nrather than a static type of an object.",
- "type": "string"
- },
- "varTableIndex": {
- "description": "Reference to a variable in the shared variable table. More than\none variable can reference the same variable in the table. The\n`var_table_index` field is an index into `variable_table` in Breakpoint.",
- "format": "int32",
- "type": "integer"
- },
- "value": {
- "description": "Simple value of the variable.",
- "type": "string"
}
- },
- "id": "Variable"
+ }
},
"StackFrame": {
+ "id": "StackFrame",
"description": "Represents a stack frame context.",
"type": "object",
"properties": {
@@ -503,10 +821,10 @@
"description": "Demangled function name at the call site.",
"type": "string"
}
- },
- "id": "StackFrame"
+ }
},
"RepoId": {
+ "id": "RepoId",
"description": "A unique identifier for a cloud repo.",
"type": "object",
"properties": {
@@ -518,10 +836,10 @@
"description": "A server-assigned, globally unique identifier.",
"type": "string"
}
- },
- "id": "RepoId"
+ }
},
"FormatMessage": {
+ "id": "FormatMessage",
"description": "Represents a message with parameters.",
"type": "object",
"properties": {
@@ -536,45 +854,35 @@
"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": {
"additionalProperties": {
"type": "string"
},
"description": "Labels with user defined metadata.",
"type": "object"
- },
- "context": {
- "description": "Any source context.",
- "$ref": "SourceContext"
}
},
"id": "ExtendedSourceContext"
},
- "ListDebuggeesResponse": {
- "description": "Response for listing debuggees.",
- "type": "object",
- "properties": {
- "debuggees": {
- "description": "List of debuggees accessible to the calling user.\nThe fields `debuggee.id` and `description` are guaranteed to be set.\nThe `description` field is a human readable field provided by agents and\ncan be displayed to users.",
- "type": "array",
- "items": {
- "$ref": "Debuggee"
- }
- }
- },
- "id": "ListDebuggeesResponse"
- },
"AliasContext": {
+ "id": "AliasContext",
"description": "An alias to a repo revision.",
"type": "object",
"properties": {
+ "name": {
+ "description": "The alias name.",
+ "type": "string"
+ },
"kind": {
"enumDescriptions": [
"Do not use.",
@@ -590,13 +898,22 @@
],
"description": "The alias kind.",
"type": "string"
- },
- "name": {
- "description": "The alias name.",
- "type": "string"
+ }
+ }
+ },
+ "ListDebuggeesResponse": {
+ "description": "Response for listing debuggees.",
+ "type": "object",
+ "properties": {
+ "debuggees": {
+ "description": "List of debuggees accessible to the calling user.\nThe fields `debuggee.id` and `description` are guaranteed to be set.\nThe `description` field is a human readable field provided by agents and\ncan be displayed to users.",
+ "type": "array",
+ "items": {
+ "$ref": "Debuggee"
+ }
}
},
- "id": "AliasContext"
+ "id": "ListDebuggeesResponse"
},
"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 `{}`.",
@@ -608,452 +925,135 @@
"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"
+ },
+ "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"
+ },
+ "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"
+ },
+ "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"
+ },
+ "description": {
+ "description": "Human readable description of the debuggee.\nIncluding a human-readable project name, environment name and version\ninformation is recommended.",
+ "type": "string"
+ },
+ "sourceContexts": {
+ "description": "References to the locations and revisions of the source code used in the\ndeployed application.",
+ "type": "array",
+ "items": {
+ "$ref": "SourceContext"
+ }
+ },
+ "extSourceContexts": {
+ "description": "References to the locations and revisions of the source code used in the\ndeployed application.\n\nNOTE: this field is experimental and can be ignored.",
+ "type": "array",
+ "items": {
+ "$ref": "ExtendedSourceContext"
+ }
+ },
+ "labels": {
+ "description": "A set of custom debuggee properties, populated by the agent, to be\ndisplayed to the user.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "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."
+ }
+ },
+ "id": "Debuggee"
+ },
+ "ProjectRepoId": {
+ "id": "ProjectRepoId",
+ "description": "Selects a repo using a Google Cloud Platform project ID\n(e.g. winged-cargo-31) and a repo name within that project.",
+ "type": "object",
+ "properties": {
+ "projectId": {
+ "description": "The ID of the project.",
+ "type": "string"
+ },
+ "repoName": {
+ "description": "The name of the repo. Leave empty for the default repo.",
+ "type": "string"
+ }
+ }
+ },
+ "ListActiveBreakpointsResponse": {
+ "id": "ListActiveBreakpointsResponse",
+ "description": "Response for listing active breakpoints.",
+ "type": "object",
+ "properties": {
+ "breakpoints": {
+ "description": "List of all active breakpoints.\nThe fields `id` and `location` are guaranteed to be set on each breakpoint.",
+ "type": "array",
+ "items": {
+ "$ref": "Breakpoint"
+ }
+ },
+ "waitExpired": {
+ "description": "If set to `true`, indicates that there is no change to the\nlist of active breakpoints and the server-selected timeout has expired.\nThe `breakpoints` field would be empty and should be ignored.",
+ "type": "boolean"
+ },
+ "nextWaitToken": {
+ "description": "A token that can be used in the next method call to block until\nthe list of breakpoints changes.",
+ "type": "string"
+ }
+ }
+ },
+ "CloudWorkspaceSourceContext": {
+ "description": "A CloudWorkspaceSourceContext denotes a workspace at a particular snapshot.",
+ "type": "object",
+ "properties": {
+ "snapshotId": {
+ "description": "The ID of the snapshot.\nAn empty snapshot_id refers to the most recent snapshot.",
+ "type": "string"
+ },
+ "workspaceId": {
+ "$ref": "CloudWorkspaceId",
+ "description": "The ID of the workspace."
+ }
+ },
+ "id": "CloudWorkspaceSourceContext"
}
},
- "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 Debugger",
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/cloud_debugger": {
- "description": "Manage cloud debugger"
- },
- "https://www.googleapis.com/auth/cloud-platform": {
- "description": "View and manage your data across Google Cloud Platform services"
- }
- }
- }
- },
- "rootUrl": "https://clouddebugger.googleapis.com/",
- "ownerDomain": "google.com",
- "name": "clouddebugger",
- "batchPath": "batch",
- "title": "Stackdriver Debugger API",
- "ownerName": "Google",
- "resources": {
- "debugger": {
- "resources": {
- "debuggees": {
- "methods": {
- "list": {
- "flatPath": "v2/debugger/debuggees",
- "path": "v2/debugger/debuggees",
- "id": "clouddebugger.debugger.debuggees.list",
- "description": "Lists all the debuggees that the user has access to.",
- "response": {
- "$ref": "ListDebuggeesResponse"
- },
- "parameterOrder": [],
- "httpMethod": "GET",
- "parameters": {
- "clientVersion": {
- "location": "query",
- "description": "The client version making the call.\nSchema: `domain/type/version` (e.g., `google.com/intellij/v1`).",
- "type": "string"
- },
- "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"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud_debugger"
- ]
- }
- },
- "resources": {
- "breakpoints": {
- "methods": {
- "set": {
- "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"
- },
- "response": {
- "$ref": "SetBreakpointResponse"
- },
- "parameterOrder": [
- "debuggeeId"
- ],
- "httpMethod": "POST",
- "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"
- },
- "debuggeeId": {
- "location": "path",
- "description": "ID of the debuggee where the breakpoint is to be set.",
- "required": true,
- "type": "string"
- }
- }
- },
- "delete": {
- "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.",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "debuggeeId",
- "breakpointId"
- ],
- "httpMethod": "DELETE",
- "parameters": {
- "clientVersion": {
- "description": "The client version making the call.\nSchema: `domain/type/version` (e.g., `google.com/intellij/v1`).",
- "type": "string",
- "location": "query"
- },
- "breakpointId": {
- "description": "ID of the breakpoint to delete.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "debuggeeId": {
- "description": "ID of the debuggee whose breakpoint to delete.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud_debugger"
- ]
- },
- "get": {
- "description": "Gets breakpoint information.",
- "httpMethod": "GET",
- "parameterOrder": [
- "debuggeeId",
- "breakpointId"
- ],
- "response": {
- "$ref": "GetBreakpointResponse"
- },
- "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": {
- "description": "ID of the debuggee whose breakpoint to get.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud_debugger"
- ],
- "flatPath": "v2/debugger/debuggees/{debuggeeId}/breakpoints/{breakpointId}",
- "id": "clouddebugger.debugger.debuggees.breakpoints.get",
- "path": "v2/debugger/debuggees/{debuggeeId}/breakpoints/{breakpointId}"
- },
- "list": {
- "flatPath": "v2/debugger/debuggees/{debuggeeId}/breakpoints",
- "path": "v2/debugger/debuggees/{debuggeeId}/breakpoints",
- "id": "clouddebugger.debugger.debuggees.breakpoints.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": {
- "description": "ID of the debuggee whose breakpoints to list.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "waitToken": {
- "description": "A wait token that, if specified, blocks the call until the breakpoints\nlist has changed, or a server selected timeout has expired. The value\nshould be set from the last response. The error code\n`google.rpc.Code.ABORTED` (RPC) is returned on wait timeout, which\nshould be called again with the same `wait_token`.",
- "type": "string",
- "location": "query"
- },
- "clientVersion": {
- "description": "The client version making the call.\nSchema: `domain/type/version` (e.g., `google.com/intellij/v1`).",
- "type": "string",
- "location": "query"
- },
- "action.value": {
- "location": "query",
- "enum": [
- "CAPTURE",
- "LOG"
- ],
- "description": "Only breakpoints with the specified action will pass the filter.",
- "type": "string"
- },
- "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"
- },
- "includeInactive": {
- "description": "When set to `true`, the response includes active and inactive\nbreakpoints. Otherwise, it includes only active breakpoints.",
- "type": "boolean",
- "location": "query"
- },
- "stripResults": {
- "description": "This field is deprecated. The following fields are always stripped out of\nthe result: `stack_frames`, `evaluated_expressions` and `variable_table`.",
- "type": "boolean",
- "location": "query"
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "controller": {
- "resources": {
- "debuggees": {
- "methods": {
- "register": {
- "flatPath": "v2/controller/debuggees/register",
- "id": "clouddebugger.controller.debuggees.register",
- "path": "v2/controller/debuggees/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"
- ]
- }
- },
- "resources": {
- "breakpoints": {
- "methods": {
- "list": {
- "description": "Returns the list of all active breakpoints for the debuggee.\n\nThe breakpoint specification (`location`, `condition`, and `expressions`\nfields) is semantically immutable, although the field values may\nchange. For example, an agent may update the location line number\nto reflect the actual line where the breakpoint was set, but this\ndoesn't change the breakpoint semantics.\n\nThis means that an agent does not need to check if a breakpoint has changed\nwhen it encounters the same breakpoint on a successive call.\nMoreover, an agent should remember the breakpoints that are completed\nuntil the controller removes them from the active list to avoid\nsetting those breakpoints again.",
- "response": {
- "$ref": "ListActiveBreakpointsResponse"
- },
- "parameterOrder": [
- "debuggeeId"
- ],
- "httpMethod": "GET",
- "parameters": {
- "debuggeeId": {
- "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": {
- "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",
- "location": "query"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud_debugger"
- ],
- "flatPath": "v2/controller/debuggees/{debuggeeId}/breakpoints",
- "path": "v2/controller/debuggees/{debuggeeId}/breakpoints",
- "id": "clouddebugger.controller.debuggees.breakpoints.list"
- },
- "update": {
- "description": "Updates the breakpoint state or mutable fields.\nThe entire Breakpoint message must be sent back to the controller service.\n\nUpdates to active breakpoint fields are only allowed if the new value\ndoes not change the breakpoint specification. Updates to the `location`,\n`condition` and `expressions` fields should not alter the breakpoint\nsemantics. These may only make changes such as canonicalizing a value\nor snapping the location to the correct line of code.",
- "request": {
- "$ref": "UpdateActiveBreakpointRequest"
- },
- "response": {
- "$ref": "UpdateActiveBreakpointResponse"
- },
- "parameterOrder": [
- "debuggeeId",
- "id"
- ],
- "httpMethod": "PUT",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud_debugger"
- ],
- "parameters": {
- "debuggeeId": {
- "location": "path",
- "description": "Identifies the debuggee being debugged.",
- "required": true,
- "type": "string"
- },
- "id": {
- "location": "path",
- "description": "Breakpoint identifier, unique in the scope of the debuggee.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v2/controller/debuggees/{debuggeeId}/breakpoints/{id}",
- "path": "v2/controller/debuggees/{debuggeeId}/breakpoints/{id}",
- "id": "clouddebugger.controller.debuggees.breakpoints.update"
- }
- }
- }
- }
- }
- }
- }
- },
- "parameters": {
- "fields": {
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string",
- "location": "query"
- },
- "uploadType": {
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string",
- "location": "query"
- },
- "$.xgafv": {
- "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": {
- "location": "query",
- "description": "OAuth access token.",
- "type": "string"
- },
- "key": {
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string",
- "location": "query"
- },
- "quotaUser": {
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string",
- "location": "query"
- },
- "pp": {
- "description": "Pretty-print response.",
- "type": "boolean",
- "default": "true",
- "location": "query"
- },
- "oauth_token": {
- "description": "OAuth 2.0 token for the current user.",
- "type": "string",
- "location": "query"
- },
- "bearer_token": {
- "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": "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": ""
+ "protocol": "rest",
+ "canonicalName": "Cloud Debugger"
}
diff --git a/clouderrorreporting/v1beta1/clouderrorreporting-api.json b/clouderrorreporting/v1beta1/clouderrorreporting-api.json
index a966ad5..f88ed61 100644
--- a/clouderrorreporting/v1beta1/clouderrorreporting-api.json
+++ b/clouderrorreporting/v1beta1/clouderrorreporting-api.json
@@ -1,4 +1,5 @@
{
+ "discoveryVersion": "v1",
"version_module": true,
"schemas": {
"ErrorEvent": {
@@ -6,6 +7,14 @@
"description": "An error event which is returned by the Error Reporting system.",
"type": "object",
"properties": {
+ "message": {
+ "description": "The stack trace that was reported or logged by the service.",
+ "type": "string"
+ },
+ "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",
@@ -14,14 +23,6 @@
"context": {
"$ref": "ErrorContext",
"description": "Data about the context in which the error occurred."
- },
- "message": {
- "description": "The stack trace that was reported or logged by the service.",
- "type": "string"
- },
- "serviceContext": {
- "description": "The `ServiceContext` for which this error was reported.",
- "$ref": "ServiceContext"
}
}
},
@@ -35,8 +36,8 @@
"type": "string"
},
"serviceContext": {
- "$ref": "ServiceContext",
- "description": "[Required] The service context in which this error has occurred."
+ "description": "[Required] The service context in which this error has occurred.",
+ "$ref": "ServiceContext"
},
"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.",
@@ -50,10 +51,13 @@
}
},
"ErrorContext": {
- "id": "ErrorContext",
"description": "A description of the context in which an error occurred.\nThis data should be provided by the application when reporting an error,\nunless the\nerror report has been generated automatically from Google App Engine logs.",
"type": "object",
"properties": {
+ "user": {
+ "description": "The user who caused or was affected by the crash.\nThis can be a user ID, an email address, or an arbitrary token that\nuniquely identifies the user.\nWhen sending an error report, leave this field empty if the user was not\nlogged in. In this case the\nError Reporting system will use other data, such as remote IP address, to\ndistinguish affected users. See `affected_users_count` in\n`ErrorGroupStats`.",
+ "type": "string"
+ },
"reportLocation": {
"$ref": "SourceLocation",
"description": "The location in the source code where the decision was made to\nreport the error, usually the place where it was logged.\nFor a logged exception this would be the source line where the\nexception is logged, usually close to the place where it was\ncaught."
@@ -68,12 +72,9 @@
"httpRequest": {
"$ref": "HttpRequestContext",
"description": "The HTTP request which was processed when the error was\ntriggered."
- },
- "user": {
- "description": "The user who caused or was affected by the crash.\nThis can be a user ID, an email address, or an arbitrary token that\nuniquely identifies the user.\nWhen sending an error report, leave this field empty if the user was not\nlogged in. In this case the\nError Reporting system will use other data, such as remote IP address, to\ndistinguish affected users. See `affected_users_count` in\n`ErrorGroupStats`.",
- "type": "string"
}
- }
+ },
+ "id": "ErrorContext"
},
"TrackingIssue": {
"description": "Information related to tracking the progress on resolving the error.",
@@ -115,8 +116,8 @@
}
},
"group": {
- "$ref": "ErrorGroup",
- "description": "Group data that is independent of the filter criteria."
+ "description": "Group data that is independent of the filter criteria.",
+ "$ref": "ErrorGroup"
},
"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.",
@@ -141,7 +142,6 @@
}
},
"ListEventsResponse": {
- "id": "ListEventsResponse",
"description": "Contains a set of requested error events.",
"type": "object",
"properties": {
@@ -161,9 +161,11 @@
"format": "google-datetime",
"type": "string"
}
- }
+ },
+ "id": "ListEventsResponse"
},
"TimedCount": {
+ "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.",
"type": "object",
"properties": {
@@ -182,11 +184,9 @@
"format": "google-datetime",
"type": "string"
}
- },
- "id": "TimedCount"
+ }
},
"ErrorGroup": {
- "id": "ErrorGroup",
"description": "Description of a group of similar error events.",
"type": "object",
"properties": {
@@ -205,7 +205,8 @@
"description": "The group resource name.\nExample: \u003ccode\u003eprojects/my-project-123/groups/my-groupid\u003c/code\u003e",
"type": "string"
}
- }
+ },
+ "id": "ErrorGroup"
},
"SourceLocation": {
"id": "SourceLocation",
@@ -228,14 +229,9 @@
}
},
"ServiceContext": {
- "id": "ServiceContext",
"description": "Describes a running service that sends errors.\nIts version changes over time and multiple versions can run in parallel.",
"type": "object",
"properties": {
- "resourceType": {
- "description": "Type of the MonitoredResource. List of possible values:\nhttps://cloud.google.com/monitoring/api/resources\n\nValue is set automatically for incoming errors and must not be set when\nreporting errors.",
- "type": "string"
- },
"version": {
"description": "Represents the source code version that the developer provided,\nwhich could represent a version label or a Git SHA-1 hash, for example.\nFor App Engine standard environment, the version is set to the version of\nthe app.",
"type": "string"
@@ -243,14 +239,19 @@
"service": {
"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": {
+ "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"
}
- }
+ },
+ "id": "ServiceContext"
},
"ReportErrorEventResponse": {
+ "id": "ReportErrorEventResponse",
"description": "Response for reporting an individual error event.\nData may be added to this message in the future.",
"type": "object",
- "properties": {},
- "id": "ReportErrorEventResponse"
+ "properties": {}
},
"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.",
@@ -285,6 +286,7 @@
"id": "HttpRequestContext"
},
"ListGroupStatsResponse": {
+ "id": "ListGroupStatsResponse",
"description": "Contains a set of requested error group stats.",
"type": "object",
"properties": {
@@ -304,8 +306,7 @@
"format": "google-datetime",
"type": "string"
}
- },
- "id": "ListGroupStatsResponse"
+ }
},
"DeleteEventsResponse": {
"id": "DeleteEventsResponse",
@@ -330,8 +331,8 @@
}
},
"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": "Clouderrorreporting",
@@ -354,16 +355,14 @@
"projects": {
"methods": {
"deleteEvents": {
+ "description": "Deletes all error events of a given project.",
+ "httpMethod": "DELETE",
"response": {
"$ref": "DeleteEventsResponse"
},
"parameterOrder": [
"projectName"
],
- "httpMethod": "DELETE",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
"parameters": {
"projectName": {
"pattern": "^projects/[^/]+$",
@@ -373,242 +372,26 @@
"type": "string"
}
},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
"flatPath": "v1beta1/projects/{projectsId}/events",
- "path": "v1beta1/{+projectName}/events",
"id": "clouderrorreporting.projects.deleteEvents",
- "description": "Deletes all error events of a given project."
+ "path": "v1beta1/{+projectName}/events"
}
},
"resources": {
"events": {
"methods": {
- "report": {
+ "list": {
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
- "projectName": {
- "pattern": "^projects/[^/]+$",
- "location": "path",
- "description": "[Required] The resource name of the Google Cloud Platform project. Written\nas `projects/` plus the\n[Google Cloud Platform project ID](https://support.google.com/cloud/answer/6158840).\nExample: `projects/my-project-123`.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1beta1/projects/{projectsId}/events:report",
- "path": "v1beta1/{+projectName}/events:report",
- "id": "clouderrorreporting.projects.events.report",
- "description": "Report an individual error event.\n\nThis endpoint accepts \u003cstrong\u003eeither\u003c/strong\u003e an OAuth token,\n\u003cstrong\u003eor\u003c/strong\u003e an\n\u003ca href=\"https://support.google.com/cloud/answer/6158862\"\u003eAPI key\u003c/a\u003e\nfor authentication. To use an API key, append it to the URL as the value of\na `key` parameter. For example:\n\u003cpre\u003ePOST https://clouderrorreporting.googleapis.com/v1beta1/projects/example-project/events:report?key=123ABC456\u003c/pre\u003e",
- "request": {
- "$ref": "ReportedErrorEvent"
- },
- "response": {
- "$ref": "ReportErrorEventResponse"
- },
- "parameterOrder": [
- "projectName"
- ],
- "httpMethod": "POST"
- },
- "list": {
- "description": "Lists the specified events.",
- "response": {
- "$ref": "ListEventsResponse"
- },
- "parameterOrder": [
- "projectName"
- ],
- "httpMethod": "GET",
- "parameters": {
- "timeRange.period": {
- "location": "query",
- "enum": [
- "PERIOD_UNSPECIFIED",
- "PERIOD_1_HOUR",
- "PERIOD_6_HOURS",
- "PERIOD_1_DAY",
- "PERIOD_1_WEEK",
- "PERIOD_30_DAYS"
- ],
- "description": "Restricts the query to the specified time range.",
- "type": "string"
- },
- "projectName": {
- "pattern": "^projects/[^/]+$",
- "location": "path",
- "description": "[Required] The resource name of the Google Cloud Platform project. Written\nas `projects/` plus the\n[Google Cloud Platform project\nID](https://support.google.com/cloud/answer/6158840).\nExample: `projects/my-project-123`.",
- "required": true,
- "type": "string"
- },
- "groupId": {
- "location": "query",
- "description": "[Required] The group for which events shall be returned.",
- "type": "string"
- },
- "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"
- },
- "pageToken": {
- "description": "[Optional] A `next_page_token` provided by a previous response.",
- "type": "string",
- "location": "query"
- },
- "pageSize": {
- "location": "query",
- "description": "[Optional] The maximum number of results to return per response.",
- "format": "int32",
- "type": "integer"
- },
- "serviceFilter.version": {
- "description": "[Optional] The exact value to match against\n[`ServiceContext.version`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.version).",
- "type": "string",
- "location": "query"
- },
"serviceFilter.resourceType": {
"description": "[Optional] The exact value to match against\n[`ServiceContext.resource_type`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.resource_type).",
"type": "string",
"location": "query"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta1/projects/{projectsId}/events",
- "path": "v1beta1/{+projectName}/events",
- "id": "clouderrorreporting.projects.events.list"
- }
- }
- },
- "groups": {
- "methods": {
- "get": {
- "description": "Get the specified group.",
- "response": {
- "$ref": "ErrorGroup"
- },
- "parameterOrder": [
- "groupName"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "groupName": {
- "pattern": "^projects/[^/]+/groups/[^/]+$",
- "location": "path",
- "description": "[Required] The group resource name. Written as\n\u003ccode\u003eprojects/\u003cvar\u003eprojectID\u003c/var\u003e/groups/\u003cvar\u003egroup_name\u003c/var\u003e\u003c/code\u003e.\nCall\n\u003ca href=\"/error-reporting/reference/rest/v1beta1/projects.groupStats/list\"\u003e\n\u003ccode\u003egroupStats.list\u003c/code\u003e\u003c/a\u003e to return a list of groups belonging to\nthis project.\n\nExample: \u003ccode\u003eprojects/my-project-123/groups/my-group\u003c/code\u003e",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1beta1/projects/{projectsId}/groups/{groupsId}",
- "path": "v1beta1/{+groupName}",
- "id": "clouderrorreporting.projects.groups.get"
- },
- "update": {
- "path": "v1beta1/{+name}",
- "id": "clouderrorreporting.projects.groups.update",
- "request": {
- "$ref": "ErrorGroup"
- },
- "description": "Replace the data for the specified group.\nFails if the group does not exist.",
- "response": {
- "$ref": "ErrorGroup"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "PUT",
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/groups/[^/]+$",
- "location": "path",
- "description": "The group resource name.\nExample: \u003ccode\u003eprojects/my-project-123/groups/my-groupid\u003c/code\u003e",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta1/projects/{projectsId}/groups/{groupsId}"
- }
- }
- },
- "groupStats": {
- "methods": {
- "list": {
- "description": "Lists the specified groups.",
- "response": {
- "$ref": "ListGroupStatsResponse"
- },
- "parameterOrder": [
- "projectName"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "serviceFilter.service": {
- "description": "[Optional] The exact value to match against\n[`ServiceContext.service`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.service).",
- "type": "string",
- "location": "query"
- },
- "pageSize": {
- "description": "[Optional] The maximum number of results to return per response.\nDefault is 20.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- },
- "order": {
- "location": "query",
- "enum": [
- "GROUP_ORDER_UNSPECIFIED",
- "COUNT_DESC",
- "LAST_SEEN_DESC",
- "CREATED_DESC",
- "AFFECTED_USERS_DESC"
- ],
- "description": "[Optional] The sort order in which the results are returned.\nDefault is `COUNT_DESC`.",
- "type": "string"
- },
- "serviceFilter.version": {
- "description": "[Optional] The exact value to match against\n[`ServiceContext.version`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.version).",
- "type": "string",
- "location": "query"
- },
- "serviceFilter.resourceType": {
- "location": "query",
- "description": "[Optional] The exact value to match against\n[`ServiceContext.resource_type`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.resource_type).",
- "type": "string"
- },
- "alignmentTime": {
- "description": "[Optional] Time where the timed counts shall be aligned if rounded\nalignment is chosen. Default is 00:00 UTC.",
- "format": "google-datetime",
- "type": "string",
- "location": "query"
- },
- "projectName": {
- "description": "[Required] The resource name of the Google Cloud Platform project. Written\nas \u003ccode\u003eprojects/\u003c/code\u003e plus the\n\u003ca href=\"https://support.google.com/cloud/answer/6158840\"\u003eGoogle Cloud\nPlatform project ID\u003c/a\u003e.\n\nExample: \u003ccode\u003eprojects/my-project-123\u003c/code\u003e.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+$",
- "location": "path"
- },
- "timedCountDuration": {
- "description": "[Optional] The preferred duration for a single returned `TimedCount`.\nIf not set, no timed counts are returned.",
- "format": "google-duration",
- "type": "string",
- "location": "query"
- },
- "pageToken": {
- "location": "query",
- "description": "[Optional] A `next_page_token` provided by a previous response. To view\nadditional results, pass this token along with the identical query\nparameters as the first request.",
- "type": "string"
},
"timeRange.period": {
"description": "Restricts the query to the specified time range.",
@@ -623,6 +406,216 @@
"PERIOD_30_DAYS"
]
},
+ "projectName": {
+ "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/[^/]+$",
+ "location": "path"
+ },
+ "groupId": {
+ "location": "query",
+ "description": "[Required] The group for which events shall be returned.",
+ "type": "string"
+ },
+ "pageToken": {
+ "description": "[Optional] A `next_page_token` provided by a previous response.",
+ "type": "string",
+ "location": "query"
+ },
+ "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": {
+ "description": "[Optional] The maximum number of results to return per response.",
+ "format": "int32",
+ "type": "integer",
+ "location": "query"
+ },
+ "serviceFilter.version": {
+ "description": "[Optional] The exact value to match against\n[`ServiceContext.version`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.version).",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectsId}/events",
+ "path": "v1beta1/{+projectName}/events",
+ "id": "clouderrorreporting.projects.events.list",
+ "description": "Lists the specified events.",
+ "response": {
+ "$ref": "ListEventsResponse"
+ },
+ "parameterOrder": [
+ "projectName"
+ ],
+ "httpMethod": "GET"
+ },
+ "report": {
+ "path": "v1beta1/{+projectName}/events:report",
+ "id": "clouderrorreporting.projects.events.report",
+ "description": "Report an individual error event.\n\nThis endpoint accepts \u003cstrong\u003eeither\u003c/strong\u003e an OAuth token,\n\u003cstrong\u003eor\u003c/strong\u003e an\n\u003ca href=\"https://support.google.com/cloud/answer/6158862\"\u003eAPI key\u003c/a\u003e\nfor authentication. To use an API key, append it to the URL as the value of\na `key` parameter. For example:\n\u003cpre\u003ePOST https://clouderrorreporting.googleapis.com/v1beta1/projects/example-project/events:report?key=123ABC456\u003c/pre\u003e",
+ "request": {
+ "$ref": "ReportedErrorEvent"
+ },
+ "response": {
+ "$ref": "ReportErrorEventResponse"
+ },
+ "parameterOrder": [
+ "projectName"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "projectName": {
+ "description": "[Required] The resource name of the Google Cloud Platform project. Written\nas `projects/` plus the\n[Google Cloud Platform project ID](https://support.google.com/cloud/answer/6158840).\nExample: `projects/my-project-123`.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectsId}/events:report"
+ }
+ }
+ },
+ "groups": {
+ "methods": {
+ "get": {
+ "parameters": {
+ "groupName": {
+ "pattern": "^projects/[^/]+/groups/[^/]+$",
+ "location": "path",
+ "description": "[Required] The group resource name. Written as\n\u003ccode\u003eprojects/\u003cvar\u003eprojectID\u003c/var\u003e/groups/\u003cvar\u003egroup_name\u003c/var\u003e\u003c/code\u003e.\nCall\n\u003ca href=\"/error-reporting/reference/rest/v1beta1/projects.groupStats/list\"\u003e\n\u003ccode\u003egroupStats.list\u003c/code\u003e\u003c/a\u003e to return a list of groups belonging to\nthis project.\n\nExample: \u003ccode\u003eprojects/my-project-123/groups/my-group\u003c/code\u003e",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta1/projects/{projectsId}/groups/{groupsId}",
+ "id": "clouderrorreporting.projects.groups.get",
+ "path": "v1beta1/{+groupName}",
+ "description": "Get the specified group.",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "ErrorGroup"
+ },
+ "parameterOrder": [
+ "groupName"
+ ]
+ },
+ "update": {
+ "path": "v1beta1/{+name}",
+ "id": "clouderrorreporting.projects.groups.update",
+ "description": "Replace the data for the specified group.\nFails if the group does not exist.",
+ "request": {
+ "$ref": "ErrorGroup"
+ },
+ "response": {
+ "$ref": "ErrorGroup"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "PUT",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The group resource name.\nExample: \u003ccode\u003eprojects/my-project-123/groups/my-groupid\u003c/code\u003e",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/groups/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectsId}/groups/{groupsId}"
+ }
+ }
+ },
+ "groupStats": {
+ "methods": {
+ "list": {
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "serviceFilter.service": {
+ "description": "[Optional] The exact value to match against\n[`ServiceContext.service`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.service).",
+ "type": "string",
+ "location": "query"
+ },
+ "pageSize": {
+ "location": "query",
+ "description": "[Optional] The maximum number of results to return per response.\nDefault is 20.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "serviceFilter.version": {
+ "description": "[Optional] The exact value to match against\n[`ServiceContext.version`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.version).",
+ "type": "string",
+ "location": "query"
+ },
+ "order": {
+ "description": "[Optional] The sort order in which the results are returned.\nDefault is `COUNT_DESC`.",
+ "type": "string",
+ "location": "query",
+ "enum": [
+ "GROUP_ORDER_UNSPECIFIED",
+ "COUNT_DESC",
+ "LAST_SEEN_DESC",
+ "CREATED_DESC",
+ "AFFECTED_USERS_DESC"
+ ]
+ },
+ "alignmentTime": {
+ "location": "query",
+ "description": "[Optional] Time where the timed counts shall be aligned if rounded\nalignment is chosen. Default is 00:00 UTC.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "serviceFilter.resourceType": {
+ "location": "query",
+ "description": "[Optional] The exact value to match against\n[`ServiceContext.resource_type`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.resource_type).",
+ "type": "string"
+ },
+ "projectName": {
+ "description": "[Required] The resource name of the Google Cloud Platform project. Written\nas \u003ccode\u003eprojects/\u003c/code\u003e plus the\n\u003ca href=\"https://support.google.com/cloud/answer/6158840\"\u003eGoogle Cloud\nPlatform project ID\u003c/a\u003e.\n\nExample: \u003ccode\u003eprojects/my-project-123\u003c/code\u003e.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+$",
+ "location": "path"
+ },
+ "timedCountDuration": {
+ "location": "query",
+ "description": "[Optional] The preferred duration for a single returned `TimedCount`.\nIf not set, no timed counts are returned.",
+ "format": "google-duration",
+ "type": "string"
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "[Optional] A `next_page_token` provided by a previous response. To view\nadditional results, pass this token along with the identical query\nparameters as the first request.",
+ "type": "string"
+ },
+ "timeRange.period": {
+ "location": "query",
+ "enum": [
+ "PERIOD_UNSPECIFIED",
+ "PERIOD_1_HOUR",
+ "PERIOD_6_HOURS",
+ "PERIOD_1_DAY",
+ "PERIOD_1_WEEK",
+ "PERIOD_30_DAYS"
+ ],
+ "description": "Restricts the query to the specified time range.",
+ "type": "string"
+ },
"alignment": {
"location": "query",
"enum": [
@@ -634,15 +627,23 @@
"type": "string"
},
"groupId": {
- "description": "[Optional] List all \u003ccode\u003eErrorGroupStats\u003c/code\u003e with these IDs.",
- "type": "string",
"repeated": true,
- "location": "query"
+ "location": "query",
+ "description": "[Optional] List all \u003ccode\u003eErrorGroupStats\u003c/code\u003e with these IDs.",
+ "type": "string"
}
},
"flatPath": "v1beta1/projects/{projectsId}/groupStats",
"path": "v1beta1/{+projectName}/groupStats",
- "id": "clouderrorreporting.projects.groupStats.list"
+ "id": "clouderrorreporting.projects.groupStats.list",
+ "description": "Lists the specified groups.",
+ "response": {
+ "$ref": "ListGroupStatsResponse"
+ },
+ "parameterOrder": [
+ "projectName"
+ ],
+ "httpMethod": "GET"
}
}
}
@@ -650,15 +651,49 @@
}
},
"parameters": {
+ "callback": {
+ "location": "query",
+ "description": "JSONP",
+ "type": "string"
+ },
+ "$.xgafv": {
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query",
+ "enum": [
+ "1",
+ "2"
+ ],
+ "description": "V1 error format.",
+ "type": "string"
+ },
+ "alt": {
+ "type": "string",
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query",
+ "description": "Data format for response.",
+ "default": "json",
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ]
+ },
"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",
- "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.",
@@ -671,16 +706,16 @@
"default": "true",
"location": "query"
},
- "oauth_token": {
- "location": "query",
- "description": "OAuth 2.0 token for the current user.",
- "type": "string"
- },
"bearer_token": {
"location": "query",
"description": "OAuth bearer token.",
"type": "string"
},
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string",
+ "location": "query"
+ },
"upload_protocol": {
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"type": "string",
@@ -698,43 +733,9 @@
"type": "string"
},
"uploadType": {
- "location": "query",
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string"
- },
- "$.xgafv": {
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query",
- "enum": [
- "1",
- "2"
- ],
- "description": "V1 error format.",
- "type": "string"
- },
- "callback": {
- "location": "query",
- "description": "JSONP",
- "type": "string"
- },
- "alt": {
- "enum": [
- "json",
- "media",
- "proto"
- ],
"type": "string",
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query",
- "description": "Data format for response.",
- "default": "json"
+ "location": "query"
}
},
"version": "v1beta1",
@@ -743,8 +744,7 @@
"description": "Groups and counts similar errors from cloud services and applications, reports new errors, and provides access to error groups and their associated errors.\n",
"servicePath": "",
"basePath": "",
- "revision": "20171215",
- "documentationLink": "https://cloud.google.com/error-reporting/",
"id": "clouderrorreporting:v1beta1",
- "discoveryVersion": "v1"
+ "revision": "20171215",
+ "documentationLink": "https://cloud.google.com/error-reporting/"
}
diff --git a/cloudfunctions/v1/cloudfunctions-api.json b/cloudfunctions/v1/cloudfunctions-api.json
index f577e12..e6320d4 100644
--- a/cloudfunctions/v1/cloudfunctions-api.json
+++ b/cloudfunctions/v1/cloudfunctions-api.json
@@ -1,463 +1,90 @@
{
- "fullyEncodeReservedExpansion": true,
- "title": "Google Cloud Functions API",
- "ownerName": "Google",
- "resources": {
- "operations": {
- "methods": {
- "list": {
- "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",
- "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",
- "parameters": {
- "name": {
- "location": "path",
- "description": "The name of the operation resource.",
- "required": true,
- "type": "string",
- "pattern": "^operations/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/operations/{operationsId}",
- "path": "v1/{+name}",
- "id": "cloudfunctions.operations.get"
- }
- }
- },
- "projects": {
- "resources": {
- "locations": {
- "methods": {
- "list": {
- "response": {
- "$ref": "ListLocationsResponse"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+$",
- "location": "path",
- "description": "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": {
- "description": "The standard list page size.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- },
- "filter": {
- "description": "The standard list filter.",
- "type": "string",
- "location": "query"
- }
- },
- "flatPath": "v1/projects/{projectsId}/locations",
- "path": "v1/{+name}/locations",
- "id": "cloudfunctions.projects.locations.list",
- "description": "Lists information about the supported locations for this service."
- }
- },
- "resources": {
- "functions": {
- "methods": {
- "patch": {
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "PATCH",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "description": "A user-defined name of the function. Function names must be unique\nglobally and match pattern `projects/*/locations/*/functions/*`",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+/functions/[^/]+$",
- "location": "path"
- },
- "updateMask": {
- "location": "query",
- "description": "Required list of fields to be updated in this request.",
- "format": "google-fieldmask",
- "type": "string"
- }
- },
- "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": {
- "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": {
- "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": {
- "id": "cloudfunctions.projects.locations.functions.list",
- "path": "v1/{+parent}/functions",
- "description": "Returns a list of functions that belong to the requested project.",
- "httpMethod": "GET",
- "response": {
- "$ref": "ListFunctionsResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "parameters": {
- "pageToken": {
- "location": "query",
- "description": "The value returned by the last\n`ListFunctionsResponse`; indicates that\nthis is a continuation of a prior `ListFunctions` call, and that the\nsystem should return the next page of data.",
- "type": "string"
- },
- "pageSize": {
- "location": "query",
- "description": "Maximum number of functions to return per call.",
- "format": "int32",
- "type": "integer"
- },
- "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/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/functions"
- },
- "call": {
- "response": {
- "$ref": "CallFunctionResponse"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "POST",
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/locations/[^/]+/functions/[^/]+$",
- "location": "path",
- "description": "The name of the function to be called.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}:call",
- "path": "v1/{+name}:call",
- "id": "cloudfunctions.projects.locations.functions.call",
- "request": {
- "$ref": "CallFunctionRequest"
- },
- "description": "Invokes synchronously deployed function. To be used for testing, very\nlimited traffic allowed."
- },
- "create": {
- "id": "cloudfunctions.projects.locations.functions.create",
- "path": "v1/{+location}/functions",
- "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.",
- "httpMethod": "POST",
- "parameterOrder": [
- "location"
- ],
- "response": {
- "$ref": "Operation"
- },
- "parameters": {
- "location": {
- "location": "path",
- "description": "The project and location in which the function should be created, specified\nin the format `projects/*/locations/*`",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/functions"
- },
- "generateUploadUrl": {
- "path": "v1/{+parent}/functions:generateUploadUrl",
- "id": "cloudfunctions.projects.locations.functions.generateUploadUrl",
- "request": {
- "$ref": "GenerateUploadUrlRequest"
- },
- "description": "Returns a signed URL for uploading a function source code.\nFor more information about the signed URL usage see:\nhttps://cloud.google.com/storage/docs/access-control/signed-urls.\nOnce the function source code upload is complete, the used signed\nURL should be provided in CreateFunction or UpdateFunction request\nas a reference to the function source code.\n\nWhen uploading source code to the generated signed URL, please follow\nthese restrictions:\n\n* Source file type should be a zip file.\n* Source file size should not exceed 100MB limit.\n\nWhen making a HTTP PUT request, these two headers need to be specified:\n\n* `content-type: application/zip`\n* `x-google-content-length-range: 0,104857600`",
- "response": {
- "$ref": "GenerateUploadUrlResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "POST",
- "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"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/functions:generateUploadUrl"
- },
- "generateDownloadUrl": {
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}:generateDownloadUrl",
- "path": "v1/{+name}:generateDownloadUrl",
- "id": "cloudfunctions.projects.locations.functions.generateDownloadUrl",
- "request": {
- "$ref": "GenerateDownloadUrlRequest"
- },
- "description": "Returns a signed URL for downloading deployed function source code.\nThe URL is only valid for a limited period and should be used within\nminutes after generation.\nFor more information about the signed URL usage see:\nhttps://cloud.google.com/storage/docs/access-control/signed-urls",
- "response": {
- "$ref": "GenerateDownloadUrlResponse"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "POST",
- "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"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- }
- }
- }
- }
- }
- }
- }
- },
- "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"
- ],
- "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": {
- "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": {
- "location": "query",
- "description": "OAuth bearer token.",
- "type": "string"
- }
- },
- "version": "v1",
- "baseUrl": "https://cloudfunctions.googleapis.com/",
- "kind": "discovery#restDescription",
- "description": "API for managing lightweight user-provided functions executed in response to events.",
- "servicePath": "",
- "basePath": "",
- "id": "cloudfunctions:v1",
- "documentationLink": "https://cloud.google.com/functions",
- "revision": "20171215",
- "discoveryVersion": "v1",
"version_module": true,
"schemas": {
- "OperationMetadataV1Beta2": {
+ "ListLocationsResponse": {
+ "description": "The response message for Locations.ListLocations.",
+ "type": "object",
+ "properties": {
+ "nextPageToken": {
+ "description": "The standard List next-page token.",
+ "type": "string"
+ },
+ "locations": {
+ "description": "A list of locations that matches the specified filter in the request.",
+ "type": "array",
+ "items": {
+ "$ref": "Location"
+ }
+ }
+ },
+ "id": "ListLocationsResponse"
+ },
+ "CallFunctionResponse": {
+ "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",
+ "description": "Response of `CallFunction` method.",
+ "type": "object"
+ },
+ "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\n1. namespace: For example, `cloud.storage` and\n `google.firebase.analytics`.\n2. resource type: The type of resource on which event occurs. For\n example, the Google Cloud Storage API includes the type `object`.\n3. action: The action that generates the event. For example, action for\n a Google Cloud Storage Object is 'change'.\nThese parts are lower case.",
+ "type": "string"
+ },
+ "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"
+ },
+ "service": {
+ "description": "The hostname of the service that should be observed.\n\nIf no string is provided, the default service implementing the API will\nbe used. For example, `storage.googleapis.com` is the default for all\nevent types in the `google.storage` namespace.",
+ "type": "string"
+ },
+ "failurePolicy": {
+ "description": "Specifies policy for failed executions.",
+ "$ref": "FailurePolicy"
+ }
+ },
+ "id": "EventTrigger"
+ },
+ "FailurePolicy": {
+ "description": "Describes the policy in case of function's execution failure.\nIf empty, then defaults to ignoring failures (i.e. not retrying them).",
+ "type": "object",
+ "properties": {
+ "retry": {
+ "description": "If specified, then the function will be retried in case of a failure.",
+ "$ref": "Retry"
+ }
+ },
+ "id": "FailurePolicy"
+ },
+ "GenerateDownloadUrlRequest": {
+ "description": "Request of `GenerateDownloadUrl` method.",
+ "type": "object",
+ "properties": {
+ "versionId": {
+ "description": "The optional version of function. If not set, default, current version\nis used.",
+ "format": "uint64",
+ "type": "string"
+ }
+ },
+ "id": "GenerateDownloadUrlRequest"
+ },
+ "OperationMetadataV1": {
"description": "Metadata describing an Operation",
"type": "object",
"properties": {
@@ -475,12 +102,6 @@
"type": "string"
},
"type": {
- "enum": [
- "OPERATION_UNSPECIFIED",
- "CREATE_FUNCTION",
- "UPDATE_FUNCTION",
- "DELETE_FUNCTION"
- ],
"description": "Type of operation.",
"type": "string",
"enumDescriptions": [
@@ -488,6 +109,12 @@
"Triggered by CreateFunction call",
"Triggered by UpdateFunction call",
"Triggered by DeleteFunction call."
+ ],
+ "enum": [
+ "OPERATION_UNSPECIFIED",
+ "CREATE_FUNCTION",
+ "UPDATE_FUNCTION",
+ "DELETE_FUNCTION"
]
},
"updateTime": {
@@ -500,12 +127,101 @@
"type": "string"
}
},
- "id": "OperationMetadataV1Beta2"
+ "id": "OperationMetadataV1"
+ },
+ "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": {
+ "description": "The error result of the operation in case of failure or cancellation.",
+ "$ref": "Status"
+ },
+ "metadata": {
+ "description": "Service-specific metadata associated with the operation. It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata. Any method that returns a\nlong-running operation should document the metadata type, if any.",
+ "type": "object",
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ }
+ },
+ "done": {
+ "description": "If the value is `false`, it means the operation is still in progress.\nIf `true`, the operation is completed, and either `error` or `response` is\navailable.",
+ "type": "boolean"
+ }
+ },
+ "id": "Operation",
+ "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
+ "type": "object"
+ },
+ "OperationMetadataV1Beta2": {
+ "properties": {
+ "request": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "description": "The original request that started the operation.",
+ "type": "object"
+ },
+ "versionId": {
+ "description": "Version id of the function created or updated by an API call.\nThis field is only pupulated for Create and Update operations.",
+ "format": "int64",
+ "type": "string"
+ },
+ "type": {
+ "enumDescriptions": [
+ "Unknown operation type.",
+ "Triggered by CreateFunction call",
+ "Triggered by UpdateFunction call",
+ "Triggered by DeleteFunction call."
+ ],
+ "enum": [
+ "OPERATION_UNSPECIFIED",
+ "CREATE_FUNCTION",
+ "UPDATE_FUNCTION",
+ "DELETE_FUNCTION"
+ ],
+ "description": "Type of operation.",
+ "type": "string"
+ },
+ "updateTime": {
+ "description": "The last update timestamp of the operation.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "target": {
+ "description": "Target of the operation - for example\nprojects/project-1/locations/region-1/functions/function-1",
+ "type": "string"
+ }
+ },
+ "id": "OperationMetadataV1Beta2",
+ "description": "Metadata describing an Operation",
+ "type": "object"
},
"Status": {
"description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
"type": "object",
"properties": {
+ "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",
@@ -516,33 +232,22 @@
},
"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"
},
"CallFunctionRequest": {
- "description": "Request for the `CallFunction` method.",
- "type": "object",
"properties": {
"data": {
"description": "Input to be passed to the function.",
"type": "string"
}
},
- "id": "CallFunctionRequest"
+ "id": "CallFunctionRequest",
+ "description": "Request for the `CallFunction` method.",
+ "type": "object"
},
"SourceRepository": {
- "description": "Describes SourceRepository, used to represent parameters related to\nsource repository where a function is hosted.",
- "type": "object",
"properties": {
"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.",
@@ -553,31 +258,22 @@
"type": "string"
}
},
- "id": "SourceRepository"
+ "id": "SourceRepository",
+ "description": "Describes SourceRepository, used to represent parameters related to\nsource repository where a function is hosted.",
+ "type": "object"
},
"CloudFunction": {
"description": "Describes a Cloud Function that contains user computation executed in\nresponse to an event. It encapsulate function and triggers configurations.",
"type": "object",
"properties": {
- "entryPoint": {
- "description": "The name of the function (as defined in source code) that will be\nexecuted. Defaults to the resource name suffix, if not specified. For\nbackward compatibility, if function with given name is not found, then the\nsystem will try to use function named \"function\".\nFor Node.js this is name of a function exported by the module specified\nin `source_location`.",
- "type": "string"
- },
- "labels": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "Labels associated with this Cloud Function.",
- "type": "object"
- },
"updateTime": {
"description": "Output only. The last update timestamp of a Cloud Function.",
"format": "google-datetime",
"type": "string"
},
"httpsTrigger": {
- "description": "An HTTPS endpoint type of source that can be triggered via URL.",
- "$ref": "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.",
@@ -592,15 +288,15 @@
"format": "google-duration",
"type": "string"
},
+ "sourceUploadUrl": {
+ "description": "The Google Cloud Storage signed URL used for source uploading, generated\nby google.cloud.functions.v1.GenerateUploadUrl",
+ "type": "string"
+ },
+ "eventTrigger": {
+ "$ref": "EventTrigger",
+ "description": "A source that fires events in response to a condition in another service."
+ },
"status": {
- "enum": [
- "CLOUD_FUNCTION_STATUS_UNSPECIFIED",
- "ACTIVE",
- "OFFLINE",
- "DEPLOY_IN_PROGRESS",
- "DELETE_IN_PROGRESS",
- "UNKNOWN"
- ],
"description": "Output only. Status of the function deployment.",
"type": "string",
"enumDescriptions": [
@@ -610,16 +306,16 @@
"Function is being created or updated.",
"Function is being deleted.",
"Function deployment failed and the function serving state is undefined.\nThe function should be updated or deleted to move it out of this state."
+ ],
+ "enum": [
+ "CLOUD_FUNCTION_STATUS_UNSPECIFIED",
+ "ACTIVE",
+ "OFFLINE",
+ "DEPLOY_IN_PROGRESS",
+ "DELETE_IN_PROGRESS",
+ "UNKNOWN"
]
},
- "sourceUploadUrl": {
- "description": "The Google Cloud Storage signed URL used for source uploading, generated\nby google.cloud.functions.v1.GenerateUploadUrl",
- "type": "string"
- },
- "eventTrigger": {
- "$ref": "EventTrigger",
- "description": "A source that fires events in response to a condition in another service."
- },
"availableMemoryMb": {
"description": "The amount of memory in MB available for a function.\nDefaults to 256MB.",
"format": "int32",
@@ -639,38 +335,36 @@
"type": "string"
},
"sourceRepository": {
- "$ref": "SourceRepository",
- "description": "**Beta Feature**\n\nThe source repository where a function is hosted."
+ "description": "**Beta Feature**\n\nThe source repository where a function is hosted.",
+ "$ref": "SourceRepository"
+ },
+ "entryPoint": {
+ "description": "The name of the function (as defined in source code) that will be\nexecuted. Defaults to the resource name suffix, if not specified. For\nbackward compatibility, if function with given name is not found, then the\nsystem will try to use function named \"function\".\nFor Node.js this is name of a function exported by the module specified\nin `source_location`.",
+ "type": "string"
+ },
+ "labels": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Labels associated with this Cloud Function.",
+ "type": "object"
}
},
"id": "CloudFunction"
},
"HttpsTrigger": {
- "description": "Describes HttpsTrigger, could be used to connect web hooks to function.",
- "type": "object",
"properties": {
"url": {
"description": "Output only. The deployed url for the function.",
"type": "string"
}
},
- "id": "HttpsTrigger"
+ "id": "HttpsTrigger",
+ "description": "Describes HttpsTrigger, could be used to connect web hooks to function.",
+ "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"
@@ -682,9 +376,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.",
@@ -704,10 +411,10 @@
"id": "Retry"
},
"GenerateUploadUrlRequest": {
- "properties": {},
- "id": "GenerateUploadUrlRequest",
"description": "Request of `GenerateSourceUploadUrl` method.",
- "type": "object"
+ "type": "object",
+ "properties": {},
+ "id": "GenerateUploadUrlRequest"
},
"ListOperationsResponse": {
"description": "The response message for Operations.ListOperations.",
@@ -739,8 +446,6 @@
"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.v1.ListFunctionsRequest\nto get more functions.",
@@ -754,177 +459,16 @@
}
}
},
- "id": "ListFunctionsResponse"
- },
- "CallFunctionResponse": {
- "description": "Response of `CallFunction` method.",
- "type": "object",
- "properties": {
- "result": {
- "description": "Result populated for successful execution of synchronous function. Will\nnot be populated if function does not return a result through context.",
- "type": "string"
- },
- "error": {
- "description": "Either system or user-function generated error. Set if execution\nwas not successful.",
- "type": "string"
- },
- "executionId": {
- "description": "Execution id of function invocation.",
- "type": "string"
- }
- },
- "id": "CallFunctionResponse"
- },
- "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": "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"
- },
- "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": "Required. The type of event to observe. For example:\n`providers/cloud.storage/eventTypes/object.change` and\n`providers/cloud.pubsub/eventTypes/topic.publish`.\n\nEvent types match pattern `providers/*/eventTypes/*.*`.\nThe pattern contains:\n\n1. namespace: For example, `cloud.storage` and\n `google.firebase.analytics`.\n2. resource type: The type of resource on which event occurs. For\n example, the Google Cloud Storage API includes the type `object`.\n3. action: The action that generates the event. For example, action for\n a Google Cloud Storage Object is 'change'.\nThese parts are lower case.",
- "type": "string"
- }
- },
- "id": "EventTrigger"
- },
- "OperationMetadataV1": {
- "description": "Metadata describing an Operation",
- "type": "object",
- "properties": {
- "updateTime": {
- "description": "The last update timestamp of the operation.",
- "format": "google-datetime",
- "type": "string"
- },
- "target": {
- "description": "Target of the operation - for example\nprojects/project-1/locations/region-1/functions/function-1",
- "type": "string"
- },
- "request": {
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- },
- "description": "The original request that started the operation.",
- "type": "object"
- },
- "versionId": {
- "description": "Version id of the function created or updated by an API call.\nThis field is only pupulated for Create and Update operations.",
- "format": "int64",
- "type": "string"
- },
- "type": {
- "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"
- ]
- }
- },
- "id": "OperationMetadataV1"
- },
- "GenerateDownloadUrlRequest": {
- "description": "Request of `GenerateDownloadUrl` method.",
- "type": "object",
- "properties": {
- "versionId": {
- "description": "The optional version of function. If not set, default, current version\nis used.",
- "format": "uint64",
- "type": "string"
- }
- },
- "id": "GenerateDownloadUrlRequest"
- },
- "FailurePolicy": {
- "description": "Describes the policy in case of function's execution failure.\nIf empty, then defaults to ignoring failures (i.e. not retrying them).",
- "type": "object",
- "properties": {
- "retry": {
- "$ref": "Retry",
- "description": "If specified, then the function will be retried in case of a failure."
- }
- },
- "id": "FailurePolicy"
- },
- "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.",
+ "id": "ListFunctionsResponse",
+ "description": "Response for the `ListFunctions` 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",
+ "icons": {
+ "x16": "http://www.google.com/images/icons/product/search-16.gif",
+ "x32": "http://www.google.com/images/icons/product/search-32.gif"
+ },
"canonicalName": "Cloud Functions",
"auth": {
"oauth2": {
@@ -938,5 +482,461 @@
"rootUrl": "https://cloudfunctions.googleapis.com/",
"ownerDomain": "google.com",
"name": "cloudfunctions",
- "batchPath": "batch"
+ "batchPath": "batch",
+ "fullyEncodeReservedExpansion": true,
+ "title": "Google Cloud Functions API",
+ "ownerName": "Google",
+ "resources": {
+ "projects": {
+ "resources": {
+ "locations": {
+ "resources": {
+ "functions": {
+ "methods": {
+ "list": {
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/functions",
+ "path": "v1/{+parent}/functions",
+ "id": "cloudfunctions.projects.locations.functions.list",
+ "description": "Returns a list of functions that belong to the requested project.",
+ "response": {
+ "$ref": "ListFunctionsResponse"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "pageSize": {
+ "description": "Maximum number of functions to return per call.",
+ "format": "int32",
+ "type": "integer",
+ "location": "query"
+ },
+ "parent": {
+ "pattern": "^projects/[^/]+/locations/[^/]+$",
+ "location": "path",
+ "description": "The project and location from which the function should be listed,\nspecified in the format `projects/*/locations/*`\nIf you want to list functions in all locations, use \"-\" in place of a\nlocation.",
+ "required": true,
+ "type": "string"
+ },
+ "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"
+ }
+ }
+ },
+ "create": {
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/functions",
+ "id": "cloudfunctions.projects.locations.functions.create",
+ "path": "v1/{+location}/functions",
+ "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.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "location"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "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"
+ ]
+ },
+ "call": {
+ "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": {
+ "pattern": "^projects/[^/]+/locations/[^/]+/functions/[^/]+$",
+ "location": "path",
+ "description": "The name of the function to be called.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}:call",
+ "id": "cloudfunctions.projects.locations.functions.call",
+ "path": "v1/{+name}:call"
+ },
+ "generateUploadUrl": {
+ "id": "cloudfunctions.projects.locations.functions.generateUploadUrl",
+ "path": "v1/{+parent}/functions:generateUploadUrl",
+ "request": {
+ "$ref": "GenerateUploadUrlRequest"
+ },
+ "description": "Returns a signed URL for uploading a function source code.\nFor more information about the signed URL usage see:\nhttps://cloud.google.com/storage/docs/access-control/signed-urls.\nOnce the function source code upload is complete, the used signed\nURL should be provided in CreateFunction or UpdateFunction request\nas a reference to the function source code.\n\nWhen uploading source code to the generated signed URL, please follow\nthese restrictions:\n\n* Source file type should be a zip file.\n* Source file size should not exceed 100MB limit.\n\nWhen making a HTTP PUT request, these two headers need to be specified:\n\n* `content-type: application/zip`\n* `x-google-content-length-range: 0,104857600`",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "parent"
+ ],
+ "response": {
+ "$ref": "GenerateUploadUrlResponse"
+ },
+ "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"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/functions:generateUploadUrl"
+ },
+ "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"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "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"
+ }
+ }
+ },
+ "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"
+ ],
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}",
+ "path": "v1/{+name}",
+ "id": "cloudfunctions.projects.locations.functions.get"
+ },
+ "patch": {
+ "path": "v1/{+name}",
+ "id": "cloudfunctions.projects.locations.functions.patch",
+ "description": "Updates existing function.",
+ "request": {
+ "$ref": "CloudFunction"
+ },
+ "response": {
+ "$ref": "Operation"
+ },
+ "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": "A user-defined name of the function. Function names must be unique\nglobally and match pattern `projects/*/locations/*/functions/*`",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+/functions/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}"
+ },
+ "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.",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "DELETE",
+ "parameters": {
+ "name": {
+ "description": "The name of the function which should be deleted.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+/functions/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}",
+ "path": "v1/{+name}",
+ "id": "cloudfunctions.projects.locations.functions.delete"
+ }
+ }
+ }
+ },
+ "methods": {
+ "list": {
+ "description": "Lists information about the supported locations for this service.",
+ "response": {
+ "$ref": "ListLocationsResponse"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "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": {
+ "location": "query",
+ "description": "The standard list page token.",
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "The standard list page size.",
+ "format": "int32",
+ "type": "integer",
+ "location": "query"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/locations",
+ "path": "v1/{+name}/locations",
+ "id": "cloudfunctions.projects.locations.list"
+ }
+ }
+ }
+ }
+ },
+ "operations": {
+ "methods": {
+ "list": {
+ "httpMethod": "GET",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "ListOperationsResponse"
+ },
+ "parameters": {
+ "filter": {
+ "location": "query",
+ "description": "The standard list filter.",
+ "type": "string"
+ },
+ "name": {
+ "location": "query",
+ "description": "The name of the operation's parent resource.",
+ "type": "string"
+ },
+ "pageToken": {
+ "description": "The standard list page token.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageSize": {
+ "description": "The standard list page size.",
+ "format": "int32",
+ "type": "integer",
+ "location": "query"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "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": {
+ "path": "v1/{+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.",
+ "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": "v1/operations/{operationsId}"
+ }
+ }
+ }
+ },
+ "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": {
+ "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": {
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query",
+ "enum": [
+ "1",
+ "2"
+ ],
+ "description": "V1 error format.",
+ "type": "string"
+ },
+ "callback": {
+ "description": "JSONP",
+ "type": "string",
+ "location": "query"
+ },
+ "alt": {
+ "description": "Data format for response.",
+ "default": "json",
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
+ "type": "string",
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query"
+ },
+ "access_token": {
+ "description": "OAuth access token.",
+ "type": "string",
+ "location": "query"
+ },
+ "key": {
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "type": "string",
+ "location": "query"
+ },
+ "quotaUser": {
+ "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": "v1",
+ "baseUrl": "https://cloudfunctions.googleapis.com/",
+ "kind": "discovery#restDescription",
+ "description": "API for managing lightweight user-provided functions executed in response to events.",
+ "servicePath": "",
+ "basePath": "",
+ "id": "cloudfunctions:v1",
+ "documentationLink": "https://cloud.google.com/functions",
+ "revision": "20171215",
+ "discoveryVersion": "v1"
}
diff --git a/cloudfunctions/v1beta2/cloudfunctions-api.json b/cloudfunctions/v1beta2/cloudfunctions-api.json
index 5efd661..adae64d 100644
--- a/cloudfunctions/v1beta2/cloudfunctions-api.json
+++ b/cloudfunctions/v1beta2/cloudfunctions-api.json
@@ -1,456 +1,39 @@
{
- "fullyEncodeReservedExpansion": true,
- "title": "Google Cloud Functions 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": {
- "name": {
- "pattern": "^projects/[^/]+$",
- "location": "path",
- "description": "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"
- },
- "filter": {
- "location": "query",
- "description": "The standard list filter.",
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta2/projects/{projectsId}/locations",
- "path": "v1beta2/{+name}/locations",
- "id": "cloudfunctions.projects.locations.list"
- }
- },
- "resources": {
- "functions": {
- "methods": {
- "call": {
- "response": {
- "$ref": "CallFunctionResponse"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/locations/[^/]+/functions/[^/]+$",
- "location": "path",
- "description": "The name of the function to be called.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "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"
- }
- },
- "create": {
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "location"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "location": {
- "description": "The project and location in which the function should be created, specified\nin the format `projects/*/locations/*`",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/functions",
- "path": "v1beta2/{+location}/functions",
- "id": "cloudfunctions.projects.locations.functions.create",
- "description": "Creates a new function. If a function with the given name already exists in\nthe specified project, the long running operation will return\n`ALREADY_EXISTS` error.",
- "request": {
- "$ref": "CloudFunction"
- }
- },
- "generateUploadUrl": {
- "path": "v1beta2/{+parent}/functions:generateUploadUrl",
- "id": "cloudfunctions.projects.locations.functions.generateUploadUrl",
- "request": {
- "$ref": "GenerateUploadUrlRequest"
- },
- "description": "Returns a signed URL for uploading a function source code.\nFor more information about the signed URL usage see:\nhttps://cloud.google.com/storage/docs/access-control/signed-urls\nOnce the function source code upload is complete, the used signed\nURL should be provided in CreateFunction or UpdateFunction request\nas a reference to the function source code.\n\nWhen uploading source code to the generated signed URL, please follow\nthese restrictions:\n\n* Source file type should be a zip file.\n* Source file size should not exceed 100MB limit.\n\nWhen making a HTTP PUT request, these two headers need to be specified:\n\n* `content-type: application/zip`\n* `x-google-content-length-range: 0,104857600`",
- "response": {
- "$ref": "GenerateUploadUrlResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "POST",
- "parameters": {
- "parent": {
- "description": "The project and location in which the Google Cloud Storage signed URL\nshould be generated, specified in the format `projects/*/locations/*`.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/functions:generateUploadUrl"
- },
- "generateDownloadUrl": {
- "response": {
- "$ref": "GenerateDownloadUrlResponse"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "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"
- }
- },
- "flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}:generateDownloadUrl",
- "path": "v1beta2/{+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"
- }
- },
- "get": {
- "parameters": {
- "name": {
- "description": "The name of the function which details should be obtained.",
- "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}",
- "id": "cloudfunctions.projects.locations.functions.get",
- "path": "v1beta2/{+name}",
- "description": "Returns a function with the given name from the requested project.",
- "httpMethod": "GET",
- "response": {
- "$ref": "CloudFunction"
- },
- "parameterOrder": [
- "name"
- ]
- },
- "update": {
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "description": "The name of the function to be updated.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+/functions/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}",
- "path": "v1beta2/{+name}",
- "id": "cloudfunctions.projects.locations.functions.update",
- "description": "Updates existing function.",
- "request": {
- "$ref": "CloudFunction"
- },
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "PUT"
- },
- "delete": {
- "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.",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "DELETE",
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/locations/[^/]+/functions/[^/]+$",
- "location": "path",
- "description": "The name of the function which should be deleted.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}"
- },
- "list": {
- "parameters": {
- "pageToken": {
- "location": "query",
- "description": "The value returned by the last\n`ListFunctionsResponse`; indicates that\nthis is a continuation of a prior `ListFunctions` call, and that the\nsystem should return the next page of data.",
- "type": "string"
- },
- "pageSize": {
- "description": "Maximum number of functions to return per call.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- },
- "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"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/functions",
- "id": "cloudfunctions.projects.locations.functions.list",
- "path": "v1beta2/{+location}/functions",
- "description": "Returns a list of functions that belong to the requested project.",
- "httpMethod": "GET",
- "response": {
- "$ref": "ListFunctionsResponse"
- },
- "parameterOrder": [
- "location"
- ]
- }
- }
- }
- }
- }
- }
- },
- "operations": {
- "methods": {
- "list": {
- "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",
- "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."
- },
- "get": {
- "parameters": {
- "name": {
- "description": "The name of the operation resource.",
- "required": true,
- "type": "string",
- "pattern": "^operations/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta2/operations/{operationsId}",
- "id": "cloudfunctions.operations.get",
- "path": "v1beta2/{+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": {
- "upload_protocol": {
- "location": "query",
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string"
- },
- "prettyPrint": {
- "location": "query",
- "description": "Returns response with indentations and line breaks.",
- "type": "boolean",
- "default": "true"
- },
- "uploadType": {
- "location": "query",
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string"
- },
- "fields": {
- "location": "query",
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string"
- },
- "callback": {
- "location": "query",
- "description": "JSONP",
- "type": "string"
- },
- "$.xgafv": {
- "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": {
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string",
- "location": "query"
- },
- "access_token": {
- "location": "query",
- "description": "OAuth access token.",
- "type": "string"
- },
- "quotaUser": {
- "location": "query",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string"
- },
- "pp": {
- "description": "Pretty-print response.",
- "type": "boolean",
- "default": "true",
- "location": "query"
- },
- "bearer_token": {
- "location": "query",
- "description": "OAuth bearer token.",
- "type": "string"
- },
- "oauth_token": {
- "location": "query",
- "description": "OAuth 2.0 token for the current user.",
- "type": "string"
- }
- },
- "version": "v1beta2",
- "baseUrl": "https://cloudfunctions.googleapis.com/",
- "kind": "discovery#restDescription",
- "description": "API for managing lightweight user-provided functions executed in response to events.",
- "servicePath": "",
- "basePath": "",
- "id": "cloudfunctions:v1beta2",
- "documentationLink": "https://cloud.google.com/functions",
"revision": "20171215",
+ "documentationLink": "https://cloud.google.com/functions",
+ "id": "cloudfunctions:v1beta2",
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
+ "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"
+ }
+ }
+ },
+ "GenerateUploadUrlResponse": {
+ "id": "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"
+ }
+ }
+ },
"ListFunctionsResponse": {
"description": "Response for the `ListFunctions` method.",
"type": "object",
@@ -488,6 +71,7 @@
}
},
"CallFunctionResponse": {
+ "id": "CallFunctionResponse",
"description": "Response of `CallFunction` method.",
"type": "object",
"properties": {
@@ -503,13 +87,16 @@
"description": "Execution id of function invocation.",
"type": "string"
}
- },
- "id": "CallFunctionResponse"
+ }
},
"EventTrigger": {
"description": "Describes EventTrigger, used to request events be sent from another\nservice.",
"type": "object",
"properties": {
+ "failurePolicy": {
+ "$ref": "FailurePolicy",
+ "description": "Specifies policy for failed executions."
+ },
"eventType": {
"description": "`event_type` names contain the service that is sending an event and the\nkind of event that was fired. Must be of the form\n`providers/*/eventTypes/*` e.g. Directly handle a Message published to\nGoogle Cloud Pub/Sub `providers/cloud.pubsub/eventTypes/topic.publish`.\n\nHandle an object changing in Google Cloud Storage:\n`providers/cloud.storage/eventTypes/object.change`\n\nHandle a write to the Firebase Realtime Database:\n`providers/google.firebase.database/eventTypes/ref.write`",
"type": "string"
@@ -521,10 +108,6 @@
"service": {
"description": "The hostname of the service that should be observed.\n\nIf no string is provided, the default service implementing the API will\nbe used. For example, `storage.googleapis.com` is the default for all\nevent types in the `google.storage` namespace.",
"type": "string"
- },
- "failurePolicy": {
- "$ref": "FailurePolicy",
- "description": "Specifies policy for failed executions."
}
},
"id": "EventTrigger"
@@ -540,15 +123,33 @@
}
}
},
+ "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"
+ }
+ }
+ },
+ "GenerateDownloadUrlRequest": {
+ "description": "Request of `GenerateDownloadUrl` method.",
+ "type": "object",
+ "properties": {
+ "versionId": {
+ "description": "The optional version of function.",
+ "format": "uint64",
+ "type": "string"
+ }
+ },
+ "id": "GenerateDownloadUrlRequest"
+ },
"OperationMetadataV1": {
"description": "Metadata describing an Operation",
"type": "object",
"properties": {
- "updateTime": {
- "description": "The last update timestamp of the operation.",
- "format": "google-datetime",
- "type": "string"
- },
"target": {
"description": "Target of the operation - for example\nprojects/project-1/locations/region-1/functions/function-1",
"type": "string"
@@ -581,32 +182,14 @@
"UPDATE_FUNCTION",
"DELETE_FUNCTION"
]
- }
- },
- "id": "OperationMetadataV1"
- },
- "GenerateDownloadUrlRequest": {
- "description": "Request of `GenerateDownloadUrl` method.",
- "type": "object",
- "properties": {
- "versionId": {
- "description": "The optional version of function.",
- "format": "uint64",
+ },
+ "updateTime": {
+ "description": "The last update timestamp of the operation.",
+ "format": "google-datetime",
"type": "string"
}
},
- "id": "GenerateDownloadUrlRequest"
- },
- "FailurePolicy": {
- "description": "Describes the policy in case of function's execution failure.\nIf empty, then defaults to ignoring failures (i.e. not retrying them).",
- "type": "object",
- "properties": {
- "retry": {
- "$ref": "Retry",
- "description": "If specified, then the function will be retried in case of a failure."
- }
- },
- "id": "FailurePolicy"
+ "id": "OperationMetadataV1"
},
"Operation": {
"description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
@@ -633,12 +216,12 @@
"type": "boolean"
},
"response": {
+ "description": "The normal response of the operation in case of success. If the original\nmethod returns no data on success, such as `Delete`, the response is\n`google.protobuf.Empty`. If the original method is standard\n`Get`/`Create`/`Update`, the response should be the resource. For other\nmethods, the response should have the type `XxxResponse`, where `Xxx`\nis the original method name. For example, if the original method name\nis `TakeSnapshot()`, the inferred response type is\n`TakeSnapshotResponse`.",
+ "type": "object",
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
- },
- "description": "The normal response of the operation in case of success. If the original\nmethod returns no data on success, such as `Delete`, the response is\n`google.protobuf.Empty`. If the original method is standard\n`Get`/`Create`/`Update`, the response should be the resource. For other\nmethods, the response should have the type `XxxResponse`, where `Xxx`\nis the original method name. For example, if the original method name\nis `TakeSnapshot()`, the inferred response type is\n`TakeSnapshotResponse`.",
- "type": "object"
+ }
}
},
"id": "Operation"
@@ -647,11 +230,6 @@
"description": "Metadata describing an Operation",
"type": "object",
"properties": {
- "updateTime": {
- "description": "The last update timestamp of the operation.",
- "format": "google-datetime",
- "type": "string"
- },
"target": {
"description": "Target of the operation - for example\nprojects/project-1/locations/region-1/functions/function-1",
"type": "string"
@@ -670,6 +248,8 @@
"type": "string"
},
"type": {
+ "description": "Type of operation.",
+ "type": "string",
"enumDescriptions": [
"Unknown operation type.",
"Triggered by CreateFunction call",
@@ -681,14 +261,18 @@
"CREATE_FUNCTION",
"UPDATE_FUNCTION",
"DELETE_FUNCTION"
- ],
- "description": "Type of operation.",
+ ]
+ },
+ "updateTime": {
+ "description": "The last update timestamp of the operation.",
+ "format": "google-datetime",
"type": "string"
}
},
"id": "OperationMetadataV1Beta2"
},
"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": {
@@ -705,17 +289,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"
+ }
}
}
- },
- "id": "Status"
+ }
},
"CallFunctionRequest": {
+ "id": "CallFunctionRequest",
"description": "Request for the `CallFunction` method.",
"type": "object",
"properties": {
@@ -723,25 +307,12 @@
"description": "Input to be passed to the function.",
"type": "string"
}
- },
- "id": "CallFunctionRequest"
+ }
},
"SourceRepository": {
"description": "Describes the location of the function source in a remote repository.",
"type": "object",
"properties": {
- "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"
@@ -753,12 +324,23 @@
"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"
},
"CloudFunction": {
- "id": "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": {
@@ -773,27 +355,22 @@
"type": "string"
}
},
+ "sourceRepositoryUrl": {
+ "description": "The URL pointing to the hosted repository where the function is defined.\nThere are supported Cloud Source Repository URLs in the following\nformats:\n\nTo refer to a specific commit:\n`https://source.developers.google.com/projects/*/repos/*/revisions/*/paths/*`\nTo refer to a moveable alias (branch):\n`https://source.developers.google.com/projects/*/repos/*/moveable-aliases/*/paths/*`\nIn particular, to refer to HEAD use `master` moveable alias.\nTo refer to a specific fixed alias (tag):\n`https://source.developers.google.com/projects/*/repos/*/fixed-aliases/*/paths/*`\n\nYou may omit `paths/*` if you want to use the main directory.",
+ "type": "string"
+ },
"updateTime": {
"description": "Output only. The last update timestamp of a Cloud Function.",
"format": "google-datetime",
"type": "string"
},
- "sourceRepositoryUrl": {
- "description": "The URL pointing to the hosted repository where the function is defined.\nThere are supported Cloud Source Repository URLs in the following\nformats:\n\nTo refer to a specific commit:\n`https://source.developers.google.com/projects/*/repos/*/revisions/*/paths/*`\nTo refer to a moveable alias (branch):\n`https://source.developers.google.com/projects/*/repos/*/moveable-aliases/*/paths/*`\nIn particular, to refer to HEAD use `master` moveable alias.\nTo refer to a specific fixed alias (tag):\n`https://source.developers.google.com/projects/*/repos/*/fixed-aliases/*/paths/*`\n\nYou may omit `paths/*` if you want to use the main directory.",
- "type": "string"
- },
"latestOperation": {
"description": "Output only. Name of the most recent operation modifying the function. If\nthe function status is `DEPLOYING` or `DELETING`, then it points to the\nactive operation.",
"type": "string"
},
"httpsTrigger": {
- "$ref": "HTTPSTrigger",
- "description": "An HTTPS endpoint type of source that can be triggered via URL."
- },
- "timeout": {
- "description": "The function execution timeout. Execution is considered failed and\ncan be terminated if the function is not completed at the end of the\ntimeout period. Defaults to 60 seconds.",
- "format": "google-duration",
- "type": "string"
+ "description": "An HTTPS endpoint type of source that can be triggered via URL.",
+ "$ref": "HTTPSTrigger"
},
"status": {
"enumDescriptions": [
@@ -813,13 +390,18 @@
"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.",
+ "$ref": "EventTrigger"
+ },
"sourceUploadUrl": {
"description": "The Google Cloud Storage signed URL used for source uploading, generated\nby google.cloud.functions.v1beta2.GenerateUploadUrl",
"type": "string"
},
- "eventTrigger": {
- "description": "A source that fires events in response to a condition in another service.",
- "$ref": "EventTrigger"
+ "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": {
"description": "The amount of memory in MB available for a function.\nDefaults to 256MB.",
@@ -844,15 +426,23 @@
"type": "string"
},
"sourceRepository": {
- "$ref": "SourceRepository",
- "description": "The hosted repository where the function is defined."
+ "description": "The hosted repository where the function is defined.",
+ "$ref": "SourceRepository"
}
- }
+ },
+ "id": "CloudFunction"
},
"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"
@@ -868,13 +458,6 @@
},
"description": "Service-specific metadata. For example the available capacity at the given\nlocation.",
"type": "object"
- },
- "labels": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "Cross-service attributes for the location. For example\n\n {\"cloud.googleapis.com/region\": \"us-east1\"}",
- "type": "object"
}
},
"id": "Location"
@@ -897,46 +480,17 @@
"id": "Retry"
},
"GenerateUploadUrlRequest": {
- "id": "GenerateUploadUrlRequest",
"description": "Request of `GenerateUploadUrl` method.",
"type": "object",
- "properties": {}
- },
- "ListOperationsResponse": {
- "description": "The response message for Operations.ListOperations.",
- "type": "object",
- "properties": {
- "nextPageToken": {
- "description": "The standard List next-page token.",
- "type": "string"
- },
- "operations": {
- "description": "A list of operations that matches the specified filter in the request.",
- "type": "array",
- "items": {
- "$ref": "Operation"
- }
- }
- },
- "id": "ListOperationsResponse"
- },
- "GenerateUploadUrlResponse": {
- "description": "Response of `GenerateUploadUrl` method.",
- "type": "object",
- "properties": {
- "uploadUrl": {
- "description": "The generated Google Cloud Storage signed URL that should be used for a\nfunction source code upload. The uploaded file should be a zip archive\nwhich contains a function.",
- "type": "string"
- }
- },
- "id": "GenerateUploadUrlResponse"
+ "properties": {},
+ "id": "GenerateUploadUrlRequest"
}
},
- "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 Functions",
"auth": {
"oauth2": {
@@ -950,5 +504,451 @@
"rootUrl": "https://cloudfunctions.googleapis.com/",
"ownerDomain": "google.com",
"name": "cloudfunctions",
- "batchPath": "batch"
+ "batchPath": "batch",
+ "fullyEncodeReservedExpansion": true,
+ "title": "Google Cloud Functions API",
+ "ownerName": "Google",
+ "resources": {
+ "operations": {
+ "methods": {
+ "list": {
+ "response": {
+ "$ref": "ListOperationsResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "GET",
+ "parameters": {
+ "filter": {
+ "location": "query",
+ "description": "The standard list filter.",
+ "type": "string"
+ },
+ "name": {
+ "description": "The name of the operation's parent resource.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageToken": {
+ "description": "The standard list page token.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageSize": {
+ "location": "query",
+ "description": "The standard list page size.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta2/operations",
+ "path": "v1beta2/operations",
+ "id": "cloudfunctions.operations.list",
+ "description": "Lists operations that match the specified filter in the request. If the\nserver doesn't support this method, it returns `UNIMPLEMENTED`.\n\nNOTE: the `name` binding allows API services to override the binding\nto use different resource name schemes, such as `users/*/operations`. To\noverride the binding, API services can add a binding such as\n`\"/v1/{name=users/*}/operations\"` to their service configuration.\nFor backwards compatibility, the default name includes the operations\ncollection id, however overriding users must ensure the name binding\nis the parent resource, without the operations collection id."
+ },
+ "get": {
+ "id": "cloudfunctions.operations.get",
+ "path": "v1beta2/{+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": {
+ "pattern": "^operations/[^/]+$",
+ "location": "path",
+ "description": "The name of the operation resource.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta2/operations/{operationsId}"
+ }
+ }
+ },
+ "projects": {
+ "resources": {
+ "locations": {
+ "methods": {
+ "list": {
+ "description": "Lists information about the supported locations for this service.",
+ "response": {
+ "$ref": "ListLocationsResponse"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The resource that owns the locations collection, if applicable.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+$",
+ "location": "path"
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "The standard list page token.",
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "The standard list page size.",
+ "format": "int32",
+ "type": "integer",
+ "location": "query"
+ },
+ "filter": {
+ "location": "query",
+ "description": "The standard list filter.",
+ "type": "string"
+ }
+ },
+ "flatPath": "v1beta2/projects/{projectsId}/locations",
+ "path": "v1beta2/{+name}/locations",
+ "id": "cloudfunctions.projects.locations.list"
+ }
+ },
+ "resources": {
+ "functions": {
+ "methods": {
+ "delete": {
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+/locations/[^/]+/functions/[^/]+$",
+ "location": "path",
+ "description": "The name of the function which should be deleted.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "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.",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "DELETE"
+ },
+ "list": {
+ "parameters": {
+ "pageToken": {
+ "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",
+ "location": "query"
+ },
+ "pageSize": {
+ "location": "query",
+ "description": "Maximum number of functions to return per call.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "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"
+ }
+ },
+ "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.",
+ "response": {
+ "$ref": "ListFunctionsResponse"
+ },
+ "parameterOrder": [
+ "location"
+ ],
+ "httpMethod": "GET"
+ },
+ "create": {
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "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"
+ }
+ },
+ "flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/functions",
+ "id": "cloudfunctions.projects.locations.functions.create",
+ "path": "v1beta2/{+location}/functions",
+ "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"
+ },
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "location"
+ ],
+ "response": {
+ "$ref": "Operation"
+ }
+ },
+ "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": {
+ "pattern": "^projects/[^/]+/locations/[^/]+/functions/[^/]+$",
+ "location": "path",
+ "description": "The name of the function to be called.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "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": {
+ "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.\n\nWhen uploading source code to the generated signed URL, please follow\nthese restrictions:\n\n* Source file type should be a zip file.\n* Source file size should not exceed 100MB limit.\n\nWhen making a HTTP PUT request, these two headers need to be specified:\n\n* `content-type: application/zip`\n* `x-google-content-length-range: 0,104857600`",
+ "request": {
+ "$ref": "GenerateUploadUrlRequest"
+ }
+ },
+ "generateDownloadUrl": {
+ "path": "v1beta2/{+name}:generateDownloadUrl",
+ "id": "cloudfunctions.projects.locations.functions.generateDownloadUrl",
+ "description": "Returns a signed URL for downloading deployed function source code.\nThe URL is only valid for a limited period and should be used within\nminutes after generation.\nFor more information about the signed URL usage see:\nhttps://cloud.google.com/storage/docs/access-control/signed-urls",
+ "request": {
+ "$ref": "GenerateDownloadUrlRequest"
+ },
+ "response": {
+ "$ref": "GenerateDownloadUrlResponse"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The name of function for which source code Google Cloud Storage signed\nURL should be generated.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+/functions/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}:generateDownloadUrl"
+ },
+ "get": {
+ "description": "Returns a function with the given name from the requested project.",
+ "response": {
+ "$ref": "CloudFunction"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "name": {
+ "description": "The name of the function which details should be obtained.",
+ "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}",
+ "path": "v1beta2/{+name}",
+ "id": "cloudfunctions.projects.locations.functions.get"
+ },
+ "update": {
+ "id": "cloudfunctions.projects.locations.functions.update",
+ "path": "v1beta2/{+name}",
+ "request": {
+ "$ref": "CloudFunction"
+ },
+ "description": "Updates existing function.",
+ "httpMethod": "PUT",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameters": {
+ "name": {
+ "description": "The name of the function to be updated.",
+ "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}"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": {
+ "$.xgafv": {
+ "description": "V1 error format.",
+ "type": "string",
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query",
+ "enum": [
+ "1",
+ "2"
+ ]
+ },
+ "callback": {
+ "location": "query",
+ "description": "JSONP",
+ "type": "string"
+ },
+ "alt": {
+ "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": {
+ "description": "Pretty-print response.",
+ "type": "boolean",
+ "default": "true",
+ "location": "query"
+ },
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string",
+ "location": "query"
+ },
+ "bearer_token": {
+ "location": "query",
+ "description": "OAuth bearer token.",
+ "type": "string"
+ },
+ "upload_protocol": {
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "type": "string",
+ "location": "query"
+ },
+ "prettyPrint": {
+ "location": "query",
+ "description": "Returns response with indentations and line breaks.",
+ "type": "boolean",
+ "default": "true"
+ },
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
+ "type": "string",
+ "location": "query"
+ },
+ "uploadType": {
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "version": "v1beta2",
+ "baseUrl": "https://cloudfunctions.googleapis.com/",
+ "kind": "discovery#restDescription",
+ "description": "API for managing lightweight user-provided functions executed in response to events.",
+ "servicePath": "",
+ "basePath": ""
}
diff --git a/cloudiot/v1/cloudiot-api.json b/cloudiot/v1/cloudiot-api.json
index 2adbe32..373ed7c 100644
--- a/cloudiot/v1/cloudiot-api.json
+++ b/cloudiot/v1/cloudiot-api.json
@@ -1,4 +1,11 @@
{
+ "rootUrl": "https://cloudiot.googleapis.com/",
+ "ownerDomain": "google.com",
+ "name": "cloudiot",
+ "batchPath": "batch",
+ "fullyEncodeReservedExpansion": true,
+ "title": "Google Cloud IoT API",
+ "ownerName": "Google",
"resources": {
"projects": {
"resources": {
@@ -6,7 +13,39 @@
"resources": {
"registries": {
"methods": {
+ "testIamPermissions": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "resource"
+ ],
+ "response": {
+ "$ref": "TestIamPermissionsResponse"
+ },
+ "parameters": {
+ "resource": {
+ "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+$",
+ "location": "path",
+ "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudiot"
+ ],
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}:testIamPermissions",
+ "id": "cloudiot.projects.locations.registries.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."
+ },
"delete": {
+ "path": "v1/{+name}",
+ "id": "cloudiot.projects.locations.registries.delete",
+ "description": "Deletes a device registry configuration.",
"response": {
"$ref": "Empty"
},
@@ -20,22 +59,16 @@
],
"parameters": {
"name": {
+ "location": "path",
"description": "The name of the device registry. For example,\n`projects/example-project/locations/us-central1/registries/my-registry`.",
"required": true,
"type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+$",
- "location": "path"
+ "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+$"
}
},
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}",
- "path": "v1/{+name}",
- "id": "cloudiot.projects.locations.registries.delete",
- "description": "Deletes a device registry configuration."
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}"
},
"list": {
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries",
- "path": "v1/{+parent}/registries",
- "id": "cloudiot.projects.locations.registries.list",
"description": "Lists device registries.",
"response": {
"$ref": "ListDeviceRegistriesResponse"
@@ -50,16 +83,16 @@
],
"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",
- "description": "The project and cloud region path. For example,\n`projects/example-project/locations/us-central1`."
+ "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",
- "location": "query"
+ "type": "string"
},
"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.",
@@ -67,24 +100,23 @@
"type": "integer",
"location": "query"
}
- }
+ },
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries",
+ "path": "v1/{+parent}/registries",
+ "id": "cloudiot.projects.locations.registries.list"
},
"create": {
- "description": "Creates a device registry that contains devices.",
"request": {
"$ref": "DeviceRegistry"
},
- "response": {
- "$ref": "DeviceRegistry"
- },
+ "description": "Creates a device registry that contains devices.",
+ "httpMethod": "POST",
"parameterOrder": [
"parent"
],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudiot"
- ],
+ "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`.",
@@ -94,11 +126,51 @@
"location": "path"
}
},
+ "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.create"
+ "id": "cloudiot.projects.locations.registries.create",
+ "path": "v1/{+parent}/registries"
},
"setIamPolicy": {
+ "response": {
+ "$ref": "Policy"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudiot"
+ ],
+ "parameters": {
+ "resource": {
+ "location": "path",
+ "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+$"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}: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": "SetIamPolicyRequest"
+ }
+ },
+ "getIamPolicy": {
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}:getIamPolicy",
+ "id": "cloudiot.projects.locations.registries.getIamPolicy",
+ "path": "v1/{+resource}:getIamPolicy",
+ "request": {
+ "$ref": "GetIamPolicyRequest"
+ },
+ "description": "Gets the access control policy for a resource.\nReturns an empty policy if the resource exists and does not have a policy\nset.",
"httpMethod": "POST",
"parameterOrder": [
"resource"
@@ -109,7 +181,7 @@
"parameters": {
"resource": {
"location": "path",
- "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.",
+ "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",
"required": true,
"type": "string",
"pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+$"
@@ -118,43 +190,7 @@
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloudiot"
- ],
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}:setIamPolicy",
- "id": "cloudiot.projects.locations.registries.setIamPolicy",
- "path": "v1/{+resource}:setIamPolicy",
- "request": {
- "$ref": "SetIamPolicyRequest"
- },
- "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy."
- },
- "getIamPolicy": {
- "response": {
- "$ref": "Policy"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudiot"
- ],
- "parameters": {
- "resource": {
- "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}:getIamPolicy",
- "path": "v1/{+resource}:getIamPolicy",
- "id": "cloudiot.projects.locations.registries.getIamPolicy",
- "description": "Gets the access control policy for a resource.\nReturns an empty policy if the resource exists and does not have a policy\nset.",
- "request": {
- "$ref": "GetIamPolicyRequest"
- }
+ ]
},
"get": {
"description": "Gets a device registry configuration.",
@@ -165,125 +201,69 @@
"name"
],
"httpMethod": "GET",
+ "parameters": {
+ "name": {
+ "location": "path",
+ "description": "The name of the device registry. For example,\n`projects/example-project/locations/us-central1/registries/my-registry`.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+$"
+ }
+ },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloudiot"
],
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+$",
- "location": "path",
- "description": "The name of the device registry. For example,\n`projects/example-project/locations/us-central1/registries/my-registry`.",
- "required": true,
- "type": "string"
- }
- },
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}",
"path": "v1/{+name}",
"id": "cloudiot.projects.locations.registries.get"
},
"patch": {
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}",
+ "id": "cloudiot.projects.locations.registries.patch",
+ "path": "v1/{+name}",
"request": {
"$ref": "DeviceRegistry"
},
"description": "Updates a device registry configuration.",
- "response": {
- "$ref": "DeviceRegistry"
- },
+ "httpMethod": "PATCH",
"parameterOrder": [
"name"
],
- "httpMethod": "PATCH",
+ "response": {
+ "$ref": "DeviceRegistry"
+ },
"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": {
+ "location": "path",
"description": "The resource path name. For example,\n`projects/example-project/locations/us-central1/registries/my-registry`.",
"required": true,
"type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+$",
- "location": "path"
+ "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+$"
+ },
+ "updateMask": {
+ "description": "Only updates the `device_registry` fields indicated by this mask.\nThe field mask must not be empty, and it must not contain fields that\nare immutable or only set by the server.\nMutable top-level fields: `event_notification_config`, `http_config`,\n`mqtt_config`, and `state_notification_config`.",
+ "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}",
- "path": "v1/{+name}",
- "id": "cloudiot.projects.locations.registries.patch"
- },
- "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.",
- "request": {
- "$ref": "TestIamPermissionsRequest"
- },
- "response": {
- "$ref": "TestIamPermissionsResponse"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudiot"
- ],
- "parameters": {
- "resource": {
- "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+$",
- "location": "path",
- "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}:testIamPermissions"
+ ]
}
},
"resources": {
"devices": {
"methods": {
- "create": {
- "request": {
- "$ref": "Device"
- },
- "description": "Creates a device in a device registry.",
- "response": {
- "$ref": "Device"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "POST",
- "parameters": {
- "parent": {
- "location": "path",
- "description": "The name of the device registry where this device should be created.\nFor example,\n`projects/example-project/locations/us-central1/registries/my-registry`.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudiot"
- ],
- "flatPath": "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.",
+ "path": "v1/{+name}:modifyCloudToDeviceConfig",
+ "id": "cloudiot.projects.locations.registries.devices.modifyCloudToDeviceConfig",
"request": {
"$ref": "ModifyCloudToDeviceConfigRequest"
},
+ "description": "Modifies the configuration for the device, which is eventually sent from\nthe Cloud IoT Core servers. Returns the modified configuration version and\nits metadata.",
"response": {
"$ref": "DeviceConfig"
},
@@ -291,31 +271,26 @@
"name"
],
"httpMethod": "POST",
+ "parameters": {
+ "name": {
+ "description": "The name of the device. For example,\n`projects/p0/locations/us-central1/registries/registry0/devices/device0` or\n`projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+/devices/[^/]+$",
+ "location": "path"
+ }
+ },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloudiot"
],
- "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"
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/devices/{devicesId}: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"
},
- "description": "Updates a device.",
"response": {
"$ref": "Device"
},
@@ -323,25 +298,28 @@
"name"
],
"httpMethod": "PATCH",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudiot"
+ ],
"parameters": {
+ "updateMask": {
+ "description": "Only updates the `device` fields indicated by this mask.\nThe field mask must not be empty, and it must not contain fields that\nare immutable or only set by the server.\nMutable top-level fields: `credentials`, `enabled_state`, and `metadata`",
+ "format": "google-fieldmask",
+ "type": "string",
+ "location": "query"
+ },
"name": {
"description": "The resource path name. For example,\n`projects/p1/locations/us-central1/registries/registry0/devices/dev0` or\n`projects/p1/locations/us-central1/registries/registry0/devices/{num_id}`.\nWhen `name` is populated as a response from the service, it always ends\nin the device numeric ID.",
"required": true,
"type": "string",
"pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+/devices/[^/]+$",
"location": "path"
- },
- "updateMask": {
- "description": "Only updates the `device` fields indicated by this mask.\nThe field mask must not be empty, and it must not contain fields that\nare immutable or only set by the server.\nMutable top-level fields: `credentials`, `enabled_state`, and `metadata`",
- "format": "google-fieldmask",
- "type": "string",
- "location": "query"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudiot"
- ]
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/devices/{devicesId}",
+ "path": "v1/{+name}",
+ "id": "cloudiot.projects.locations.registries.devices.patch"
},
"get": {
"description": "Gets details about a device.",
@@ -352,56 +330,57 @@
"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"
],
- "parameters": {
- "name": {
- "description": "The name of the device. For example,\n`projects/p0/locations/us-central1/registries/registry0/devices/device0` or\n`projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+/devices/[^/]+$",
- "location": "path"
- },
- "fieldMask": {
- "description": "The fields of the `Device` resource to be returned in the response. If the\nfield mask is unset or empty, all fields are returned.",
- "format": "google-fieldmask",
- "type": "string",
- "location": "query"
- }
- },
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/devices/{devicesId}",
"path": "v1/{+name}",
"id": "cloudiot.projects.locations.registries.devices.get"
},
"delete": {
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/devices/{devicesId}",
- "id": "cloudiot.projects.locations.registries.devices.delete",
- "path": "v1/{+name}",
"description": "Deletes a device.",
"httpMethod": "DELETE",
- "response": {
- "$ref": "Empty"
- },
"parameterOrder": [
"name"
],
+ "response": {
+ "$ref": "Empty"
+ },
"parameters": {
"name": {
+ "location": "path",
"description": "The name of the device. For example,\n`projects/p0/locations/us-central1/registries/registry0/devices/device0` or\n`projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`.",
"required": true,
"type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+/devices/[^/]+$",
- "location": "path"
+ "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+/devices/[^/]+$"
}
},
"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.delete",
+ "path": "v1/{+name}"
},
"list": {
+ "description": "List devices in a device registry.",
"response": {
"$ref": "ListDevicesResponse"
},
@@ -410,32 +389,6 @@
],
"httpMethod": "GET",
"parameters": {
- "pageSize": {
- "type": "integer",
- "location": "query",
- "description": "The maximum number of devices to return in the response. If this value\nis zero, the service will select a default size. A call may return fewer\nobjects than requested, but if there is a non-empty `page_token`, it\nindicates that more entries are available.",
- "format": "int32"
- },
- "parent": {
- "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"
- },
"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",
@@ -446,6 +399,32 @@
"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": {
+ "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"
+ },
+ "deviceNumIds": {
+ "description": "A list of device numerical ids. If empty, it will ignore this field. This\nfield cannot hold more than 10,000 entries.",
+ "format": "uint64",
+ "type": "string",
+ "repeated": true,
+ "location": "query"
}
},
"scopes": [
@@ -454,8 +433,36 @@
],
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/devices",
"path": "v1/{+parent}/devices",
- "id": "cloudiot.projects.locations.registries.devices.list",
- "description": "List devices in a device registry."
+ "id": "cloudiot.projects.locations.registries.devices.list"
+ },
+ "create": {
+ "response": {
+ "$ref": "Device"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "POST",
+ "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": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/devices",
+ "path": "v1/{+parent}/devices",
+ "id": "cloudiot.projects.locations.registries.devices.create",
+ "description": "Creates a device in a device registry.",
+ "request": {
+ "$ref": "Device"
+ }
}
},
"resources": {
@@ -475,18 +482,18 @@
"https://www.googleapis.com/auth/cloudiot"
],
"parameters": {
- "numVersions": {
- "location": "query",
- "description": "The number of versions to list. Versions are listed in decreasing order of\nthe version number. The maximum number of versions retained is 10. If this\nvalue is zero, it will return all the versions available.",
- "format": "int32",
- "type": "integer"
- },
"name": {
"description": "The name of the device. For example,\n`projects/p0/locations/us-central1/registries/registry0/devices/device0` or\n`projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`.",
"required": true,
"type": "string",
"pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+/devices/[^/]+$",
"location": "path"
+ },
+ "numVersions": {
+ "description": "The number of versions to list. Versions are listed in decreasing order of\nthe version number. The maximum number of versions retained is 10. If this\nvalue is zero, it will return all the versions available.",
+ "format": "int32",
+ "type": "integer",
+ "location": "query"
}
},
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/devices/{devicesId}/configVersions",
@@ -498,6 +505,10 @@
"states": {
"methods": {
"list": {
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/devices/{devicesId}/states",
+ "path": "v1/{+name}/states",
+ "id": "cloudiot.projects.locations.registries.devices.states.list",
+ "description": "Lists the last few versions of the device state in descending order (i.e.:\nnewest first).",
"response": {
"$ref": "ListDeviceStatesResponse"
},
@@ -510,24 +521,20 @@
"https://www.googleapis.com/auth/cloudiot"
],
"parameters": {
+ "numStates": {
+ "location": "query",
+ "description": "The number of states to list. States are listed in descending order of\nupdate time. The maximum number of states retained is 10. If this\nvalue is zero, it will return all the states available.",
+ "format": "int32",
+ "type": "integer"
+ },
"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/[^/]+$"
- },
- "numStates": {
- "type": "integer",
- "location": "query",
- "description": "The number of states to list. States are listed in descending order of\nupdate time. The maximum number of states retained is 10. If this\nvalue is zero, it will return all the states available.",
- "format": "int32"
}
- },
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/devices/{devicesId}/states",
- "path": "v1/{+name}/states",
- "id": "cloudiot.projects.locations.registries.devices.states.list",
- "description": "Lists the last few versions of the device state in descending order (i.e.:\nnewest first)."
+ }
}
}
}
@@ -552,19 +559,17 @@
"type": "boolean",
"default": "true"
},
- "fields": {
- "location": "query",
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string"
- },
"uploadType": {
"location": "query",
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"type": "string"
},
- "$.xgafv": {
- "description": "V1 error format.",
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
"type": "string",
+ "location": "query"
+ },
+ "$.xgafv": {
"enumDescriptions": [
"v1 error format",
"v2 error format"
@@ -573,14 +578,21 @@
"enum": [
"1",
"2"
- ]
- },
- "callback": {
- "location": "query",
- "description": "JSONP",
+ ],
+ "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",
@@ -589,23 +601,18 @@
],
"location": "query",
"description": "Data format for response.",
- "default": "json",
- "enum": [
- "json",
- "media",
- "proto"
- ]
+ "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"
},
- "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.",
@@ -634,449 +641,14 @@
"description": "Registers and manages IoT (Internet of Things) devices that connect to the Google Cloud Platform.\n",
"kind": "discovery#restDescription",
"basePath": "",
+ "revision": "20171215",
"documentationLink": "https://cloud.google.com/iot",
"id": "cloudiot:v1",
- "revision": "20171215",
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
- "Expr": {
- "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",
- "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`.",
- "type": "object",
- "properties": {
- "versionToUpdate": {
- "description": "The version number to update. If this value is zero, it will not check the\nversion number of the server and will always update the current version;\notherwise, this update will fail if the version number found on the server\ndoes not match this version number. This is used to support multiple\nsimultaneous updates without losing data.",
- "format": "int64",
- "type": "string"
- },
- "binaryData": {
- "description": "The configuration data for the device.",
- "format": "byte",
- "type": "string"
- }
- },
- "id": "ModifyCloudToDeviceConfigRequest"
- },
- "ListDeviceStatesResponse": {
- "id": "ListDeviceStatesResponse",
- "description": "Response for `ListDeviceStates`.",
- "type": "object",
- "properties": {
- "deviceStates": {
- "type": "array",
- "items": {
- "$ref": "DeviceState"
- },
- "description": "The last few device states. States are listed in descending order of server\nupdate time, starting from the most recent one."
- }
- }
- },
- "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": {
- "description": "Request message for `GetIamPolicy` method.",
- "type": "object",
- "properties": {},
- "id": "GetIamPolicyRequest"
- },
- "Device": {
- "description": "The device resource.",
- "type": "object",
- "properties": {
- "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",
- "type": "string"
- },
- "blocked": {
- "description": "If a device is blocked, connections or requests from this device will fail.\nCan be used to temporarily prevent the device from connecting if, for\nexample, the sensor is generating bad data and needs maintenance.",
- "type": "boolean"
- },
- "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. This field is only for devices connecting through MQTT.",
- "format": "google-datetime",
- "type": "string"
- },
- "lastEventTime": {
- "description": "[Output only] The last time a telemetry event was received. Timestamps are\nperiodically collected and written to storage; they may be stale by a few\nminutes.",
- "format": "google-datetime",
- "type": "string"
- },
- "lastConfigSendTime": {
- "description": "[Output only] The last time a cloud-to-device config version was sent to\nthe device.",
- "format": "google-datetime",
- "type": "string"
- },
- "lastErrorStatus": {
- "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.",
- "format": "google-datetime",
- "type": "string"
- },
- "state": {
- "description": "[Output only] The state most recently received from the device. If no state\nhas been reported, this field is not present.",
- "$ref": "DeviceState"
- },
- "config": {
- "description": "The most recent device configuration, which is eventually sent from\nCloud IoT Core to the device. If not present on creation, the\nconfiguration will be initialized with an empty payload and version value\nof `1`. To update this field after creation, use the\n`DeviceManager.ModifyCloudToDeviceConfig` method.",
- "$ref": "DeviceConfig"
- },
- "name": {
- "description": "The resource path name. For example,\n`projects/p1/locations/us-central1/registries/registry0/devices/dev0` or\n`projects/p1/locations/us-central1/registries/registry0/devices/{num_id}`.\nWhen `name` is populated as a response from the service, it always ends\nin the device numeric ID.",
- "type": "string"
- },
- "credentials": {
- "description": "The credentials used to authenticate this device. To allow credential\nrotation without interruption, multiple device credentials can be bound to\nthis device. No more than 3 credentials can be bound to a single device at\na time. When new credentials are added to a device, they are verified\nagainst the registry credentials. For details, see the description of the\n`DeviceRegistry.credentials` field.",
- "type": "array",
- "items": {
- "$ref": "DeviceCredential"
- }
- },
- "lastErrorTime": {
- "description": "[Output only] The time the most recent error occurred, such as a failure to\npublish to Cloud Pub/Sub. This field is the timestamp of\n'last_error_status'.",
- "format": "google-datetime",
- "type": "string"
- },
- "metadata": {
- "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"
- }
- },
- "id": "Device"
- },
- "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"
- },
- "X509CertificateDetails": {
- "description": "Details of an X.509 certificate. For informational purposes only.",
- "type": "object",
- "properties": {
- "signatureAlgorithm": {
- "description": "The algorithm used to sign the certificate.",
- "type": "string"
- },
- "startTime": {
- "description": "The time the certificate becomes valid.",
- "format": "google-datetime",
- "type": "string"
- },
- "expiryTime": {
- "description": "The time the certificate becomes invalid.",
- "format": "google-datetime",
- "type": "string"
- },
- "subject": {
- "description": "The entity the certificate and public key belong to.",
- "type": "string"
- },
- "issuer": {
- "description": "The entity that signed the certificate.",
- "type": "string"
- },
- "publicKeyType": {
- "description": "The type of public key in the certificate.",
- "type": "string"
- }
- },
- "id": "X509CertificateDetails"
- },
- "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"
- },
- "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"
- },
- "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"
- },
- "PublicKeyCredential": {
- "properties": {
- "key": {
- "description": "The key data.",
- "type": "string"
- },
- "format": {
- "enum": [
- "UNSPECIFIED_PUBLIC_KEY_FORMAT",
- "RSA_PEM",
- "RSA_X509_PEM",
- "ES256_PEM",
- "ES256_X509_PEM"
- ],
- "description": "The format of the key.",
- "type": "string",
- "enumDescriptions": [
- "The format has not been specified. This is an invalid default value and\nmust not be used.",
- "An RSA public key encoded in base64, and wrapped by\n`-----BEGIN PUBLIC KEY-----` and `-----END PUBLIC KEY-----`. This can be\nused to verify `RS256` signatures in JWT tokens ([RFC7518](\nhttps://www.ietf.org/rfc/rfc7518.txt)).",
- "As RSA_PEM, but wrapped in an X.509v3 certificate ([RFC5280](\nhttps://www.ietf.org/rfc/rfc5280.txt)), encoded in base64, and wrapped by\n`-----BEGIN CERTIFICATE-----` and `-----END CERTIFICATE-----`.",
- "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.",
- "As ES256_PEM, but wrapped in an X.509v3 certificate ([RFC5280](\nhttps://www.ietf.org/rfc/rfc5280.txt)), encoded in base64, and wrapped by\n`-----BEGIN CERTIFICATE-----` and `-----END CERTIFICATE-----`."
- ]
- }
- },
- "id": "PublicKeyCredential",
- "description": "A public key format and data.",
- "type": "object"
- },
- "PublicKeyCertificate": {
- "description": "A public key certificate format and data.",
- "type": "object",
- "properties": {
- "x509Details": {
- "$ref": "X509CertificateDetails",
- "description": "[Output only] The certificate details. Used only for X.509 certificates."
- },
- "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"
- },
- "certificate": {
- "description": "The certificate data.",
- "type": "string"
- }
- },
- "id": "PublicKeyCertificate"
- },
- "DeviceState": {
- "description": "The device state, as reported by the device.",
- "type": "object",
- "properties": {
- "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": {
- "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"
- ]
- },
- "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"
- },
- "StateNotificationConfig": {
- "id": "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`.",
- "type": "string"
- }
- }
- },
- "TestIamPermissionsRequest": {
- "id": "TestIamPermissionsRequest",
- "description": "Request message for `TestIamPermissions` method.",
- "type": "object",
- "properties": {
- "permissions": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "description": "The set of permissions to check for the `resource`. Permissions with\nwildcards (such as '*' or 'storage.*') are not allowed. For more\ninformation see\n[IAM Overview](https://cloud.google.com/iam/docs/overview#permissions)."
- }
- }
- },
- "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": {
- "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"
- }
- },
- "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"
- }
- },
- "id": "Policy"
- },
- "RegistryCredential": {
- "description": "A server-stored registry credential used to validate device credentials.",
- "type": "object",
- "properties": {
- "publicKeyCertificate": {
- "$ref": "PublicKeyCertificate",
- "description": "A public key certificate used to verify the device credentials."
- }
- },
- "id": "RegistryCredential"
- },
- "ListDeviceRegistriesResponse": {
- "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",
- "description": "Response for `ListDeviceRegistries`."
- },
"DeviceRegistry": {
- "description": "A container for a group of devices.",
- "type": "object",
"properties": {
- "mqttConfig": {
- "description": "The MQTT configuration for this device registry.",
- "$ref": "MqttConfig"
- },
- "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.",
- "$ref": "StateNotificationConfig"
- },
"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",
@@ -1089,11 +661,11 @@
"type": "string"
},
"eventNotificationConfigs": {
+ "description": "The configuration for notification of telemetry events received from the\ndevice. All telemetry events that were successfully published by the\ndevice and acknowledged by Cloud IoT Core are guaranteed to be\ndelivered to Cloud Pub/Sub. Only the first configuration is used. If you\ntry to publish a device telemetry event using MQTT without specifying a\nCloud Pub/Sub topic for the device's registry, the connection closes\nautomatically. If you try to do so using an HTTP connection, an error\nis returned.",
"type": "array",
"items": {
"$ref": "EventNotificationConfig"
- },
- "description": "The configuration for notification of telemetry events received from the\ndevice. All telemetry events that were successfully published by the\ndevice and acknowledged by Cloud IoT Core are guaranteed to be\ndelivered to Cloud Pub/Sub. Only the first configuration is used. If you\ntry to publish a device telemetry event using MQTT without specifying a\nCloud Pub/Sub topic for the device's registry, the connection closes\nautomatically. If you try to do so using an HTTP connection, an error\nis returned."
+ }
},
"httpConfig": {
"$ref": "HttpConfig",
@@ -1102,24 +674,34 @@
"id": {
"description": "The identifier of this device registry. For example, `myRegistry`.",
"type": "string"
+ },
+ "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"
+ "id": "DeviceRegistry",
+ "description": "A container for a group of devices.",
+ "type": "object"
},
"ListDevicesResponse": {
"description": "Response for `ListDevices`.",
"type": "object",
"properties": {
- "devices": {
- "type": "array",
- "items": {
- "$ref": "Device"
- },
- "description": "The devices that match the request."
- },
"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"
@@ -1128,13 +710,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": {
- "auditLogConfigs": {
- "description": "The configuration for logging of each type of permission.\nNext ID: 4",
- "type": "array",
- "items": {
- "$ref": "AuditLogConfig"
- }
- },
"exemptedMembers": {
"type": "array",
"items": {
@@ -1144,18 +719,20 @@
"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"
},
"HttpConfig": {
- "id": "HttpConfig",
- "description": "The configuration of the HTTP bridge for a device registry.",
- "type": "object",
"properties": {
"httpEnabledState": {
- "description": "If enabled, allows devices to use DeviceService via the HTTP protocol.\nOtherwise, any requests to DeviceService will fail for this registry.",
- "type": "string",
"enumDescriptions": [
"No HTTP state specified. If not specified, DeviceService will be\nenabled by default.",
"Enables DeviceService (HTTP) service for the registry.",
@@ -1165,9 +742,14 @@
"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.",
@@ -1186,8 +768,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.",
@@ -1195,9 +775,9 @@
"type": "string"
},
"cloudUpdateTime": {
- "type": "string",
"description": "[Output only] The time at which this configuration version was updated in\nCloud IoT Core. This timestamp is set by the server.",
- "format": "google-datetime"
+ "format": "google-datetime",
+ "type": "string"
},
"deviceAckTime": {
"description": "[Output only] The time at which Cloud IoT Core 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\nthe config was sent to the device, many config versions may have been\navailable in Cloud IoT Core while the device was disconnected, and on\nconnection, only the latest version is sent to the device. Some\nversions may never be sent to the device, and therefore are never\nacknowledged. This timestamp is set by Cloud IoT Core.",
@@ -1210,15 +790,15 @@
"type": "string"
}
},
- "id": "DeviceConfig"
+ "id": "DeviceConfig",
+ "description": "The device configuration. Eventually delivered to devices.",
+ "type": "object"
},
"MqttConfig": {
- "id": "MqttConfig",
"description": "The configuration of MQTT for a device registry.",
"type": "object",
"properties": {
"mqttEnabledState": {
- "type": "string",
"enumDescriptions": [
"No MQTT state specified. If not specified, MQTT will be enabled by default.",
"Enables a MQTT connection.",
@@ -1229,9 +809,11 @@
"MQTT_ENABLED",
"MQTT_DISABLED"
],
- "description": "If enabled, allows connections using the MQTT protocol. Otherwise, MQTT\nconnections to this registry will fail."
+ "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.",
@@ -1265,8 +847,8 @@
"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"
+ "$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",
@@ -1281,31 +863,449 @@
}
},
"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"
+ },
+ "ModifyCloudToDeviceConfigRequest": {
+ "description": "Request for `ModifyCloudToDeviceConfig`.",
+ "type": "object",
+ "properties": {
+ "versionToUpdate": {
+ "description": "The version number to update. If this value is zero, it will not check the\nversion number of the server and will always update the current version;\notherwise, this update will fail if the version number found on the server\ndoes not match this version number. This is used to support multiple\nsimultaneous updates without losing data.",
+ "format": "int64",
+ "type": "string"
+ },
+ "binaryData": {
+ "description": "The configuration data for the device.",
+ "format": "byte",
+ "type": "string"
+ }
+ },
+ "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.",
+ "type": "array",
+ "items": {
+ "$ref": "DeviceState"
+ }
+ }
+ },
+ "id": "ListDeviceStatesResponse"
+ },
+ "GetIamPolicyRequest": {
+ "description": "Request message for `GetIamPolicy` method.",
+ "type": "object",
+ "properties": {},
+ "id": "GetIamPolicyRequest"
+ },
+ "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"
+ },
+ "Device": {
+ "description": "The device resource.",
+ "type": "object",
+ "properties": {
+ "lastEventTime": {
+ "description": "[Output only] The last time a telemetry event was received. Timestamps are\nperiodically collected and written to storage; they may be stale by a few\nminutes.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "lastConfigSendTime": {
+ "description": "[Output only] The last time a cloud-to-device config version was sent to\nthe device.",
+ "format": "google-datetime",
+ "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."
+ },
+ "lastStateTime": {
+ "description": "[Output only] The last time a state event was received. Timestamps are\nperiodically collected and written to storage; they may be stale by a few\nminutes.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "state": {
+ "$ref": "DeviceState",
+ "description": "[Output only] The state most recently received from the device. If no state\nhas been reported, this field is not present."
+ },
+ "config": {
+ "description": "The most recent device configuration, which is eventually sent from\nCloud IoT Core to the device. If not present on creation, the\nconfiguration will be initialized with an empty payload and version value\nof `1`. To update this field after creation, use the\n`DeviceManager.ModifyCloudToDeviceConfig` method.",
+ "$ref": "DeviceConfig"
+ },
+ "credentials": {
+ "description": "The credentials used to authenticate this device. To allow credential\nrotation without interruption, multiple device credentials can be bound to\nthis device. No more than 3 credentials can be bound to a single device at\na time. When new credentials are added to a device, they are verified\nagainst the registry credentials. For details, see the description of the\n`DeviceRegistry.credentials` field.",
+ "type": "array",
+ "items": {
+ "$ref": "DeviceCredential"
+ }
+ },
+ "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 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",
+ "type": "string"
+ },
+ "blocked": {
+ "description": "If a device is blocked, connections or requests from this device will fail.\nCan be used to temporarily prevent the device from connecting if, for\nexample, the sensor is generating bad data and needs maintenance.",
+ "type": "boolean"
+ },
+ "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. This field is only for devices connecting through MQTT.",
+ "format": "google-datetime",
+ "type": "string"
+ }
+ },
+ "id": "Device"
+ },
+ "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"
+ },
+ "X509CertificateDetails": {
+ "description": "Details of an X.509 certificate. For informational purposes only.",
+ "type": "object",
+ "properties": {
+ "publicKeyType": {
+ "description": "The type of public key in the certificate.",
+ "type": "string"
+ },
+ "signatureAlgorithm": {
+ "description": "The algorithm used to sign the certificate.",
+ "type": "string"
+ },
+ "startTime": {
+ "description": "The time the certificate becomes valid.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "expiryTime": {
+ "description": "The time the certificate becomes invalid.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "subject": {
+ "description": "The entity the certificate and public key belong to.",
+ "type": "string"
+ },
+ "issuer": {
+ "description": "The entity that signed the certificate.",
+ "type": "string"
+ }
+ },
+ "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`.",
+ "type": "string"
+ }
+ },
+ "id": "EventNotificationConfig"
+ },
+ "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"
+ },
+ "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"
+ },
+ "PublicKeyCredential": {
+ "description": "A public key format and data.",
+ "type": "object",
+ "properties": {
+ "key": {
+ "description": "The key data.",
+ "type": "string"
+ },
+ "format": {
+ "description": "The format of the key.",
+ "type": "string",
+ "enumDescriptions": [
+ "The format has not been specified. This is an invalid default value and\nmust not be used.",
+ "An RSA public key encoded in base64, and wrapped by\n`-----BEGIN PUBLIC KEY-----` and `-----END PUBLIC KEY-----`. This can be\nused to verify `RS256` signatures in JWT tokens ([RFC7518](\nhttps://www.ietf.org/rfc/rfc7518.txt)).",
+ "As RSA_PEM, but wrapped in an X.509v3 certificate ([RFC5280](\nhttps://www.ietf.org/rfc/rfc5280.txt)), encoded in base64, and wrapped by\n`-----BEGIN CERTIFICATE-----` and `-----END CERTIFICATE-----`.",
+ "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.",
+ "As ES256_PEM, but wrapped in an X.509v3 certificate ([RFC5280](\nhttps://www.ietf.org/rfc/rfc5280.txt)), encoded in base64, and wrapped by\n`-----BEGIN CERTIFICATE-----` and `-----END CERTIFICATE-----`."
+ ],
+ "enum": [
+ "UNSPECIFIED_PUBLIC_KEY_FORMAT",
+ "RSA_PEM",
+ "RSA_X509_PEM",
+ "ES256_PEM",
+ "ES256_X509_PEM"
+ ]
+ }
+ },
+ "id": "PublicKeyCredential"
+ },
+ "PublicKeyCertificate": {
+ "description": "A public key certificate format and data.",
+ "type": "object",
+ "properties": {
+ "certificate": {
+ "description": "The certificate data.",
+ "type": "string"
+ },
+ "x509Details": {
+ "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"
+ }
+ },
+ "id": "PublicKeyCertificate"
+ },
+ "DeviceState": {
+ "description": "The device state, as reported by the device.",
+ "type": "object",
+ "properties": {
+ "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.",
+ "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"
+ },
+ "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`.",
+ "type": "string"
+ }
+ },
+ "id": "StateNotificationConfig"
+ },
+ "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"
+ },
+ "RegistryCredential": {
+ "description": "A server-stored registry credential used to validate device credentials.",
+ "type": "object",
+ "properties": {
+ "publicKeyCertificate": {
+ "description": "A public key certificate used to verify the device credentials.",
+ "$ref": "PublicKeyCertificate"
+ }
+ },
+ "id": "RegistryCredential"
+ },
+ "ListDeviceRegistriesResponse": {
+ "properties": {
+ "deviceRegistries": {
+ "description": "The registries that matched the query.",
+ "type": "array",
+ "items": {
+ "$ref": "DeviceRegistry"
+ }
+ },
+ "nextPageToken": {
+ "description": "If not empty, indicates that there may be more registries that match the\nrequest; this value should be passed in a new\n`ListDeviceRegistriesRequest`.",
+ "type": "string"
+ }
+ },
+ "id": "ListDeviceRegistriesResponse",
+ "description": "Response for `ListDeviceRegistries`.",
+ "type": "object"
}
},
"protocol": "rest",
"icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
+ "x32": "http://www.google.com/images/icons/product/search-32.gif",
+ "x16": "http://www.google.com/images/icons/product/search-16.gif"
},
"canonicalName": "Cloud Iot",
"auth": {
"oauth2": {
"scopes": {
- "https://www.googleapis.com/auth/cloudiot": {
- "description": "Register and manage devices in the Google Cloud IoT service"
- },
"https://www.googleapis.com/auth/cloud-platform": {
"description": "View and manage your data across Google Cloud Platform services"
+ },
+ "https://www.googleapis.com/auth/cloudiot": {
+ "description": "Register and manage devices in the Google Cloud IoT service"
}
}
}
- },
- "rootUrl": "https://cloudiot.googleapis.com/",
- "ownerDomain": "google.com",
- "name": "cloudiot",
- "batchPath": "batch",
- "fullyEncodeReservedExpansion": true,
- "title": "Google Cloud IoT API",
- "ownerName": "Google"
+ }
}
diff --git a/cloudiot/v1beta1/cloudiot-api.json b/cloudiot/v1beta1/cloudiot-api.json
index 0eb503b..e297cc5 100644
--- a/cloudiot/v1beta1/cloudiot-api.json
+++ b/cloudiot/v1beta1/cloudiot-api.json
@@ -1,10 +1,4 @@
{
- "rootUrl": "https://cloudiot.googleapis.com/",
- "ownerDomain": "google.com",
- "name": "cloudiot",
- "batchPath": "batch",
- "fullyEncodeReservedExpansion": true,
- "title": "Google Cloud IoT API",
"ownerName": "Google",
"resources": {
"projects": {
@@ -13,66 +7,7 @@
"resources": {
"registries": {
"methods": {
- "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": "^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}: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."
- },
- "get": {
- "path": "v1beta1/{+name}",
- "id": "cloudiot.projects.locations.registries.get",
- "description": "Gets a device registry configuration.",
- "response": {
- "$ref": "DeviceRegistry"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "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": "v1beta1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}"
- },
"patch": {
- "request": {
- "$ref": "DeviceRegistry"
- },
- "description": "Updates a device registry configuration.",
"response": {
"$ref": "DeviceRegistry"
},
@@ -82,10 +17,10 @@
"httpMethod": "PATCH",
"parameters": {
"updateMask": {
- "location": "query",
"description": "Only updates the `device_registry` fields indicated by this mask.\nThe field mask must not be empty, and it must not contain fields that\nare immutable or only set by the server.\nMutable top-level fields: `event_notification_config` and `mqtt_config`",
"format": "google-fieldmask",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"name": {
"description": "The resource path name. For example,\n`projects/example-project/locations/us-central1/registries/my-registry`.",
@@ -101,46 +36,24 @@
],
"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}",
"path": "v1beta1/{+name}",
- "id": "cloudiot.projects.locations.registries.patch"
- },
- "testIamPermissions": {
- "id": "cloudiot.projects.locations.registries.testIamPermissions",
- "path": "v1beta1/{+resource}:testIamPermissions",
+ "id": "cloudiot.projects.locations.registries.patch",
"request": {
- "$ref": "TestIamPermissionsRequest"
+ "$ref": "DeviceRegistry"
},
- "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.",
- "httpMethod": "POST",
- "parameterOrder": [
- "resource"
- ],
- "response": {
- "$ref": "TestIamPermissionsResponse"
- },
- "parameters": {
- "resource": {
- "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+$",
- "location": "path",
- "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudiot"
- ],
- "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}:testIamPermissions"
+ "description": "Updates a device registry configuration."
},
- "delete": {
- "description": "Deletes a device registry configuration.",
- "httpMethod": "DELETE",
+ "get": {
"response": {
- "$ref": "Empty"
+ "$ref": "DeviceRegistry"
},
"parameterOrder": [
"name"
],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudiot"
+ ],
"parameters": {
"name": {
"location": "path",
@@ -150,16 +63,67 @@
"pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+$"
}
},
+ "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}",
+ "path": "v1beta1/{+name}",
+ "id": "cloudiot.projects.locations.registries.get",
+ "description": "Gets a device registry configuration."
+ },
+ "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": {
+ "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"
+ }
+ },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloudiot"
],
+ "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}:testIamPermissions",
+ "path": "v1beta1/{+resource}:testIamPermissions",
+ "id": "cloudiot.projects.locations.registries.testIamPermissions"
+ },
+ "delete": {
"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}",
+ "path": "v1beta1/{+name}",
"id": "cloudiot.projects.locations.registries.delete",
- "path": "v1beta1/{+name}"
+ "description": "Deletes a device registry configuration.",
+ "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/[^/]+$",
+ "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"
+ }
+ }
},
"list": {
- "description": "Lists device registries.",
"response": {
"$ref": "ListDeviceRegistriesResponse"
},
@@ -172,6 +136,13 @@
"https://www.googleapis.com/auth/cloudiot"
],
"parameters": {
+ "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": {
"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.",
@@ -182,18 +153,41 @@
"format": "int32",
"type": "integer",
"location": "query"
- },
- "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"
}
},
"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/registries",
"path": "v1beta1/{+parent}/registries",
- "id": "cloudiot.projects.locations.registries.list"
+ "id": "cloudiot.projects.locations.registries.list",
+ "description": "Lists device registries."
+ },
+ "setIamPolicy": {
+ "path": "v1beta1/{+resource}:setIamPolicy",
+ "id": "cloudiot.projects.locations.registries.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/cloudiot"
+ ],
+ "parameters": {
+ "resource": {
+ "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}:setIamPolicy"
},
"create": {
"response": {
@@ -224,10 +218,13 @@
"$ref": "DeviceRegistry"
}
},
- "setIamPolicy": {
- "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.",
+ "getIamPolicy": {
+ "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}:getIamPolicy",
+ "path": "v1beta1/{+resource}:getIamPolicy",
+ "id": "cloudiot.projects.locations.registries.getIamPolicy",
+ "description": "Gets the access control policy for a resource.\nReturns an empty policy if the resource exists and does not have a policy\nset.",
"request": {
- "$ref": "SetIamPolicyRequest"
+ "$ref": "GetIamPolicyRequest"
},
"response": {
"$ref": "Policy"
@@ -242,34 +239,70 @@
],
"parameters": {
"resource": {
+ "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+$",
"location": "path",
- "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.",
+ "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",
"required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+$"
+ "type": "string"
}
- },
- "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}:setIamPolicy",
- "path": "v1beta1/{+resource}:setIamPolicy",
- "id": "cloudiot.projects.locations.registries.setIamPolicy"
+ }
}
},
"resources": {
"devices": {
"methods": {
- "delete": {
+ "modifyCloudToDeviceConfig": {
"response": {
- "$ref": "Empty"
+ "$ref": "DeviceConfig"
},
"parameterOrder": [
"name"
],
- "httpMethod": "DELETE",
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudiot"
+ ],
"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/[^/]+$"
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/devices/{devicesId}:modifyCloudToDeviceConfig",
+ "path": "v1beta1/{+name}:modifyCloudToDeviceConfig",
+ "id": "cloudiot.projects.locations.registries.devices.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"
+ }
+ },
+ "patch": {
+ "request": {
+ "$ref": "Device"
+ },
+ "description": "Updates a device.",
+ "httpMethod": "PATCH",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Device"
+ },
+ "parameters": {
+ "updateMask": {
+ "description": "Only updates the `device` fields indicated by this mask.\nThe field mask must not be empty, and it must not contain fields that\nare immutable or only set by the server.\nMutable top-level fields: `credentials` and `enabled_state`",
+ "format": "google-fieldmask",
+ "type": "string",
+ "location": "query"
+ },
+ "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}`.",
+ "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"
}
@@ -279,45 +312,96 @@
"https://www.googleapis.com/auth/cloudiot"
],
"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/devices/{devicesId}",
- "path": "v1beta1/{+name}",
- "id": "cloudiot.projects.locations.registries.devices.delete",
- "description": "Deletes a device."
+ "id": "cloudiot.projects.locations.registries.devices.patch",
+ "path": "v1beta1/{+name}"
},
- "list": {
- "path": "v1beta1/{+parent}/devices",
- "id": "cloudiot.projects.locations.registries.devices.list",
- "description": "List devices in a device registry.",
+ "get": {
+ "description": "Gets details about a device.",
"response": {
- "$ref": "ListDevicesResponse"
+ "$ref": "Device"
},
"parameterOrder": [
- "parent"
+ "name"
],
"httpMethod": "GET",
"parameters": {
- "deviceNumIds": {
- "description": "A list of device numerical ids. If empty, it will ignore this field. This\nfield cannot hold more than 10,000 entries.",
- "format": "uint64",
+ "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",
- "repeated": true,
- "location": "query"
- },
+ "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+/devices/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudiot"
+ ],
+ "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/devices/{devicesId}",
+ "path": "v1beta1/{+name}",
+ "id": "cloudiot.projects.locations.registries.devices.get"
+ },
+ "delete": {
+ "path": "v1beta1/{+name}",
+ "id": "cloudiot.projects.locations.registries.devices.delete",
+ "description": "Deletes a device.",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "DELETE",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudiot"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The name of the device. For example,\n`projects/p0/locations/us-central1/registries/registry0/devices/device0` or\n`projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+/devices/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/devices/{devicesId}"
+ },
+ "list": {
+ "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/devices",
+ "id": "cloudiot.projects.locations.registries.devices.list",
+ "path": "v1beta1/{+parent}/devices",
+ "description": "List devices in a device registry.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "parent"
+ ],
+ "response": {
+ "$ref": "ListDevicesResponse"
+ },
+ "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"
+ "type": "string",
+ "location": "query"
},
"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"
+ "type": "integer",
+ "location": "query"
+ },
+ "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"
},
"parent": {
"description": "The device registry path. Required. For example,\n`projects/my-project/locations/us-central1/registries/my-registry`.",
@@ -326,18 +410,18 @@
"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.",
+ "deviceNumIds": {
+ "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",
- "repeated": true,
- "location": "query"
+ "repeated": true
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloudiot"
- ],
- "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/devices"
+ ]
},
"create": {
"response": {
@@ -367,102 +451,13 @@
"request": {
"$ref": "Device"
}
- },
- "modifyCloudToDeviceConfig": {
- "request": {
- "$ref": "ModifyCloudToDeviceConfigRequest"
- },
- "description": "Modifies the configuration for the device, which is eventually sent from\nthe Cloud IoT servers. Returns the modified configuration version and its\nmeta-data.",
- "httpMethod": "POST",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "DeviceConfig"
- },
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+/devices/[^/]+$",
- "location": "path",
- "description": "The name of the device. For example,\n`projects/p0/locations/us-central1/registries/registry0/devices/device0` or\n`projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudiot"
- ],
- "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/devices/{devicesId}:modifyCloudToDeviceConfig",
- "id": "cloudiot.projects.locations.registries.devices.modifyCloudToDeviceConfig",
- "path": "v1beta1/{+name}:modifyCloudToDeviceConfig"
- },
- "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": {
- "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` and `enabled_state`",
- "format": "google-fieldmask",
- "type": "string"
- },
- "name": {
- "description": "The resource path name. For example,\n`projects/p1/locations/us-central1/registries/registry0/devices/dev0` or\n`projects/p1/locations/us-central1/registries/registry0/devices/{num_id}`.\nWhen `name` is populated as a response from the service, it always ends\nin the device numeric ID.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+/devices/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/devices/{devicesId}",
- "path": "v1beta1/{+name}",
- "id": "cloudiot.projects.locations.registries.devices.patch"
- },
- "get": {
- "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"
- }
- },
- "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/devices/{devicesId}"
}
},
"resources": {
"configVersions": {
"methods": {
"list": {
+ "description": "Lists the last few versions of the device configuration in descending\norder (i.e.: newest first).",
"response": {
"$ref": "ListDeviceConfigVersionsResponse"
},
@@ -475,24 +470,23 @@
"https://www.googleapis.com/auth/cloudiot"
],
"parameters": {
+ "numVersions": {
+ "location": "query",
+ "description": "The number of versions to list. Versions are listed in decreasing order of\nthe version number. The maximum number of versions retained is 10. If this\nvalue is zero, it will return all the versions available.",
+ "format": "int32",
+ "type": "integer"
+ },
"name": {
"pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+/devices/[^/]+$",
"location": "path",
"description": "The name of the device. For example,\n`projects/p0/locations/us-central1/registries/registry0/devices/device0` or\n`projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`.",
"required": true,
"type": "string"
- },
- "numVersions": {
- "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"
}
},
"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/devices/{devicesId}/configVersions",
"path": "v1beta1/{+name}/configVersions",
- "id": "cloudiot.projects.locations.registries.devices.configVersions.list",
- "description": "Lists the last few versions of the device configuration in descending\norder (i.e.: newest first)."
+ "id": "cloudiot.projects.locations.registries.devices.configVersions.list"
}
}
}
@@ -506,22 +500,32 @@
}
},
"parameters": {
+ "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",
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query"
- },
- "callback": {
- "location": "query",
- "description": "JSONP",
"type": "string"
},
"alt": {
@@ -546,9 +550,9 @@
"location": "query"
},
"access_token": {
+ "location": "query",
"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.",
@@ -556,41 +560,31 @@
"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"
+ },
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
"type": "string",
"location": "query"
},
"upload_protocol": {
- "location": "query",
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"prettyPrint": {
"location": "query",
"description": "Returns response with indentations and line breaks.",
"type": "boolean",
"default": "true"
- },
- "uploadType": {
- "location": "query",
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string"
- },
- "fields": {
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string",
- "location": "query"
}
},
"version": "v1beta1",
@@ -599,23 +593,12 @@
"description": "Registers and manages IoT (Internet of Things) devices that connect to the Google Cloud Platform.\n",
"servicePath": "",
"basePath": "",
- "revision": "20171215",
- "documentationLink": "https://cloud.google.com/iot",
"id": "cloudiot:v1beta1",
+ "documentationLink": "https://cloud.google.com/iot",
+ "revision": "20171215",
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
- "NotificationConfig": {
- "description": "Configuration to forward messages such as telemetry events.",
- "type": "object",
- "properties": {
- "pubsubTopicName": {
- "description": "A Cloud Pub/Sub topic name. For example,\n`projects/myProject/topics/deviceEvents`.",
- "type": "string"
- }
- },
- "id": "NotificationConfig"
- },
"TestIamPermissionsRequest": {
"description": "Request message for `TestIamPermissions` method.",
"type": "object",
@@ -630,23 +613,21 @@
},
"id": "TestIamPermissionsRequest"
},
+ "NotificationConfig": {
+ "description": "Configuration to forward messages such as telemetry events.",
+ "type": "object",
+ "properties": {
+ "pubsubTopicName": {
+ "description": "A Cloud Pub/Sub topic name. For example,\n`projects/myProject/topics/deviceEvents`.",
+ "type": "string"
+ }
+ },
+ "id": "NotificationConfig"
+ },
"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",
@@ -660,11 +641,26 @@
"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.",
@@ -678,14 +674,35 @@
"type": "string"
}
},
- "id": "ListDeviceRegistriesResponse",
- "description": "Response for `ListDeviceRegistries`.",
- "type": "object"
+ "id": "ListDeviceRegistriesResponse"
},
"Device": {
"description": "The device resource.",
"type": "object",
"properties": {
+ "enabledState": {
+ "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."
+ ],
+ "enum": [
+ "UNSPECIFIED_ENABLED_STATE",
+ "DEVICE_ENABLED",
+ "DEVICE_DISABLED"
+ ]
+ },
+ "id": {
+ "description": "The user-defined device identifier. The device ID must be unique\nwithin a device registry.",
+ "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",
@@ -697,8 +714,8 @@
"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."
+ "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"
},
"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.",
@@ -706,8 +723,8 @@
"type": "string"
},
"config": {
- "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.",
- "$ref": "DeviceConfig"
+ "$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.",
@@ -724,41 +741,12 @@
"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"
- },
- "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"
- },
- "id": {
- "description": "The user-defined device identifier. The device ID must be unique\nwithin a device registry.",
- "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"
}
},
"id": "Device"
},
"DeviceRegistry": {
- "description": "A container for a group of devices.",
- "type": "object",
"properties": {
- "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."
@@ -770,9 +758,15 @@
"eventNotificationConfig": {
"description": "Configuration to notify events received from the device.",
"$ref": "NotificationConfig"
+ },
+ "id": {
+ "description": "The identifier of this device registry. For example, `myRegistry`.",
+ "type": "string"
}
},
- "id": "DeviceRegistry"
+ "id": "DeviceRegistry",
+ "description": "A container for a group of devices.",
+ "type": "object"
},
"ListDeviceConfigVersionsResponse": {
"description": "Response for `ListDeviceConfigVersions`.",
@@ -806,6 +800,22 @@
},
"id": "ListDevicesResponse"
},
+ "DeviceCredential": {
+ "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": {
+ "$ref": "PublicKeyCredential",
+ "description": "A public key used to verify the signature of JSON Web Tokens (JWTs)."
+ }
+ },
+ "id": "DeviceCredential",
+ "description": "A server-stored device credential used for authentication.",
+ "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",
@@ -830,26 +840,14 @@
},
"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": {
- "$ref": "PublicKeyCredential",
- "description": "A public key used to verify the signature of JSON Web Tokens (JWTs)."
- }
- },
- "id": "DeviceCredential"
- },
"DeviceConfig": {
"description": "The device configuration and its metadata. Eventually delivered to devices.",
"type": "object",
"properties": {
+ "data": {
+ "description": "The device configuration data.",
+ "$ref": "DeviceConfigData"
+ },
"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",
@@ -864,10 +862,6 @@
"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"
@@ -877,6 +871,8 @@
"type": "object",
"properties": {
"mqttConfigState": {
+ "description": "If enabled, allows connections using the MQTT protocol. Otherwise any MQTT\nconnection 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.",
@@ -886,9 +882,7 @@
"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"
@@ -896,8 +890,8 @@
"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"
+ "$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.",
@@ -910,9 +904,16 @@
"type": "object"
},
"Status": {
- "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
- "type": "object",
"properties": {
+ "code": {
+ "description": "The status code, which should be an enum value of google.rpc.Code.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "message": {
+ "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
+ "type": "string"
+ },
"details": {
"description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.",
"type": "array",
@@ -923,20 +924,15 @@
},
"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"
+ "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": {
"$ref": "Expr",
@@ -954,9 +950,7 @@
"type": "string"
}
},
- "id": "Binding",
- "description": "Associates `members` with a `role`.",
- "type": "object"
+ "id": "Binding"
},
"Empty": {
"properties": {},
@@ -1000,29 +994,29 @@
"id": "DeviceConfigData"
},
"PublicKeyCredential": {
- "description": "A public key format and data.",
- "type": "object",
"properties": {
+ "key": {
+ "description": "The key data.",
+ "type": "string"
+ },
"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"
- },
- "key": {
- "description": "The key data.",
- "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"
+ "id": "PublicKeyCredential",
+ "description": "A public key format and data.",
+ "type": "object"
},
"ModifyCloudToDeviceConfigRequest": {
"description": "Request for `ModifyCloudToDeviceConfig`.",
@@ -1061,9 +1055,14 @@
"id": "TestIamPermissionsResponse"
},
"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.",
@@ -1079,23 +1078,18 @@
],
"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"
+ "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"
}
},
- "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": "Cloud Iot",
"auth": {
"oauth2": {
@@ -1108,5 +1102,11 @@
}
}
}
- }
+ },
+ "rootUrl": "https://cloudiot.googleapis.com/",
+ "ownerDomain": "google.com",
+ "name": "cloudiot",
+ "batchPath": "batch",
+ "fullyEncodeReservedExpansion": true,
+ "title": "Google Cloud IoT API"
}
diff --git a/cloudkms/v1/cloudkms-api.json b/cloudkms/v1/cloudkms-api.json
index 605bdfa..5d76be6 100644
--- a/cloudkms/v1/cloudkms-api.json
+++ b/cloudkms/v1/cloudkms-api.json
@@ -1,166 +1,861 @@
{
+ "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": {
+ "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"
+ }
+ },
+ "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.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Location"
+ },
+ "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": {
+ "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.",
+ "response": {
+ "$ref": "TestIamPermissionsResponse"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "resource": {
+ "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}:testIamPermissions",
+ "path": "v1/{+resource}:testIamPermissions",
+ "id": "cloudkms.projects.locations.keyRings.testIamPermissions"
+ },
+ "list": {
+ "response": {
+ "$ref": "ListKeyRingsResponse"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "pageSize": {
+ "description": "Optional limit on the number of KeyRings to include in the\nresponse. Further KeyRings can subsequently be obtained by\nincluding the ListKeyRingsResponse.next_page_token in a subsequent\nrequest. If unspecified, the server will pick an appropriate default.",
+ "format": "int32",
+ "type": "integer",
+ "location": "query"
+ },
+ "parent": {
+ "location": "path",
+ "description": "Required. The resource name of the location associated with the\nKeyRings, in the format `projects/*/locations/*`.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+$"
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "Optional pagination token, returned earlier via\nListKeyRingsResponse.next_page_token.",
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings",
+ "path": "v1/{+parent}/keyRings",
+ "id": "cloudkms.projects.locations.keyRings.list",
+ "description": "Lists KeyRings."
+ },
+ "create": {
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings",
+ "id": "cloudkms.projects.locations.keyRings.create",
+ "path": "v1/{+parent}/keyRings",
+ "request": {
+ "$ref": "KeyRing"
+ },
+ "description": "Create a new KeyRing in a given Project and Location.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "parent"
+ ],
+ "response": {
+ "$ref": "KeyRing"
+ },
+ "parameters": {
+ "parent": {
+ "pattern": "^projects/[^/]+/locations/[^/]+$",
+ "location": "path",
+ "description": "Required. The resource name of the location associated with the\nKeyRings, in the format `projects/*/locations/*`.",
+ "required": true,
+ "type": "string"
+ },
+ "keyRingId": {
+ "description": "Required. It must be unique within a location and match the regular\nexpression `[a-zA-Z0-9_-]{1,63}`",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "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"
+ ],
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}: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"
+ },
+ "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/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}:getIamPolicy",
+ "path": "v1/{+resource}:getIamPolicy",
+ "id": "cloudkms.projects.locations.keyRings.getIamPolicy"
+ },
+ "get": {
+ "response": {
+ "$ref": "KeyRing"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "location": "path",
+ "description": "The name of the KeyRing to get.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+$"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}",
+ "path": "v1/{+name}",
+ "id": "cloudkms.projects.locations.keyRings.get",
+ "description": "Returns metadata for a given KeyRing."
+ }
+ },
+ "resources": {
+ "cryptoKeys": {
+ "resources": {
+ "cryptoKeyVersions": {
+ "methods": {
+ "restore": {
+ "response": {
+ "$ref": "CryptoKeyVersion"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "name": {
+ "location": "path",
+ "description": "The resource name of the CryptoKeyVersion to restore.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+/cryptoKeyVersions/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}/cryptoKeyVersions/{cryptoKeyVersionsId}:restore",
+ "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."
+ },
+ "patch": {
+ "path": "v1/{+name}",
+ "id": "cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.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}"
+ },
+ "get": {
+ "response": {
+ "$ref": "CryptoKeyVersion"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The name of the CryptoKeyVersion to get.",
+ "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.get",
+ "description": "Returns metadata for a given CryptoKeyVersion."
+ },
+ "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": {
+ "description": "Optional pagination token, returned earlier via\nListCryptoKeyVersionsResponse.next_page_token.",
+ "type": "string",
+ "location": "query"
+ },
+ "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": {
+ "request": {
+ "$ref": "CryptoKeyVersion"
+ },
+ "description": "Create a new CryptoKeyVersion in a CryptoKey.\n\nThe server will assign the next sequential id. If unset,\nstate will be set to\nENABLED.",
+ "response": {
+ "$ref": "CryptoKeyVersion"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "parent": {
+ "description": "Required. The name of the CryptoKey associated with\nthe CryptoKeyVersions.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}/cryptoKeyVersions",
+ "path": "v1/{+parent}/cryptoKeyVersions",
+ "id": "cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.create"
+ },
+ "destroy": {
+ "response": {
+ "$ref": "CryptoKeyVersion"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "name": {
+ "description": "The resource name of the CryptoKeyVersion to destroy.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+/cryptoKeyVersions/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}/cryptoKeyVersions/{cryptoKeyVersionsId}:destroy",
+ "path": "v1/{+name}:destroy",
+ "id": "cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.destroy",
+ "request": {
+ "$ref": "DestroyCryptoKeyVersionRequest"
+ },
+ "description": "Schedule a CryptoKeyVersion for destruction.\n\nUpon calling this method, CryptoKeyVersion.state will be set to\nDESTROY_SCHEDULED\nand destroy_time will be set to a time 24\nhours in the future, at which point the state\nwill be changed to\nDESTROYED, and the key\nmaterial will be irrevocably destroyed.\n\nBefore the destroy_time is reached,\nRestoreCryptoKeyVersion may be called to reverse the process."
+ }
+ }
+ }
+ },
+ "methods": {
+ "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": {
+ "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$",
+ "location": "path",
+ "description": "The resource name of the CryptoKey to update.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}:updatePrimaryVersion",
+ "path": "v1/{+name}:updatePrimaryVersion",
+ "id": "cloudkms.projects.locations.keyRings.cryptoKeys.updatePrimaryVersion"
+ },
+ "getIamPolicy": {
+ "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.",
+ "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"
+ ]
+ },
+ "patch": {
+ "response": {
+ "$ref": "CryptoKey"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "PATCH",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "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"
+ },
+ "updateMask": {
+ "location": "query",
+ "description": "Required list of fields to be updated in this request.",
+ "format": "google-fieldmask",
+ "type": "string"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}",
+ "path": "v1/{+name}",
+ "id": "cloudkms.projects.locations.keyRings.cryptoKeys.patch",
+ "description": "Update a CryptoKey.",
+ "request": {
+ "$ref": "CryptoKey"
+ }
+ },
+ "get": {
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}",
+ "path": "v1/{+name}",
+ "id": "cloudkms.projects.locations.keyRings.cryptoKeys.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": {
+ "description": "The name of the CryptoKey to get.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$",
+ "location": "path"
+ }
+ }
+ },
+ "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": {
+ "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"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}:testIamPermissions",
+ "path": "v1/{+resource}:testIamPermissions",
+ "id": "cloudkms.projects.locations.keyRings.cryptoKeys.testIamPermissions"
+ },
+ "decrypt": {
+ "response": {
+ "$ref": "DecryptResponse"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "description": "Required. The resource name of the CryptoKey to use for decryption.\nThe server will choose the appropriate version.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}:decrypt",
+ "path": "v1/{+name}:decrypt",
+ "id": "cloudkms.projects.locations.keyRings.cryptoKeys.decrypt",
+ "description": "Decrypts data that was protected by Encrypt.",
+ "request": {
+ "$ref": "DecryptRequest"
+ }
+ },
+ "list": {
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "parent"
+ ],
+ "response": {
+ "$ref": "ListCryptoKeysResponse"
+ },
+ "parameters": {
+ "parent": {
+ "description": "Required. The resource name of the KeyRing to list, in the format\n`projects/*/locations/*/keyRings/*`.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+$",
+ "location": "path"
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "Optional pagination token, returned earlier via\nListCryptoKeysResponse.next_page_token.",
+ "type": "string"
+ },
+ "pageSize": {
+ "location": "query",
+ "description": "Optional limit on the number of CryptoKeys to include in the\nresponse. Further CryptoKeys can subsequently be obtained by\nincluding the ListCryptoKeysResponse.next_page_token in a subsequent\nrequest. If unspecified, the server will pick an appropriate default.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys",
+ "id": "cloudkms.projects.locations.keyRings.cryptoKeys.list",
+ "path": "v1/{+parent}/cryptoKeys",
+ "description": "Lists 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": {
+ "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"
+ },
+ "create": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "parent"
+ ],
+ "response": {
+ "$ref": "CryptoKey"
+ },
+ "parameters": {
+ "parent": {
+ "description": "Required. The name of the KeyRing associated with the\nCryptoKeys.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+$",
+ "location": "path"
+ },
+ "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"
+ }
+ },
+ "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."
+ },
+ "setIamPolicy": {
+ "id": "cloudkms.projects.locations.keyRings.cryptoKeys.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": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}:setIamPolicy"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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": {
+ "description": "OAuth access token.",
+ "type": "string",
+ "location": "query"
+ },
+ "key": {
+ "location": "query",
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "type": "string"
+ },
+ "quotaUser": {
+ "location": "query",
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "type": "string"
+ },
+ "pp": {
+ "description": "Pretty-print response.",
+ "type": "boolean",
+ "default": "true",
+ "location": "query"
+ },
+ "oauth_token": {
+ "location": "query",
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string"
+ },
+ "bearer_token": {
+ "description": "OAuth bearer token.",
+ "type": "string",
+ "location": "query"
+ },
+ "upload_protocol": {
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "type": "string",
+ "location": "query"
+ },
+ "prettyPrint": {
+ "location": "query",
+ "description": "Returns response with indentations and line breaks.",
+ "type": "boolean",
+ "default": "true"
+ },
+ "uploadType": {
+ "location": "query",
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string"
+ },
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
+ "type": "string",
+ "location": "query"
+ },
+ "$.xgafv": {
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query",
+ "enum": [
+ "1",
+ "2"
+ ],
+ "description": "V1 error format.",
+ "type": "string"
+ },
+ "callback": {
+ "description": "JSONP",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "version": "v1",
+ "baseUrl": "https://cloudkms.googleapis.com/",
+ "description": "Manages encryption for your cloud services the same way you do on-premises. You can generate, use, rotate, and destroy AES256 encryption keys.",
+ "kind": "discovery#restDescription",
+ "servicePath": "",
+ "basePath": "",
+ "revision": "20171218",
+ "documentationLink": "https://cloud.google.com/kms/",
+ "id": "cloudkms:v1",
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
- "CryptoKey": {
- "description": "A CryptoKey represents a logical key that can be used for cryptographic\noperations.\n\nA CryptoKey is made up of one or more versions, which\nrepresent the actual key material used in cryptographic operations.",
- "type": "object",
- "properties": {
- "labels": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "Labels with user-defined metadata. For more information, see\n[Labeling Keys](/kms/docs/labeling-keys).",
- "type": "object"
- },
- "createTime": {
- "description": "Output only. The time at which this CryptoKey was created.",
- "format": "google-datetime",
- "type": "string"
- },
- "rotationPeriod": {
- "description": "next_rotation_time will be advanced by this period when the service\nautomatically rotates a key. Must be at least one day.\n\nIf rotation_period is set, next_rotation_time must also be set.",
- "format": "google-duration",
- "type": "string"
- },
- "primary": {
- "description": "Output only. A copy of the \"primary\" CryptoKeyVersion that will be used\nby Encrypt when this CryptoKey is given\nin EncryptRequest.name.\n\nThe CryptoKey's primary version can be updated via\nUpdateCryptoKeyPrimaryVersion.",
- "$ref": "CryptoKeyVersion"
- },
- "name": {
- "description": "Output only. The resource name for this CryptoKey in the format\n`projects/*/locations/*/keyRings/*/cryptoKeys/*`.",
- "type": "string"
- },
- "purpose": {
- "description": "The immutable purpose of this CryptoKey. Currently, the only acceptable\npurpose is ENCRYPT_DECRYPT.",
- "type": "string",
- "enumDescriptions": [
- "Not specified.",
- "CryptoKeys with this purpose may be used with\nEncrypt and\nDecrypt."
- ],
- "enum": [
- "CRYPTO_KEY_PURPOSE_UNSPECIFIED",
- "ENCRYPT_DECRYPT"
- ]
- },
- "nextRotationTime": {
- "description": "At next_rotation_time, the Key Management Service will automatically:\n\n1. Create a new version of this CryptoKey.\n2. Mark the new version as primary.\n\nKey rotations performed manually via\nCreateCryptoKeyVersion and\nUpdateCryptoKeyPrimaryVersion\ndo not affect next_rotation_time.",
- "format": "google-datetime",
- "type": "string"
- }
- },
- "id": "CryptoKey"
- },
- "DecryptResponse": {
- "description": "Response message for KeyManagementService.Decrypt.",
- "type": "object",
- "properties": {
- "plaintext": {
- "description": "The decrypted data originally supplied in EncryptRequest.plaintext.",
- "format": "byte",
- "type": "string"
- }
- },
- "id": "DecryptResponse"
- },
- "TestIamPermissionsRequest": {
- "description": "Request message for `TestIamPermissions` method.",
- "type": "object",
- "properties": {
- "permissions": {
- "description": "The set of permissions to check for the `resource`. Permissions with\nwildcards (such as '*' or 'storage.*') are not allowed. For more\ninformation see\n[IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).",
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "id": "TestIamPermissionsRequest"
- },
- "EncryptResponse": {
- "properties": {
- "ciphertext": {
- "description": "The encrypted data.",
- "format": "byte",
- "type": "string"
- },
- "name": {
- "description": "The resource name of the CryptoKeyVersion used in encryption.",
- "type": "string"
- }
- },
- "id": "EncryptResponse",
- "description": "Response message for KeyManagementService.Encrypt.",
- "type": "object"
- },
- "KeyRing": {
- "description": "A KeyRing is a toplevel logical grouping of CryptoKeys.",
- "type": "object",
- "properties": {
- "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"
- }
- },
- "id": "KeyRing"
- },
- "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"
- },
- "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"
- },
"UpdateCryptoKeyPrimaryVersionRequest": {
"description": "Request message for KeyManagementService.UpdateCryptoKeyPrimaryVersion.",
"type": "object",
@@ -173,15 +868,22 @@
"id": "UpdateCryptoKeyPrimaryVersionRequest"
},
"RestoreCryptoKeyVersionRequest": {
- "properties": {},
- "id": "RestoreCryptoKeyVersionRequest",
"description": "Request message for KeyManagementService.RestoreCryptoKeyVersion.",
- "type": "object"
+ "type": "object",
+ "properties": {},
+ "id": "RestoreCryptoKeyVersionRequest"
},
"ListKeyRingsResponse": {
"description": "Response message for KeyManagementService.ListKeyRings.",
"type": "object",
"properties": {
+ "keyRings": {
+ "description": "The list of KeyRings.",
+ "type": "array",
+ "items": {
+ "$ref": "KeyRing"
+ }
+ },
"nextPageToken": {
"description": "A token to retrieve next page of results. Pass this value in\nListKeyRingsRequest.page_token to retrieve the next page of results.",
"type": "string"
@@ -190,18 +892,13 @@
"description": "The total number of KeyRings that matched the query.",
"format": "int32",
"type": "integer"
- },
- "keyRings": {
- "description": "The list of KeyRings.",
- "type": "array",
- "items": {
- "$ref": "KeyRing"
- }
}
},
"id": "ListKeyRingsResponse"
},
"AuditConfig": {
+ "description": "Specifies the audit configuration for a service.\nThe configuration determines which permission types are logged, and what\nidentities, if any, are exempted from logging.\nAn AuditConfig must have one or more AuditLogConfigs.\n\nIf there are AuditConfigs for both `allServices` and a specific service,\nthe union of the two AuditConfigs is used for that service: the log_types\nspecified in each AuditConfig are enabled, and the exempted_members in each\nAuditConfig are exempted.\n\nExample Policy with multiple AuditConfigs:\n\n {\n \"audit_configs\": [\n {\n \"service\": \"allServices\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n },\n {\n \"log_type\": \"ADMIN_READ\",\n }\n ]\n },\n {\n \"service\": \"fooservice.googleapis.com\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n },\n {\n \"log_type\": \"DATA_WRITE\",\n \"exempted_members\": [\n \"user:bar@gmail.com\"\n ]\n }\n ]\n }\n ]\n }\n\nFor fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ\nlogging. It also exempts foo@gmail.com from DATA_READ logging, and\nbar@gmail.com from DATA_WRITE logging.",
+ "type": "object",
"properties": {
"exemptedMembers": {
"type": "array",
@@ -221,41 +918,12 @@
}
}
},
- "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"
+ "id": "AuditConfig"
},
"CryptoKeyVersion": {
"description": "A CryptoKeyVersion represents an individual cryptographic key, and the\nassociated key material.\n\nIt can be used for cryptographic operations either directly, or via its\nparent CryptoKey, in which case the server will choose the appropriate\nversion for the operation.\n\nFor security reasons, the raw cryptographic key material represented by a\nCryptoKeyVersion can never be viewed or exported. It can only be used to\nencrypt or decrypt data when an authorized user or application invokes Cloud\nKMS.",
"type": "object",
"properties": {
- "createTime": {
- "description": "Output only. The time at which this CryptoKeyVersion was created.",
- "format": "google-datetime",
- "type": "string"
- },
- "state": {
- "enumDescriptions": [
- "Not specified.",
- "This version may be used in Encrypt and\nDecrypt requests.",
- "This version may not be used, but the key material is still available,\nand the version can be placed back into the ENABLED state.",
- "This version is destroyed, and the key material is no longer stored.\nA version may not leave this state once entered.",
- "This version is scheduled for destruction, and will be destroyed soon.\nCall\nRestoreCryptoKeyVersion\nto put it back into the DISABLED state."
- ],
- "enum": [
- "CRYPTO_KEY_VERSION_STATE_UNSPECIFIED",
- "ENABLED",
- "DISABLED",
- "DESTROYED",
- "DESTROY_SCHEDULED"
- ],
- "description": "The current state of the CryptoKeyVersion.",
- "type": "string"
- },
- "name": {
- "description": "Output only. The resource name for this CryptoKeyVersion in the format\n`projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`.",
- "type": "string"
- },
"destroyEventTime": {
"description": "Output only. The time this CryptoKeyVersion's key material was\ndestroyed. Only present if state is\nDESTROYED.",
"format": "google-datetime",
@@ -265,20 +933,47 @@
"description": "Output only. The time this CryptoKeyVersion's key material is scheduled\nfor destruction. Only present if state is\nDESTROY_SCHEDULED.",
"format": "google-datetime",
"type": "string"
+ },
+ "createTime": {
+ "description": "Output only. The time at which this CryptoKeyVersion was created.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "state": {
+ "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"
}
},
"id": "CryptoKeyVersion"
},
"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"
+ },
+ "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",
@@ -306,10 +1001,6 @@
"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",
@@ -320,6 +1011,10 @@
"role": {
"description": "Role that is assigned to `members`.\nFor example, `roles/viewer`, `roles/editor`, or `roles/owner`.\nRequired",
"type": "string"
+ },
+ "condition": {
+ "$ref": "Expr",
+ "description": "The condition that is associated with this binding.\nNOTE: an unsatisfied condition will not allow user access via current\nbinding. Different bindings, including their conditions, are examined\nindependently.\nThis field is GOOGLE_INTERNAL."
}
},
"id": "Binding"
@@ -348,8 +1043,6 @@
"id": "Expr"
},
"EncryptRequest": {
- "description": "Request message for KeyManagementService.Encrypt.",
- "type": "object",
"properties": {
"additionalAuthenticatedData": {
"description": "Optional data that, if specified, must also be provided during decryption\nthrough DecryptRequest.additional_authenticated_data. Must be no\nlarger than 64KiB.",
@@ -362,9 +1055,13 @@
"type": "string"
}
},
- "id": "EncryptRequest"
+ "id": "EncryptRequest",
+ "description": "Request message for KeyManagementService.Encrypt.",
+ "type": "object"
},
"ListCryptoKeyVersionsResponse": {
+ "description": "Response message for KeyManagementService.ListCryptoKeyVersions.",
+ "type": "object",
"properties": {
"nextPageToken": {
"description": "A token to retrieve next page of results. Pass this value in\nListCryptoKeyVersionsRequest.page_token to retrieve the next page of\nresults.",
@@ -383,13 +1080,9 @@
}
}
},
- "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": {
"description": "Cross-service attributes for the location. For example\n\n {\"cloud.googleapis.com/region\": \"us-east1\"}",
@@ -407,15 +1100,17 @@
"type": "string"
},
"metadata": {
- "description": "Service-specific metadata. For example the available capacity at the given\nlocation.",
- "type": "object",
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
- }
+ },
+ "description": "Service-specific metadata. For example the available capacity at the given\nlocation.",
+ "type": "object"
}
},
- "id": "Location"
+ "id": "Location",
+ "description": "A resource that represents Google Cloud Platform location.",
+ "type": "object"
},
"ListCryptoKeysResponse": {
"description": "Response message for KeyManagementService.ListCryptoKeys.",
@@ -455,16 +1150,29 @@
"id": "TestIamPermissionsResponse"
},
"DestroyCryptoKeyVersionRequest": {
- "description": "Request message for KeyManagementService.DestroyCryptoKeyVersion.",
- "type": "object",
"properties": {},
- "id": "DestroyCryptoKeyVersionRequest"
+ "id": "DestroyCryptoKeyVersionRequest",
+ "description": "Request message for KeyManagementService.DestroyCryptoKeyVersion.",
+ "type": "object"
},
"AuditLogConfig": {
"description": "Provides the configuration for logging a type of permissions.\nExample:\n\n {\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n }\n ]\n }\n\nThis enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting\nfoo@gmail.com from DATA_READ logging.",
"type": "object",
"properties": {
+ "exemptedMembers": {
+ "description": "Specifies the identities that do not cause logging for this type of\npermission.\nFollows the same format of Binding.members.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
"logType": {
+ "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",
@@ -472,882 +1180,174 @@
"DATA_READ"
],
"description": "The log type that this config enables.",
+ "type": "string"
+ }
+ },
+ "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": [
- "Default case. Should never be this.",
- "Admin reads. Example: CloudIAM getIamPolicy",
- "Data writes. Example: CloudSQL Users create",
- "Data reads. Example: CloudSQL Users list"
+ "Not specified.",
+ "CryptoKeys with this purpose may be used with\nEncrypt and\nDecrypt."
+ ],
+ "enum": [
+ "CRYPTO_KEY_PURPOSE_UNSPECIFIED",
+ "ENCRYPT_DECRYPT"
]
},
- "exemptedMembers": {
- "description": "Specifies the identities that do not cause logging for this type of\npermission.\nFollows the same format of Binding.members.",
+ "nextRotationTime": {
+ "description": "At next_rotation_time, the Key Management Service will automatically:\n\n1. Create a new version of this CryptoKey.\n2. Mark the new version as primary.\n\nKey rotations performed manually via\nCreateCryptoKeyVersion and\nUpdateCryptoKeyPrimaryVersion\ndo not affect next_rotation_time.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "labels": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Labels with user-defined metadata. For more information, see\n[Labeling Keys](/kms/docs/labeling-keys).",
+ "type": "object"
+ },
+ "createTime": {
+ "description": "Output only. The time at which this CryptoKey was created.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "rotationPeriod": {
+ "description": "next_rotation_time will be advanced by this period when the service\nautomatically rotates a key. Must be at least one day.\n\nIf rotation_period is set, next_rotation_time must also be set.",
+ "format": "google-duration",
+ "type": "string"
+ },
+ "primary": {
+ "description": "Output only. A copy of the \"primary\" CryptoKeyVersion that will be used\nby Encrypt when this CryptoKey is given\nin EncryptRequest.name.\n\nThe CryptoKey's primary version can be updated via\nUpdateCryptoKeyPrimaryVersion.",
+ "$ref": "CryptoKeyVersion"
+ },
+ "name": {
+ "description": "Output only. The resource name for this CryptoKey in the format\n`projects/*/locations/*/keyRings/*/cryptoKeys/*`.",
+ "type": "string"
+ }
+ },
+ "id": "CryptoKey"
+ },
+ "DecryptResponse": {
+ "description": "Response message for KeyManagementService.Decrypt.",
+ "type": "object",
+ "properties": {
+ "plaintext": {
+ "description": "The decrypted data originally supplied in EncryptRequest.plaintext.",
+ "format": "byte",
+ "type": "string"
+ }
+ },
+ "id": "DecryptResponse"
+ },
+ "TestIamPermissionsRequest": {
+ "description": "Request message for `TestIamPermissions` method.",
+ "type": "object",
+ "properties": {
+ "permissions": {
+ "description": "The set of permissions to check for the `resource`. Permissions with\nwildcards (such as '*' or 'storage.*') are not allowed. For more\ninformation see\n[IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).",
"type": "array",
"items": {
"type": "string"
}
}
},
- "id": "AuditLogConfig"
+ "id": "TestIamPermissionsRequest"
+ },
+ "EncryptResponse": {
+ "properties": {
+ "name": {
+ "description": "The resource name of the CryptoKeyVersion used in encryption.",
+ "type": "string"
+ },
+ "ciphertext": {
+ "description": "The encrypted data.",
+ "format": "byte",
+ "type": "string"
+ }
+ },
+ "id": "EncryptResponse",
+ "description": "Response message for KeyManagementService.Encrypt.",
+ "type": "object"
+ },
+ "KeyRing": {
+ "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"
+ }
+ },
+ "id": "KeyRing",
+ "description": "A KeyRing is a toplevel logical grouping of CryptoKeys.",
+ "type": "object"
+ },
+ "ListLocationsResponse": {
+ "description": "The response message for Locations.ListLocations.",
+ "type": "object",
+ "properties": {
+ "locations": {
+ "description": "A list of locations that matches the specified filter in the request.",
+ "type": "array",
+ "items": {
+ "$ref": "Location"
+ }
+ },
+ "nextPageToken": {
+ "description": "The standard List next-page token.",
+ "type": "string"
+ }
+ },
+ "id": "ListLocationsResponse"
+ },
+ "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"
}
},
"icons": {
"x32": "http://www.google.com/images/icons/product/search-32.gif",
"x16": "http://www.google.com/images/icons/product/search-16.gif"
},
- "protocol": "rest",
- "canonicalName": "Cloud KMS",
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/cloud-platform": {
- "description": "View and manage your data across Google Cloud Platform services"
- }
- }
- }
- },
- "rootUrl": "https://cloudkms.googleapis.com/",
- "ownerDomain": "google.com",
- "name": "cloudkms",
- "batchPath": "batch",
- "title": "Google Cloud Key Management Service (KMS) API",
- "ownerName": "Google",
- "resources": {
- "projects": {
- "resources": {
- "locations": {
- "methods": {
- "list": {
- "response": {
- "$ref": "ListLocationsResponse"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "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"
- },
- "filter": {
- "description": "The standard list filter.",
- "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": {
- "response": {
- "$ref": "Location"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "location": "path",
- "description": "Resource name for the location.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+$"
- }
- },
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}",
- "path": "v1/{+name}",
- "id": "cloudkms.projects.locations.get",
- "description": "Get information about a location."
- }
- },
- "resources": {
- "keyRings": {
- "resources": {
- "cryptoKeys": {
- "resources": {
- "cryptoKeyVersions": {
- "methods": {
- "list": {
- "description": "Lists CryptoKeyVersions.",
- "response": {
- "$ref": "ListCryptoKeyVersionsResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "GET",
- "parameters": {
- "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"
- },
- "pageToken": {
- "description": "Optional pagination token, returned earlier via\nListCryptoKeyVersionsResponse.next_page_token.",
- "type": "string",
- "location": "query"
- },
- "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"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}/cryptoKeyVersions",
- "path": "v1/{+parent}/cryptoKeyVersions",
- "id": "cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.list"
- },
- "destroy": {
- "response": {
- "$ref": "CryptoKeyVersion"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "POST",
- "parameters": {
- "name": {
- "description": "The resource name of the CryptoKeyVersion to destroy.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+/cryptoKeyVersions/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}/cryptoKeyVersions/{cryptoKeyVersionsId}:destroy",
- "path": "v1/{+name}:destroy",
- "id": "cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.destroy",
- "request": {
- "$ref": "DestroyCryptoKeyVersionRequest"
- },
- "description": "Schedule a CryptoKeyVersion for destruction.\n\nUpon calling this method, CryptoKeyVersion.state will be set to\nDESTROY_SCHEDULED\nand destroy_time will be set to a time 24\nhours in the future, at which point the state\nwill be changed to\nDESTROYED, and the key\nmaterial will be irrevocably destroyed.\n\nBefore the destroy_time is reached,\nRestoreCryptoKeyVersion may be called to reverse the process."
- },
- "create": {
- "response": {
- "$ref": "CryptoKeyVersion"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "POST",
- "parameters": {
- "parent": {
- "description": "Required. The name of the CryptoKey associated with\nthe CryptoKeyVersions.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}/cryptoKeyVersions",
- "path": "v1/{+parent}/cryptoKeyVersions",
- "id": "cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.create",
- "request": {
- "$ref": "CryptoKeyVersion"
- },
- "description": "Create a new CryptoKeyVersion in a CryptoKey.\n\nThe server will assign the next sequential id. If unset,\nstate will be set to\nENABLED."
- },
- "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": {
- "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",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "description": "The name of the CryptoKeyVersion to get.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+/cryptoKeyVersions/[^/]+$",
- "location": "path"
- }
- }
- },
- "patch": {
- "description": "Update a CryptoKeyVersion's metadata.\n\nstate may be changed between\nENABLED and\nDISABLED using this\nmethod. See DestroyCryptoKeyVersion and RestoreCryptoKeyVersion to\nmove between other states.",
- "request": {
- "$ref": "CryptoKeyVersion"
- },
- "response": {
- "$ref": "CryptoKeyVersion"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "PATCH",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "updateMask": {
- "description": "Required list of fields to be updated in this request.",
- "format": "google-fieldmask",
- "type": "string",
- "location": "query"
- },
- "name": {
- "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": {
- "testIamPermissions": {
- "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/[^/]+/cryptoKeys/[^/]+$"
- }
- },
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}:testIamPermissions",
- "path": "v1/{+resource}:testIamPermissions",
- "id": "cloudkms.projects.locations.keyRings.cryptoKeys.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"
- }
- },
- "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": {
- "description": "Required. The resource name of the CryptoKey to use for decryption.\nThe server will choose the appropriate version.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}:decrypt",
- "path": "v1/{+name}:decrypt",
- "id": "cloudkms.projects.locations.keyRings.cryptoKeys.decrypt"
- },
- "list": {
- "description": "Lists CryptoKeys.",
- "response": {
- "$ref": "ListCryptoKeysResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "GET",
- "parameters": {
- "pageSize": {
- "location": "query",
- "description": "Optional limit on the number of CryptoKeys to include in the\nresponse. Further CryptoKeys can subsequently be obtained by\nincluding the ListCryptoKeysResponse.next_page_token in a subsequent\nrequest. If unspecified, the server will pick an appropriate default.",
- "format": "int32",
- "type": "integer"
- },
- "parent": {
- "description": "Required. The resource name of the KeyRing to list, in the format\n`projects/*/locations/*/keyRings/*`.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+$",
- "location": "path"
- },
- "pageToken": {
- "location": "query",
- "description": "Optional pagination token, returned earlier via\nListCryptoKeysResponse.next_page_token.",
- "type": "string"
- }
- },
- "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"
- },
- "encrypt": {
- "response": {
- "$ref": "EncryptResponse"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "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"
- }
- },
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}:encrypt",
- "path": "v1/{+name}:encrypt",
- "id": "cloudkms.projects.locations.keyRings.cryptoKeys.encrypt",
- "description": "Encrypts data, so that it can only be recovered by a call to Decrypt.",
- "request": {
- "$ref": "EncryptRequest"
- }
- },
- "setIamPolicy": {
- "id": "cloudkms.projects.locations.keyRings.cryptoKeys.setIamPolicy",
- "path": "v1/{+resource}:setIamPolicy",
- "request": {
- "$ref": "SetIamPolicyRequest"
- },
- "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.",
- "httpMethod": "POST",
- "parameterOrder": [
- "resource"
- ],
- "response": {
- "$ref": "Policy"
- },
- "parameters": {
- "resource": {
- "location": "path",
- "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}:setIamPolicy"
- },
- "create": {
- "path": "v1/{+parent}/cryptoKeys",
- "id": "cloudkms.projects.locations.keyRings.cryptoKeys.create",
- "request": {
- "$ref": "CryptoKey"
- },
- "description": "Create a new CryptoKey within a KeyRing.\n\nCryptoKey.purpose is required.",
- "response": {
- "$ref": "CryptoKey"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "POST",
- "parameters": {
- "cryptoKeyId": {
- "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"
- },
- "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": {
- "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",
- "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": {
- "location": "path",
- "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/[^/]+$"
- }
- },
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}",
- "path": "v1/{+name}",
- "id": "cloudkms.projects.locations.keyRings.cryptoKeys.patch"
- },
- "get": {
- "response": {
- "$ref": "CryptoKey"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "parameters": {
- "name": {
- "location": "path",
- "description": "The name of the CryptoKey to get.",
- "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}",
- "path": "v1/{+name}",
- "id": "cloudkms.projects.locations.keyRings.cryptoKeys.get",
- "description": "Returns metadata for a given CryptoKey, as well as its\nprimary CryptoKeyVersion."
- }
- }
- }
- },
- "methods": {
- "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.",
- "response": {
- "$ref": "TestIamPermissionsResponse"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
- "parameters": {
- "resource": {
- "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}:testIamPermissions"
- },
- "list": {
- "path": "v1/{+parent}/keyRings",
- "id": "cloudkms.projects.locations.keyRings.list",
- "description": "Lists KeyRings.",
- "response": {
- "$ref": "ListKeyRingsResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "GET",
- "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"
- },
- "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"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings"
- },
- "create": {
- "response": {
- "$ref": "KeyRing"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "parent": {
- "location": "path",
- "description": "Required. The resource name of the location associated with the\nKeyRings, in the format `projects/*/locations/*`.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+$"
- },
- "keyRingId": {
- "description": "Required. It must be unique within a location and match the regular\nexpression `[a-zA-Z0-9_-]{1,63}`",
- "type": "string",
- "location": "query"
- }
- },
- "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": {
- "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"
- },
- "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"
- }
- }
- },
- "getIamPolicy": {
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}:getIamPolicy",
- "path": "v1/{+resource}:getIamPolicy",
- "id": "cloudkms.projects.locations.keyRings.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/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- },
- "get": {
- "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",
- "description": "Returns metadata for a given KeyRing."
- }
- }
- }
- }
- }
- }
- }
- },
- "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"
- },
- "oauth_token": {
- "description": "OAuth 2.0 token for the current user.",
- "type": "string",
- "location": "query"
- },
- "bearer_token": {
- "description": "OAuth bearer token.",
- "type": "string",
- "location": "query"
- },
- "upload_protocol": {
- "location": "query",
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string"
- },
- "prettyPrint": {
- "description": "Returns response with indentations and line breaks.",
- "type": "boolean",
- "default": "true",
- "location": "query"
- },
- "uploadType": {
- "location": "query",
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string"
- },
- "fields": {
- "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"
- }
- },
- "version": "v1",
- "baseUrl": "https://cloudkms.googleapis.com/",
- "servicePath": "",
- "description": "Manages encryption for your cloud services the same way you do on-premises. You can generate, use, rotate, and destroy AES256 encryption keys.",
- "kind": "discovery#restDescription",
- "basePath": "",
- "revision": "20171218",
- "documentationLink": "https://cloud.google.com/kms/",
- "id": "cloudkms:v1"
+ "protocol": "rest"
}
diff --git a/cloudresourcemanager/v1/cloudresourcemanager-api.json b/cloudresourcemanager/v1/cloudresourcemanager-api.json
index a2d1084..d156986 100644
--- a/cloudresourcemanager/v1/cloudresourcemanager-api.json
+++ b/cloudresourcemanager/v1/cloudresourcemanager-api.json
@@ -1,321 +1,12 @@
{
+ "discoveryVersion": "v1",
"schemas": {
- "Constraint": {
- "description": "A `Constraint` describes a way in which a resource's configuration can be\nrestricted. For example, it controls which cloud services can be activated\nacross an organization, or whether a Compute Engine instance can have\nserial port connections established. `Constraints` can be configured by the\norganization's policy adminstrator to fit the needs of the organzation by\nsetting Policies for `Constraints` at different locations in the\norganization's resource hierarchy. Policies are inherited down the resource\nhierarchy from higher levels, but can also be overridden. For details about\nthe inheritance rules please read about\nPolicies.\n\n`Constraints` have a default behavior determined by the `constraint_default`\nfield, which is the enforcement behavior that is used in the absence of a\n`Policy` being defined or inherited for the resource in question.",
- "type": "object",
- "properties": {
- "displayName": {
- "description": "The human readable name.\n\nMutable.",
- "type": "string"
- },
- "description": {
- "description": "Detailed description of what this `Constraint` controls as well as how and\nwhere it is enforced.\n\nMutable.",
- "type": "string"
- },
- "booleanConstraint": {
- "description": "Defines this constraint as being a BooleanConstraint.",
- "$ref": "BooleanConstraint"
- },
- "constraintDefault": {
- "description": "The evaluation behavior of this constraint in the absense of 'Policy'.",
- "type": "string",
- "enumDescriptions": [
- "This is only used for distinguishing unset values and should never be\nused.",
- "Indicate that all values are allowed for list constraints.\nIndicate that enforcement is off for boolean constraints.",
- "Indicate that all values are denied for list constraints.\nIndicate that enforcement is on for boolean constraints."
- ],
- "enum": [
- "CONSTRAINT_DEFAULT_UNSPECIFIED",
- "ALLOW",
- "DENY"
- ]
- },
- "name": {
- "description": "Immutable value, required to globally be unique. For example,\n`constraints/serviceuser.services`",
- "type": "string"
- },
- "listConstraint": {
- "description": "Defines this constraint as being a ListConstraint.",
- "$ref": "ListConstraint"
- },
- "version": {
- "description": "Version of the `Constraint`. Default version is 0;",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "Constraint"
- },
- "ListLiensResponse": {
- "description": "The response message for Liens.ListLiens.",
- "type": "object",
- "properties": {
- "nextPageToken": {
- "description": "Token to retrieve the next page of results, or empty if there are no more\nresults in the list.",
- "type": "string"
- },
- "liens": {
- "description": "A list of Liens.",
- "type": "array",
- "items": {
- "$ref": "Lien"
- }
- }
- },
- "id": "ListLiensResponse"
- },
- "Status": {
- "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
- "type": "object",
- "properties": {
- "details": {
- "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.",
- "type": "array",
- "items": {
- "type": "object",
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- }
- }
- },
- "code": {
- "description": "The status code, which should be an enum value of google.rpc.Code.",
- "format": "int32",
- "type": "integer"
- },
- "message": {
- "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
- "type": "string"
- }
- },
- "id": "Status"
- },
- "Binding": {
- "description": "Associates `members` with a `role`.",
- "type": "object",
- "properties": {
- "members": {
- "description": "Specifies the identities requesting access for a Cloud Platform resource.\n`members` can have the following values:\n\n* `allUsers`: A special identifier that represents anyone who is\n on the internet; with or without a Google account.\n\n* `allAuthenticatedUsers`: A special identifier that represents anyone\n who is authenticated with a Google account or a service account.\n\n* `user:{emailid}`: An email address that represents a specific Google\n account. For example, `alice@gmail.com` or `joe@example.com`.\n\n\n* `serviceAccount:{emailid}`: An email address that represents a service\n account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{emailid}`: An email address that represents a Google group.\n For example, `admins@example.com`.\n\n\n* `domain:{domain}`: A Google Apps domain name that represents all the\n users of that domain. For example, `google.com` or `example.com`.\n\n",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "role": {
- "description": "Role that is assigned to `members`.\nFor example, `roles/viewer`, `roles/editor`, or `roles/owner`.\nRequired",
- "type": "string"
- }
- },
- "id": "Binding"
- },
- "GetOrgPolicyRequest": {
- "description": "The request sent to the GetOrgPolicy method.",
- "type": "object",
- "properties": {
- "constraint": {
- "description": "Name of the `Constraint` to get the `Policy`.",
- "type": "string"
- }
- },
- "id": "GetOrgPolicyRequest"
- },
- "RestoreDefault": {
- "description": "Ignores policies set above this resource and restores the\n`constraint_default` enforcement behavior of the specific `Constraint` at\nthis resource.\n\nSuppose that `constraint_default` is set to `ALLOW` for the\n`Constraint` `constraints/serviceuser.services`. Suppose that organization\nfoo.com sets a `Policy` at their Organization resource node that restricts\nthe allowed service activations to deny all service activations. They\ncould then set a `Policy` with the `policy_type` `restore_default` on\nseveral experimental projects, restoring the `constraint_default`\nenforcement of the `Constraint` for only those projects, allowing those\nprojects to have all services activated.",
- "type": "object",
- "properties": {},
- "id": "RestoreDefault"
- },
- "ClearOrgPolicyRequest": {
- "description": "The request sent to the ClearOrgPolicy method.",
- "type": "object",
- "properties": {
- "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": {
- "description": "A status object which is used as the `metadata` field for the Operation\nreturned by CreateProject. It provides insight for when significant phases of\nProject creation have completed.",
- "type": "object",
- "properties": {
- "ready": {
- "description": "True if the project creation process is complete.",
- "type": "boolean"
- },
- "createTime": {
- "description": "Creation time of the project creation workflow.",
- "format": "google-datetime",
- "type": "string"
- },
- "gettable": {
- "description": "True if the project can be retrieved using GetProject. No other operations\non the project are guaranteed to work until the project creation is\ncomplete.",
- "type": "boolean"
- }
- },
- "id": "ProjectCreationStatus"
- },
- "BooleanConstraint": {
- "description": "A `Constraint` that is either enforced or not.\n\nFor example a constraint `constraints/compute.disableSerialPortAccess`.\nIf it is enforced on a VM instance, serial port connections will not be\nopened to that instance.",
- "type": "object",
- "properties": {},
- "id": "BooleanConstraint"
- },
- "GetIamPolicyRequest": {
- "description": "Request message for `GetIamPolicy` method.",
- "type": "object",
- "properties": {},
- "id": "GetIamPolicyRequest"
- },
- "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"
- },
- "OrganizationOwner": {
- "description": "The entity that owns an Organization. The lifetime of the Organization and\nall of its descendants are bound to the `OrganizationOwner`. If the\n`OrganizationOwner` is deleted, the Organization and all its descendants will\nbe deleted.",
- "type": "object",
- "properties": {
- "directoryCustomerId": {
- "description": "The Google for Work customer id used in the Directory API.",
- "type": "string"
- }
- },
- "id": "OrganizationOwner"
- },
- "ListProjectsResponse": {
- "description": "A page of the response received from the\nListProjects\nmethod.\n\nA paginated response where more pages are available has\n`next_page_token` set. This token can be used in a subsequent request to\nretrieve the next request page.",
- "type": "object",
- "properties": {
- "projects": {
- "description": "The list of Projects that matched the list filter. This list can\nbe paginated.",
- "type": "array",
- "items": {
- "$ref": "Project"
- }
- },
- "nextPageToken": {
- "description": "Pagination token.\n\nIf the result set is too large to fit in a single response, this token\nis returned. It encodes the position of the current result cursor.\nFeeding this value into a new list request with the `page_token` parameter\ngives the next page of the results.\n\nWhen `next_page_token` is not filled in, there is no next page and\nthe list returned is the last page in the result set.\n\nPagination tokens have a limited lifetime.",
- "type": "string"
- }
- },
- "id": "ListProjectsResponse"
- },
- "Project": {
- "description": "A Project is a high-level Google Cloud Platform entity. It is a\ncontainer for ACLs, APIs, App Engine Apps, VMs, and other\nGoogle Cloud Platform resources.",
- "type": "object",
- "properties": {
- "labels": {
- "description": "The labels associated with this Project.\n\nLabel keys must be between 1 and 63 characters long and must conform\nto the following regular expression: \\[a-z\\](\\[-a-z0-9\\]*\\[a-z0-9\\])?.\n\nLabel values must be between 0 and 63 characters long and must conform\nto the regular expression (\\[a-z\\](\\[-a-z0-9\\]*\\[a-z0-9\\])?)?.\n\nNo more than 256 labels can be associated with a given resource.\n\nClients should store labels in a representation such as JSON that does not\ndepend on specific characters being disallowed.\n\nExample: \u003ccode\u003e\"environment\" : \"dev\"\u003c/code\u003e\nRead-write.",
- "type": "object",
- "additionalProperties": {
- "type": "string"
- }
- },
- "createTime": {
- "description": "Creation time.\n\nRead-only.",
- "format": "google-datetime",
- "type": "string"
- },
- "name": {
- "description": "The user-assigned display name of the Project.\nIt must be 4 to 30 characters.\nAllowed characters are: lowercase and uppercase letters, numbers,\nhyphen, single-quote, double-quote, space, and exclamation point.\n\nExample: \u003ccode\u003eMy Project\u003c/code\u003e\nRead-write.",
- "type": "string"
- },
- "projectId": {
- "description": "The unique, user-assigned ID of the Project.\nIt must be 6 to 30 lowercase letters, digits, or hyphens.\nIt must start with a letter.\nTrailing hyphens are prohibited.\n\nExample: \u003ccode\u003etokyo-rain-123\u003c/code\u003e\nRead-only after creation.",
- "type": "string"
- },
- "lifecycleState": {
- "enumDescriptions": [
- "Unspecified state. This is only used/useful for distinguishing\nunset values.",
- "The normal and active state.",
- "The project has been marked for deletion by the user\n(by invoking\nDeleteProject)\nor by the system (Google Cloud Platform).\nThis can generally be reversed by invoking UndeleteProject.",
- "This lifecycle state is no longer used and not returned by the API."
- ],
- "enum": [
- "LIFECYCLE_STATE_UNSPECIFIED",
- "ACTIVE",
- "DELETE_REQUESTED",
- "DELETE_IN_PROGRESS"
- ],
- "description": "The Project lifecycle state.\n\nRead-only.",
- "type": "string"
- },
- "projectNumber": {
- "description": "The number uniquely identifying the project.\n\nExample: \u003ccode\u003e415104041262\u003c/code\u003e\nRead-only.",
- "format": "int64",
- "type": "string"
- },
- "parent": {
- "description": "An optional reference to a parent Resource.\n\nSupported parent types include \"organization\" and \"folder\". Once set, the\nparent cannot be cleared. The `parent` can be set on creation or using the\n`UpdateProject` method; the end user must have the\n`resourcemanager.projects.create` permission on the parent.\n\nRead-write.",
- "$ref": "ResourceId"
- }
- },
- "id": "Project"
- },
- "SearchOrganizationsResponse": {
- "description": "The response returned from the `SearchOrganizations` method.",
- "type": "object",
- "properties": {
- "organizations": {
- "description": "The list of Organizations that matched the search query, possibly\npaginated.",
- "type": "array",
- "items": {
- "$ref": "Organization"
- }
- },
- "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"
- }
- },
- "id": "SearchOrganizationsResponse"
- },
- "ListOrgPoliciesResponse": {
- "description": "The response returned from the ListOrgPolicies method. It will be empty\nif no `Policies` are set on the resource.",
- "type": "object",
- "properties": {
- "policies": {
- "description": "The `Policies` that are set on the resource. It will be empty if no\n`Policies` are set.",
- "type": "array",
- "items": {
- "$ref": "OrgPolicy"
- }
- },
- "nextPageToken": {
- "description": "Page token used to retrieve the next page. This is currently not used, but\nthe server may at any point start supplying a valid token.",
- "type": "string"
- }
- },
- "id": "ListOrgPoliciesResponse"
- },
"FolderOperationError": {
"description": "A classification of the Folder Operation error.",
"type": "object",
"properties": {
"errorMessageId": {
+ "type": "string",
"enumDescriptions": [
"The error type was unrecognized or unspecified.",
"The attempted action would violate the max folder depth constraint.",
@@ -340,23 +31,11 @@
"FOLDER_TO_DELETE_NON_EMPTY_VIOLATION",
"DELETED_FOLDER_HEIGHT_VIOLATION"
],
- "description": "The type of operation error experienced.",
- "type": "string"
+ "description": "The type of operation error experienced."
}
},
"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",
@@ -395,27 +74,21 @@
},
"id": "OrgPolicy"
},
+ "BooleanPolicy": {
+ "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",
+ "description": "Used in `policy_type` to specify how `boolean_policy` will behave at this\nresource.",
+ "type": "object"
+ },
"Lien": {
"description": "A Lien represents an encumbrance on the actions that can be performed on a\nresource.",
"type": "object",
"properties": {
- "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": {
- "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": {
- "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",
@@ -426,28 +99,45 @@
"parent": {
"description": "A reference to the resource this Lien is attached to. The server will\nvalidate the parent against those for which Liens are supported.\n\nExample: `projects/1234`",
"type": "string"
+ },
+ "createTime": {
+ "description": "The creation time of this Lien.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "origin": {
+ "description": "A stable, user-visible/meaningful string identifying the origin of the\nLien, intended to be inspected programmatically. Maximum length of 200\ncharacters.\n\nExample: 'compute.googleapis.com'",
+ "type": "string"
+ },
+ "name": {
+ "description": "A system-generated unique identifier for this Lien.\n\nExample: `liens/1234abcd`",
+ "type": "string"
+ },
+ "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"
}
},
"id": "Lien"
},
"Ancestor": {
- "description": "Identifying information for a single ancestor of a project.",
"type": "object",
"properties": {
"resourceId": {
- "$ref": "ResourceId",
- "description": "Resource id of the ancestor."
+ "description": "Resource id of the ancestor.",
+ "$ref": "ResourceId"
}
},
- "id": "Ancestor"
+ "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"
+ "type": "string",
+ "description": "Optional. The Google Cloud Console will try to default to a configuration\nthat matches the value specified in this `Constraint`."
}
},
"id": "ListConstraint"
@@ -464,20 +154,20 @@
"id": "SetOrgPolicyRequest"
},
"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."
- },
"updateMask": {
+ "type": "string",
"description": "OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only\nthe fields in the mask will be modified. If no mask is provided, the\nfollowing default mask is used:\npaths: \"bindings, etag\"\nThis field is only used by Cloud IAM.",
- "format": "google-fieldmask",
- "type": "string"
+ "format": "google-fieldmask"
+ },
+ "policy": {
+ "description": "REQUIRED: The complete policy to be applied to the `resource`. The size of\nthe policy is limited to a few 10s of KB. An empty policy is a\nvalid policy but certain Cloud Platform services (such as Projects)\nmight reject them.",
+ "$ref": "Policy"
}
- },
- "id": "SetIamPolicyRequest"
+ }
},
"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 `{}`.",
@@ -489,42 +179,41 @@
"description": "The root node in the resource hierarchy to which a particular entity's\n(e.g., company) resources belong.",
"type": "object",
"properties": {
- "displayName": {
- "description": "A friendly string to be used to refer to the Organization in the UI.\nAssigned by the server, set to the primary domain of the G Suite\ncustomer that owns the organization.\n@OutputOnly",
- "type": "string"
- },
"creationTime": {
"description": "Timestamp when the Organization was created. Assigned by the server.\n@OutputOnly",
"format": "google-datetime",
"type": "string"
},
"owner": {
- "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"
+ "$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."
- ],
- "enum": [
- "LIFECYCLE_STATE_UNSPECIFIED",
- "ACTIVE",
- "DELETE_REQUESTED"
]
},
"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": {
+ "description": "A friendly string to be used to refer to the Organization in the UI.\nAssigned by the server, set to the primary domain of the G Suite\ncustomer that owns the organization.\n@OutputOnly",
+ "type": "string"
}
},
"id": "Organization"
},
"ListAvailableOrgPolicyConstraintsResponse": {
- "description": "The response returned from the ListAvailableOrgPolicyConstraints method.\nReturns all `Constraints` that could be set at this level of the hierarchy\n(contrast with the response from `ListPolicies`, which returns all policies\nwhich are set).",
"type": "object",
"properties": {
"constraints": {
@@ -539,7 +228,8 @@
"type": "string"
}
},
- "id": "ListAvailableOrgPolicyConstraintsResponse"
+ "id": "ListAvailableOrgPolicyConstraintsResponse",
+ "description": "The response returned from the ListAvailableOrgPolicyConstraints method.\nReturns all `Constraints` that could be set at this level of the hierarchy\n(contrast with the response from `ListPolicies`, which returns all policies\nwhich are set)."
},
"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.",
@@ -585,6 +275,7 @@
"id": "ListPolicy"
},
"GetAncestryResponse": {
+ "id": "GetAncestryResponse",
"description": "Response from the GetAncestry method.",
"type": "object",
"properties": {
@@ -595,11 +286,9 @@
"$ref": "Ancestor"
}
}
- },
- "id": "GetAncestryResponse"
+ }
},
"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": {
@@ -626,7 +315,8 @@
}
}
},
- "id": "AuditLogConfig"
+ "id": "AuditLogConfig",
+ "description": "Provides the configuration for logging a type of permissions.\nExample:\n\n {\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n }\n ]\n }\n\nThis enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting\nfoo@gmail.com from DATA_READ logging."
},
"SearchOrganizationsRequest": {
"description": "The request sent to the `SearchOrganizations` method.",
@@ -655,8 +345,6 @@
"id": "GetAncestryRequest"
},
"TestIamPermissionsRequest": {
- "description": "Request message for `TestIamPermissions` method.",
- "type": "object",
"properties": {
"permissions": {
"description": "The set of permissions to check for the `resource`. Permissions with\nwildcards (such as '*' or 'storage.*') are not allowed. For more\ninformation see\n[IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).",
@@ -666,50 +354,29 @@
}
}
},
- "id": "TestIamPermissionsRequest"
+ "id": "TestIamPermissionsRequest",
+ "description": "Request message for `TestIamPermissions` method.",
+ "type": "object"
},
- "FolderOperation": {
- "description": "Metadata describing a long running folder operation",
+ "ListAvailableOrgPolicyConstraintsRequest": {
"type": "object",
"properties": {
- "displayName": {
- "description": "The display name of the folder.",
+ "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"
},
- "sourceParent": {
- "description": "The resource name of the folder's parent.\nOnly applicable when the operation_type is MOVE.",
- "type": "string"
- },
- "destinationParent": {
- "description": "The resource name of the folder or organization we are either creating\nthe folder under or moving the folder to.",
- "type": "string"
- },
- "operationType": {
- "enumDescriptions": [
- "Operation type not specified.",
- "A create folder operation.",
- "A move folder operation."
- ],
- "enum": [
- "OPERATION_TYPE_UNSPECIFIED",
- "CREATE",
- "MOVE"
- ],
- "description": "The type of this operation.",
- "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": "FolderOperation"
+ "id": "ListAvailableOrgPolicyConstraintsRequest",
+ "description": "The request sent to the [ListAvailableOrgPolicyConstraints]\ngoogle.cloud.OrgPolicy.v1.ListAvailableOrgPolicyConstraints] method."
},
"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",
@@ -728,25 +395,48 @@
"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"
}
},
- "id": "Policy"
+ "id": "Policy",
+ "description": "Defines an Identity and Access Management (IAM) policy. It is used to\nspecify access control policies for Cloud Platform resources.\n\n\nA `Policy` consists of a list of `bindings`. A `Binding` binds a list of\n`members` to a `role`, where the members can be user accounts, Google groups,\nGoogle domains, and service accounts. A `role` is a named list of permissions\ndefined by IAM.\n\n**Example**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/owner\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-other-app@appspot.gserviceaccount.com\",\n ]\n },\n {\n \"role\": \"roles/viewer\",\n \"members\": [\"user:sean@example.com\"]\n }\n ]\n }\n\nFor a description of IAM and its features, see the\n[IAM developer's guide](https://cloud.google.com/iam)."
},
- "ListAvailableOrgPolicyConstraintsRequest": {
- "description": "The request sent to the [ListAvailableOrgPolicyConstraints]\ngoogle.cloud.OrgPolicy.v1.ListAvailableOrgPolicyConstraints] method.",
+ "FolderOperation": {
+ "description": "Metadata describing a long running folder operation",
"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.",
+ "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": {
+ "description": "The display name of the folder.",
"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"
+ "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": "ListAvailableOrgPolicyConstraintsRequest"
+ "id": "FolderOperation"
},
"ResourceId": {
"description": "A container to reference an id for any resource type. A `resource` in Google\nCloud Platform is a generic term for something you (a developer) may want to\ninteract with through one of our API's. Some examples are an App Engine app,\na Compute Engine instance, a Cloud SQL database, and so on.",
@@ -775,7 +465,6 @@
"id": "GetEffectiveOrgPolicyRequest"
},
"ListOrgPoliciesRequest": {
- "description": "The request sent to the ListOrgPolicies method.",
"type": "object",
"properties": {
"pageSize": {
@@ -788,7 +477,43 @@
"type": "string"
}
},
- "id": "ListOrgPoliciesRequest"
+ "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": {
+ "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": {
+ "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."
+ }
+ },
+ "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.",
@@ -808,47 +533,323 @@
},
"id": "AuditConfig"
},
- "Operation": {
- "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
+ "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": {
- "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`.",
+ "displayName": {
+ "description": "The human readable name.\n\nMutable.",
"type": "string"
},
- "error": {
- "$ref": "Status",
- "description": "The error result of the operation in case of failure or cancellation."
+ "description": {
+ "description": "Detailed description of what this `Constraint` controls as well as how and\nwhere it is enforced.\n\nMutable.",
+ "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"
+ "booleanConstraint": {
+ "description": "Defines this constraint as being a BooleanConstraint.",
+ "$ref": "BooleanConstraint"
+ },
+ "constraintDefault": {
+ "enumDescriptions": [
+ "This is only used for distinguishing unset values and should never be\nused.",
+ "Indicate that all values are allowed for list constraints.\nIndicate that enforcement is off for boolean constraints.",
+ "Indicate that all values are denied for list constraints.\nIndicate that enforcement is on for boolean constraints."
+ ],
+ "enum": [
+ "CONSTRAINT_DEFAULT_UNSPECIFIED",
+ "ALLOW",
+ "DENY"
+ ],
+ "description": "The evaluation behavior of this constraint in the absense of 'Policy'.",
+ "type": "string"
+ },
+ "name": {
+ "description": "Immutable value, required to globally be unique. For example,\n`constraints/serviceuser.services`",
+ "type": "string"
+ },
+ "version": {
+ "description": "Version of the `Constraint`. Default version is 0;",
+ "format": "int32",
+ "type": "integer"
+ },
+ "listConstraint": {
+ "$ref": "ListConstraint",
+ "description": "Defines this constraint as being a ListConstraint."
}
},
- "id": "Operation"
+ "id": "Constraint"
+ },
+ "ListLiensResponse": {
+ "description": "The response message for Liens.ListLiens.",
+ "type": "object",
+ "properties": {
+ "nextPageToken": {
+ "description": "Token to retrieve the next page of results, or empty if there are no more\nresults in the list.",
+ "type": "string"
+ },
+ "liens": {
+ "description": "A list of Liens.",
+ "type": "array",
+ "items": {
+ "$ref": "Lien"
+ }
+ }
+ },
+ "id": "ListLiensResponse"
+ },
+ "Status": {
+ "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
+ "type": "object",
+ "properties": {
+ "details": {
+ "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ }
+ }
+ },
+ "code": {
+ "description": "The status code, which should be an enum value of google.rpc.Code.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "message": {
+ "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"
+ },
+ "Binding": {
+ "description": "Associates `members` with a `role`.",
+ "type": "object",
+ "properties": {
+ "members": {
+ "description": "Specifies the identities requesting access for a Cloud Platform resource.\n`members` can have the following values:\n\n* `allUsers`: A special identifier that represents anyone who is\n on the internet; with or without a Google account.\n\n* `allAuthenticatedUsers`: A special identifier that represents anyone\n who is authenticated with a Google account or a service account.\n\n* `user:{emailid}`: An email address that represents a specific Google\n account. For example, `alice@gmail.com` or `joe@example.com`.\n\n\n* `serviceAccount:{emailid}`: An email address that represents a service\n account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{emailid}`: An email address that represents a Google group.\n For example, `admins@example.com`.\n\n\n* `domain:{domain}`: A Google Apps domain name that represents all the\n users of that domain. For example, `google.com` or `example.com`.\n\n",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "role": {
+ "description": "Role that is assigned to `members`.\nFor example, `roles/viewer`, `roles/editor`, or `roles/owner`.\nRequired",
+ "type": "string"
+ }
+ },
+ "id": "Binding"
+ },
+ "GetOrgPolicyRequest": {
+ "properties": {
+ "constraint": {
+ "description": "Name of the `Constraint` to get the `Policy`.",
+ "type": "string"
+ }
+ },
+ "id": "GetOrgPolicyRequest",
+ "description": "The request sent to the GetOrgPolicy method.",
+ "type": "object"
+ },
+ "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": {
+ "type": "string",
+ "description": "The current version, for concurrency control. Not sending an `etag`\nwill cause the `Policy` to be cleared blindly.",
+ "format": "byte"
+ },
+ "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": {
+ "description": "A status object which is used as the `metadata` field for the Operation\nreturned by CreateProject. It provides insight for when significant phases of\nProject creation have completed.",
+ "type": "object",
+ "properties": {
+ "ready": {
+ "description": "True if the project creation process is complete.",
+ "type": "boolean"
+ },
+ "createTime": {
+ "description": "Creation time of the project creation workflow.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "gettable": {
+ "description": "True if the project can be retrieved using GetProject. No other operations\non the project are guaranteed to work until the project creation is\ncomplete.",
+ "type": "boolean"
+ }
+ },
+ "id": "ProjectCreationStatus"
+ },
+ "BooleanConstraint": {
+ "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.",
+ "type": "object",
+ "properties": {}
+ },
+ "TestIamPermissionsResponse": {
+ "description": "Response message for `TestIamPermissions` method.",
+ "type": "object",
+ "properties": {
+ "permissions": {
+ "description": "A subset of `TestPermissionsRequest.permissions` that the caller is\nallowed.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "id": "TestIamPermissionsResponse"
+ },
+ "GetIamPolicyRequest": {
+ "description": "Request message for `GetIamPolicy` method.",
+ "type": "object",
+ "properties": {},
+ "id": "GetIamPolicyRequest"
+ },
+ "OrganizationOwner": {
+ "description": "The entity that owns an Organization. The lifetime of the Organization and\nall of its descendants are bound to the `OrganizationOwner`. If the\n`OrganizationOwner` is deleted, the Organization and all its descendants will\nbe deleted.",
+ "type": "object",
+ "properties": {
+ "directoryCustomerId": {
+ "description": "The Google for Work customer id used in the Directory API.",
+ "type": "string"
+ }
+ },
+ "id": "OrganizationOwner"
+ },
+ "ListProjectsResponse": {
+ "description": "A page of the response received from the\nListProjects\nmethod.\n\nA paginated response where more pages are available has\n`next_page_token` set. This token can be used in a subsequent request to\nretrieve the next request page.",
+ "type": "object",
+ "properties": {
+ "projects": {
+ "description": "The list of Projects that matched the list filter. This list can\nbe paginated.",
+ "type": "array",
+ "items": {
+ "$ref": "Project"
+ }
+ },
+ "nextPageToken": {
+ "type": "string",
+ "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."
+ }
+ },
+ "id": "ListProjectsResponse"
+ },
+ "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": {
+ "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"
+ },
+ "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": {
+ "type": "string",
+ "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."
+ },
+ "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"
+ }
+ }
+ },
+ "ListOrgPoliciesResponse": {
+ "id": "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": {
+ "description": "The `Policies` that are set on the resource. It will be empty if no\n`Policies` are set.",
+ "type": "array",
+ "items": {
+ "$ref": "OrgPolicy"
+ }
+ }
+ }
+ },
+ "SearchOrganizationsResponse": {
+ "description": "The response returned from the `SearchOrganizations` method.",
+ "type": "object",
+ "properties": {
+ "organizations": {
+ "description": "The list of Organizations that matched the search query, possibly\npaginated.",
+ "type": "array",
+ "items": {
+ "$ref": "Organization"
+ }
+ },
+ "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"
+ }
+ },
+ "id": "SearchOrganizationsResponse"
}
},
+ "protocol": "rest",
"icons": {
"x16": "http://www.google.com/images/icons/product/search-16.gif",
"x32": "http://www.google.com/images/icons/product/search-32.gif"
},
- "protocol": "rest",
"canonicalName": "Cloud Resource Manager",
"auth": {
"oauth2": {
@@ -870,65 +871,8 @@
"title": "Google Cloud Resource Manager API",
"ownerName": "Google",
"resources": {
- "organizations": {
+ "projects": {
"methods": {
- "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"
- },
- "response": {
- "$ref": "TestIamPermissionsResponse"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {
- "resource": {
- "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
- "required": true,
- "type": "string",
- "pattern": "^organizations/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1/organizations/{organizationsId}:testIamPermissions",
- "path": "v1/{+resource}:testIamPermissions",
- "id": "cloudresourcemanager.organizations.testIamPermissions"
- },
- "clearOrgPolicy": {
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
- "parameters": {
- "resource": {
- "description": "Name of the resource for the `Policy` to clear.",
- "required": true,
- "type": "string",
- "pattern": "^organizations/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/organizations/{organizationsId}:clearOrgPolicy",
- "path": "v1/{+resource}:clearOrgPolicy",
- "id": "cloudresourcemanager.organizations.clearOrgPolicy",
- "request": {
- "$ref": "ClearOrgPolicyRequest"
- },
- "description": "Clears a `Policy` from a resource."
- },
"setOrgPolicy": {
"request": {
"$ref": "SetOrgPolicyRequest"
@@ -947,440 +891,35 @@
"description": "Resource name of the resource to attach the `Policy`.",
"required": true,
"type": "string",
- "pattern": "^organizations/[^/]+$"
+ "pattern": "^projects/[^/]+$"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
- "flatPath": "v1/organizations/{organizationsId}:setOrgPolicy",
+ "flatPath": "v1/projects/{projectsId}:setOrgPolicy",
"path": "v1/{+resource}:setOrgPolicy",
- "id": "cloudresourcemanager.organizations.setOrgPolicy"
- },
- "setIamPolicy": {
- "request": {
- "$ref": "SetIamPolicyRequest"
- },
- "description": "Sets the access control policy on an Organization resource. Replaces any\nexisting policy. The `resource` field should be the organization's resource\nname, e.g. \"organizations/123\".\n\nAuthorization requires the Google IAM permission\n`resourcemanager.organizations.setIamPolicy` on the specified organization",
- "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": "^organizations/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/organizations/{organizationsId}:setIamPolicy",
- "path": "v1/{+resource}:setIamPolicy",
- "id": "cloudresourcemanager.organizations.setIamPolicy"
- },
- "listAvailableOrgPolicyConstraints": {
- "response": {
- "$ref": "ListAvailableOrgPolicyConstraintsResponse"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {
- "resource": {
- "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"
- }
- },
- "listOrgPolicies": {
- "httpMethod": "POST",
- "parameterOrder": [
- "resource"
- ],
- "response": {
- "$ref": "ListOrgPoliciesResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {
- "resource": {
- "location": "path",
- "description": "Name of the resource to list Policies for.",
- "required": true,
- "type": "string",
- "pattern": "^organizations/[^/]+$"
- }
- },
- "flatPath": "v1/organizations/{organizationsId}:listOrgPolicies",
- "id": "cloudresourcemanager.organizations.listOrgPolicies",
- "path": "v1/{+resource}:listOrgPolicies",
- "description": "Lists all the `Policies` set for a particular resource.",
- "request": {
- "$ref": "ListOrgPoliciesRequest"
- }
- },
- "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",
- "response": {
- "$ref": "Policy"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
- "parameters": {
- "resource": {
- "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",
- "required": true,
- "type": "string",
- "pattern": "^organizations/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1/organizations/{organizationsId}:getIamPolicy",
- "path": "v1/{+resource}:getIamPolicy",
- "id": "cloudresourcemanager.organizations.getIamPolicy"
- },
- "getOrgPolicy": {
- "request": {
- "$ref": "GetOrgPolicyRequest"
- },
- "description": "Gets a `Policy` on a resource.\n\nIf no `Policy` is set on the resource, a `Policy` is returned with default\nvalues including `POLICY_TYPE_NOT_SET` for the `policy_type oneof`. The\n`etag` value can be used with `SetOrgPolicy()` to create or update a\n`Policy` during read-modify-write.",
- "response": {
- "$ref": "OrgPolicy"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
- "parameters": {
- "resource": {
- "location": "path",
- "description": "Name of the resource the `Policy` is set on.",
- "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}:getOrgPolicy",
- "path": "v1/{+resource}:getOrgPolicy",
- "id": "cloudresourcemanager.organizations.getOrgPolicy"
- },
- "search": {
- "description": "Searches Organization resources that are visible to the user and satisfy\nthe specified filter. This method returns Organizations in an unspecified\norder. New Organizations do not necessarily appear at the end of the\nresults.\n\nSearch will only return organizations on which the user has the permission\n`resourcemanager.organizations.get`",
- "request": {
- "$ref": "SearchOrganizationsRequest"
- },
- "response": {
- "$ref": "SearchOrganizationsResponse"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {},
- "flatPath": "v1/organizations:search",
- "path": "v1/organizations:search",
- "id": "cloudresourcemanager.organizations.search"
- },
- "getEffectiveOrgPolicy": {
- "request": {
- "$ref": "GetEffectiveOrgPolicyRequest"
- },
- "description": "Gets the effective `Policy` on a resource. This is the result of merging\n`Policies` in the resource hierarchy. The returned `Policy` will not have\nan `etag`set because it is a computed `Policy` across multiple resources.",
- "response": {
- "$ref": "OrgPolicy"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
- "parameters": {
- "resource": {
- "description": "The name of the resource to start computing the effective `Policy`.",
- "required": true,
- "type": "string",
- "pattern": "^organizations/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1/organizations/{organizationsId}:getEffectiveOrgPolicy",
- "path": "v1/{+resource}:getEffectiveOrgPolicy",
- "id": "cloudresourcemanager.organizations.getEffectiveOrgPolicy"
- },
- "get": {
- "description": "Fetches an Organization resource identified by the specified resource name.",
- "httpMethod": "GET",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Organization"
- },
- "parameters": {
- "name": {
- "description": "The resource name of the Organization to fetch, e.g. \"organizations/1234\".",
- "required": true,
- "type": "string",
- "pattern": "^organizations/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1/organizations/{organizationsId}",
- "id": "cloudresourcemanager.organizations.get",
- "path": "v1/{+name}"
- }
- }
- },
- "liens": {
- "methods": {
- "list": {
- "description": "List all Liens applied to the `parent` resource.\n\nCallers of this method will require permission on the `parent` resource.\nFor example, a Lien with a `parent` of `projects/1234` requires permission\n`resourcemanager.projects.get`.",
- "response": {
- "$ref": "ListLiensResponse"
- },
- "parameterOrder": [],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {
- "pageSize": {
- "description": "The maximum number of items to return. This is a suggestion for the server.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- },
- "parent": {
- "location": "query",
- "description": "The name of the resource to list all attached Liens.\nFor example, `projects/1234`.",
- "type": "string"
- },
- "pageToken": {
- "location": "query",
- "description": "The `next_page_token` value returned from a previous List request, if any.",
- "type": "string"
- }
- },
- "flatPath": "v1/liens",
- "path": "v1/liens",
- "id": "cloudresourcemanager.liens.list"
+ "id": "cloudresourcemanager.projects.setOrgPolicy"
},
"create": {
"response": {
- "$ref": "Lien"
+ "$ref": "Operation"
},
"parameterOrder": [],
"httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
"parameters": {},
- "flatPath": "v1/liens",
- "path": "v1/liens",
- "id": "cloudresourcemanager.liens.create",
- "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"
- }
- },
- "delete": {
- "flatPath": "v1/liens/{liensId}",
- "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`.",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "DELETE",
- "parameters": {
- "name": {
- "location": "path",
- "description": "The name/identifier of the Lien to delete.",
- "required": true,
- "type": "string",
- "pattern": "^liens/.+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ]
- }
- }
- },
- "operations": {
- "methods": {
- "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/.+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1/operations/{operationsId}",
- "path": "v1/{+name}",
- "id": "cloudresourcemanager.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."
- }
- }
- },
- "folders": {
- "methods": {
- "clearOrgPolicy": {
- "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": "^folders/[^/]+$"
- }
- },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
- "flatPath": "v1/folders/{foldersId}:clearOrgPolicy",
- "path": "v1/{+resource}:clearOrgPolicy",
- "id": "cloudresourcemanager.folders.clearOrgPolicy",
+ "flatPath": "v1/projects",
+ "path": "v1/projects",
+ "id": "cloudresourcemanager.projects.create",
"request": {
- "$ref": "ClearOrgPolicyRequest"
+ "$ref": "Project"
},
- "description": "Clears a `Policy` from a 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`.",
- "response": {
- "$ref": "OrgPolicy"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
- "parameters": {
- "resource": {
- "location": "path",
- "description": "Resource name of the resource to attach the `Policy`.",
- "required": true,
- "type": "string",
- "pattern": "^folders/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/folders/{foldersId}:setOrgPolicy",
- "path": "v1/{+resource}:setOrgPolicy",
- "id": "cloudresourcemanager.folders.setOrgPolicy"
- },
- "listAvailableOrgPolicyConstraints": {
- "response": {
- "$ref": "ListAvailableOrgPolicyConstraintsResponse"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {
- "resource": {
- "location": "path",
- "description": "Name of the resource to list `Constraints` for.",
- "required": true,
- "type": "string",
- "pattern": "^folders/[^/]+$"
- }
- },
- "flatPath": "v1/folders/{foldersId}:listAvailableOrgPolicyConstraints",
- "path": "v1/{+resource}:listAvailableOrgPolicyConstraints",
- "id": "cloudresourcemanager.folders.listAvailableOrgPolicyConstraints",
- "description": "Lists `Constraints` that could be applied on the specified resource.",
- "request": {
- "$ref": "ListAvailableOrgPolicyConstraintsRequest"
- }
+ "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": {
- "request": {
- "$ref": "ListOrgPoliciesRequest"
- },
- "description": "Lists all the `Policies` set for a particular resource.",
"httpMethod": "POST",
"parameterOrder": [
"resource"
@@ -1390,97 +929,6 @@
},
"parameters": {
"resource": {
- "description": "Name of the resource to list Policies for.",
- "required": true,
- "type": "string",
- "pattern": "^folders/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1/folders/{foldersId}:listOrgPolicies",
- "id": "cloudresourcemanager.folders.listOrgPolicies",
- "path": "v1/{+resource}:listOrgPolicies"
- },
- "getOrgPolicy": {
- "request": {
- "$ref": "GetOrgPolicyRequest"
- },
- "description": "Gets a `Policy` on a resource.\n\nIf no `Policy` is set on the resource, a `Policy` is returned with default\nvalues including `POLICY_TYPE_NOT_SET` for the `policy_type oneof`. The\n`etag` value can be used with `SetOrgPolicy()` to create or update a\n`Policy` during read-modify-write.",
- "httpMethod": "POST",
- "parameterOrder": [
- "resource"
- ],
- "response": {
- "$ref": "OrgPolicy"
- },
- "parameters": {
- "resource": {
- "description": "Name of the resource the `Policy` is set on.",
- "required": true,
- "type": "string",
- "pattern": "^folders/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1/folders/{foldersId}:getOrgPolicy",
- "id": "cloudresourcemanager.folders.getOrgPolicy",
- "path": "v1/{+resource}:getOrgPolicy"
- },
- "getEffectiveOrgPolicy": {
- "flatPath": "v1/folders/{foldersId}:getEffectiveOrgPolicy",
- "id": "cloudresourcemanager.folders.getEffectiveOrgPolicy",
- "path": "v1/{+resource}:getEffectiveOrgPolicy",
- "request": {
- "$ref": "GetEffectiveOrgPolicyRequest"
- },
- "description": "Gets the effective `Policy` on a resource. This is the result of merging\n`Policies` in the resource hierarchy. The returned `Policy` will not have\nan `etag`set because it is a computed `Policy` across multiple resources.",
- "httpMethod": "POST",
- "parameterOrder": [
- "resource"
- ],
- "response": {
- "$ref": "OrgPolicy"
- },
- "parameters": {
- "resource": {
- "description": "The name of the resource to start computing the effective `Policy`.",
- "required": true,
- "type": "string",
- "pattern": "^folders/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ]
- }
- }
- },
- "projects": {
- "methods": {
- "listOrgPolicies": {
- "request": {
- "$ref": "ListOrgPoliciesRequest"
- },
- "description": "Lists all the `Policies` set for a particular resource.",
- "response": {
- "$ref": "ListOrgPoliciesResponse"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
- "parameters": {
- "resource": {
"location": "path",
"description": "Name of the resource to list Policies for.",
"required": true,
@@ -1493,14 +941,14 @@
"https://www.googleapis.com/auth/cloud-platform.read-only"
],
"flatPath": "v1/projects/{projectsId}:listOrgPolicies",
+ "id": "cloudresourcemanager.projects.listOrgPolicies",
"path": "v1/{+resource}:listOrgPolicies",
- "id": "cloudresourcemanager.projects.listOrgPolicies"
+ "request": {
+ "$ref": "ListOrgPoliciesRequest"
+ },
+ "description": "Lists all the `Policies` set for a particular resource."
},
"get": {
- "flatPath": "v1/projects/{projectId}",
- "path": "v1/projects/{projectId}",
- "id": "cloudresourcemanager.projects.get",
- "description": "Retrieves the Project identified by the specified\n`project_id` (for example, `my-project-123`).\n\nThe caller must have read permissions for this Project.",
"response": {
"$ref": "Project"
},
@@ -1508,10 +956,6 @@
"projectId"
],
"httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
"parameters": {
"projectId": {
"description": "The Project ID (for example, `my-project-123`).\n\nRequired.",
@@ -1519,7 +963,15 @@
"type": "string",
"location": "path"
}
- }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "flatPath": "v1/projects/{projectId}",
+ "path": "v1/projects/{projectId}",
+ "id": "cloudresourcemanager.projects.get",
+ "description": "Retrieves the Project identified by the specified\n`project_id` (for example, `my-project-123`).\n\nThe caller must have read permissions for this Project."
},
"getAncestry": {
"request": {
@@ -1535,10 +987,10 @@
"httpMethod": "POST",
"parameters": {
"projectId": {
- "location": "path",
"description": "The Project ID (for example, `my-project-123`).\n\nRequired.",
"required": true,
- "type": "string"
+ "type": "string",
+ "location": "path"
}
},
"scopes": [
@@ -1550,6 +1002,10 @@
"id": "cloudresourcemanager.projects.getAncestry"
},
"testIamPermissions": {
+ "request": {
+ "$ref": "TestIamPermissionsRequest"
+ },
+ "description": "Returns permissions that a caller has on the specified Project.\n\nThere are no permissions required for making this API call.",
"httpMethod": "POST",
"parameterOrder": [
"resource"
@@ -1571,11 +1027,7 @@
],
"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."
+ "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.",
@@ -1602,6 +1054,10 @@
"id": "cloudresourcemanager.projects.delete"
},
"clearOrgPolicy": {
+ "request": {
+ "$ref": "ClearOrgPolicyRequest"
+ },
+ "description": "Clears a `Policy` from a resource.",
"response": {
"$ref": "Empty"
},
@@ -1611,11 +1067,11 @@
"httpMethod": "POST",
"parameters": {
"resource": {
+ "pattern": "^projects/[^/]+$",
+ "location": "path",
"description": "Name of the resource for the `Policy` to clear.",
"required": true,
- "type": "string",
- "pattern": "^projects/[^/]+$",
- "location": "path"
+ "type": "string"
}
},
"scopes": [
@@ -1623,20 +1079,9 @@
],
"flatPath": "v1/projects/{projectsId}:clearOrgPolicy",
"path": "v1/{+resource}:clearOrgPolicy",
- "id": "cloudresourcemanager.projects.clearOrgPolicy",
- "request": {
- "$ref": "ClearOrgPolicyRequest"
- },
- "description": "Clears a `Policy` from a resource."
+ "id": "cloudresourcemanager.projects.clearOrgPolicy"
},
"setIamPolicy": {
- "flatPath": "v1/projects/{resource}:setIamPolicy",
- "path": "v1/projects/{resource}:setIamPolicy",
- "id": "cloudresourcemanager.projects.setIamPolicy",
- "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",
- "request": {
- "$ref": "SetIamPolicyRequest"
- },
"response": {
"$ref": "Policy"
},
@@ -1649,13 +1094,730 @@
],
"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"
+ }
+ },
+ "flatPath": "v1/projects/{resource}:setIamPolicy",
+ "path": "v1/projects/{resource}:setIamPolicy",
+ "id": "cloudresourcemanager.projects.setIamPolicy",
+ "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",
+ "request": {
+ "$ref": "SetIamPolicyRequest"
+ }
+ },
+ "listAvailableOrgPolicyConstraints": {
+ "path": "v1/{+resource}:listAvailableOrgPolicyConstraints",
+ "id": "cloudresourcemanager.projects.listAvailableOrgPolicyConstraints",
+ "request": {
+ "$ref": "ListAvailableOrgPolicyConstraintsRequest"
+ },
+ "description": "Lists `Constraints` that could be applied on the specified 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"
+ ],
+ "flatPath": "v1/projects/{projectsId}:listAvailableOrgPolicyConstraints"
+ },
+ "getIamPolicy": {
+ "flatPath": "v1/projects/{resource}:getIamPolicy",
+ "id": "cloudresourcemanager.projects.getIamPolicy",
+ "path": "v1/projects/{resource}:getIamPolicy",
+ "request": {
+ "$ref": "GetIamPolicyRequest"
+ },
+ "description": "Returns the IAM access control policy for the specified Project.\nPermission is denied if the policy or the resource does not exist.\n\nAuthorization requires the Google IAM permission\n`resourcemanager.projects.getIamPolicy` on the project",
+ "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"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ]
+ },
+ "getOrgPolicy": {
+ "response": {
+ "$ref": "OrgPolicy"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "parameters": {
+ "resource": {
+ "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"
+ }
+ },
+ "getEffectiveOrgPolicy": {
+ "flatPath": "v1/projects/{projectsId}:getEffectiveOrgPolicy",
+ "id": "cloudresourcemanager.projects.getEffectiveOrgPolicy",
+ "path": "v1/{+resource}:getEffectiveOrgPolicy",
+ "request": {
+ "$ref": "GetEffectiveOrgPolicyRequest"
+ },
+ "description": "Gets the effective `Policy` on a resource. This is the result of merging\n`Policies` in the resource hierarchy. The returned `Policy` will not have\nan `etag`set because it is a computed `Policy` across multiple resources.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "resource"
+ ],
+ "response": {
+ "$ref": "OrgPolicy"
+ },
+ "parameters": {
+ "resource": {
+ "location": "path",
+ "description": "The name of the resource to start computing the effective `Policy`.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ]
+ },
+ "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": "v1/projects/{projectId}:undelete",
+ "path": "v1/projects/{projectId}:undelete",
+ "id": "cloudresourcemanager.projects.undelete"
+ },
+ "update": {
+ "httpMethod": "PUT",
+ "parameterOrder": [
+ "projectId"
+ ],
+ "response": {
+ "$ref": "Project"
+ },
+ "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"
+ ],
+ "flatPath": "v1/projects/{projectId}",
+ "id": "cloudresourcemanager.projects.update",
+ "path": "v1/projects/{projectId}",
+ "request": {
+ "$ref": "Project"
+ },
+ "description": "Updates the attributes of the Project identified by the specified\n`project_id` (for example, `my-project-123`).\n\nThe caller must have modify permissions for this Project."
+ },
+ "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": {
+ "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"
+ },
+ "filter": {
+ "description": "An expression for filtering the results of the request. Filter rules are\ncase insensitive. The fields eligible for filtering are:\n\n+ `name`\n+ `id`\n+ \u003ccode\u003elabels.\u003cem\u003ekey\u003c/em\u003e\u003c/code\u003e where *key* is the name of a label\n\nSome examples of using labels as filters:\n\n|Filter|Description|\n|------|-----------|\n|name:how*|The project's name starts with \"how\".|\n|name:Howl|The project's name is `Howl` or `howl`.|\n|name:HOWL|Equivalent to above.|\n|NAME:howl|Equivalent to above.|\n|labels.color:*|The project has the label `color`.|\n|labels.color:red|The project's label `color` has the value `red`.|\n|labels.color:red labels.size:big|The project's label `color` has the value `red` and its label `size` has the value `big`.\n\nIf you specify a filter that has both `parent.type` and `parent.id`, then\nthe `resourcemanager.projects.list` permission is checked on the parent.\nIf the user has this permission, all projects under the parent will be\nreturned after remaining filters have been applied. If the user lacks this\npermission, then all projects for which the user has the\n`resourcemanager.projects.get` permission will be returned after remaining\nfilters have been applied. If no filter is specified, the call will return\nprojects for which the user has `resourcemanager.projects.get` permissions.\n\nOptional.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "flatPath": "v1/projects",
+ "path": "v1/projects",
+ "id": "cloudresourcemanager.projects.list",
+ "description": "Lists Projects that are visible to the user and satisfy the\nspecified filter. This method returns Projects in an unspecified order.\nThis method is eventually consistent with project mutations; this means\nthat a newly created project may not appear in the results or recent\nupdates to an existing project may not be reflected in the results. To\nretrieve the latest state of a project, use the\nGetProject method."
+ }
+ }
+ },
+ "organizations": {
+ "methods": {
+ "getIamPolicy": {
+ "path": "v1/{+resource}:getIamPolicy",
+ "id": "cloudresourcemanager.organizations.getIamPolicy",
+ "description": "Gets the access control policy for an Organization resource. May be empty\nif no such policy or resource exists. The `resource` field should be the\norganization's resource name, e.g. \"organizations/123\".\n\nAuthorization requires the Google IAM permission\n`resourcemanager.organizations.getIamPolicy` on the specified organization",
+ "request": {
+ "$ref": "GetIamPolicyRequest"
+ },
+ "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": "^organizations/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/organizations/{organizationsId}:getIamPolicy"
+ },
+ "search": {
+ "description": "Searches Organization resources that are visible to the user and satisfy\nthe specified filter. This method returns Organizations in an unspecified\norder. New Organizations do not necessarily appear at the end of the\nresults.\n\nSearch will only return organizations on which the user has the permission\n`resourcemanager.organizations.get`",
+ "request": {
+ "$ref": "SearchOrganizationsRequest"
+ },
+ "response": {
+ "$ref": "SearchOrganizationsResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "parameters": {},
+ "flatPath": "v1/organizations:search",
+ "path": "v1/organizations:search",
+ "id": "cloudresourcemanager.organizations.search"
+ },
+ "getOrgPolicy": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "resource"
+ ],
+ "response": {
+ "$ref": "OrgPolicy"
+ },
+ "parameters": {
+ "resource": {
+ "pattern": "^organizations/[^/]+$",
+ "location": "path",
+ "description": "Name of the resource the `Policy` is set on.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "flatPath": "v1/organizations/{organizationsId}: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": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "resource"
+ ],
+ "response": {
+ "$ref": "OrgPolicy"
+ },
+ "parameters": {
+ "resource": {
+ "location": "path",
+ "description": "The name of the resource to start computing the effective `Policy`.",
+ "required": true,
+ "type": "string",
+ "pattern": "^organizations/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "flatPath": "v1/organizations/{organizationsId}:getEffectiveOrgPolicy",
+ "id": "cloudresourcemanager.organizations.getEffectiveOrgPolicy",
+ "path": "v1/{+resource}:getEffectiveOrgPolicy",
+ "request": {
+ "$ref": "GetEffectiveOrgPolicyRequest"
+ },
+ "description": "Gets the effective `Policy` on a resource. This is the result of merging\n`Policies` in the resource hierarchy. The returned `Policy` will not have\nan `etag`set because it is a computed `Policy` across multiple resources."
+ },
+ "get": {
+ "description": "Fetches an Organization resource identified by the specified resource name.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Organization"
+ },
+ "parameters": {
+ "name": {
+ "description": "The resource name of the Organization to fetch, e.g. \"organizations/1234\".",
+ "required": true,
+ "type": "string",
+ "pattern": "^organizations/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "flatPath": "v1/organizations/{organizationsId}",
+ "id": "cloudresourcemanager.organizations.get",
+ "path": "v1/{+name}"
+ },
+ "testIamPermissions": {
+ "response": {
+ "$ref": "TestIamPermissionsResponse"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "parameters": {
+ "resource": {
+ "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",
+ "path": "v1/{+resource}:testIamPermissions",
+ "id": "cloudresourcemanager.organizations.testIamPermissions",
+ "description": "Returns permissions that a caller has on the specified Organization.\nThe `resource` field should be the organization's resource name,\ne.g. \"organizations/123\".\n\nThere are no permissions required for making this API call.",
+ "request": {
+ "$ref": "TestIamPermissionsRequest"
+ }
+ },
+ "clearOrgPolicy": {
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "resource": {
+ "pattern": "^organizations/[^/]+$",
+ "location": "path",
+ "description": "Name of the resource for the `Policy` to clear.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/organizations/{organizationsId}:clearOrgPolicy",
+ "path": "v1/{+resource}:clearOrgPolicy",
+ "id": "cloudresourcemanager.organizations.clearOrgPolicy",
+ "request": {
+ "$ref": "ClearOrgPolicyRequest"
+ },
+ "description": "Clears a `Policy` from a resource."
+ },
+ "setOrgPolicy": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "resource"
+ ],
+ "response": {
+ "$ref": "OrgPolicy"
+ },
+ "parameters": {
+ "resource": {
+ "description": "Resource name of the resource to attach the `Policy`.",
+ "required": true,
+ "type": "string",
+ "pattern": "^organizations/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/organizations/{organizationsId}:setOrgPolicy",
+ "id": "cloudresourcemanager.organizations.setOrgPolicy",
+ "path": "v1/{+resource}:setOrgPolicy",
+ "request": {
+ "$ref": "SetOrgPolicyRequest"
+ },
+ "description": "Updates the specified `Policy` on the resource. Creates a new `Policy` for\nthat `Constraint` on the resource if one does not exist.\n\nNot supplying an `etag` on the request `Policy` results in an unconditional\nwrite of the `Policy`."
+ },
+ "setIamPolicy": {
+ "path": "v1/{+resource}:setIamPolicy",
+ "id": "cloudresourcemanager.organizations.setIamPolicy",
+ "request": {
+ "$ref": "SetIamPolicyRequest"
+ },
+ "description": "Sets the access control policy on an Organization resource. Replaces any\nexisting policy. The `resource` field should be the organization's resource\nname, e.g. \"organizations/123\".\n\nAuthorization requires the Google IAM permission\n`resourcemanager.organizations.setIamPolicy` on the specified organization",
+ "response": {
+ "$ref": "Policy"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "resource": {
+ "pattern": "^organizations/[^/]+$",
"location": "path",
"description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.",
"required": true,
"type": "string"
}
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/organizations/{organizationsId}:setIamPolicy"
+ },
+ "listAvailableOrgPolicyConstraints": {
+ "response": {
+ "$ref": "ListAvailableOrgPolicyConstraintsResponse"
+ },
+ "parameterOrder": [
+ "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"
+ ],
+ "flatPath": "v1/organizations/{organizationsId}:listAvailableOrgPolicyConstraints",
+ "path": "v1/{+resource}:listAvailableOrgPolicyConstraints",
+ "id": "cloudresourcemanager.organizations.listAvailableOrgPolicyConstraints",
+ "request": {
+ "$ref": "ListAvailableOrgPolicyConstraintsRequest"
+ },
+ "description": "Lists `Constraints` that could be applied on the specified resource."
+ },
+ "listOrgPolicies": {
+ "request": {
+ "$ref": "ListOrgPoliciesRequest"
+ },
+ "description": "Lists all the `Policies` set for a particular resource.",
+ "response": {
+ "$ref": "ListOrgPoliciesResponse"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "resource": {
+ "pattern": "^organizations/[^/]+$",
+ "location": "path",
+ "description": "Name of the resource to list Policies for.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "flatPath": "v1/organizations/{organizationsId}:listOrgPolicies",
+ "path": "v1/{+resource}:listOrgPolicies",
+ "id": "cloudresourcemanager.organizations.listOrgPolicies"
+ }
+ }
+ },
+ "liens": {
+ "methods": {
+ "create": {
+ "description": "Create a Lien which applies to the resource denoted by the `parent` field.\n\nCallers of this method will require permission on the `parent` resource.\nFor example, applying to `projects/1234` requires permission\n`resourcemanager.projects.updateLiens`.\n\nNOTE: Some resources may limit the number of Liens which may be applied.",
+ "request": {
+ "$ref": "Lien"
+ },
+ "response": {
+ "$ref": "Lien"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "parameters": {},
+ "flatPath": "v1/liens",
+ "path": "v1/liens",
+ "id": "cloudresourcemanager.liens.create"
+ },
+ "delete": {
+ "flatPath": "v1/liens/{liensId}",
+ "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`.",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "DELETE",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The name/identifier of the Lien to delete.",
+ "required": true,
+ "type": "string",
+ "pattern": "^liens/.+$",
+ "location": "path"
+ }
}
},
+ "list": {
+ "path": "v1/liens",
+ "id": "cloudresourcemanager.liens.list",
+ "description": "List all Liens applied to the `parent` resource.\n\nCallers of this method will require permission on the `parent` resource.\nFor example, a Lien with a `parent` of `projects/1234` requires permission\n`resourcemanager.projects.get`.",
+ "response": {
+ "$ref": "ListLiensResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "GET",
+ "parameters": {
+ "pageToken": {
+ "location": "query",
+ "description": "The `next_page_token` value returned from a previous List request, if any.",
+ "type": "string"
+ },
+ "pageSize": {
+ "location": "query",
+ "description": "The maximum number of items to return. This is a suggestion for the server.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "parent": {
+ "description": "The name of the resource to list all attached Liens.\nFor example, `projects/1234`.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "flatPath": "v1/liens"
+ }
+ }
+ },
+ "operations": {
+ "methods": {
+ "get": {
+ "description": "Gets the latest state of a long-running operation. Clients can use this\nmethod to poll the operation result at intervals as recommended by the API\nservice.",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "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",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "flatPath": "v1/operations/{operationsId}",
+ "path": "v1/{+name}",
+ "id": "cloudresourcemanager.operations.get"
+ }
+ }
+ },
+ "folders": {
+ "methods": {
+ "clearOrgPolicy": {
+ "request": {
+ "$ref": "ClearOrgPolicyRequest"
+ },
+ "description": "Clears a `Policy` from a resource.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "resource"
+ ],
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameters": {
+ "resource": {
+ "required": true,
+ "type": "string",
+ "pattern": "^folders/[^/]+$",
+ "location": "path",
+ "description": "Name of the resource for the `Policy` to clear."
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/folders/{foldersId}:clearOrgPolicy",
+ "id": "cloudresourcemanager.folders.clearOrgPolicy",
+ "path": "v1/{+resource}:clearOrgPolicy"
+ },
+ "setOrgPolicy": {
+ "path": "v1/{+resource}:setOrgPolicy",
+ "id": "cloudresourcemanager.folders.setOrgPolicy",
+ "request": {
+ "$ref": "SetOrgPolicyRequest"
+ },
+ "description": "Updates the specified `Policy` on the resource. Creates a new `Policy` for\nthat `Constraint` on the resource if one does not exist.\n\nNot supplying an `etag` on the request `Policy` results in an unconditional\nwrite of the `Policy`.",
+ "response": {
+ "$ref": "OrgPolicy"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "resource": {
+ "description": "Resource name of the resource to attach the `Policy`.",
+ "required": true,
+ "type": "string",
+ "pattern": "^folders/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/folders/{foldersId}:setOrgPolicy"
+ },
+ "listOrgPolicies": {
+ "request": {
+ "$ref": "ListOrgPoliciesRequest"
+ },
+ "description": "Lists all the `Policies` set for a particular resource.",
+ "response": {
+ "$ref": "ListOrgPoliciesResponse"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "resource": {
+ "description": "Name of the resource to list Policies for.",
+ "required": true,
+ "type": "string",
+ "pattern": "^folders/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "flatPath": "v1/folders/{foldersId}:listOrgPolicies",
+ "path": "v1/{+resource}:listOrgPolicies",
+ "id": "cloudresourcemanager.folders.listOrgPolicies"
+ },
"listAvailableOrgPolicyConstraints": {
"description": "Lists `Constraints` that could be applied on the specified resource.",
"request": {
@@ -1674,50 +1836,22 @@
],
"parameters": {
"resource": {
- "location": "path",
"description": "Name of the resource to list `Constraints` for.",
"required": true,
"type": "string",
- "pattern": "^projects/[^/]+$"
+ "pattern": "^folders/[^/]+$",
+ "location": "path"
}
},
- "flatPath": "v1/projects/{projectsId}:listAvailableOrgPolicyConstraints",
+ "flatPath": "v1/folders/{foldersId}:listAvailableOrgPolicyConstraints",
"path": "v1/{+resource}:listAvailableOrgPolicyConstraints",
- "id": "cloudresourcemanager.projects.listAvailableOrgPolicyConstraints"
- },
- "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"
- }
- },
- "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",
- "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"
+ "id": "cloudresourcemanager.folders.listAvailableOrgPolicyConstraints"
},
"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"
},
+ "description": "Gets a `Policy` on a resource.\n\nIf no `Policy` is set on the resource, a `Policy` is returned with default\nvalues including `POLICY_TYPE_NOT_SET` for the `policy_type oneof`. The\n`etag` value can be used with `SetOrgPolicy()` to create or update a\n`Policy` during read-modify-write.",
"response": {
"$ref": "OrgPolicy"
},
@@ -1725,55 +1859,28 @@
"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 the `Policy` is set on.",
"required": true,
"type": "string",
- "pattern": "^projects/[^/]+$"
- }
- },
- "flatPath": "v1/projects/{projectsId}:getOrgPolicy",
- "path": "v1/{+resource}:getOrgPolicy",
- "id": "cloudresourcemanager.projects.getOrgPolicy"
- },
- "undelete": {
- "flatPath": "v1/projects/{projectId}:undelete",
- "path": "v1/projects/{projectId}:undelete",
- "id": "cloudresourcemanager.projects.undelete",
- "request": {
- "$ref": "UndeleteProjectRequest"
- },
- "description": "Restores the Project identified by the specified\n`project_id` (for example, `my-project-123`).\nYou can only use this method for a Project that has a lifecycle state of\nDELETE_REQUESTED.\nAfter deletion starts, the Project cannot be restored.\n\nThe caller must have modify permissions for this Project.",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "projectId"
- ],
- "httpMethod": "POST",
- "parameters": {
- "projectId": {
- "location": "path",
- "description": "The project ID (for example, `foo-bar-123`).\n\nRequired.",
- "required": true,
- "type": "string"
+ "pattern": "^folders/[^/]+$",
+ "location": "path"
}
},
"scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "flatPath": "v1/folders/{foldersId}:getOrgPolicy",
+ "path": "v1/{+resource}:getOrgPolicy",
+ "id": "cloudresourcemanager.folders.getOrgPolicy"
},
"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"
},
- "description": "Gets the effective `Policy` on a resource. This is the result of merging\n`Policies` in the resource hierarchy. The returned `Policy` will not have\nan `etag`set because it is a computed `Policy` across multiple resources.",
"response": {
"$ref": "OrgPolicy"
},
@@ -1781,153 +1888,68 @@
"resource"
],
"httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
"parameters": {
"resource": {
+ "location": "path",
"description": "The name of the resource to start computing the effective `Policy`.",
"required": true,
"type": "string",
- "pattern": "^projects/[^/]+$",
- "location": "path"
+ "pattern": "^folders/[^/]+$"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1/projects/{projectsId}:getEffectiveOrgPolicy",
+ "flatPath": "v1/folders/{foldersId}:getEffectiveOrgPolicy",
"path": "v1/{+resource}:getEffectiveOrgPolicy",
- "id": "cloudresourcemanager.projects.getEffectiveOrgPolicy"
- },
- "update": {
- "flatPath": "v1/projects/{projectId}",
- "path": "v1/projects/{projectId}",
- "id": "cloudresourcemanager.projects.update",
- "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.",
- "response": {
- "$ref": "Project"
- },
- "parameterOrder": [
- "projectId"
- ],
- "httpMethod": "PUT",
- "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"
- ]
- },
- "list": {
- "flatPath": "v1/projects",
- "path": "v1/projects",
- "id": "cloudresourcemanager.projects.list",
- "description": "Lists Projects that are visible to the user and satisfy the\nspecified filter. This method returns Projects in an unspecified order.\nThis method is eventually consistent with project mutations; this means\nthat a newly created project may not appear in the results or recent\nupdates to an existing project may not be reflected in the results. To\nretrieve the latest state of a project, use the\nGetProject method.",
- "response": {
- "$ref": "ListProjectsResponse"
- },
- "parameterOrder": [],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {
- "filter": {
- "description": "An expression for filtering the results of the request. Filter rules are\ncase insensitive. The fields eligible for filtering are:\n\n+ `name`\n+ `id`\n+ \u003ccode\u003elabels.\u003cem\u003ekey\u003c/em\u003e\u003c/code\u003e where *key* is the name of a label\n\nSome examples of using labels as filters:\n\n|Filter|Description|\n|------|-----------|\n|name:how*|The project's name starts with \"how\".|\n|name:Howl|The project's name is `Howl` or `howl`.|\n|name:HOWL|Equivalent to above.|\n|NAME:howl|Equivalent to above.|\n|labels.color:*|The project has the label `color`.|\n|labels.color:red|The project's label `color` has the value `red`.|\n|labels.color:red labels.size:big|The project's label `color` has the value `red` and its label `size` has the value `big`.\n\nIf you specify a filter that has both `parent.type` and `parent.id`, then\nthe `resourcemanager.projects.list` permission is checked on the parent.\nIf the user has this permission, all projects under the parent will be\nreturned after remaining filters have been applied. If the user lacks this\npermission, then all projects for which the user has the\n`resourcemanager.projects.get` permission will be returned after remaining\nfilters have been applied. If no filter is specified, the call will return\nprojects for which the user has `resourcemanager.projects.get` permissions.\n\nOptional.",
- "type": "string",
- "location": "query"
- },
- "pageToken": {
- "description": "A pagination token returned from a previous call to ListProjects\nthat indicates from where listing should continue.\n\nOptional.",
- "type": "string",
- "location": "query"
- },
- "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"
- }
- }
- },
- "setOrgPolicy": {
- "flatPath": "v1/projects/{projectsId}:setOrgPolicy",
- "path": "v1/{+resource}:setOrgPolicy",
- "id": "cloudresourcemanager.projects.setOrgPolicy",
- "request": {
- "$ref": "SetOrgPolicyRequest"
- },
- "description": "Updates the specified `Policy` on the resource. Creates a new `Policy` for\nthat `Constraint` on the resource if one does not exist.\n\nNot supplying an `etag` on the request `Policy` results in an unconditional\nwrite of the `Policy`.",
- "response": {
- "$ref": "OrgPolicy"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
- "parameters": {
- "resource": {
- "description": "Resource name of the resource to attach the `Policy`.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- },
- "create": {
- "request": {
- "$ref": "Project"
- },
- "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.",
- "httpMethod": "POST",
- "parameterOrder": [],
- "response": {
- "$ref": "Operation"
- },
- "parameters": {},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects",
- "id": "cloudresourcemanager.projects.create",
- "path": "v1/projects"
+ "id": "cloudresourcemanager.folders.getEffectiveOrgPolicy"
}
}
}
},
"parameters": {
+ "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": {
+ "description": "OAuth access token.",
+ "type": "string",
+ "location": "query"
+ },
+ "quotaUser": {
+ "location": "query",
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "type": "string"
+ },
+ "pp": {
+ "description": "Pretty-print response.",
+ "type": "boolean",
+ "default": "true",
+ "location": "query"
+ },
"oauth_token": {
"location": "query",
"description": "OAuth 2.0 token for the current user.",
"type": "string"
},
"bearer_token": {
+ "location": "query",
"description": "OAuth bearer token.",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"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",
- "location": "query"
+ "default": "true"
},
"uploadType": {
"location": "query",
@@ -1958,6 +1980,11 @@
"type": "string"
},
"alt": {
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
"type": "string",
"enumDescriptions": [
"Responses with Content-Type of application/json",
@@ -1966,43 +1993,16 @@
],
"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"
+ "default": "json"
}
},
"version": "v1",
"baseUrl": "https://cloudresourcemanager.googleapis.com/",
+ "servicePath": "",
"kind": "discovery#restDescription",
"description": "The Google Cloud Resource Manager API provides methods for creating, reading, and updating project metadata.",
- "servicePath": "",
"basePath": "",
"revision": "20171218",
"documentationLink": "https://cloud.google.com/resource-manager",
- "id": "cloudresourcemanager:v1",
- "discoveryVersion": "v1"
+ "id": "cloudresourcemanager:v1"
}
diff --git a/cloudresourcemanager/v1beta1/cloudresourcemanager-api.json b/cloudresourcemanager/v1beta1/cloudresourcemanager-api.json
index ebc34b8..251cf67 100644
--- a/cloudresourcemanager/v1beta1/cloudresourcemanager-api.json
+++ b/cloudresourcemanager/v1beta1/cloudresourcemanager-api.json
@@ -1,135 +1,46 @@
{
- "batchPath": "batch",
"fullyEncodeReservedExpansion": true,
"title": "Google Cloud Resource Manager API",
"ownerName": "Google",
"resources": {
"projects": {
"methods": {
- "list": {
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "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": {
- "description": "A pagination token returned from a previous call to ListProjects\nthat indicates from where listing should continue.\n\nOptional.",
- "type": "string",
- "location": "query"
- },
- "pageSize": {
- "description": "The maximum number of Projects to return in the response.\nThe server can return fewer Projects than requested.\nIf unspecified, server picks an appropriate default.\n\nOptional.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- }
- },
- "flatPath": "v1beta1/projects",
- "path": "v1beta1/projects",
- "id": "cloudresourcemanager.projects.list",
- "description": "Lists Projects that are visible to the user and satisfy the\nspecified filter. This method returns Projects in an unspecified order.\nThis method is eventually consistent with project mutations; this means\nthat a newly created project may not appear in the results or recent\nupdates to an existing project may not be reflected in the results. To\nretrieve the latest state of a project, use the GetProjectmethod.",
- "response": {
- "$ref": "ListProjectsResponse"
- },
- "parameterOrder": [],
- "httpMethod": "GET"
- },
- "setIamPolicy": {
- "httpMethod": "POST",
- "parameterOrder": [
- "resource"
- ],
- "response": {
- "$ref": "Policy"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "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."
- }
- },
- "flatPath": "v1beta1/projects/{resource}:setIamPolicy",
- "id": "cloudresourcemanager.projects.setIamPolicy",
- "path": "v1beta1/projects/{resource}:setIamPolicy",
- "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.",
- "request": {
- "$ref": "SetIamPolicyRequest"
- }
- },
- "create": {
- "description": "Creates a Project resource.\n\nInitially, the Project resource is owned by its creator exclusively.\nThe creator can later grant permission to others to read or update the\nProject.\n\nSeveral APIs are activated automatically for the Project, including\nGoogle Cloud Storage.",
- "request": {
- "$ref": "Project"
- },
- "response": {
- "$ref": "Project"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "useLegacyStack": {
- "location": "query",
- "description": "A safety hatch to opt out of the new reliable project creation process.",
- "type": "boolean"
- }
- },
- "flatPath": "v1beta1/projects",
- "path": "v1beta1/projects",
- "id": "cloudresourcemanager.projects.create"
- },
"getIamPolicy": {
- "response": {
- "$ref": "Policy"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {
- "resource": {
- "location": "path",
- "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1beta1/projects/{resource}:getIamPolicy",
- "path": "v1beta1/projects/{resource}:getIamPolicy",
- "id": "cloudresourcemanager.projects.getIamPolicy",
- "description": "Returns the IAM access control policy for the specified Project.\nPermission is denied if the policy or the resource does not exist.",
"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": {
- "flatPath": "v1beta1/projects/{projectId}",
- "id": "cloudresourcemanager.projects.get",
- "path": "v1beta1/projects/{projectId}",
- "description": "Retrieves the Project identified by the specified\n`project_id` (for example, `my-project-123`).\n\nThe caller must have read permissions for this Project.",
- "httpMethod": "GET",
+ "response": {
+ "$ref": "Project"
+ },
"parameterOrder": [
"projectId"
],
- "response": {
- "$ref": "Project"
- },
+ "httpMethod": "GET",
"parameters": {
"projectId": {
"description": "The Project ID (for example, `my-project-123`).\n\nRequired.",
@@ -141,9 +52,20 @@
"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",
+ "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."
},
"undelete": {
+ "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"
+ },
"response": {
"$ref": "Empty"
},
@@ -156,21 +78,20 @@
],
"parameters": {
"projectId": {
- "location": "path",
"description": "The project ID (for example, `foo-bar-123`).\n\nRequired.",
"required": true,
- "type": "string"
+ "type": "string",
+ "location": "path"
}
- },
- "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"
}
},
"update": {
+ "path": "v1beta1/projects/{projectId}",
+ "id": "cloudresourcemanager.projects.update",
+ "description": "Updates the attributes of the Project identified by the specified\n`project_id` (for example, `my-project-123`).\n\nThe caller must have modify permissions for this Project.",
+ "request": {
+ "$ref": "Project"
+ },
"response": {
"$ref": "Project"
},
@@ -189,19 +110,9 @@
"location": "path"
}
},
- "flatPath": "v1beta1/projects/{projectId}",
- "path": "v1beta1/projects/{projectId}",
- "id": "cloudresourcemanager.projects.update",
- "description": "Updates the attributes of the Project identified by the specified\n`project_id` (for example, `my-project-123`).\n\nThe caller must have modify permissions for this Project.",
- "request": {
- "$ref": "Project"
- }
+ "flatPath": "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.",
"httpMethod": "POST",
"parameterOrder": [
"projectId"
@@ -223,7 +134,11 @@
],
"flatPath": "v1beta1/projects/{projectId}:getAncestry",
"id": "cloudresourcemanager.projects.getAncestry",
- "path": "v1beta1/projects/{projectId}: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."
},
"testIamPermissions": {
"response": {
@@ -233,6 +148,181 @@
"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",
+ "location": "path"
+ }
+ },
+ "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."
+ },
+ "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.",
+ "httpMethod": "DELETE",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "projectId"
+ ],
+ "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": "v1beta1/projects/{projectId}",
+ "id": "cloudresourcemanager.projects.delete",
+ "path": "v1beta1/projects/{projectId}"
+ },
+ "list": {
+ "response": {
+ "$ref": "ListProjectsResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "parameters": {
+ "filter": {
+ "description": "An expression for filtering the results of the request. Filter rules are\ncase insensitive. The fields eligible for filtering are:\n\n+ `name`\n+ `id`\n+ \u003ccode\u003elabels.\u003cem\u003ekey\u003c/em\u003e\u003c/code\u003e where *key* is the name of a label\n\nSome examples of using labels as filters:\n\n|Filter|Description|\n|------|-----------|\n|name:how*|The project's name starts with \"how\".|\n|name:Howl|The project's name is `Howl` or `howl`.|\n|name:HOWL|Equivalent to above.|\n|NAME:howl|Equivalent to above.|\n|labels.color:*|The project has the label `color`.|\n|labels.color:red|The project's label `color` has the value `red`.|\n|labels.color:red labels.size:big|The project's label `color` has the value `red` and its label `size` has the value `big`.\n\nIf you specify a filter that has both `parent.type` and `parent.id`, then\nthe `resourcemanager.projects.list` permission is checked on the parent.\nIf the user has this permission, all projects under the parent will be\nreturned after remaining filters have been applied. If the user lacks this\npermission, then all projects for which the user has the\n`resourcemanager.projects.get` permission will be returned after remaining\nfilters have been applied. If no filter is specified, the call will return\nprojects for which the user has `resourcemanager.projects.get` permissions.\n\nOptional.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageToken": {
+ "description": "A pagination token returned from a previous call to ListProjects\nthat indicates from where listing should continue.\n\nOptional.",
+ "type": "string",
+ "location": "query"
+ },
+ "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"
+ }
+ },
+ "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": {
+ "response": {
+ "$ref": "Policy"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "resource": {
+ "location": "path",
+ "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1beta1/projects/{resource}:setIamPolicy",
+ "path": "v1beta1/projects/{resource}:setIamPolicy",
+ "id": "cloudresourcemanager.projects.setIamPolicy",
+ "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.",
+ "request": {
+ "$ref": "SetIamPolicyRequest"
+ }
+ },
+ "create": {
+ "response": {
+ "$ref": "Project"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "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",
+ "path": "v1beta1/projects",
+ "id": "cloudresourcemanager.projects.create",
+ "request": {
+ "$ref": "Project"
+ },
+ "description": "Creates a Project resource.\n\nInitially, the Project resource is owned by its creator exclusively.\nThe creator can later grant permission to others to read or update the\nProject.\n\nSeveral APIs are activated automatically for the Project, including\nGoogle Cloud Storage."
+ }
+ }
+ },
+ "organizations": {
+ "methods": {
+ "update": {
+ "id": "cloudresourcemanager.organizations.update",
+ "path": "v1beta1/{+name}",
+ "request": {
+ "$ref": "Organization"
+ },
+ "description": "Updates an Organization resource identified by the specified resource name.",
+ "httpMethod": "PUT",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Organization"
+ },
+ "parameters": {
+ "name": {
+ "pattern": "^organizations/[^/]+$",
+ "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"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta1/organizations/{organizationsId}"
+ },
+ "testIamPermissions": {
+ "flatPath": "v1beta1/organizations/{organizationsId}:testIamPermissions",
+ "path": "v1beta1/{+resource}:testIamPermissions",
+ "id": "cloudresourcemanager.organizations.testIamPermissions",
+ "description": "Returns permissions that a caller has on the specified Organization.\nThe `resource` field should be the organization's resource name,\ne.g. \"organizations/123\".",
+ "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"
@@ -242,50 +332,45 @@
"description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
"required": true,
"type": "string",
+ "pattern": "^organizations/[^/]+$",
"location": "path"
}
- },
- "flatPath": "v1beta1/projects/{resource}:testIamPermissions",
- "path": "v1beta1/projects/{resource}:testIamPermissions",
- "id": "cloudresourcemanager.projects.testIamPermissions",
- "description": "Returns permissions that a caller has on the specified Project.",
- "request": {
- "$ref": "TestIamPermissionsRequest"
}
},
- "delete": {
+ "list": {
+ "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.",
"response": {
- "$ref": "Empty"
+ "$ref": "ListOrganizationsResponse"
},
- "parameterOrder": [
- "projectId"
- ],
- "httpMethod": "DELETE",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
+ "parameterOrder": [],
+ "httpMethod": "GET",
"parameters": {
- "projectId": {
- "description": "The Project ID (for example, `foo-bar-123`).\n\nRequired.",
- "required": true,
- "type": "string",
- "location": "path"
+ "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"
+ },
+ "pageSize": {
+ "description": "The maximum number of Organizations to return in the response.\nThis field is optional.",
+ "format": "int32",
+ "type": "integer",
+ "location": "query"
+ },
+ "filter": {
+ "location": "query",
+ "description": "An optional query string used to filter the Organizations to return in\nthe response. Filter rules are case-insensitive.\n\n\nOrganizations may be filtered by `owner.directoryCustomerId` or by\n`domain`, where the domain is a Google for Work domain, for example:\n\n|Filter|Description|\n|------|-----------|\n|owner.directorycustomerid:123456789|Organizations with `owner.directory_customer_id` equal to `123456789`.|\n|domain:google.com|Organizations corresponding to the domain `google.com`.|\n\nThis field is optional.",
+ "type": "string"
}
},
- "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."
- }
- }
- },
- "organizations": {
- "methods": {
- "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\".",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "flatPath": "v1beta1/organizations"
+ },
+ "setIamPolicy": {
"httpMethod": "POST",
"parameterOrder": [
"resource"
@@ -295,7 +380,7 @@
},
"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": "^organizations/[^/]+$",
@@ -303,12 +388,44 @@
}
},
"scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta1/organizations/{organizationsId}:setIamPolicy",
+ "id": "cloudresourcemanager.organizations.setIamPolicy",
+ "path": "v1beta1/{+resource}:setIamPolicy",
+ "request": {
+ "$ref": "SetIamPolicyRequest"
+ },
+ "description": "Sets the access control policy on an Organization resource. Replaces any\nexisting policy. The `resource` field should be the organization's resource\nname, e.g. \"organizations/123\"."
+ },
+ "getIamPolicy": {
+ "path": "v1beta1/{+resource}:getIamPolicy",
+ "id": "cloudresourcemanager.organizations.getIamPolicy",
+ "request": {
+ "$ref": "GetIamPolicyRequest"
+ },
+ "description": "Gets the access control policy for an Organization resource. May be empty\nif no such policy or resource exists. The `resource` field should be the\norganization's resource name, e.g. \"organizations/123\".",
+ "response": {
+ "$ref": "Policy"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "resource": {
+ "location": "path",
+ "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",
+ "required": true,
+ "type": "string",
+ "pattern": "^organizations/[^/]+$"
+ }
+ },
+ "scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
],
- "flatPath": "v1beta1/organizations/{organizationsId}:getIamPolicy",
- "id": "cloudresourcemanager.organizations.getIamPolicy",
- "path": "v1beta1/{+resource}:getIamPolicy"
+ "flatPath": "v1beta1/organizations/{organizationsId}:getIamPolicy"
},
"get": {
"response": {
@@ -323,146 +440,56 @@
"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": {
+ "pattern": "^organizations/[^/]+$",
+ "location": "path",
"description": "The resource name of the Organization to fetch, e.g. \"organizations/1234\".",
"required": true,
- "type": "string",
- "pattern": "^organizations/[^/]+$",
- "location": "path"
- },
- "organizationId": {
- "type": "string",
- "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"
}
},
"flatPath": "v1beta1/organizations/{organizationsId}",
"path": "v1beta1/{+name}",
"id": "cloudresourcemanager.organizations.get",
"description": "Fetches an Organization resource identified by the specified resource name."
- },
- "update": {
- "httpMethod": "PUT",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Organization"
- },
- "parameters": {
- "name": {
- "description": "Output Only. The resource name of the organization. This is the\norganization's relative path in the API. Its format is\n\"organizations/[organization_id]\". For example, \"organizations/1234\".",
- "required": true,
- "type": "string",
- "pattern": "^organizations/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta1/organizations/{organizationsId}",
- "id": "cloudresourcemanager.organizations.update",
- "path": "v1beta1/{+name}",
- "request": {
- "$ref": "Organization"
- },
- "description": "Updates an Organization resource identified by the specified resource name."
- },
- "testIamPermissions": {
- "flatPath": "v1beta1/organizations/{organizationsId}:testIamPermissions",
- "id": "cloudresourcemanager.organizations.testIamPermissions",
- "path": "v1beta1/{+resource}:testIamPermissions",
- "request": {
- "$ref": "TestIamPermissionsRequest"
- },
- "description": "Returns permissions that a caller has on the specified Organization.\nThe `resource` field should be the organization's resource name,\ne.g. \"organizations/123\".",
- "httpMethod": "POST",
- "parameterOrder": [
- "resource"
- ],
- "response": {
- "$ref": "TestIamPermissionsResponse"
- },
- "parameters": {
- "resource": {
- "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
- "required": true,
- "type": "string",
- "pattern": "^organizations/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ]
- },
- "list": {
- "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.",
- "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": {
- "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"
- },
- "pageSize": {
- "location": "query",
- "description": "The maximum number of Organizations to return in the response.\nThis field is optional.",
- "format": "int32",
- "type": "integer"
- },
- "filter": {
- "location": "query",
- "description": "An optional query string used to filter the Organizations to return in\nthe response. Filter rules are case-insensitive.\n\n\nOrganizations may be filtered by `owner.directoryCustomerId` or by\n`domain`, where the domain is a Google for Work domain, for example:\n\n|Filter|Description|\n|------|-----------|\n|owner.directorycustomerid:123456789|Organizations with `owner.directory_customer_id` equal to `123456789`.|\n|domain:google.com|Organizations corresponding to the domain `google.com`.|\n\nThis field is optional.",
- "type": "string"
- }
- },
- "flatPath": "v1beta1/organizations"
- },
- "setIamPolicy": {
- "httpMethod": "POST",
- "parameterOrder": [
- "resource"
- ],
- "response": {
- "$ref": "Policy"
- },
- "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",
- "id": "cloudresourcemanager.organizations.setIamPolicy",
- "path": "v1beta1/{+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\".",
- "request": {
- "$ref": "SetIamPolicyRequest"
- }
}
}
}
},
"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": {
+ "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": [
@@ -479,20 +506,20 @@
"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",
- "location": "query"
+ "type": "string"
},
"pp": {
"location": "query",
@@ -500,15 +527,15 @@
"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"
+ "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\").",
@@ -516,38 +543,10 @@
"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"
- },
- "fields": {
- "location": "query",
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string"
- },
- "callback": {
- "location": "query",
- "description": "JSONP",
- "type": "string"
- },
- "$.xgafv": {
- "description": "V1 error format.",
- "type": "string",
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query",
- "enum": [
- "1",
- "2"
- ]
+ "default": "true"
}
},
"version": "v1beta1",
@@ -556,79 +555,16 @@
"description": "The Google Cloud Resource Manager API provides methods for creating, reading, and updating project metadata.",
"servicePath": "",
"basePath": "",
- "revision": "20171218",
- "documentationLink": "https://cloud.google.com/resource-manager",
"id": "cloudresourcemanager:v1beta1",
+ "documentationLink": "https://cloud.google.com/resource-manager",
+ "revision": "20171218",
"discoveryVersion": "v1",
"schemas": {
- "Ancestor": {
- "description": "Identifying information for a single ancestor of a project.",
- "type": "object",
- "properties": {
- "resourceId": {
- "description": "Resource id of the ancestor.",
- "$ref": "ResourceId"
- }
- },
- "id": "Ancestor"
- },
- "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": {
- "organizations": {
- "description": "The list of Organizations that matched the list query, possibly paginated.",
- "type": "array",
- "items": {
- "$ref": "Organization"
- }
- },
- "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"
- }
- },
- "id": "ListOrganizationsResponse"
- },
- "Binding": {
- "type": "object",
- "properties": {
- "role": {
- "description": "Role that is assigned to `members`.\nFor example, `roles/viewer`, `roles/editor`, or `roles/owner`.\nRequired",
- "type": "string"
- },
- "members": {
- "description": "Specifies the identities requesting access for a Cloud Platform resource.\n`members` can have the following values:\n\n* `allUsers`: A special identifier that represents anyone who is\n on the internet; with or without a Google account.\n\n* `allAuthenticatedUsers`: A special identifier that represents anyone\n who is authenticated with a Google account or a service account.\n\n* `user:{emailid}`: An email address that represents a specific Google\n account. For example, `alice@gmail.com` or `joe@example.com`.\n\n\n* `serviceAccount:{emailid}`: An email address that represents a service\n account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{emailid}`: An email address that represents a Google group.\n For example, `admins@example.com`.\n\n\n* `domain:{domain}`: A Google Apps domain name that represents all the\n users of that domain. For example, `google.com` or `example.com`.\n\n",
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "id": "Binding",
- "description": "Associates `members` with a `role`."
- },
"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"
},
"UndeleteProjectRequest": {
"description": "The request sent to the UndeleteProject\nmethod.",
@@ -640,6 +576,20 @@
"description": "The root node in the resource hierarchy to which a particular entity's\n(e.g., company) resources belong.",
"type": "object",
"properties": {
+ "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."
+ ]
+ },
"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"
@@ -660,20 +610,6 @@
"organizationId": {
"description": "An immutable id for the Organization that is assigned on creation. This\nshould be omitted when creating a new Organization.\nThis field is read-only.\nThis field is deprecated and will be removed in v1. Use name instead.",
"type": "string"
- },
- "lifecycleState": {
- "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."
- ],
- "enum": [
- "LIFECYCLE_STATE_UNSPECIFIED",
- "ACTIVE",
- "DELETE_REQUESTED"
- ]
}
},
"id": "Organization"
@@ -723,11 +659,11 @@
"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"
- },
- "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"
@@ -744,8 +680,6 @@
"id": "OrganizationOwner"
},
"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.",
@@ -755,7 +689,6 @@
}
},
"logType": {
- "type": "string",
"enumDescriptions": [
"Default case. Should never be this.",
"Admin reads. Example: CloudIAM getIamPolicy",
@@ -768,10 +701,13 @@
"DATA_WRITE",
"DATA_READ"
],
- "description": "The log type that this config enables."
+ "description": "The log type that this config enables.",
+ "type": "string"
}
},
- "id": "AuditLogConfig"
+ "id": "AuditLogConfig",
+ "description": "Provides the configuration for logging a type of permissions.\nExample:\n\n {\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n }\n ]\n }\n\nThis enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting\nfoo@gmail.com from DATA_READ logging.",
+ "type": "object"
},
"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.",
@@ -801,18 +737,27 @@
"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": {
+ "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"
+ },
+ "labels": {
+ "description": "The labels associated with this Project.\n\nLabel keys must be between 1 and 63 characters long and must conform\nto the following regular expression: \\[a-z\\](\\[-a-z0-9\\]*\\[a-z0-9\\])?.\n\nLabel values must be between 0 and 63 characters long and must conform\nto the regular expression (\\[a-z\\](\\[-a-z0-9\\]*\\[a-z0-9\\])?)?.\n\nNo more than 256 labels can be associated with a given resource.\n\nClients should store labels in a representation such as JSON that does not\ndepend on specific characters being disallowed.\n\nExample: \u003ccode\u003e\"environment\" : \"dev\"\u003c/code\u003e\nRead-write.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
"createTime": {
"description": "Creation time.\n\nRead-only.",
"format": "google-datetime",
"type": "string"
},
- "labels": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "The labels associated with this Project.\n\nLabel keys must be between 1 and 63 characters long and must conform\nto the following regular expression: \\[a-z\\](\\[-a-z0-9\\]*\\[a-z0-9\\])?.\n\nLabel values must be between 0 and 63 characters long and must conform\nto the regular expression (\\[a-z\\](\\[-a-z0-9\\]*\\[a-z0-9\\])?)?.\n\nNo more than 256 labels can be associated with a given resource.\n\nClients should store labels in a representation such as JSON that does not\ndepend on specific characters being disallowed.\n\nExample: \u003ccode\u003e\"environment\" : \"dev\"\u003c/code\u003e\nRead-write.",
- "type": "object"
- },
"name": {
"description": "The user-assigned display name of the Project.\nIt must be 4 to 30 characters.\nAllowed characters are: lowercase and uppercase letters, numbers,\nhyphen, single-quote, double-quote, space, and exclamation point.\n\nExample: \u003ccode\u003eMy Project\u003c/code\u003e\nRead-write.",
"type": "string"
@@ -822,7 +767,6 @@
"type": "string"
},
"lifecycleState": {
- "type": "string",
"enumDescriptions": [
"Unspecified state. This is only used/useful for distinguishing\nunset values.",
"The normal and active state.",
@@ -835,33 +779,25 @@
"DELETE_REQUESTED",
"DELETE_IN_PROGRESS"
],
- "description": "The Project lifecycle state.\n\nRead-only."
- },
- "projectNumber": {
- "description": "The number uniquely identifying the project.\n\nExample: \u003ccode\u003e415104041262\u003c/code\u003e\nRead-only.",
- "format": "int64",
+ "description": "The Project lifecycle state.\n\nRead-only.",
"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."
}
},
"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"
- },
- "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"
+ "id": "TestIamPermissionsRequest",
+ "description": "Request message for `TestIamPermissions` method.",
+ "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).",
@@ -885,11 +821,11 @@
}
},
"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"
@@ -930,22 +866,21 @@
"id": "FolderOperationError"
},
"FolderOperation": {
- "id": "FolderOperation",
"description": "Metadata describing a long running folder operation",
"type": "object",
"properties": {
"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."
+ ],
+ "enum": [
+ "OPERATION_TYPE_UNSPECIFIED",
+ "CREATE",
+ "MOVE"
]
},
"displayName": {
@@ -960,61 +895,126 @@
"description": "The resource name of the folder or organization we are either creating\nthe folder under or moving the folder to.",
"type": "string"
}
- }
+ },
+ "id": "FolderOperation"
},
"ResourceId": {
+ "description": "A container to reference an id for any resource type. A `resource` in Google\nCloud Platform is a generic term for something you (a developer) may want to\ninteract with through one of our API's. Some examples are an App Engine app,\na Compute Engine instance, a Cloud SQL database, and so on.",
"type": "object",
"properties": {
- "type": {
- "description": "Required field representing the resource type this id is for.\nAt present, the valid types are \"project\", \"folder\", and \"organization\".",
- "type": "string"
- },
"id": {
"description": "Required field for the type-specific id. This should correspond to the id\nused in the type-specific API's.",
"type": "string"
+ },
+ "type": {
+ "description": "Required field representing the resource type this id is for.\nAt present, the valid types are \"project\", \"folder\", and \"organization\".",
+ "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": {
"description": "Specifies the audit configuration for a service.\nThe configuration determines which permission types are logged, and what\nidentities, if any, are exempted from logging.\nAn AuditConfig must have one or more AuditLogConfigs.\n\nIf there are AuditConfigs for both `allServices` and a specific service,\nthe union of the two AuditConfigs is used for that service: the log_types\nspecified in each AuditConfig are enabled, and the exempted_members in each\nAuditConfig are exempted.\n\nExample Policy with multiple AuditConfigs:\n\n {\n \"audit_configs\": [\n {\n \"service\": \"allServices\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n },\n {\n \"log_type\": \"ADMIN_READ\",\n }\n ]\n },\n {\n \"service\": \"fooservice.googleapis.com\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n },\n {\n \"log_type\": \"DATA_WRITE\",\n \"exempted_members\": [\n \"user:bar@gmail.com\"\n ]\n }\n ]\n }\n ]\n }\n\nFor fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ\nlogging. It also exempts foo@gmail.com from DATA_READ logging, and\nbar@gmail.com from DATA_WRITE logging.",
"type": "object",
"properties": {
- "service": {
- "description": "Specifies a service that will be enabled for audit logging.\nFor example, `storage.googleapis.com`, `cloudsql.googleapis.com`.\n`allServices` is a special value that covers all services.",
- "type": "string"
- },
"auditLogConfigs": {
"description": "The configuration for logging of each type of permission.\nNext ID: 4",
"type": "array",
"items": {
"$ref": "AuditLogConfig"
}
+ },
+ "service": {
+ "description": "Specifies a service that will be enabled for audit logging.\nFor example, `storage.googleapis.com`, `cloudsql.googleapis.com`.\n`allServices` is a special value that covers all services.",
+ "type": "string"
}
},
"id": "AuditConfig"
+ },
+ "Ancestor": {
+ "description": "Identifying information for a single ancestor of a project.",
+ "type": "object",
+ "properties": {
+ "resourceId": {
+ "description": "Resource id of the ancestor.",
+ "$ref": "ResourceId"
+ }
+ },
+ "id": "Ancestor"
+ },
+ "SetIamPolicyRequest": {
+ "description": "Request message for `SetIamPolicy` method.",
+ "type": "object",
+ "properties": {
+ "updateMask": {
+ "description": "OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only\nthe fields in the mask will be modified. If no mask is provided, the\nfollowing default mask is used:\npaths: \"bindings, etag\"\nThis field is only used by Cloud IAM.",
+ "format": "google-fieldmask",
+ "type": "string"
+ },
+ "policy": {
+ "description": "REQUIRED: The complete policy to be applied to the `resource`. The size of\nthe policy is limited to a few 10s of KB. An empty policy is a\nvalid policy but certain Cloud Platform services (such as Projects)\nmight reject them.",
+ "$ref": "Policy"
+ }
+ },
+ "id": "SetIamPolicyRequest"
+ },
+ "ListOrganizationsResponse": {
+ "description": "The response returned from the `ListOrganizations` method.",
+ "type": "object",
+ "properties": {
+ "organizations": {
+ "description": "The list of Organizations that matched the list query, possibly paginated.",
+ "type": "array",
+ "items": {
+ "$ref": "Organization"
+ }
+ },
+ "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"
+ }
+ },
+ "id": "ListOrganizationsResponse"
+ },
+ "Binding": {
+ "description": "Associates `members` with a `role`.",
+ "type": "object",
+ "properties": {
+ "members": {
+ "description": "Specifies the identities requesting access for a Cloud Platform resource.\n`members` can have the following values:\n\n* `allUsers`: A special identifier that represents anyone who is\n on the internet; with or without a Google account.\n\n* `allAuthenticatedUsers`: A special identifier that represents anyone\n who is authenticated with a Google account or a service account.\n\n* `user:{emailid}`: An email address that represents a specific Google\n account. For example, `alice@gmail.com` or `joe@example.com`.\n\n\n* `serviceAccount:{emailid}`: An email address that represents a service\n account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{emailid}`: An email address that represents a Google group.\n For example, `admins@example.com`.\n\n\n* `domain:{domain}`: A Google Apps domain name that represents all the\n users of that domain. For example, `google.com` or `example.com`.\n\n",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "role": {
+ "description": "Role that is assigned to `members`.\nFor example, `roles/viewer`, `roles/editor`, or `roles/owner`.\nRequired",
+ "type": "string"
+ }
+ },
+ "id": "Binding"
}
},
"icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
+ "x32": "http://www.google.com/images/icons/product/search-32.gif",
+ "x16": "http://www.google.com/images/icons/product/search-16.gif"
},
"protocol": "rest",
"canonicalName": "Cloud Resource Manager",
"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/cloud-platform.read-only": {
+ "description": "View your data across Google Cloud Platform services"
}
}
}
},
"rootUrl": "https://cloudresourcemanager.googleapis.com/",
"ownerDomain": "google.com",
- "name": "cloudresourcemanager"
+ "name": "cloudresourcemanager",
+ "batchPath": "batch"
}
diff --git a/cloudresourcemanager/v2beta1/cloudresourcemanager-api.json b/cloudresourcemanager/v2beta1/cloudresourcemanager-api.json
index 8ad91b0..4a1d8d2 100644
--- a/cloudresourcemanager/v2beta1/cloudresourcemanager-api.json
+++ b/cloudresourcemanager/v2beta1/cloudresourcemanager-api.json
@@ -1,32 +1,89 @@
{
- "kind": "discovery#restDescription",
- "description": "The Google Cloud Resource Manager API provides methods for creating, reading, and updating project metadata.",
- "servicePath": "",
- "basePath": "",
- "id": "cloudresourcemanager:v2beta1",
- "documentationLink": "https://cloud.google.com/resource-manager",
- "revision": "20171218",
"discoveryVersion": "v1",
"schemas": {
- "SetIamPolicyRequest": {
- "type": "object",
+ "AuditConfig": {
"properties": {
- "updateMask": {
- "type": "string",
- "description": "OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only\nthe fields in the mask will be modified. If no mask is provided, the\nfollowing default mask is used:\npaths: \"bindings, etag\"\nThis field is only used by Cloud IAM.",
- "format": "google-fieldmask"
+ "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"
},
- "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."
+ "auditLogConfigs": {
+ "description": "The configuration for logging of each type of permission.\nNext ID: 4",
+ "type": "array",
+ "items": {
+ "$ref": "AuditLogConfig"
+ }
}
},
- "id": "SetIamPolicyRequest",
- "description": "Request message for `SetIamPolicy` method."
+ "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"
+ },
+ "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"
+ },
+ "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.",
+ "type": "array",
+ "items": {
+ "$ref": "Folder"
+ }
+ },
+ "nextPageToken": {
+ "description": "A pagination token returned from a previous call to `ListFolders`\nthat indicates from where listing should continue.\nThis field is optional.",
+ "type": "string"
+ }
+ },
+ "id": "ListFoldersResponse"
+ },
+ "MoveFolderRequest": {
+ "properties": {
+ "destinationParent": {
+ "description": "The resource name of the Folder or Organization to reparent\nthe folder under.\nMust be of the form `folders/{folder_id}` or `organizations/{org_id}`.",
+ "type": "string"
+ }
+ },
+ "id": "MoveFolderRequest",
+ "description": "The MoveFolder request message.",
+ "type": "object"
},
"SearchFoldersResponse": {
- "description": "The response message for searching folders.",
- "type": "object",
"properties": {
"nextPageToken": {
"description": "A pagination token returned from a previous call to `SearchFolders`\nthat indicates from where searching should continue.\nThis field is optional.",
@@ -40,17 +97,28 @@
}
}
},
- "id": "SearchFoldersResponse"
+ "id": "SearchFoldersResponse",
+ "description": "The response message for searching folders.",
+ "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.",
+ "SetIamPolicyRequest": {
+ "description": "Request message for `SetIamPolicy` method.",
"type": "object",
"properties": {
- "code": {
- "description": "The status code, which should be an enum value of google.rpc.Code.",
- "format": "int32",
- "type": "integer"
+ "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": {
+ "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"
@@ -60,17 +128,23 @@
"type": "array",
"items": {
"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"
},
"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"
},
"Binding": {
- "type": "object",
"properties": {
"members": {
"description": "Specifies the identities requesting access for a Cloud Platform resource.\n`members` can have the following values:\n\n* `allUsers`: A special identifier that represents anyone who is\n on the internet; with or without a Google account.\n\n* `allAuthenticatedUsers`: A special identifier that represents anyone\n who is authenticated with a Google account or a service account.\n\n* `user:{emailid}`: An email address that represents a specific Google\n account. For example, `alice@gmail.com` or `joe@example.com`.\n\n\n* `serviceAccount:{emailid}`: An email address that represents a service\n account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{emailid}`: An email address that represents a Google group.\n For example, `admins@example.com`.\n\n\n* `domain:{domain}`: A Google Apps domain name that represents all the\n users of that domain. For example, `google.com` or `example.com`.\n\n",
@@ -85,9 +159,11 @@
}
},
"id": "Binding",
- "description": "Associates `members` with a `role`."
+ "description": "Associates `members` with a `role`.",
+ "type": "object"
},
"SearchFoldersRequest": {
+ "description": "The request message for searching folders.",
"type": "object",
"properties": {
"pageToken": {
@@ -104,35 +180,11 @@
"type": "string"
}
},
- "id": "SearchFoldersRequest",
- "description": "The request message for searching folders."
- },
- "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"
+ "id": "SearchFoldersRequest"
},
"Folder": {
- "description": "A Folder in an Organization's resource hierarchy, used to\norganize that Organization's resources.",
- "type": "object",
"properties": {
"lifecycleState": {
- "type": "string",
"enumDescriptions": [
"Unspecified state.",
"The normal and active state.",
@@ -143,7 +195,8 @@
"ACTIVE",
"DELETE_REQUESTED"
],
- "description": "Output only. The lifecycle state of the folder.\nUpdates to the lifecycle_state must be performed via\nDeleteFolder and\nUndeleteFolder."
+ "description": "Output only. The lifecycle state of the folder.\nUpdates to the lifecycle_state must be performed via\nDeleteFolder and\nUndeleteFolder.",
+ "type": "string"
},
"name": {
"description": "Output only. The resource name of the Folder.\nIts format is `folders/{folder_id}`, for example: \"folders/1234\".",
@@ -163,13 +216,35 @@
"type": "string"
}
},
- "id": "Folder"
+ "id": "Folder",
+ "description": "A Folder in an Organization's resource hierarchy, used to\norganize that Organization's resources.",
+ "type": "object"
+ },
+ "ProjectCreationStatus": {
+ "description": "A status object which is used as the `metadata` field for the Operation\nreturned by CreateProject. It provides insight for when significant phases of\nProject creation have completed.",
+ "type": "object",
+ "properties": {
+ "ready": {
+ "description": "True if the project creation process is complete.",
+ "type": "boolean"
+ },
+ "createTime": {
+ "description": "Creation time of the project creation workflow.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "gettable": {
+ "description": "True if the project can be retrieved using GetProject. No other operations\non the project are guaranteed to work until the project creation is\ncomplete.",
+ "type": "boolean"
+ }
+ },
+ "id": "ProjectCreationStatus"
},
"GetIamPolicyRequest": {
- "description": "Request message for `GetIamPolicy` method.",
- "type": "object",
"properties": {},
- "id": "GetIamPolicyRequest"
+ "id": "GetIamPolicyRequest",
+ "description": "Request message for `GetIamPolicy` method.",
+ "type": "object"
},
"TestIamPermissionsResponse": {
"description": "Response message for `TestIamPermissions` method.",
@@ -186,10 +261,10 @@
"id": "TestIamPermissionsResponse"
},
"UndeleteFolderRequest": {
- "properties": {},
- "id": "UndeleteFolderRequest",
"description": "The UndeleteFolder request message.",
- "type": "object"
+ "type": "object",
+ "properties": {},
+ "id": "UndeleteFolderRequest"
},
"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.",
@@ -235,6 +310,74 @@
},
"id": "TestIamPermissionsRequest"
},
+ "FolderOperationError": {
+ "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",
+ "description": "A classification of the Folder Operation error.",
+ "type": "object"
+ },
+ "FolderOperation": {
+ "description": "Metadata describing a long running folder operation",
+ "type": "object",
+ "properties": {
+ "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": {
+ "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",
@@ -265,172 +408,22 @@
}
},
"id": "Policy"
- },
- "FolderOperation": {
- "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": {
- "type": "string",
- "description": "The resource name of the folder or organization we are either creating\nthe folder under or moving the folder to."
- }
- },
- "id": "FolderOperation",
- "description": "Metadata describing a long running folder operation",
- "type": "object"
- },
- "FolderOperationError": {
- "properties": {
- "errorMessageId": {
- "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."
- ],
- "enum": [
- "ERROR_TYPE_UNSPECIFIED",
- "ACTIVE_FOLDER_HEIGHT_VIOLATION",
- "MAX_CHILD_FOLDERS_VIOLATION",
- "FOLDER_NAME_UNIQUENESS_VIOLATION",
- "RESOURCE_DELETED_VIOLATION",
- "PARENT_DELETED_VIOLATION",
- "CYCLE_INTRODUCED_VIOLATION",
- "FOLDER_BEING_MOVED_VIOLATION",
- "FOLDER_TO_DELETE_NON_EMPTY_VIOLATION",
- "DELETED_FOLDER_HEIGHT_VIOLATION"
- ],
- "description": "The type of operation error experienced."
- }
- },
- "id": "FolderOperationError",
- "description": "A classification of the Folder Operation error.",
- "type": "object"
- },
- "Operation": {
- "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",
- "description": "This resource represents a long-running operation that is the result of a\nnetwork API call."
- },
- "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"
- }
- }
- }
- },
- "ListFoldersResponse": {
- "description": "The ListFolders response message.",
- "type": "object",
- "properties": {
- "nextPageToken": {
- "description": "A pagination token returned from a previous call to `ListFolders`\nthat indicates from where listing should continue.\nThis field is optional.",
- "type": "string"
- },
- "folders": {
- "type": "array",
- "items": {
- "$ref": "Folder"
- },
- "description": "A possibly paginated list of Folders that are direct descendants of\nthe specified parent resource."
- }
- },
- "id": "ListFoldersResponse"
- },
- "MoveFolderRequest": {
- "type": "object",
- "properties": {
- "destinationParent": {
- "description": "The resource name of the Folder or Organization to reparent\nthe folder under.\nMust be of the form `folders/{folder_id}` or `organizations/{org_id}`.",
- "type": "string"
- }
- },
- "id": "MoveFolderRequest",
- "description": "The MoveFolder request message."
}
},
+ "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 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"
+ },
+ "https://www.googleapis.com/auth/cloud-platform.read-only": {
+ "description": "View your data across Google Cloud Platform services"
}
}
}
@@ -445,98 +438,12 @@
"resources": {
"folders": {
"methods": {
- "delete": {
- "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.",
- "response": {
- "$ref": "Folder"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "DELETE",
- "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/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v2beta1/folders/{foldersId}"
- },
- "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": {
- "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",
- "location": "query"
- },
- "showDeleted": {
- "location": "query",
- "description": "Controls whether Folders in the\nDELETE_REQUESTED\nstate should be returned.",
- "type": "boolean"
- },
- "pageToken": {
- "type": "string",
- "location": "query",
- "description": "A pagination token returned from a previous call to `ListFolders`\nthat indicates where this listing should continue from.\nThis field is optional."
- },
- "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",
- "path": "v2beta1/folders",
- "id": "cloudresourcemanager.folders.list"
- },
- "setIamPolicy": {
- "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"
- },
- "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"
- ]
- },
"create": {
+ "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}`.",
@@ -548,17 +455,40 @@
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v2beta1/folders",
- "path": "v2beta1/folders",
"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.",
+ "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."
+ },
+ "setIamPolicy": {
"response": {
- "$ref": "Operation"
+ "$ref": "Policy"
},
- "parameterOrder": [],
- "httpMethod": "POST"
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "resource": {
+ "pattern": "^folders/[^/]+$",
+ "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": "v2beta1/folders/{foldersId}:setIamPolicy",
+ "path": "v2beta1/{+resource}:setIamPolicy",
+ "id": "cloudresourcemanager.folders.setIamPolicy",
+ "request": {
+ "$ref": "SetIamPolicyRequest"
+ },
+ "description": "Sets the access control policy on a Folder, replacing any existing policy.\nThe `resource` field should be the Folder's resource name, e.g.\n\"folders/1234\".\nThe caller must have `resourcemanager.folders.setIamPolicy` permission\non the identified folder."
},
"getIamPolicy": {
"response": {
@@ -574,11 +504,11 @@
],
"parameters": {
"resource": {
+ "pattern": "^folders/[^/]+$",
"location": "path",
"description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",
"required": true,
- "type": "string",
- "pattern": "^folders/[^/]+$"
+ "type": "string"
}
},
"flatPath": "v2beta1/folders/{foldersId}:getIamPolicy",
@@ -590,57 +520,51 @@
}
},
"search": {
+ "path": "v2beta1/folders:search",
+ "id": "cloudresourcemanager.folders.search",
+ "description": "Search for folders that match specific filter criteria.\nSearch provides an eventually consistent view of the folders a user has\naccess to which meet the specified filter criteria.\n\nThis will only return folders on which the caller has the\npermission `resourcemanager.folders.get`.",
"request": {
"$ref": "SearchFoldersRequest"
},
- "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": {},
+ "parameterOrder": [],
+ "httpMethod": "POST",
"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"
+ "parameters": {},
+ "flatPath": "v2beta1/folders:search"
},
- "patch": {
- "flatPath": "v2beta1/folders/{foldersId}",
- "path": "v2beta1/{+name}",
- "id": "cloudresourcemanager.folders.patch",
+ "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": "Folder"
+ "$ref": "UndeleteFolderRequest"
},
- "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.",
"response": {
"$ref": "Folder"
},
"parameterOrder": [
"name"
],
- "httpMethod": "PATCH",
+ "httpMethod": "POST",
+ "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": {
- "description": "Output only. The resource name of the Folder.\nIts format is `folders/{folder_id}`, for example: \"folders/1234\".",
+ "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"
},
"get": {
"response": {
@@ -650,37 +574,127 @@
"name"
],
"httpMethod": "GET",
- "parameters": {
- "name": {
- "location": "path",
- "description": "The resource name of the Folder to retrieve.\nMust be of the form `folders/{folder_id}`.",
- "required": true,
- "type": "string",
- "pattern": "^folders/[^/]+$"
- }
- },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
],
+ "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."
},
- "undelete": {
+ "patch": {
+ "response": {
+ "$ref": "Folder"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "PATCH",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "updateMask": {
+ "description": "Fields to be updated.\nOnly the `display_name` can be updated.",
+ "format": "google-fieldmask",
+ "type": "string",
+ "location": "query"
+ },
+ "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"
+ }
+ },
+ "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.",
"httpMethod": "POST",
"parameterOrder": [
"name"
],
"response": {
+ "$ref": "Operation"
+ },
+ "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",
+ "id": "cloudresourcemanager.folders.move",
+ "path": "v2beta1/{+name}:move"
+ },
+ "testIamPermissions": {
+ "response": {
+ "$ref": "TestIamPermissionsResponse"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "resource": {
+ "pattern": "^folders/[^/]+$",
+ "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": "v2beta1/folders/{foldersId}:testIamPermissions",
+ "path": "v2beta1/{+resource}:testIamPermissions",
+ "id": "cloudresourcemanager.folders.testIamPermissions",
+ "description": "Returns permissions that a caller has on the specified Folder.\nThe `resource` field should be the Folder's resource name,\ne.g. \"folders/1234\".\n\nThere are no permissions required for making this API call.",
+ "request": {
+ "$ref": "TestIamPermissionsRequest"
+ }
+ },
+ "delete": {
+ "response": {
"$ref": "Folder"
},
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "DELETE",
"parameters": {
"name": {
"pattern": "^folders/[^/]+$",
"location": "path",
- "description": "The resource name of the Folder to undelete.\nMust be of the form `folders/{folder_id}`.",
+ "description": "the resource name of the Folder to be deleted.\nMust be of the form `folders/{folder_id}`.",
"required": true,
"type": "string"
}
@@ -688,69 +702,48 @@
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
- "flatPath": "v2beta1/folders/{foldersId}:undelete",
- "id": "cloudresourcemanager.folders.undelete",
- "path": "v2beta1/{+name}: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."
+ "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."
},
- "move": {
- "flatPath": "v2beta1/folders/{foldersId}:move",
- "path": "v2beta1/{+name}:move",
- "id": "cloudresourcemanager.folders.move",
- "description": "Moves a Folder under a new resource parent.\nReturns an Operation which can be used to track the progress of the\nfolder move workflow.\nUpon success the Operation.response field will be populated with the\nmoved Folder.\nUpon failure, a FolderOperationError categorizing the failure cause will\nbe returned - if the failure occurs synchronously then the\nFolderOperationError will be returned via the Status.details field\nand if it occurs asynchronously then the FolderOperation will be returned\nvia the the Operation.error field.\nIn addition, the Operation.metadata field will be populated with a\nFolderOperation message as an aid to stateless clients.\nFolder moves will be rejected if they violate either the naming, height\nor fanout constraints described in the\nCreateFolder documentation.\nThe caller must have `resourcemanager.folders.move` permission on the\nfolder's current and proposed new parent.",
- "request": {
- "$ref": "MoveFolderRequest"
- },
+ "list": {
"response": {
- "$ref": "Operation"
+ "$ref": "ListFoldersResponse"
},
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "POST",
+ "parameterOrder": [],
+ "httpMethod": "GET",
"scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
+ "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 move.\nMust be of the form folders/{folder_id}",
- "required": true,
- "type": "string",
- "pattern": "^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.",
- "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/[^/]+$"
+ "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": {
+ "location": "query",
+ "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"
+ },
+ "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"
- ],
- "flatPath": "v2beta1/folders/{foldersId}:testIamPermissions",
- "id": "cloudresourcemanager.folders.testIamPermissions",
- "path": "v2beta1/{+resource}:testIamPermissions"
+ "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."
}
}
}
@@ -767,19 +760,17 @@
"type": "boolean",
"default": "true"
},
+ "uploadType": {
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string",
+ "location": "query"
+ },
"fields": {
"description": "Selector specifying which fields to include in a partial response.",
"type": "string",
"location": "query"
},
- "uploadType": {
- "location": "query",
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string"
- },
"$.xgafv": {
- "description": "V1 error format.",
- "type": "string",
"enumDescriptions": [
"v1 error format",
"v2 error format"
@@ -788,15 +779,16 @@
"enum": [
"1",
"2"
- ]
+ ],
+ "description": "V1 error format.",
+ "type": "string"
},
"callback": {
- "type": "string",
"location": "query",
- "description": "JSONP"
+ "description": "JSONP",
+ "type": "string"
},
"alt": {
- "default": "json",
"enum": [
"json",
"media",
@@ -809,22 +801,23 @@
"Responses with Content-Type of application/x-protobuf"
],
"location": "query",
- "description": "Data format for response."
+ "description": "Data format for response.",
+ "default": "json"
},
"access_token": {
- "type": "string",
"location": "query",
- "description": "OAuth access token."
+ "description": "OAuth access token.",
+ "type": "string"
},
"key": {
+ "location": "query",
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string",
- "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": {
"description": "Pretty-print response.",
@@ -833,9 +826,9 @@
"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",
@@ -844,5 +837,12 @@
}
},
"version": "v2beta1",
- "baseUrl": "https://cloudresourcemanager.googleapis.com/"
+ "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": "20171218",
+ "documentationLink": "https://cloud.google.com/resource-manager",
+ "id": "cloudresourcemanager:v2beta1"
}
diff --git a/cloudshell/v1/cloudshell-api.json b/cloudshell/v1/cloudshell-api.json
index da4f394..be14766 100644
--- a/cloudshell/v1/cloudshell-api.json
+++ b/cloudshell/v1/cloudshell-api.json
@@ -1,26 +1,9 @@
{
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/cloud-platform": {
- "description": "View and manage your data across Google Cloud Platform services"
- }
- }
- }
- },
- "rootUrl": "https://cloudshell.googleapis.com/",
- "ownerDomain": "google.com",
- "name": "cloudshell",
- "batchPath": "batch",
- "fullyEncodeReservedExpansion": true,
- "title": "Cloud Shell API",
"ownerName": "Google",
"resources": {
"operations": {
"methods": {
"cancel": {
- "path": "v1/{+name}:cancel",
- "id": "cloudshell.operations.cancel",
"description": "Starts asynchronous cancellation on a long-running operation. The server\nmakes a best effort to cancel the operation, but success is not\nguaranteed. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`. Clients can use\nOperations.GetOperation or\nother methods to check whether the cancellation succeeded or whether the\noperation completed despite cancellation. On successful cancellation,\nthe operation is not deleted; instead, it becomes an operation with\nan Operation.error value with a google.rpc.Status.code of 1,\ncorresponding to `Code.CANCELLED`.",
"request": {
"$ref": "CancelOperationRequest"
@@ -44,21 +27,11 @@
"location": "path"
}
},
- "flatPath": "v1/operations/{operationsId}:cancel"
+ "flatPath": "v1/operations/{operationsId}:cancel",
+ "path": "v1/{+name}:cancel",
+ "id": "cloudshell.operations.cancel"
},
"delete": {
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "pattern": "^operations/.+$",
- "location": "path",
- "description": "The name of the operation resource to be deleted.",
- "required": true,
- "type": "string"
- }
- },
"flatPath": "v1/operations/{operationsId}",
"path": "v1/{+name}",
"id": "cloudshell.operations.delete",
@@ -69,9 +42,22 @@
"parameterOrder": [
"name"
],
- "httpMethod": "DELETE"
+ "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": "^operations/.+$",
+ "location": "path"
+ }
+ }
},
"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.",
@@ -87,47 +73,31 @@
],
"parameters": {
"filter": {
- "location": "query",
"description": "The standard list filter.",
- "type": "string"
- },
- "name": {
- "pattern": "^operations$",
- "location": "path",
- "description": "The name of the operation's parent resource.",
- "required": true,
- "type": "string"
- },
- "pageToken": {
- "description": "The standard list page token.",
"type": "string",
"location": "query"
},
+ "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"
}
- },
- "flatPath": "v1/operations"
+ }
},
"get": {
- "parameters": {
- "name": {
- "description": "The name of the operation resource.",
- "required": true,
- "type": "string",
- "pattern": "^operations/.+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/operations/{operationsId}",
- "id": "cloudshell.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",
"response": {
@@ -135,12 +105,48 @@
},
"parameterOrder": [
"name"
- ]
+ ],
+ "parameters": {
+ "name": {
+ "location": "path",
+ "description": "The name of the operation resource.",
+ "required": true,
+ "type": "string",
+ "pattern": "^operations/.+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/operations/{operationsId}",
+ "id": "cloudshell.operations.get",
+ "path": "v1/{+name}"
}
}
}
},
"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": {
+ "description": "Selector specifying which fields to include in a partial response.",
+ "type": "string",
+ "location": "query"
+ },
"callback": {
"description": "JSONP",
"type": "string",
@@ -160,7 +166,6 @@
"type": "string"
},
"alt": {
- "type": "string",
"enumDescriptions": [
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
@@ -173,12 +178,13 @@
"json",
"media",
"proto"
- ]
+ ],
+ "type": "string"
},
"key": {
- "location": "query",
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"access_token": {
"location": "query",
@@ -186,46 +192,25 @@
"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"
},
+ "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"
- },
- "uploadType": {
- "location": "query",
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string"
- },
- "fields": {
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string",
- "location": "query"
}
},
"version": "v1",
@@ -240,134 +225,21 @@
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
- "Operation": {
- "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
- "type": "object",
- "properties": {
- "name": {
- "description": "The server-assigned name, which is only unique within the same service that\noriginally returns it. If you use the default HTTP mapping, the\n`name` should have the format of `operations/some/unique/name`.",
- "type": "string"
- },
- "error": {
- "$ref": "Status",
- "description": "The error result of the operation in case of failure or cancellation."
- },
- "metadata": {
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- },
- "description": "Service-specific metadata associated with the operation. It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata. Any method that returns a\nlong-running operation should document the metadata type, if any.",
- "type": "object"
- },
- "done": {
- "description": "If the value is `false`, it means the operation is still in progress.\nIf `true`, the operation is completed, and either `error` or `response` is\navailable.",
- "type": "boolean"
- },
- "response": {
- "description": "The normal response of the operation in case of success. If the original\nmethod returns no data on success, such as `Delete`, the response is\n`google.protobuf.Empty`. If the original method is standard\n`Get`/`Create`/`Update`, the response should be the resource. For other\nmethods, the response should have the type `XxxResponse`, where `Xxx`\nis the original method name. For example, if the original method name\nis `TakeSnapshot()`, the inferred response type is\n`TakeSnapshotResponse`.",
- "type": "object",
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- }
- }
- },
- "id": "Operation"
- },
- "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"
- }
- }
- }
- },
- "Environment": {
- "description": "A Cloud Shell environment, which is defined as the combination of a Docker\nimage specifying what is installed on the environment and a home directory\ncontaining the user's data that will remain across sessions. Each user has a\nsingle environment with the ID \"default\".",
- "type": "object",
- "properties": {
- "publicKeys": {
- "description": "Output only. Public keys associated with the environment. Clients can\nconnect to this environment via SSH only if they possess a private key\ncorresponding to at least one of these public keys. Keys can be added to or\nremoved from the environment using the CreatePublicKey and DeletePublicKey\nmethods.",
- "type": "array",
- "items": {
- "$ref": "PublicKey"
- }
- },
- "dockerImage": {
- "description": "Required. Full path to the Docker image used to run this environment, e.g.\n\"gcr.io/dev-con/cloud-devshell:latest\".",
- "type": "string"
- },
- "state": {
- "description": "Output only. Current execution state of this environment.",
- "type": "string",
- "enumDescriptions": [
- "The environment's states is unknown.",
- "The environment is not running and can't be connected to. Starting the\nenvironment will transition it to the STARTING state.",
- "The environment is being started but is not yet ready to accept\nconnections.",
- "The environment is running and ready to accept connections. It will\nautomatically transition back to DISABLED after a period of inactivity or\nif another environment is started."
- ],
- "enum": [
- "STATE_UNSPECIFIED",
- "DISABLED",
- "STARTING",
- "RUNNING"
- ]
- },
- "name": {
- "description": "Output only. Full name of this resource, in the format\n`users/{owner_email}/environments/{environment_id}`. `{owner_email}` is the\nemail address of the user to whom this environment belongs, and\n`{environment_id}` is the identifier of this environment. For example,\n`users/someone@example.com/environments/default`.",
- "type": "string"
- },
- "sshHost": {
- "description": "Output only. Host to which clients can connect to initiate SSH sessions\nwith the environment.",
- "type": "string"
- },
- "sshPort": {
- "description": "Output only. Port to which clients can connect to initiate SSH sessions\nwith the environment.",
- "format": "int32",
- "type": "integer"
- },
- "id": {
- "description": "Output only. The environment's identifier, which is always \"default\".",
- "type": "string"
- },
- "sshUsername": {
- "description": "Output only. Username that clients should use when initiating SSH sessions\nwith the environment.",
- "type": "string"
- }
- },
- "id": "Environment"
- },
"StartEnvironmentResponse": {
- "id": "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."
+ "description": "Environment that was started.",
+ "$ref": "Environment"
}
- }
+ },
+ "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": {
- "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",
@@ -383,11 +255,15 @@
"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"
},
"PublicKey": {
- "id": "PublicKey",
"description": "A public SSH key, corresponding to a private SSH key held by the client.",
"type": "object",
"properties": {
@@ -420,7 +296,8 @@
"ECDSA_SHA2_NISTP521"
]
}
- }
+ },
+ "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 `{}`.",
@@ -429,17 +306,18 @@
"id": "Empty"
},
"CancelOperationRequest": {
- "id": "CancelOperationRequest",
"description": "The request message for Operations.CancelOperation.",
"type": "object",
- "properties": {}
+ "properties": {},
+ "id": "CancelOperationRequest"
},
"StartEnvironmentMetadata": {
- "id": "StartEnvironmentMetadata",
"description": "Message included in the metadata field of operations returned from\nStartEnvironment.",
"type": "object",
"properties": {
"state": {
+ "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.",
@@ -451,17 +329,139 @@
"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": {
+ "done": {
+ "description": "If the value is `false`, it means the operation is still in progress.\nIf `true`, the operation is completed, and either `error` or `response` is\navailable.",
+ "type": "boolean"
+ },
+ "response": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "description": "The normal response of the operation in case of success. If the original\nmethod returns no data on success, such as `Delete`, the response is\n`google.protobuf.Empty`. If the original method is standard\n`Get`/`Create`/`Update`, the response should be the resource. For other\nmethods, the response should have the type `XxxResponse`, where `Xxx`\nis the original method name. For example, if the original method name\nis `TakeSnapshot()`, the inferred response type is\n`TakeSnapshotResponse`.",
+ "type": "object"
+ },
+ "name": {
+ "description": "The server-assigned name, which is only unique within the same service that\noriginally returns it. If you use the default HTTP mapping, the\n`name` should have the format of `operations/some/unique/name`.",
"type": "string"
+ },
+ "error": {
+ "$ref": "Status",
+ "description": "The error result of the operation in case of failure or cancellation."
+ },
+ "metadata": {
+ "description": "Service-specific metadata associated with the operation. It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata. Any method that returns a\nlong-running operation should document the metadata type, if any.",
+ "type": "object",
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ }
+ }
+ },
+ "id": "Operation"
+ },
+ "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"
+ },
+ "Environment": {
+ "description": "A Cloud Shell environment, which is defined as the combination of a Docker\nimage specifying what is installed on the environment and a home directory\ncontaining the user's data that will remain across sessions. Each user has a\nsingle environment with the ID \"default\".",
+ "type": "object",
+ "properties": {
+ "publicKeys": {
+ "description": "Output only. Public keys associated with the environment. Clients can\nconnect to this environment via SSH only if they possess a private key\ncorresponding to at least one of these public keys. Keys can be added to or\nremoved from the environment using the CreatePublicKey and DeletePublicKey\nmethods.",
+ "type": "array",
+ "items": {
+ "$ref": "PublicKey"
+ }
+ },
+ "dockerImage": {
+ "description": "Required. Full path to the Docker image used to run this environment, e.g.\n\"gcr.io/dev-con/cloud-devshell:latest\".",
+ "type": "string"
+ },
+ "state": {
+ "enumDescriptions": [
+ "The environment's states is unknown.",
+ "The environment is not running and can't be connected to. Starting the\nenvironment will transition it to the STARTING state.",
+ "The environment is being started but is not yet ready to accept\nconnections.",
+ "The environment is running and ready to accept connections. It will\nautomatically transition back to DISABLED after a period of inactivity or\nif another environment is started."
+ ],
+ "enum": [
+ "STATE_UNSPECIFIED",
+ "DISABLED",
+ "STARTING",
+ "RUNNING"
+ ],
+ "description": "Output only. Current execution state of this environment.",
+ "type": "string"
+ },
+ "name": {
+ "description": "Output only. Full name of this resource, in the format\n`users/{owner_email}/environments/{environment_id}`. `{owner_email}` is the\nemail address of the user to whom this environment belongs, and\n`{environment_id}` is the identifier of this environment. For example,\n`users/someone@example.com/environments/default`.",
+ "type": "string"
+ },
+ "sshHost": {
+ "description": "Output only. Host to which clients can connect to initiate SSH sessions\nwith the environment.",
+ "type": "string"
+ },
+ "sshPort": {
+ "description": "Output only. Port to which clients can connect to initiate SSH sessions\nwith the environment.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "id": {
+ "description": "Output only. The environment's identifier, which is always \"default\".",
+ "type": "string"
+ },
+ "sshUsername": {
+ "description": "Output only. Username that clients should use when initiating SSH sessions\nwith the environment.",
+ "type": "string"
+ }
+ },
+ "id": "Environment"
+ }
+ },
+ "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 Shell",
+ "auth": {
+ "oauth2": {
+ "scopes": {
+ "https://www.googleapis.com/auth/cloud-platform": {
+ "description": "View and manage your data across Google Cloud Platform services"
}
}
}
},
- "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 Shell"
+ "rootUrl": "https://cloudshell.googleapis.com/",
+ "ownerDomain": "google.com",
+ "name": "cloudshell",
+ "batchPath": "batch",
+ "fullyEncodeReservedExpansion": true,
+ "title": "Cloud Shell API"
}
diff --git a/cloudshell/v1alpha1/cloudshell-api.json b/cloudshell/v1alpha1/cloudshell-api.json
index d3fefce..e5ee442 100644
--- a/cloudshell/v1alpha1/cloudshell-api.json
+++ b/cloudshell/v1alpha1/cloudshell-api.json
@@ -8,38 +8,42 @@
"publicKeys": {
"methods": {
"delete": {
- "httpMethod": "DELETE",
"response": {
"$ref": "Empty"
},
"parameterOrder": [
"name"
],
- "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"
- }
- },
+ "httpMethod": "DELETE",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
+ "parameters": {
+ "name": {
+ "pattern": "^users/[^/]+/environments/[^/]+/publicKeys/[^/]+$",
+ "location": "path",
+ "description": "Name of the resource to be deleted, e.g.\n`users/me/environments/default/publicKeys/my-key`.",
+ "required": true,
+ "type": "string"
+ }
+ },
"flatPath": "v1alpha1/users/{usersId}/environments/{environmentsId}/publicKeys/{publicKeysId}",
- "id": "cloudshell.users.environments.publicKeys.delete",
"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": {
- "httpMethod": "POST",
- "parameterOrder": [
- "parent"
- ],
+ "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": {
"description": "Parent resource name, e.g. `users/me/environments/default`.",
@@ -53,18 +57,20 @@
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v1alpha1/users/{usersId}/environments/{environmentsId}/publicKeys",
- "id": "cloudshell.users.environments.publicKeys.create",
"path": "v1alpha1/{+parent}/publicKeys",
- "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."
+ "id": "cloudshell.users.environments.publicKeys.create"
}
}
}
},
"methods": {
"start": {
+ "path": "v1alpha1/{+name}:start",
+ "id": "cloudshell.users.environments.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"
+ },
"response": {
"$ref": "Operation"
},
@@ -77,24 +83,16 @@
],
"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"
+ "type": "string",
+ "pattern": "^users/[^/]+/environments/[^/]+$",
+ "location": "path"
}
},
- "flatPath": "v1alpha1/users/{usersId}/environments/{environmentsId}:start",
- "path": "v1alpha1/{+name}:start",
- "id": "cloudshell.users.environments.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"
- }
+ "flatPath": "v1alpha1/users/{usersId}/environments/{environmentsId}:start"
},
"get": {
- "id": "cloudshell.users.environments.get",
- "path": "v1alpha1/{+name}",
"description": "Gets an environment. Returns NOT_FOUND if the environment does not exist.",
"httpMethod": "GET",
"response": {
@@ -115,7 +113,9 @@
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
- "flatPath": "v1alpha1/users/{usersId}/environments/{environmentsId}"
+ "flatPath": "v1alpha1/users/{usersId}/environments/{environmentsId}",
+ "id": "cloudshell.users.environments.get",
+ "path": "v1alpha1/{+name}"
},
"patch": {
"response": {
@@ -125,13 +125,16 @@
"name"
],
"httpMethod": "PATCH",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
"parameters": {
"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"
+ "type": "string",
+ "pattern": "^users/[^/]+/environments/[^/]+$",
+ "location": "path"
},
"updateMask": {
"location": "query",
@@ -140,16 +143,13 @@
"type": "string"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
"flatPath": "v1alpha1/users/{usersId}/environments/{environmentsId}",
"path": "v1alpha1/{+name}",
"id": "cloudshell.users.environments.patch",
+ "description": "Updates an existing environment.",
"request": {
"$ref": "Environment"
- },
- "description": "Updates an existing environment."
+ }
}
}
}
@@ -157,7 +157,52 @@
}
},
"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"
+ },
+ "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",
@@ -165,23 +210,17 @@
],
"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"
+ "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"
+ "type": "string",
+ "location": "query"
+ },
+ "access_token": {
+ "description": "OAuth access token.",
+ "type": "string",
+ "location": "query"
},
"quotaUser": {
"location": "query",
@@ -189,199 +228,51 @@
"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",
- "location": "query"
+ "type": "string"
},
"oauth_token": {
"description": "OAuth 2.0 token for the current user.",
"type": "string",
"location": "query"
- },
- "upload_protocol": {
- "location": "query",
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string"
- },
- "prettyPrint": {
- "location": "query",
- "description": "Returns response with indentations and line breaks.",
- "type": "boolean",
- "default": "true"
- },
- "fields": {
- "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": {
- "location": "query",
- "description": "JSONP",
- "type": "string"
- },
- "$.xgafv": {
- "enum": [
- "1",
- "2"
- ],
- "description": "V1 error format.",
- "type": "string",
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query"
}
},
"version": "v1alpha1",
"baseUrl": "https://cloudshell.googleapis.com/",
- "servicePath": "",
- "description": "Allows users to start, configure, and connect to interactive shell sessions running in the cloud.\n",
"kind": "discovery#restDescription",
+ "description": "Allows users to start, configure, and connect to interactive shell sessions running in the cloud.\n",
+ "servicePath": "",
"basePath": "",
- "revision": "20171215",
- "documentationLink": "https://cloud.google.com/shell/docs/",
"id": "cloudshell:v1alpha1",
+ "documentationLink": "https://cloud.google.com/shell/docs/",
+ "revision": "20171215",
"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": {
- "state": {
- "enumDescriptions": [
- "The environment's start state is unknown.",
- "The environment is in the process of being started, but no additional\ndetails are available.",
- "Startup is waiting for the user's disk to be unarchived. This can happen\nwhen the user returns to Cloud Shell after not having used it for a\nwhile, and suggests that startup will take longer than normal.",
- "Startup is complete and the user should be able to establish an SSH\nconnection to their environment."
- ],
- "enum": [
- "STATE_UNSPECIFIED",
- "STARTING",
- "UNARCHIVING_DISK",
- "FINISHED"
- ],
- "description": "Current state of the environment being started.",
- "type": "string"
+ "environment": {
+ "$ref": "Environment",
+ "description": "Environment that was started."
}
},
- "id": "StartEnvironmentMetadata"
- },
- "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"
- },
- "Environment": {
- "properties": {
- "sshPort": {
- "description": "Output only. Port to which clients can connect to initiate SSH sessions\nwith the environment.",
- "format": "int32",
- "type": "integer"
- },
- "id": {
- "description": "Output only. The environment's identifier, which is always \"default\".",
- "type": "string"
- },
- "sshUsername": {
- "description": "Output only. Username that clients should use when initiating SSH sessions\nwith the environment.",
- "type": "string"
- },
- "publicKeys": {
- "description": "Output only. Public keys associated with the environment. Clients can\nconnect to this environment via SSH only if they possess a private key\ncorresponding to at least one of these public keys. Keys can be added to or\nremoved from the environment using the CreatePublicKey and DeletePublicKey\nmethods.",
- "type": "array",
- "items": {
- "$ref": "PublicKey"
- }
- },
- "dockerImage": {
- "description": "Required. Full path to the Docker image used to run this environment, e.g.\n\"gcr.io/dev-con/cloud-devshell:latest\".",
- "type": "string"
- },
- "state": {
- "enumDescriptions": [
- "The environment's states is unknown.",
- "The environment is not running and can't be connected to. Starting the\nenvironment will transition it to the STARTING state.",
- "The environment is being started but is not yet ready to accept\nconnections.",
- "The environment is running and ready to accept connections. It will\nautomatically transition back to DISABLED after a period of inactivity or\nif another environment is started."
- ],
- "enum": [
- "STATE_UNSPECIFIED",
- "DISABLED",
- "STARTING",
- "RUNNING"
- ],
- "description": "Output only. Current execution state of this environment.",
- "type": "string"
- },
- "name": {
- "description": "Output only. Full name of this resource, in the format\n`users/{owner_email}/environments/{environment_id}`. `{owner_email}` is the\nemail address of the user to whom this environment belongs, and\n`{environment_id}` is the identifier of this environment. For example,\n`users/someone@example.com/environments/default`.",
- "type": "string"
- },
- "sshHost": {
- "description": "Output only. Host to which clients can connect to initiate SSH sessions\nwith the environment.",
- "type": "string"
- }
- },
- "id": "Environment",
- "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": {
- "description": "Request message for CreatePublicKey.",
- "type": "object",
- "properties": {
- "key": {
- "description": "Key that should be added to the environment.",
- "$ref": "PublicKey"
- }
- },
- "id": "CreatePublicKeyRequest"
+ "id": "StartEnvironmentResponse"
},
"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",
@@ -397,34 +288,27 @@
"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"
},
- "StartEnvironmentResponse": {
- "properties": {
- "environment": {
- "description": "Environment that was started.",
- "$ref": "Environment"
- }
- },
- "id": "StartEnvironmentResponse",
- "description": "Message included in the response field of operations returned from\nStartEnvironment once the\noperation is complete.",
- "type": "object"
- },
"StartEnvironmentRequest": {
"properties": {},
"id": "StartEnvironmentRequest",
"description": "Request message for StartEnvironment.",
"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"
+ },
"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`.",
@@ -456,22 +340,138 @@
"type": "string"
}
},
- "id": "PublicKey",
- "description": "A public SSH key, corresponding to a private SSH key held by the client.",
+ "id": "PublicKey"
+ },
+ "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",
+ "UNARCHIVING_DISK",
+ "FINISHED"
+ ],
+ "description": "Current state of the environment being started.",
+ "type": "string"
+ }
+ },
+ "id": "StartEnvironmentMetadata",
+ "description": "Message included in the metadata field of operations returned from\nStartEnvironment.",
"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 `{}`.",
+ "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": {
+ "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",
+ "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
+ "type": "object"
+ },
+ "Environment": {
+ "description": "A Cloud Shell environment, which is defined as the combination of a Docker\nimage specifying what is installed on the environment and a home directory\ncontaining the user's data that will remain across sessions. Each user has a\nsingle environment with the ID \"default\".",
+ "type": "object",
+ "properties": {
+ "dockerImage": {
+ "description": "Required. Full path to the Docker image used to run this environment, e.g.\n\"gcr.io/dev-con/cloud-devshell:latest\".",
+ "type": "string"
+ },
+ "state": {
+ "enumDescriptions": [
+ "The environment's states is unknown.",
+ "The environment is not running and can't be connected to. Starting the\nenvironment will transition it to the STARTING state.",
+ "The environment is being started but is not yet ready to accept\nconnections.",
+ "The environment is running and ready to accept connections. It will\nautomatically transition back to DISABLED after a period of inactivity or\nif another environment is started."
+ ],
+ "enum": [
+ "STATE_UNSPECIFIED",
+ "DISABLED",
+ "STARTING",
+ "RUNNING"
+ ],
+ "description": "Output only. Current execution state of this environment.",
+ "type": "string"
+ },
+ "name": {
+ "description": "Output only. Full name of this resource, in the format\n`users/{owner_email}/environments/{environment_id}`. `{owner_email}` is the\nemail address of the user to whom this environment belongs, and\n`{environment_id}` is the identifier of this environment. For example,\n`users/someone@example.com/environments/default`.",
+ "type": "string"
+ },
+ "sshHost": {
+ "description": "Output only. Host to which clients can connect to initiate SSH sessions\nwith the environment.",
+ "type": "string"
+ },
+ "sshPort": {
+ "description": "Output only. Port to which clients can connect to initiate SSH sessions\nwith the environment.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "id": {
+ "description": "Output only. The environment's identifier, which is always \"default\".",
+ "type": "string"
+ },
+ "sshUsername": {
+ "description": "Output only. Username that clients should use when initiating SSH sessions\nwith the environment.",
+ "type": "string"
+ },
+ "publicKeys": {
+ "description": "Output only. Public keys associated with the environment. Clients can\nconnect to this environment via SSH only if they possess a private key\ncorresponding to at least one of these public keys. Keys can be added to or\nremoved from the environment using the CreatePublicKey and DeletePublicKey\nmethods.",
+ "type": "array",
+ "items": {
+ "$ref": "PublicKey"
+ }
+ }
+ },
+ "id": "Environment"
+ },
+ "CreatePublicKeyRequest": {
+ "properties": {
+ "key": {
+ "description": "Key that should be added to the environment.",
+ "$ref": "PublicKey"
+ }
+ },
+ "id": "CreatePublicKeyRequest",
+ "description": "Request message for CreatePublicKey.",
"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": "Cloud Shell",
"auth": {
"oauth2": {
diff --git a/cloudtasks/v2beta2/cloudtasks-api.json b/cloudtasks/v2beta2/cloudtasks-api.json
index 4ddc137..c2d89f7 100644
--- a/cloudtasks/v2beta2/cloudtasks-api.json
+++ b/cloudtasks/v2beta2/cloudtasks-api.json
@@ -5,25 +5,163 @@
"basePath": "",
"id": "cloudtasks:v2beta2",
"documentationLink": "https://cloud.google.com/cloud-tasks/",
- "revision": "20171219",
+ "revision": "20180102",
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
- "PullTasksRequest": {
- "description": "Request message for pulling tasks using CloudTasks.PullTasks.",
+ "PauseQueueRequest": {
+ "description": "Request message for CloudTasks.PauseQueue.",
+ "type": "object",
+ "properties": {},
+ "id": "PauseQueueRequest"
+ },
+ "PurgeQueueRequest": {
+ "description": "Request message for CloudTasks.PurgeQueue.",
+ "type": "object",
+ "properties": {},
+ "id": "PurgeQueueRequest"
+ },
+ "Task": {
+ "description": "A unit of scheduled work.",
"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\nPullTasksResponse will contain only tasks whose\nPullMessage.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).",
+ "appEngineHttpRequest": {
+ "description": "App Engine HTTP request that is sent to the task's target. Can be set\nonly if Queue.app_engine_http_target is set.\n\nAn App Engine task is a task that has AppEngineHttpRequest set.",
+ "$ref": "AppEngineHttpRequest"
+ },
+ "view": {
+ "description": "Output only. The view specifies which subset of the Task has\nbeen returned.",
+ "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"
+ ]
+ },
+ "pullMessage": {
+ "description": "Pull message contains data that should be used by the caller of\nCloudTasks.LeaseTasks to process the task. Can be set only if\nQueue.pull_target is set.\n\nA pull task is a task that has PullMessage set.",
+ "$ref": "PullMessage"
+ },
+ "scheduleTime": {
+ "description": "The time when the task is scheduled to be attempted.\n\nFor App Engine queues, this is when the task will be attempted or retried.\n\nFor pull queues, this is the time when the task is available to\nbe leased; if a task is currently leased, this is the time when\nthe current lease expires, that is, the time that the task was\nleased plus the LeaseTasksRequest.lease_duration.\n\n`schedule_time` will be truncated to the nearest microsecond.",
+ "format": "google-datetime",
"type": "string"
},
- "maxTasks": {
- "description": "The maximum number of tasks to lease. The maximum that can be\nrequested is 1000.",
+ "createTime": {
+ "description": "Output only. The time that the task was created.\n\n`create_time` will be truncated to the nearest second.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "status": {
+ "$ref": "TaskStatus",
+ "description": "Output only. The task status."
+ },
+ "name": {
+ "description": "The task name.\n\nThe task name must have the following format:\n`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`\n\n* `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]),\n hyphens (-), colons (:), or periods (.).\n For more information, see\n [Identifying projects](/resource-manager/docs/creating-managing-projects#identifying_projects)\n* `LOCATION_ID` is the canonical ID for the task's location.\n The list of available locations can be obtained by calling\n google.cloud.location.Locations.ListLocations.\n For more information, see https://cloud.google.com/about/locations/.\n* `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or\n hyphens (-). The maximum length is 100 characters.\n* `TASK_ID` can contain only letters ([A-Za-z]), numbers ([0-9]),\n hyphens (-), or underscores (_). The maximum length is 500 characters.\n\nOptionally caller-specified in CreateTaskRequest.",
+ "type": "string"
+ }
+ },
+ "id": "Task"
+ },
+ "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": {
+ "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"
+ },
+ "PullMessage": {
+ "description": "The pull message contains data that can be used by the caller of\nCloudTasks.LeaseTasks to process the task.\n\nThis proto can only be used for tasks in a queue which has\nQueue.pull_target set.",
+ "type": "object",
+ "properties": {
+ "tag": {
+ "description": "The task's tag.\n\nTags allow similar tasks to be processed in a batch. If you label\ntasks with a tag, your worker can lease tasks\nwith the same tag using LeaseTasksRequest.filter. For example,\nif you want to aggregate the events associated with a specific\nuser once a day, you could tag tasks with the user ID.\n\nThe task's tag can only be set when the\ntask is created.\n\nThe tag must be less than 500 bytes.",
+ "format": "byte",
+ "type": "string"
+ },
+ "payload": {
+ "description": "A data payload consumed by the worker to execute the task.",
+ "format": "byte",
+ "type": "string"
+ }
+ },
+ "id": "PullMessage"
+ },
+ "Binding": {
+ "properties": {
+ "members": {
+ "description": "Specifies the identities requesting access for a Cloud Platform resource.\n`members` can have the following values:\n\n* `allUsers`: A special identifier that represents anyone who is\n on the internet; with or without a Google account.\n\n* `allAuthenticatedUsers`: A special identifier that represents anyone\n who is authenticated with a Google account or a service account.\n\n* `user:{emailid}`: An email address that represents a specific Google\n account. For example, `alice@gmail.com` or `joe@example.com`.\n\n\n* `serviceAccount:{emailid}`: An email address that represents a service\n account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{emailid}`: An email address that represents a Google group.\n For example, `admins@example.com`.\n\n\n* `domain:{domain}`: A Google Apps domain name that represents all the\n users of that domain. For example, `google.com` or `example.com`.\n\n",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "role": {
+ "description": "Role that is assigned to `members`.\nFor example, `roles/viewer`, `roles/editor`, or `roles/owner`.\nRequired",
+ "type": "string"
+ }
+ },
+ "id": "Binding",
+ "description": "Associates `members` with a `role`.",
+ "type": "object"
+ },
+ "RenewLeaseRequest": {
+ "description": "Request message for renewing a lease using CloudTasks.RenewLease.",
+ "type": "object",
+ "properties": {
+ "scheduleTime": {
+ "description": "Required.\n\nThe task's current schedule time, available in the Task.schedule_time\nreturned in LeaseTasksResponse.tasks or\nCloudTasks.RenewLease. This restriction is to ensure that your\nworker currently holds the lease.",
+ "format": "google-datetime",
+ "type": "string"
+ },
"leaseDuration": {
- "description": "The duration of the lease.\n\nEach task returned in the PullTasksResponse will have its\nTask.schedule_time set to the current time plus the\n`lease_duration`. A task that has been returned in a\nPullTasksResponse is leased -- that task will not be\nreturned in a different PullTasksResponse 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\nPullTasksResponse 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.",
+ "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"
},
@@ -42,7 +180,252 @@
"type": "string"
}
},
- "id": "PullTasksRequest"
+ "id": "RenewLeaseRequest"
+ },
+ "TaskStatus": {
+ "description": "Status of the task.",
+ "type": "object",
+ "properties": {
+ "firstAttemptStatus": {
+ "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).",
+ "format": "int32",
+ "type": "integer"
+ },
+ "lastAttemptStatus": {
+ "$ref": "AttemptStatus",
+ "description": "Output only. The status of the task's last attempt.\n\nThis field is not calculated for\n[pull tasks](google.cloud.tasks.v2beta2.PullTaskTarget)."
+ },
+ "attemptDispatchCount": {
+ "description": "Output only. The number of attempts dispatched.\n\nThis count includes tasks which have been dispatched but haven't\nreceived a response.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "TaskStatus"
+ },
+ "AppEngineHttpRequest": {
+ "description": "App Engine HTTP request.\n\nThe message defines the HTTP request that is sent to an App Engine app when\nthe task is dispatched.\n\nThis proto can only be used for tasks in a queue which has\nQueue.app_engine_http_target set.\n\nUsing AppEngineHttpRequest requires\n[`appengine.applications.get`](/appengine/docs/admin-api/access-control)\nGoogle IAM permission for the project\nand the following scope:\n\n`https://www.googleapis.com/auth/cloud-platform`\n\nThe task will be delivered to the App Engine app which belongs to the same\nproject as the queue. For more information, see\n[How Requests are Routed](/appengine/docs/standard/python/how-requests-are-routed)\nand how routing is affected by\n[dispatch files](/appengine/docs/python/config/dispatchref).\n\nThe AppEngineRouting used to construct the URL that the task is\ndelivered to can be set at the queue-level or task-level:\n\n* If set, AppEngineHttpTarget.app_engine_routing_override is used for\n all tasks in the queue, no matter what the setting is for the\n task-level app_engine_routing.\n\n\nThe `url` that the task will be sent to is:\n\n* `url =` AppEngineRouting.host `+` AppEngineHttpRequest.relative_url\n\nThe task attempt has succeeded if the app's request handler returns\nan HTTP response code in the range [`200` - `299`]. `503` is\nconsidered an App Engine system error instead of an application\nerror. Requests returning error `503` will be retried regardless of\nretry configuration and not counted against retry counts.\nAny other response code or a failure to receive a response before the\ndeadline is a failed attempt.",
+ "type": "object",
+ "properties": {
+ "relativeUrl": {
+ "description": "The relative URL.\n\nThe relative URL must begin with \"/\" and must be a valid HTTP relative URL.\nIt can contain a path and query string arguments.\nIf the relative URL is empty, then the root path \"/\" will be used.\nNo spaces are allowed, and the maximum length allowed is 2083 characters.",
+ "type": "string"
+ },
+ "headers": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "HTTP request headers.\n\nThis map contains the header field names and values.\nHeaders can be set when the\n[task is created](google.cloud.tasks.v2beta2.CloudTasks.CreateTask).\nRepeated headers are not supported but a header value can contain commas.\n\nCloud Tasks sets some headers to default values:\n\n* `User-Agent`: By default, this header is\n `\"AppEngine-Google; (+http://code.google.com/appengine)\"`.\n This header can be modified, but Cloud Tasks will append\n `\"AppEngine-Google; (+http://code.google.com/appengine)\"` to the\n modified `User-Agent`.\n\nIf the task has an AppEngineHttpRequest.payload, Cloud Tasks sets the\nfollowing headers:\n\n* `Content-Type`: By default, the `Content-Type` header is set to\n `\"application/octet-stream\"`. The default can be overridden by explictly\n setting `Content-Type` to a particular media type when the\n [task is created](google.cloud.tasks.v2beta2.CloudTasks.CreateTask).\n For example, `Content-Type` can be set to `\"application/json\"`.\n* `Content-Length`: This is computed by Cloud Tasks. This value is\n output only. It cannot be changed.\n\nThe headers below cannot be set or overridden:\n\n* `Host`\n* `X-Google-*`\n* `X-AppEngine-*`\n\nIn addition, Cloud Tasks sets some headers when the task is dispatched,\nsuch as headers containing information about the task; see\n[request headers](/appengine/docs/python/taskqueue/push/creating-handlers#reading_request_headers).\nThese headers are set only when the task is dispatched, so they are not\nvisible when the task is returned in a Cloud Tasks response.\n\nAlthough there is no specific limit for the maximum number of headers or\nthe size, there is a limit on the maximum size of the Task. For more\ninformation, see the CloudTasks.CreateTask documentation.",
+ "type": "object"
+ },
+ "appEngineRouting": {
+ "$ref": "AppEngineRouting",
+ "description": "Task-level setting for App Engine routing.\n\nIf set, AppEngineHttpTarget.app_engine_routing_override is used for\nall tasks in the queue, no matter what the setting is for the\ntask-level app_engine_routing."
+ },
+ "httpMethod": {
+ "enumDescriptions": [
+ "HTTP method unspecified",
+ "HTTP Post",
+ "HTTP Get",
+ "HTTP Head",
+ "HTTP Put",
+ "HTTP Delete"
+ ],
+ "enum": [
+ "HTTP_METHOD_UNSPECIFIED",
+ "POST",
+ "GET",
+ "HEAD",
+ "PUT",
+ "DELETE"
+ ],
+ "description": "The HTTP method to use for the request. The default is POST.\n\nThe app's request handler for the task's target URL must be able to handle\nHTTP requests with this http_method, otherwise the task attempt will fail\nwith error code 405 (Method Not Allowed). See\n[Writing a push task request handler](/appengine/docs/java/taskqueue/push/creating-handlers#writing_a_push_task_request_handler)\nand the documentation for the request handlers in the language your app is\nwritten in e.g.\n[Python Request Handler](/appengine/docs/python/tools/webapp/requesthandlerclass).",
+ "type": "string"
+ },
+ "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"
+ }
+ },
+ "id": "AppEngineHttpRequest"
+ },
+ "GetIamPolicyRequest": {
+ "properties": {},
+ "id": "GetIamPolicyRequest",
+ "description": "Request message for `GetIamPolicy` method.",
+ "type": "object"
+ },
+ "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"
+ },
+ "RetryConfig": {
+ "description": "Retry config.\n\nThese settings determine how a failed task attempt is retried.",
+ "type": "object",
+ "properties": {
+ "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",
+ "type": "integer"
+ },
+ "maxAttempts": {
+ "description": "The maximum number of attempts for a task.\n\nCloud Tasks will attempt the task `max_attempts` times (that\nis, if the first attempt fails, then there will be\n`max_attempts - 1` retries). Must be \u003e 0.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "unlimitedAttempts": {
+ "description": "If true, then the number of attempts is unlimited.",
+ "type": "boolean"
+ },
+ "minBackoff": {
+ "description": "The minimum amount of time to wait before retrying a task after\nit fails.\n\n* For [App Engine queues](google.cloud.tasks.v2beta2.AppEngineHttpTarget),\n this field is 0.1 seconds by default.\n* For [pull queues](google.cloud.tasks.v2beta2.PullTarget), this\n field is output only and always 0.\n\n`min_backoff` will be truncated to the nearest second.\n\nThis field has the same meaning as\n[min_backoff_seconds in queue.yaml](/appengine/docs/standard/python/config/queueref#retry_parameters).",
+ "format": "google-duration",
+ "type": "string"
+ },
+ "maxBackoff": {
+ "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"
+ },
+ "PullTarget": {
+ "description": "Pull target.",
+ "type": "object",
+ "properties": {},
+ "id": "PullTarget"
+ },
+ "ResumeQueueRequest": {
+ "description": "Request message for CloudTasks.ResumeQueue.",
+ "type": "object",
+ "properties": {},
+ "id": "ResumeQueueRequest"
+ },
+ "ListTasksResponse": {
+ "description": "Response message for listing tasks using CloudTasks.ListTasks.",
+ "type": "object",
+ "properties": {
+ "tasks": {
+ "description": "The list of tasks.",
+ "type": "array",
+ "items": {
+ "$ref": "Task"
+ }
+ },
+ "nextPageToken": {
+ "description": "A token to retrieve next page of results.\n\nTo return the next page of results, call\nCloudTasks.ListTasks with this value as the\nListTasksRequest.page_token.\n\nIf the next_page_token is empty, there are no more results.",
+ "type": "string"
+ }
+ },
+ "id": "ListTasksResponse"
+ },
+ "CreateTaskRequest": {
+ "description": "Request message for CloudTasks.CreateTask.",
+ "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"
+ },
+ "task": {
+ "$ref": "Task",
+ "description": "Required.\n\nThe task to add.\n\nTask names have the following format:\n`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`.\nThe user can optionally specify a name for the task in\nTask.name. If a name is not specified then the system will\ngenerate a random unique task id, which will be returned in the\nresponse's Task.name.\n\nIf Task.schedule_time is not set or is in the past then Cloud\nTasks will set it to the current time.\n\nTask De-duplication:\n\nExplicitly specifying a task ID enables task de-duplication. If\na task's ID is identical to that of an existing task or a task\nthat was deleted or completed recently then the call will fail\nwith google.rpc.Code.ALREADY_EXISTS.\nIf the task's queue was created using Cloud Tasks, then another task with\nthe same name can't be created for ~1hour after the original task was\ndeleted or completed. If the task's queue was created using queue.yaml or\nqueue.xml, then another task with the same name can't be created\nfor ~9days after the original task was deleted or completed.\n\nBecause there is an extra lookup cost to identify duplicate task\nnames, these CloudTasks.CreateTask calls have significantly\nincreased latency. Using hashed strings for the task id or for\nthe prefix of the task id is recommended. Choosing task ids that\nare sequential or have sequential prefixes, for example using a\ntimestamp, causes an increase in latency and error rates in all\ntask commands. The infrastructure relies on an approximately\nuniform distribution of task ids to store and serve tasks\nefficiently."
+ }
+ },
+ "id": "CreateTaskRequest"
+ },
+ "LeaseTasksResponse": {
+ "properties": {
+ "tasks": {
+ "description": "The leased tasks.",
+ "type": "array",
+ "items": {
+ "$ref": "Task"
+ }
+ }
+ },
+ "id": "LeaseTasksResponse",
+ "description": "Response message for leasing tasks using CloudTasks.LeaseTasks.",
+ "type": "object"
+ },
+ "Queue": {
+ "description": "A queue is a container of related tasks. Queues are configured to manage\nhow those tasks are dispatched. Configurable properties include rate limits,\nretry options, target types, and others.",
+ "type": "object",
+ "properties": {
+ "appEngineHttpTarget": {
+ "description": "App Engine HTTP target.\n\nAn App Engine queue is a queue that has an AppEngineHttpTarget.",
+ "$ref": "AppEngineHttpTarget"
+ },
+ "purgeTime": {
+ "description": "Output only. The last time this queue was purged.\n\nAll tasks that were created before this time\nwere purged.\n\nA queue can be purged using CloudTasks.PurgeQueue, the\n[App Engine Task Queue SDK, or the Cloud Console](/appengine/docs/standard/python/taskqueue/push/deleting-tasks-and-queues#purging_all_tasks_from_a_queue).\n\nPurge time will be truncated to the nearest microsecond. Purge\ntime will be zero if the queue has never been purged.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "state": {
+ "enumDescriptions": [
+ "Unspecified state.",
+ "The queue is running. Tasks can be dispatched.\n\nIf the queue was created using Cloud Tasks and the queue has had no\nactivity (method calls or task dispatches) for 30 days, the queue may\ntake a few minutes to re-activate. Some method calls may return\ngoogle.rpc.Code.NOT_FOUND and tasks may not be dispatched for a few\nminutes until the queue has been re-activated.",
+ "Tasks are paused by the user. If the queue is paused then Cloud\nTasks will stop delivering tasks from it, but more tasks can\nstill be added to it by the user. When a pull queue is paused,\nall CloudTasks.LeaseTasks calls will return a\n`FAILED_PRECONDITION` error.",
+ "The queue is disabled.\n\nA queue becomes `DISABLED` when\n[queue.yaml](/appengine/docs/python/config/queueref) or\n[queue.xml](appengine/docs/standard/java/config/queueref) is uploaded\nwhich does not contain the queue. You cannot directly disable a queue.\n\nWhen a queue is disabled, tasks can still be added to a queue\nbut the tasks are not dispatched and CloudTasks.LeaseTasks calls\nreturn a `FAILED_PRECONDITION` error.\n\nTo permanently delete this queue and all of its tasks, call\nCloudTasks.DeleteQueue."
+ ],
+ "enum": [
+ "STATE_UNSPECIFIED",
+ "RUNNING",
+ "PAUSED",
+ "DISABLED"
+ ],
+ "description": "Output only. The state of the queue.\n\n`state` can only be changed by called\nCloudTasks.PauseQueue, CloudTasks.ResumeQueue, or uploading\n[queue.yaml](/appengine/docs/python/config/queueref).\nCloudTasks.UpdateQueue cannot be used to change `state`.",
+ "type": "string"
+ },
+ "retryConfig": {
+ "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"
+ },
+ "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).",
+ "$ref": "RateLimits"
+ },
+ "pullTarget": {
+ "description": "Pull target.\n\nA pull queue is a queue that has a PullTarget.",
+ "$ref": "PullTarget"
+ }
+ },
+ "id": "Queue"
},
"SetIamPolicyRequest": {
"description": "Request message for `SetIamPolicy` method.",
@@ -85,64 +468,48 @@
"id": "Empty"
},
"AppEngineHttpTarget": {
+ "description": "App Engine HTTP target.\n\nThe task will be delivered to the App Engine application hostname\nspecified by its AppEngineHttpTarget and AppEngineHttpRequest.\nThe documentation for AppEngineHttpRequest explains how the\ntask's host URL is constructed.\n\nUsing AppEngineHttpTarget requires\n[`appengine.applications.get`](/appengine/docs/admin-api/access-control)\nGoogle IAM permission for the project\nand the following scope:\n\n`https://www.googleapis.com/auth/cloud-platform`",
+ "type": "object",
"properties": {
"appEngineRoutingOverride": {
- "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"
+ "$ref": "AppEngineRouting",
+ "description": "Overrides for the\ntask-level app_engine_routing.\n\nIf set, AppEngineHttpTarget.app_engine_routing_override is used for\nall tasks in the queue, no matter what the setting is for the\ntask-level app_engine_routing."
}
},
- "id": "AppEngineHttpTarget",
- "description": "App Engine HTTP target.\n\nThe task will be delivered to the App Engine application hostname\nspecified by its AppEngineHttpTarget and AppEngineHttpRequest.\nThe documentation for AppEngineHttpRequest explains how the\ntask's host URL is constructed.\n\nUsing AppEngineHttpTarget requires\n[`appengine.applications.get`](/appengine/docs/admin-api/access-control)\nGoogle IAM permission for the project\nand the following scope:\n\n`https://www.googleapis.com/auth/cloud-platform`",
- "type": "object"
+ "id": "AppEngineHttpTarget"
},
"Location": {
"description": "A resource that represents Google Cloud Platform location.",
"type": "object",
"properties": {
- "labels": {
- "description": "Cross-service attributes for the location. For example\n\n {\"cloud.googleapis.com/region\": \"us-east1\"}",
- "type": "object",
- "additionalProperties": {
- "type": "string"
- }
- },
- "name": {
- "description": "Resource name for the location, which may vary between implementations.\nFor example: `\"projects/example-project/locations/us-east1\"`",
- "type": "string"
- },
"locationId": {
"description": "The canonical id for this location. For example: `\"us-east1\"`.",
"type": "string"
},
"metadata": {
+ "description": "Service-specific metadata. For example the available capacity at the given\nlocation.",
+ "type": "object",
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
+ }
+ },
+ "labels": {
+ "additionalProperties": {
+ "type": "string"
},
- "description": "Service-specific metadata. For example the available capacity at the given\nlocation.",
+ "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"
},
"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\nPullMessage.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.",
@@ -156,23 +523,41 @@
],
"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"
+ },
+ "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\nPullMessage.tag is equal to `\u003cmy-tag\u003e`. `\u003cmy-tag\u003e` must be less than\n500 bytes.\n\nWhen `filter` is set to `tag_function=oldest_tag()`, only tasks which have\nthe same tag as the task with the oldest schedule_time will be returned.\n\nGrammar Syntax:\n\n* `filter = \"tag=\" tag | \"tag_function=\" function`\n\n* `tag = string | bytes`\n\n* `function = \"oldest_tag()\"`\n\nThe `oldest_tag()` function returns tasks which have the same tag as the\noldest task (ordered by schedule time).",
+ "type": "string"
+ },
+ "maxTasks": {
+ "description": "The maximum number of tasks to lease. The maximum that can be\nrequested is 1000.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "leaseDuration": {
+ "description": "The duration of the lease.\n\nEach task returned in the LeaseTasksResponse will have its\nTask.schedule_time set to the current time plus the\n`lease_duration`. A task that has been returned in a\nLeaseTasksResponse is leased -- that task will not be\nreturned in a different LeaseTasksResponse before the\nTask.schedule_time.\n\nAfter the worker has successfully finished the work\nassociated with the task, the worker must call\nCloudTasks.AcknowledgeTask. If the task is not acknowledged\nvia CloudTasks.AcknowledgeTask before the\nTask.schedule_time then it will be returned in a later\nLeaseTasksResponse so that another worker can process\nit.\n\nThe maximum lease duration is 1 week.\n`lease_duration` will be truncated to the nearest second.",
+ "format": "google-duration",
+ "type": "string"
}
},
- "id": "LeaseTasksRequest"
+ "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.",
+ "description": "Required.\n\nThe task's current schedule time, available in the Task.schedule_time\nreturned in LeaseTasksResponse.tasks or\nCloudTasks.RenewLease. This restriction is to ensure that your\nworker currently holds the lease.",
"format": "google-datetime",
"type": "string"
}
},
- "id": "AcknowledgeTaskRequest",
- "description": "Request message for acknowledging a task using\nCloudTasks.AcknowledgeTask.",
- "type": "object"
+ "id": "AcknowledgeTaskRequest"
},
"ListQueuesResponse": {
+ "description": "Response message for CloudTasks.ListQueues.",
+ "type": "object",
"properties": {
"queues": {
"description": "The list of queues.",
@@ -186,13 +571,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).",
@@ -202,33 +583,13 @@
}
}
},
- "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"
- },
- "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",
- "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": "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.",
@@ -242,16 +603,38 @@
}
}
},
- "id": "ListLocationsResponse",
- "description": "The response message for Locations.ListLocations.",
- "type": "object"
+ "id": "ListLocationsResponse"
+ },
+ "Policy": {
+ "description": "Defines an Identity and Access Management (IAM) policy. It is used to\nspecify access control policies for Cloud Platform resources.\n\n\nA `Policy` consists of a list of `bindings`. A `Binding` binds a list of\n`members` to a `role`, where the members can be user accounts, Google groups,\nGoogle domains, and service accounts. A `role` is a named list of permissions\ndefined by IAM.\n\n**Example**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/owner\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-other-app@appspot.gserviceaccount.com\",\n ]\n },\n {\n \"role\": \"roles/viewer\",\n \"members\": [\"user:sean@example.com\"]\n }\n ]\n }\n\nFor a description of IAM and its features, see the\n[IAM developer's guide](https://cloud.google.com/iam/docs).",
+ "type": "object",
+ "properties": {
+ "etag": {
+ "description": "`etag` is used for optimistic concurrency control as a way to help\nprevent simultaneous updates of a policy from overwriting each other.\nIt is strongly suggested that systems make use of the `etag` in the\nread-modify-write cycle to perform policy updates in order to avoid race\nconditions: An `etag` is returned in the response to `getIamPolicy`, and\nsystems are expected to put that etag in the request to `setIamPolicy` to\nensure that their change will be applied to the same version of the policy.\n\nIf no `etag` is provided in the call to `setIamPolicy`, then the existing\npolicy is overwritten blindly.",
+ "format": "byte",
+ "type": "string"
+ },
+ "version": {
+ "description": "Deprecated.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "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"
},
"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.",
+ "description": "Required.\n\nThe task's current schedule time, available in the Task.schedule_time\nreturned in LeaseTasksResponse.tasks or\nCloudTasks.RenewLease. This restriction is to ensure that your\nworker currently holds the lease.",
"format": "google-datetime",
"type": "string"
},
@@ -292,16 +675,21 @@
"type": "string"
},
"responseStatus": {
- "$ref": "Status",
- "description": "Output only. The response from the target for this attempt.\n\nIf the task has not been attempted or the task is currently running\nthen the response status is google.rpc.Code.UNKNOWN."
+ "description": "Output only. The response from the target for this attempt.\n\nIf the task has not been attempted or the task is currently running\nthen the response status is google.rpc.Code.UNKNOWN.",
+ "$ref": "Status"
}
},
"id": "AttemptStatus"
},
"RateLimits": {
"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).",
+ "description": "The maximum rate at which tasks are dispatched from this\nqueue.\n\nThe maximum allowed value is 500.\n\n* For App Engine queues, this field is 1 by default.\n* For pull queues, this field is output only and always 10,000.\n In addition to the `max_tasks_dispatched_per_second` limit, a maximum of\n 10 QPS of CloudTasks.LeaseTasks requests are allowed per queue.\n\nThis field has the same meaning as\n[rate in queue.yaml](/appengine/docs/standard/python/config/queueref#rate).",
"format": "double",
"type": "number"
},
@@ -309,455 +697,18 @@
"description": "Output only. The max burst size.\n\nMax burst size limits how fast the queue is processed when many\ntasks are in the queue and the rate is high. This field allows\nthe queue to have a high rate so processing starts shortly after\na task is enqueued, but still limits resource usage when many\ntasks are enqueued in a short period of time.\n\n* For App Engine queues, if\n RateLimits.max_tasks_dispatched_per_second is 1, this\n field is 10; otherwise this field is\n RateLimits.max_tasks_dispatched_per_second / 5.\n* For pull queues, this field is output only and always 10,000.\n\nNote: For App Engine queues that were created through\n`queue.yaml/xml`, `max_burst_size` might not have the same\nsettings as specified above; CloudTasks.UpdateQueue can be\nused to set `max_burst_size` only to the values specified above.\n\nThis field has the same meaning as\n[bucket_size in queue.yaml](/appengine/docs/standard/python/config/queueref#bucket_size).",
"format": "int32",
"type": "integer"
- },
- "maxConcurrentTasks": {
- "description": "The maximum number of concurrent tasks that Cloud Tasks allows\nto be dispatched for this queue. After this threshold has been\nreached, Cloud Tasks stops dispatching tasks until the number of\nconcurrent requests decreases.\n\nThe maximum allowed value is 5,000.\n\n* For App Engine queues, this field is 10 by default.\n* For pull queues, this field is output only and always -1, which\n indicates no limit.\n\nThis field has the same meaning as\n[max_concurrent_requests in queue.yaml](/appengine/docs/standard/python/config/queueref#max_concurrent_requests).",
- "format": "int32",
- "type": "integer"
}
},
"id": "RateLimits",
"description": "Rate limits.\n\nThis message determines the maximum rate that tasks can be dispatched by a\nqueue, regardless of whether the dispatch is a first task attempt or a retry.",
"type": "object"
- },
- "PurgeQueueRequest": {
- "description": "Request message for CloudTasks.PurgeQueue.",
- "type": "object",
- "properties": {},
- "id": "PurgeQueueRequest"
- },
- "PauseQueueRequest": {
- "description": "Request message for CloudTasks.PauseQueue.",
- "type": "object",
- "properties": {},
- "id": "PauseQueueRequest"
- },
- "RunTaskRequest": {
- "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",
- "description": "Request message for forcing a task to run now using\nCloudTasks.RunTask.",
- "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"
- },
- "Task": {
- "description": "A unit of scheduled work.",
- "type": "object",
- "properties": {
- "pullMessage": {
- "$ref": "PullMessage",
- "description": "Pull message contains data that should be used by the caller of\nCloudTasks.PullTasks to process the task. Can be set only if\nQueue.pull_target is set.\n\nA pull task is a task that has PullMessage set."
- },
- "scheduleTime": {
- "description": "The time when the task is scheduled to be attempted.\n\nFor App Engine queues, this is when the task will be attempted or retried.\n\nFor pull queues, this is the time when the task is available to\nbe leased; if a task is currently leased, this is the time when\nthe current lease expires, that is, the time that the task was\nleased plus the PullTasksRequest.lease_duration.\n\n`schedule_time` will be truncated to the nearest microsecond.",
- "format": "google-datetime",
- "type": "string"
- },
- "createTime": {
- "description": "Output only. The time that the task was created.\n\n`create_time` will be truncated to the nearest second.",
- "format": "google-datetime",
- "type": "string"
- },
- "status": {
- "description": "Output only. The task status.",
- "$ref": "TaskStatus"
- },
- "name": {
- "description": "The task name.\n\nThe task name must have the following format:\n`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`\n\n* `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]),\n hyphens (-), colons (:), or periods (.).\n For more information, see\n [Identifying projects](/resource-manager/docs/creating-managing-projects#identifying_projects)\n* `LOCATION_ID` is the canonical ID for the task's location.\n The list of available locations can be obtained by calling\n google.cloud.location.Locations.ListLocations.\n For more information, see https://cloud.google.com/about/locations/.\n* `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or\n hyphens (-). The maximum length is 100 characters.\n* `TASK_ID` can contain only letters ([A-Za-z]), numbers ([0-9]),\n hyphens (-), or underscores (_). The maximum length is 500 characters.\n\nOptionally caller-specified in CreateTaskRequest.",
- "type": "string"
- },
- "appEngineHttpRequest": {
- "description": "App Engine HTTP request that is sent to the task's target. Can be set\nonly if Queue.app_engine_http_target is set.\n\nAn App Engine task is a task that has AppEngineHttpRequest set.",
- "$ref": "AppEngineHttpRequest"
- },
- "view": {
- "enumDescriptions": [
- "Unspecified. Defaults to BASIC.",
- "The basic view omits fields which can be large or can contain\nsensitive data.\n\nThis view does not include (AppEngineHttpRequest.payload\nand PullMessage.payload). These payloads are desirable to\nreturn only when needed, because they can be large and because\nof the sensitivity of the data that you choose to store in it.",
- "All information is returned.\n\nAuthorization for Task.View.FULL requires\n`cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)\npermission on the Queue.name resource."
- ],
- "enum": [
- "VIEW_UNSPECIFIED",
- "BASIC",
- "FULL"
- ],
- "description": "Output only. The view specifies which subset of the Task has\nbeen returned.",
- "type": "string"
- }
- },
- "id": "Task"
- },
- "Status": {
- "properties": {
- "code": {
- "description": "The status code, which should be an enum value of google.rpc.Code.",
- "format": "int32",
- "type": "integer"
- },
- "message": {
- "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
- "type": "string"
- },
- "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"
- },
- "PullMessage": {
- "properties": {
- "payload": {
- "description": "A data payload consumed by the task worker to execute the task.",
- "format": "byte",
- "type": "string"
- },
- "tag": {
- "description": "The task's tag.\n\nTags allow similar tasks to be processed in a batch. If you label\ntasks with a tag, your task worker can pull tasks\nwith the same tag using PullTasksRequest.filter. For example,\nif you want to aggregate the events associated with a specific\nuser once a day, you could tag tasks with the user ID.\n\nThe task's tag can only be set when the\ntask is created.\n\nThe tag must be less than 500 bytes.",
- "format": "byte",
- "type": "string"
- }
- },
- "id": "PullMessage",
- "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.",
- "type": "object"
- },
- "Binding": {
- "properties": {
- "members": {
- "description": "Specifies the identities requesting access for a Cloud Platform resource.\n`members` can have the following values:\n\n* `allUsers`: A special identifier that represents anyone who is\n on the internet; with or without a Google account.\n\n* `allAuthenticatedUsers`: A special identifier that represents anyone\n who is authenticated with a Google account or a service account.\n\n* `user:{emailid}`: An email address that represents a specific Google\n account. For example, `alice@gmail.com` or `joe@example.com`.\n\n\n* `serviceAccount:{emailid}`: An email address that represents a service\n account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{emailid}`: An email address that represents a Google group.\n For example, `admins@example.com`.\n\n\n* `domain:{domain}`: A Google Apps domain name that represents all the\n users of that domain. For example, `google.com` or `example.com`.\n\n",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "role": {
- "description": "Role that is assigned to `members`.\nFor example, `roles/viewer`, `roles/editor`, or `roles/owner`.\nRequired",
- "type": "string"
- }
- },
- "id": "Binding",
- "description": "Associates `members` with a `role`.",
- "type": "object"
- },
- "RenewLeaseRequest": {
- "description": "Request message for renewing a lease using CloudTasks.RenewLease.",
- "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"
- },
- "leaseDuration": {
- "description": "Required.\n\nThe desired new lease duration, starting from now.\n\n\nThe maximum lease duration is 1 week.\n`lease_duration` will be truncated to the nearest second.",
- "format": "google-duration",
- "type": "string"
- },
- "responseView": {
- "enumDescriptions": [
- "Unspecified. Defaults to BASIC.",
- "The basic view omits fields which can be large or can contain\nsensitive data.\n\nThis view does not include (AppEngineHttpRequest.payload\nand PullMessage.payload). These payloads are desirable to\nreturn only when needed, because they can be large and because\nof the sensitivity of the data that you choose to store in it.",
- "All information is returned.\n\nAuthorization for Task.View.FULL requires\n`cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)\npermission on the Queue.name resource."
- ],
- "enum": [
- "VIEW_UNSPECIFIED",
- "BASIC",
- "FULL"
- ],
- "description": "The response_view specifies which subset of the Task will be\nreturned.\n\nBy default response_view is Task.View.BASIC; not all\ninformation is retrieved by default because some data, such as\npayloads, might be desirable to return only when needed because\nof its large size or because of the sensitivity of data that it\ncontains.\n\nAuthorization for Task.View.FULL requires `cloudtasks.tasks.fullView`\n[Google IAM](/iam/) permission on the\nTask.name resource.",
- "type": "string"
- }
- },
- "id": "RenewLeaseRequest"
- },
- "TaskStatus": {
- "properties": {
- "attemptDispatchCount": {
- "description": "Output only. The number of attempts dispatched.\n\nThis count includes tasks which have been dispatched but haven't\nreceived a response.",
- "format": "int32",
- "type": "integer"
- },
- "firstAttemptStatus": {
- "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).",
- "format": "int32",
- "type": "integer"
- },
- "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)."
- }
- },
- "id": "TaskStatus",
- "description": "Status of the task.",
- "type": "object"
- },
- "AppEngineHttpRequest": {
- "properties": {
- "headers": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "HTTP request headers.\n\nThis map contains the header field names and values.\nHeaders can be set when the\n[task is created](google.cloud.tasks.v2beta2.CloudTasks.CreateTask).\nRepeated headers are not supported but a header value can contain commas.\n\nCloud Tasks sets some headers to default values:\n\n* `User-Agent`: By default, this header is\n `\"AppEngine-Google; (+http://code.google.com/appengine)\"`.\n This header can be modified, but Cloud Tasks will append\n `\"AppEngine-Google; (+http://code.google.com/appengine)\"` to the\n modified `User-Agent`.\n\nIf the task has an AppEngineHttpRequest.payload, Cloud Tasks sets the\nfollowing headers:\n\n* `Content-Type`: By default, the `Content-Type` header is set to\n `\"application/octet-stream\"`. The default can be overridden by explictly\n setting `Content-Type` to a particular media type when the\n [task is created](google.cloud.tasks.v2beta2.CloudTasks.CreateTask).\n For example, `Content-Type` can be set to `\"application/json\"`.\n* `Content-Length`: This is computed by Cloud Tasks. This value is\n output only. It cannot be changed.\n\nThe headers below cannot be set or overridden:\n\n* `Host`\n* `X-Google-*`\n* `X-AppEngine-*`\n\nIn addition, Cloud Tasks sets some headers when the task is dispatched,\nsuch as headers containing information about the task; see\n[request headers](/appengine/docs/python/taskqueue/push/creating-handlers#reading_request_headers).\nThese headers are set only when the task is dispatched, so they are not\nvisible when the task is returned in a Cloud Tasks response.\n\nAlthough there is no specific limit for the maximum number of headers or\nthe size, there is a limit on the maximum size of the Task. For more\ninformation, see the CloudTasks.CreateTask documentation.",
- "type": "object"
- },
- "appEngineRouting": {
- "$ref": "AppEngineRouting",
- "description": "Task-level setting for App Engine routing.\n\nIf set, AppEngineHttpTarget.app_engine_routing_override is used for\nall tasks in the queue, no matter what the setting is for the\ntask-level app_engine_routing."
- },
- "httpMethod": {
- "enum": [
- "HTTP_METHOD_UNSPECIFIED",
- "POST",
- "GET",
- "HEAD",
- "PUT",
- "DELETE"
- ],
- "description": "The HTTP method to use for the request. The default is POST.\n\nThe app's request handler for the task's target URL must be able to handle\nHTTP requests with this http_method, otherwise the task attempt will fail\nwith error code 405 (Method Not Allowed). See\n[Writing a push task request handler](/appengine/docs/java/taskqueue/push/creating-handlers#writing_a_push_task_request_handler)\nand the documentation for the request handlers in the language your app is\nwritten in e.g.\n[Python Request Handler](/appengine/docs/python/tools/webapp/requesthandlerclass).",
- "type": "string",
- "enumDescriptions": [
- "HTTP method unspecified",
- "HTTP Post",
- "HTTP Get",
- "HTTP Head",
- "HTTP Put",
- "HTTP Delete"
- ]
- },
- "payload": {
- "description": "Payload.\n\nThe payload will be sent as the HTTP message body. A message\nbody, and thus a payload, is allowed only if the HTTP method is\nPOST or PUT. It is an error to set a data payload on a task with\nan incompatible HttpMethod.",
- "format": "byte",
- "type": "string"
- },
- "relativeUrl": {
- "description": "The relative URL.\n\nThe relative URL must begin with \"/\" and must be a valid HTTP relative URL.\nIt can contain a path and query string arguments.\nIf the relative URL is empty, then the root path \"/\" will be used.\nNo spaces are allowed, and the maximum length allowed is 2083 characters.",
- "type": "string"
- }
- },
- "id": "AppEngineHttpRequest",
- "description": "App Engine HTTP request.\n\nThe message defines the HTTP request that is sent to an App Engine app when\nthe task is dispatched.\n\nThis proto can only be used for tasks in a queue which has\nQueue.app_engine_http_target set.\n\nUsing AppEngineHttpRequest requires\n[`appengine.applications.get`](/appengine/docs/admin-api/access-control)\nGoogle IAM permission for the project\nand the following scope:\n\n`https://www.googleapis.com/auth/cloud-platform`\n\nThe task will be delivered to the App Engine app which belongs to the same\nproject as the queue. For more information, see\n[How Requests are Routed](/appengine/docs/standard/python/how-requests-are-routed)\nand how routing is affected by\n[dispatch files](/appengine/docs/python/config/dispatchref).\n\nThe AppEngineRouting used to construct the URL that the task is\ndelivered to can be set at the queue-level or task-level:\n\n* If set, AppEngineHttpTarget.app_engine_routing_override is used for\n all tasks in the queue, no matter what the setting is for the\n task-level app_engine_routing.\n\n\nThe `url` that the task will be sent to is:\n\n* `url =` AppEngineRouting.host `+` AppEngineHttpRequest.relative_url\n\nThe task attempt has succeeded if the app's request handler returns\nan HTTP response code in the range [`200` - `299`]. `503` is\nconsidered an App Engine system error instead of an application\nerror. Requests returning error `503` will be retried regardless of\nretry configuration and not counted against retry counts.\nAny other response code or a failure to receive a response before the\ndeadline is a failed attempt.",
- "type": "object"
- },
- "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"
- },
- "RetryConfig": {
- "description": "Retry config.\n\nThese settings determine how a failed task attempt is retried.",
- "type": "object",
- "properties": {
- "minBackoff": {
- "description": "The minimum amount of time to wait before retrying a task after\nit fails.\n\n* For [App Engine queues](google.cloud.tasks.v2beta2.AppEngineHttpTarget),\n this field is 0.1 seconds by default.\n* For [pull queues](google.cloud.tasks.v2beta2.PullTarget), this\n field is output only and always 0.\n\n`min_backoff` will be truncated to the nearest second.\n\nThis field has the same meaning as\n[min_backoff_seconds in queue.yaml](/appengine/docs/standard/python/config/queueref#retry_parameters).",
- "format": "google-duration",
- "type": "string"
- },
- "maxBackoff": {
- "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"
- },
- "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",
- "type": "integer"
- },
- "maxAttempts": {
- "description": "The maximum number of attempts for a task.\n\nCloud Tasks will attempt the task `max_attempts` times (that\nis, if the first attempt fails, then there will be\n`max_attempts - 1` retries). Must be \u003e 0.",
- "format": "int32",
- "type": "integer"
- },
- "unlimitedAttempts": {
- "description": "If true, then the number of attempts is unlimited.",
- "type": "boolean"
- }
- },
- "id": "RetryConfig"
- },
- "PullTarget": {
- "description": "Pull target.",
- "type": "object",
- "properties": {},
- "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.",
- "type": "array",
- "items": {
- "$ref": "Task"
- }
- },
- "nextPageToken": {
- "description": "A token to retrieve next page of results.\n\nTo return the next page of results, call\nCloudTasks.ListTasks with this value as the\nListTasksRequest.page_token.\n\nIf the next_page_token is empty, there are no more results.",
- "type": "string"
- }
- },
- "id": "ListTasksResponse"
- },
- "CreateTaskRequest": {
- "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"
- },
- "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"
- }
- },
- "id": "CreateTaskRequest",
- "description": "Request message for CloudTasks.CreateTask.",
- "type": "object"
- },
- "LeaseTasksResponse": {
- "description": "Response message for leasing tasks using CloudTasks.LeaseTasks.",
- "type": "object",
- "properties": {
- "tasks": {
- "description": "The leased tasks.",
- "type": "array",
- "items": {
- "$ref": "Task"
- }
- }
- },
- "id": "LeaseTasksResponse"
- },
- "Queue": {
- "description": "A queue is a container of related tasks. Queues are configured to manage\nhow those tasks are dispatched. Configurable properties include rate limits,\nretry options, target types, and others.",
- "type": "object",
- "properties": {
- "pullTarget": {
- "description": "Pull target.\n\nA pull queue is a queue that has a PullTarget.",
- "$ref": "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": {
- "$ref": "RetryConfig",
- "description": "Settings that determine the retry behavior.\n\n* For tasks created using Cloud Tasks: the queue-level retry settings\n apply to all tasks in the queue that were created using Cloud Tasks.\n Retry settings cannot be set on individual tasks.\n* For tasks created using the App Engine SDK: the queue-level retry\n settings apply to all tasks in the queue which do not have retry settings\n explicitly set on the task and were created by the App Engine SDK. See\n [App Engine documentation](/appengine/docs/standard/python/taskqueue/push/retrying-tasks)."
- },
- "state": {
- "enumDescriptions": [
- "Unspecified state.",
- "The queue is running. Tasks can be dispatched.\n\nIf the queue was created using Cloud Tasks and the queue has had no\nactivity (method calls or task dispatches) for 30 days, the queue may\ntake a few minutes to re-activate. Some method calls may return\ngoogle.rpc.Code.NOT_FOUND and tasks may not be dispatched for a few\nminutes until the queue has been re-activated.",
- "Tasks are paused by the user. If the queue is paused then Cloud\nTasks will stop delivering tasks from it, but more tasks can\nstill be added to it by the user. When a pull queue is paused,\nall CloudTasks.PullTasks calls will return a\n`FAILED_PRECONDITION` error.",
- "The queue is disabled.\n\nA queue becomes `DISABLED` when\n[queue.yaml](/appengine/docs/python/config/queueref) or\n[queue.xml](appengine/docs/standard/java/config/queueref) is uploaded\nwhich does not contain the queue. You cannot directly disable a queue.\n\nWhen a queue is disabled, tasks can still be added to a queue\nbut the tasks are not dispatched and CloudTasks.PullTasks calls\nreturn a `FAILED_PRECONDITION` error.\n\nTo permanently delete this queue and all of its tasks, call\nCloudTasks.DeleteQueue."
- ],
- "enum": [
- "STATE_UNSPECIFIED",
- "RUNNING",
- "PAUSED",
- "DISABLED"
- ],
- "description": "Output only. The state of the queue.\n\n`state` can only be changed by called\nCloudTasks.PauseQueue, CloudTasks.ResumeQueue, or uploading\n[queue.yaml](/appengine/docs/python/config/queueref).\nCloudTasks.UpdateQueue cannot be used to change `state`.",
- "type": "string"
- },
- "name": {
- "description": "The queue name.\n\nThe queue name must have the following format:\n`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`\n\n* `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]),\n hyphens (-), colons (:), or periods (.).\n For more information, see\n [Identifying projects](/resource-manager/docs/creating-managing-projects#identifying_projects)\n* `LOCATION_ID` is the canonical ID for the queue's location.\n The list of available locations can be obtained by calling\n google.cloud.location.Locations.ListLocations.\n For more information, see https://cloud.google.com/about/locations/.\n* `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or\n hyphens (-). The maximum length is 100 characters.\n\nCaller-specified and required in CreateQueueRequest, after which\nit becomes output only.",
- "type": "string"
- },
- "rateLimits": {
- "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).",
- "$ref": "RateLimits"
- }
- },
- "id": "Queue"
}
},
- "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": {
@@ -779,521 +730,11 @@
"projects": {
"resources": {
"locations": {
- "methods": {
- "list": {
- "description": "Lists information about the supported locations for this service.",
- "response": {
- "$ref": "ListLocationsResponse"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+$",
- "location": "path",
- "description": "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": {
- "description": "The standard list page size.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- },
- "filter": {
- "description": "The standard list filter.",
- "type": "string",
- "location": "query"
- }
- },
- "flatPath": "v2beta2/projects/{projectsId}/locations",
- "path": "v2beta2/{+name}/locations",
- "id": "cloudtasks.projects.locations.list"
- },
- "get": {
- "description": "Get information about a location.",
- "response": {
- "$ref": "Location"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "parameters": {
- "name": {
- "description": "Resource name for the location.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}",
- "path": "v2beta2/{+name}",
- "id": "cloudtasks.projects.locations.get"
- }
- },
"resources": {
"queues": {
- "methods": {
- "purge": {
- "request": {
- "$ref": "PurgeQueueRequest"
- },
- "description": "Purges a queue by deleting all of its tasks.\n\nAll tasks created before this method is called are permanently deleted.\n\nPurge operations can take up to one minute to take effect. Tasks\nmight be dispatched before the purge takes effect. A purge is irreversible.",
- "httpMethod": "POST",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Queue"
- },
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+$",
- "location": "path",
- "description": "Required.\n\nThe queue name. For example:\n`projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID`",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}:purge",
- "id": "cloudtasks.projects.locations.queues.purge",
- "path": "v2beta2/{+name}:purge"
- },
- "testIamPermissions": {
- "response": {
- "$ref": "TestIamPermissionsResponse"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
- "parameters": {
- "resource": {
- "pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+$",
- "location": "path",
- "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}:testIamPermissions",
- "path": "v2beta2/{+resource}:testIamPermissions",
- "id": "cloudtasks.projects.locations.queues.testIamPermissions",
- "request": {
- "$ref": "TestIamPermissionsRequest"
- },
- "description": "Returns permissions that a caller has on a Queue.\nIf the resource does not exist, this will return an empty set of\npermissions, not a google.rpc.Code.NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning."
- },
- "pause": {
- "httpMethod": "POST",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Queue"
- },
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+$",
- "location": "path",
- "description": "Required.\n\nThe queue name. For example:\n`projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID`",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}:pause",
- "id": "cloudtasks.projects.locations.queues.pause",
- "path": "v2beta2/{+name}:pause",
- "request": {
- "$ref": "PauseQueueRequest"
- },
- "description": "Pauses the queue.\n\nIf a queue is paused then the system will stop executing the\ntasks in the queue until it is resumed via\nCloudTasks.ResumeQueue. Tasks can still be added when the\nqueue is paused. The state of the queue is stored in\nQueue.state; if paused it will be set to\nQueue.State.PAUSED."
- },
- "delete": {
- "httpMethod": "DELETE",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Empty"
- },
- "parameters": {
- "name": {
- "description": "Required.\n\nThe queue name. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}",
- "id": "cloudtasks.projects.locations.queues.delete",
- "path": "v2beta2/{+name}",
- "description": "Deletes a queue.\n\nThis command will delete the queue even if it has tasks in it.\n\nNote: If you delete a queue, a queue with the same name can't be created\nfor 7 days.\n\nWARNING: Using this method may have unintended side effects if you are\nusing an App Engine `queue.yaml` or `queue.xml` file to manage your queues.\nRead\n[Overview of Queue Management and queue.yaml](/cloud-tasks/docs/queue-yaml)\ncarefully before using this method."
- },
- "list": {
- "response": {
- "$ref": "ListQueuesResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "parent": {
- "location": "path",
- "description": "Required.\n\nThe location name.\nFor example: `projects/PROJECT_ID/locations/LOCATION_ID`",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+$"
- },
- "filter": {
- "location": "query",
- "description": "`filter` can be used to specify a subset of queues. Any Queue\nfield can be used as a filter and several operators as supported.\nFor example: `\u003c=, \u003c, \u003e=, \u003e, !=, =, :`. The filter syntax is the same as\ndescribed in\n[Stackdriver's Advanced Logs Filters](/logging/docs/view/advanced_filters).\n\nSample filter \"app_engine_http_target: *\".\n\nNote that using filters might cause fewer queues than the\nrequested_page size to be returned.",
- "type": "string"
- },
- "pageToken": {
- "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",
- "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"
- }
- },
- "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."
- },
- "create": {
- "response": {
- "$ref": "Queue"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "parent": {
- "pattern": "^projects/[^/]+/locations/[^/]+$",
- "location": "path",
- "description": "Required.\n\nThe location name in which the queue will be created.\nFor example: `projects/PROJECT_ID/locations/LOCATION_ID`\n\nThe list of allowed locations can be obtained by calling Cloud\nTasks' implementation of\ngoogle.cloud.location.Locations.ListLocations.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues",
- "path": "v2beta2/{+parent}/queues",
- "id": "cloudtasks.projects.locations.queues.create",
- "description": "Creates a queue.\n\nQueues created with this method allow tasks to live for a maximum of 31\ndays. After a task is 31 days old, the task will be deleted regardless of whether\nit was dispatched or not.\n\nWARNING: Using this method may have unintended side effects if you are\nusing an App Engine `queue.yaml` or `queue.xml` file to manage your queues.\nRead\n[Overview of Queue Management and queue.yaml](/cloud-tasks/docs/queue-yaml)\ncarefully before using this method.",
- "request": {
- "$ref": "Queue"
- }
- },
- "setIamPolicy": {
- "response": {
- "$ref": "Policy"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "resource": {
- "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}:setIamPolicy",
- "path": "v2beta2/{+resource}:setIamPolicy",
- "id": "cloudtasks.projects.locations.queues.setIamPolicy",
- "description": "Sets the access control policy for a Queue. Replaces any existing\npolicy.\n\nNote: The Cloud Console does not check queue-level IAM permissions yet.\nProject-level permissions are required to use the Cloud Console.\n\nAuthorization requires the following [Google IAM](/iam) permission on the\nspecified resource parent:\n\n* `cloudtasks.queues.setIamPolicy`",
- "request": {
- "$ref": "SetIamPolicyRequest"
- }
- },
- "resume": {
- "httpMethod": "POST",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Queue"
- },
- "parameters": {
- "name": {
- "description": "Required.\n\nThe queue name. For example:\n`projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID`",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}:resume",
- "id": "cloudtasks.projects.locations.queues.resume",
- "path": "v2beta2/{+name}:resume",
- "request": {
- "$ref": "ResumeQueueRequest"
- },
- "description": "Resume a queue.\n\nThis method resumes a queue after it has been\nQueue.State.PAUSED or Queue.State.DISABLED. The state of\na queue is stored in Queue.state; after calling this method it\nwill be set to Queue.State.RUNNING.\n\nWARNING: Resuming many high-QPS queues at the same time can\nlead to target overloading. If you are resuming high-QPS\nqueues, follow the 500/50/5 pattern described in\n[Managing Cloud Tasks Scaling Risks](/cloud-tasks/pdfs/managing-cloud-tasks-scaling-risks-2017-06-05.pdf)."
- },
- "getIamPolicy": {
- "response": {
- "$ref": "Policy"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
- "parameters": {
- "resource": {
- "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}:getIamPolicy",
- "path": "v2beta2/{+resource}:getIamPolicy",
- "id": "cloudtasks.projects.locations.queues.getIamPolicy",
- "request": {
- "$ref": "GetIamPolicyRequest"
- },
- "description": "Gets the access control policy for a Queue.\nReturns an empty policy if the resource exists and does not have a policy\nset.\n\nAuthorization requires the following [Google IAM](/iam) permission on the\nspecified resource parent:\n\n* `cloudtasks.queues.getIamPolicy`"
- },
- "get": {
- "description": "Gets a queue.",
- "response": {
- "$ref": "Queue"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "description": "Required.\n\nThe resource name of the queue. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}",
- "path": "v2beta2/{+name}",
- "id": "cloudtasks.projects.locations.queues.get"
- },
- "patch": {
- "description": "Updates a queue.\n\nThis method creates the queue if it does not exist and updates\nthe queue if it does exist.\n\nQueues created with this method allow tasks to live for a maximum of 31\ndays. After a task is 31 days old, the task will be deleted regardless of whether\nit was dispatched or not.\n\nWARNING: Using this method may have unintended side effects if you are\nusing an App Engine `queue.yaml` or `queue.xml` file to manage your queues.\nRead\n[Overview of Queue Management and queue.yaml](/cloud-tasks/docs/queue-yaml)\ncarefully before using this method.",
- "request": {
- "$ref": "Queue"
- },
- "response": {
- "$ref": "Queue"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "PATCH",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+$",
- "location": "path",
- "description": "The queue name.\n\nThe queue name must have the following format:\n`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`\n\n* `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]),\n hyphens (-), colons (:), or periods (.).\n For more information, see\n [Identifying projects](/resource-manager/docs/creating-managing-projects#identifying_projects)\n* `LOCATION_ID` is the canonical ID for the queue's location.\n The list of available locations can be obtained by calling\n google.cloud.location.Locations.ListLocations.\n For more information, see https://cloud.google.com/about/locations/.\n* `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or\n hyphens (-). The maximum length is 100 characters.\n\nCaller-specified and required in CreateQueueRequest, after which\nit becomes output only.",
- "required": true,
- "type": "string"
- },
- "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"
- }
- },
- "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}",
- "path": "v2beta2/{+name}",
- "id": "cloudtasks.projects.locations.queues.patch"
- }
- },
"resources": {
"tasks": {
"methods": {
- "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": {
- "httpMethod": "POST",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Task"
- },
- "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",
- "id": "cloudtasks.projects.locations.queues.tasks.renewLease",
- "path": "v2beta2/{+name}: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."
- },
- "get": {
- "description": "Gets a task.",
- "response": {
- "$ref": "Task"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "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/[^/]+$"
- },
- "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"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}/tasks/{tasksId}",
- "path": "v2beta2/{+name}",
- "id": "cloudtasks.projects.locations.queues.tasks.get"
- },
- "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"
- },
- "response": {
- "$ref": "LeaseTasksResponse"
- },
- "parameterOrder": [
- "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`",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+$"
- }
- },
- "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}/tasks:lease",
- "path": "v2beta2/{+parent}/tasks:lease",
- "id": "cloudtasks.projects.locations.queues.tasks.lease"
- },
"delete": {
"httpMethod": "DELETE",
"response": {
@@ -1319,34 +760,6 @@
"path": "v2beta2/{+name}",
"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": {
- "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.",
- "httpMethod": "POST",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "PullTasksResponse"
- },
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+$",
- "location": "path",
- "description": "Required.\n\nThe queue name. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}/tasks:pull",
- "id": "cloudtasks.projects.locations.queues.tasks.pull",
- "path": "v2beta2/{+name}/tasks:pull"
- },
"list": {
"response": {
"$ref": "ListTasksResponse"
@@ -1360,17 +773,17 @@
],
"parameters": {
"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",
- "location": "query"
+ "type": "integer"
},
"parent": {
+ "location": "path",
"description": "Required.\n\nThe queue name. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`",
"required": true,
"type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+$",
- "location": "path"
+ "pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+$"
},
"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.",
@@ -1383,14 +796,14 @@
]
},
"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",
- "location": "query"
+ "type": "string"
},
"pageToken": {
- "location": "query",
"description": "A token identifying the page of results to return.\n\nTo request the first page results, page_token must be empty. To\nrequest the next page of results, page_token must be the value of\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"
+ "type": "string",
+ "location": "query"
}
},
"flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}/tasks",
@@ -1399,10 +812,6 @@
"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": {
- "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.",
"httpMethod": "POST",
"parameterOrder": [
"parent"
@@ -1424,13 +833,13 @@
],
"flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}/tasks",
"id": "cloudtasks.projects.locations.queues.tasks.create",
- "path": "v2beta2/{+parent}/tasks"
+ "path": "v2beta2/{+parent}/tasks",
+ "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": {
- "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.",
"response": {
"$ref": "Task"
},
@@ -1438,27 +847,34 @@
"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"
],
+ "parameters": {
+ "name": {
+ "location": "path",
+ "description": "Required.\n\nThe task name. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+/tasks/[^/]+$"
+ }
+ },
"flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}/tasks/{tasksId}:run",
"path": "v2beta2/{+name}:run",
- "id": "cloudtasks.projects.locations.queues.tasks.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"
+ }
},
"cancelLease": {
+ "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}/tasks/{tasksId}:cancelLease",
+ "id": "cloudtasks.projects.locations.queues.tasks.cancelLease",
+ "path": "v2beta2/{+name}:cancelLease",
"request": {
"$ref": "CancelLeaseRequest"
},
- "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.",
+ "description": "Cancel a pull task's lease.\n\nThe worker can use this method to cancel a task's lease\nby setting Task.schedule_time to now. This will make the task\navailable to be leased to the next caller of CloudTasks.LeaseTasks.",
"httpMethod": "POST",
"parameterOrder": [
"name"
@@ -1477,21 +893,575 @@
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "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 worker, that is, the entity that received this task in\na LeaseTasksResponse, must call this method to indicate that\nthe work associated with the task has finished.\n\nThe worker must acknowledge a task within the\nLeaseTasksRequest.lease_duration or the lease will expire and\nthe task will become ready to be returned in a different\nLeaseTasksResponse. After the task is acknowledged, it will\nnot be returned by a later CloudTasks.LeaseTasks,\nCloudTasks.GetTask, or CloudTasks.ListTasks.\n\nTo acknowledge multiple tasks at the same time, use\n[HTTP batching](/storage/docs/json_api/v1/how-tos/batch)\nor the batching documentation for your client library, for example\nhttps://developers.google.com/api-client-library/python/guide/batch.",
+ "request": {
+ "$ref": "AcknowledgeTaskRequest"
+ },
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "name"
],
- "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}/tasks/{tasksId}:cancelLease",
- "id": "cloudtasks.projects.locations.queues.tasks.cancelLease",
- "path": "v2beta2/{+name}:cancelLease"
+ "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": {
+ "request": {
+ "$ref": "RenewLeaseRequest"
+ },
+ "description": "Renew the current lease of a pull task.\n\nThe 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": {
+ "response": {
+ "$ref": "Task"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "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"
+ },
+ "responseView": {
+ "description": "The response_view specifies which subset of the Task will be\nreturned.\n\nBy default response_view is Task.View.BASIC; not all\ninformation is retrieved by default because some data, such as\npayloads, might be desirable to return only when needed because\nof its large size or because of the sensitivity of data that it\ncontains.\n\nAuthorization for Task.View.FULL requires `cloudtasks.tasks.fullView`\n[Google IAM](/iam/) permission on the\nTask.name resource.",
+ "type": "string",
+ "location": "query",
+ "enum": [
+ "VIEW_UNSPECIFIED",
+ "BASIC",
+ "FULL"
+ ]
+ }
+ },
+ "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}/tasks/{tasksId}",
+ "path": "v2beta2/{+name}",
+ "id": "cloudtasks.projects.locations.queues.tasks.get",
+ "description": "Gets a task."
+ },
+ "lease": {
+ "response": {
+ "$ref": "LeaseTasksResponse"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "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:lease",
+ "path": "v2beta2/{+parent}/tasks:lease",
+ "id": "cloudtasks.projects.locations.queues.tasks.lease",
+ "request": {
+ "$ref": "LeaseTasksRequest"
+ },
+ "description": "\nLeases tasks from a pull queue for LeaseTasksRequest.lease_duration.\n\nThis method is invoked by the worker to obtain a\nlease. The 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 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."
}
}
}
+ },
+ "methods": {
+ "resume": {
+ "path": "v2beta2/{+name}:resume",
+ "id": "cloudtasks.projects.locations.queues.resume",
+ "description": "Resume a queue.\n\nThis method resumes a queue after it has been\nQueue.State.PAUSED or Queue.State.DISABLED. The state of\na queue is stored in Queue.state; after calling this method it\nwill be set to Queue.State.RUNNING.\n\nWARNING: Resuming many high-QPS queues at the same time can\nlead to target overloading. If you are resuming high-QPS\nqueues, follow the 500/50/5 pattern described in\n[Managing Cloud Tasks Scaling Risks](/cloud-tasks/pdfs/managing-cloud-tasks-scaling-risks-2017-06-05.pdf).",
+ "request": {
+ "$ref": "ResumeQueueRequest"
+ },
+ "response": {
+ "$ref": "Queue"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "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"
+ },
+ "getIamPolicy": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "resource"
+ ],
+ "response": {
+ "$ref": "Policy"
+ },
+ "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"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}:getIamPolicy",
+ "id": "cloudtasks.projects.locations.queues.getIamPolicy",
+ "path": "v2beta2/{+resource}:getIamPolicy",
+ "request": {
+ "$ref": "GetIamPolicyRequest"
+ },
+ "description": "Gets the access control policy for a Queue.\nReturns an empty policy if the resource exists and does not have a policy\nset.\n\nAuthorization requires the following [Google IAM](/iam) permission on the\nspecified resource parent:\n\n* `cloudtasks.queues.getIamPolicy`"
+ },
+ "patch": {
+ "response": {
+ "$ref": "Queue"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "PATCH",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "updateMask": {
+ "location": "query",
+ "description": "A mask used to specify which fields of the queue are being updated.\n\nIf empty, then all fields will be updated.",
+ "format": "google-fieldmask",
+ "type": "string"
+ },
+ "name": {
+ "location": "path",
+ "description": "The queue name.\n\nThe queue name must have the following format:\n`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`\n\n* `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]),\n hyphens (-), colons (:), or periods (.).\n For more information, see\n [Identifying projects](/resource-manager/docs/creating-managing-projects#identifying_projects)\n* `LOCATION_ID` is the canonical ID for the queue's location.\n The list of available locations can be obtained by calling\n google.cloud.location.Locations.ListLocations.\n For more information, see https://cloud.google.com/about/locations/.\n* `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or\n hyphens (-). The maximum length is 100 characters.\n\nCaller-specified and required in CreateQueueRequest, after which\nit becomes output only.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+$"
+ }
+ },
+ "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}",
+ "path": "v2beta2/{+name}",
+ "id": "cloudtasks.projects.locations.queues.patch",
+ "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"
+ }
+ },
+ "get": {
+ "description": "Gets a queue.",
+ "response": {
+ "$ref": "Queue"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "name": {
+ "location": "path",
+ "description": "Required.\n\nThe resource name of the queue. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+$"
+ }
+ },
+ "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"
+ },
+ "purge": {
+ "response": {
+ "$ref": "Queue"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "description": "Required.\n\nThe queue name. For example:\n`projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID`",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}:purge",
+ "path": "v2beta2/{+name}:purge",
+ "id": "cloudtasks.projects.locations.queues.purge",
+ "description": "Purges a queue by deleting all of its tasks.\n\nAll tasks created before this method is called are permanently deleted.\n\nPurge operations can take up to one minute to take effect. Tasks\nmight be dispatched before the purge takes effect. A purge is irreversible.",
+ "request": {
+ "$ref": "PurgeQueueRequest"
+ }
+ },
+ "testIamPermissions": {
+ "path": "v2beta2/{+resource}:testIamPermissions",
+ "id": "cloudtasks.projects.locations.queues.testIamPermissions",
+ "description": "Returns permissions that a caller has on a Queue.\nIf the resource does not exist, this will return an empty set of\npermissions, not a google.rpc.Code.NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning.",
+ "request": {
+ "$ref": "TestIamPermissionsRequest"
+ },
+ "response": {
+ "$ref": "TestIamPermissionsResponse"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "resource": {
+ "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}:testIamPermissions"
+ },
+ "pause": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Queue"
+ },
+ "parameters": {
+ "name": {
+ "description": "Required.\n\nThe queue name. For example:\n`projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID`",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}:pause",
+ "id": "cloudtasks.projects.locations.queues.pause",
+ "path": "v2beta2/{+name}:pause",
+ "request": {
+ "$ref": "PauseQueueRequest"
+ },
+ "description": "Pauses the queue.\n\nIf a queue is paused then the system will stop executing the\ntasks in the queue until it is resumed via\nCloudTasks.ResumeQueue. Tasks can still be added when the\nqueue is paused. The state of the queue is stored in\nQueue.state; if paused it will be set to\nQueue.State.PAUSED."
+ },
+ "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"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "DELETE",
+ "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/locations/LOCATION_ID/queues/QUEUE_ID`",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}",
+ "path": "v2beta2/{+name}",
+ "id": "cloudtasks.projects.locations.queues.delete"
+ },
+ "list": {
+ "description": "Lists queues.\n\nQueues are returned in lexicographical order.",
+ "response": {
+ "$ref": "ListQueuesResponse"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "filter": {
+ "location": "query",
+ "description": "`filter` can be used to specify a subset of queues. Any Queue\nfield can be used as a filter and several operators as supported.\nFor example: `\u003c=, \u003c, \u003e=, \u003e, !=, =, :`. The filter syntax is the same as\ndescribed in\n[Stackdriver's Advanced Logs Filters](/logging/docs/view/advanced_filters).\n\nSample filter \"app_engine_http_target: *\".\n\nNote that using filters might cause fewer queues than the\nrequested_page size to be returned.",
+ "type": "string"
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "A token identifying the page of results to return.\n\nTo request the first page results, page_token must be empty. To\nrequest the next page of results, page_token must be the value of\nListQueuesResponse.next_page_token returned from the previous\ncall to CloudTasks.ListQueues method. It is an error to\nswitch the value of ListQueuesRequest.filter while iterating\nthrough pages.",
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "Requested page size.\n\nThe maximum page size is 9800. If unspecified, the page size will\nbe the maximum. Fewer queues than requested might be returned,\neven if more queues exist; use\nListQueuesResponse.next_page_token to determine if more\nqueues exist.",
+ "format": "int32",
+ "type": "integer",
+ "location": "query"
+ },
+ "parent": {
+ "description": "Required.\n\nThe location name.\nFor example: `projects/PROJECT_ID/locations/LOCATION_ID`",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues",
+ "path": "v2beta2/{+parent}/queues",
+ "id": "cloudtasks.projects.locations.queues.list"
+ },
+ "setIamPolicy": {
+ "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}:setIamPolicy",
+ "id": "cloudtasks.projects.locations.queues.setIamPolicy",
+ "path": "v2beta2/{+resource}: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`",
+ "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/[^/]+/locations/[^/]+/queues/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "create": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "parent"
+ ],
+ "response": {
+ "$ref": "Queue"
+ },
+ "parameters": {
+ "parent": {
+ "pattern": "^projects/[^/]+/locations/[^/]+$",
+ "location": "path",
+ "description": "Required.\n\nThe location name in which the queue will be created.\nFor example: `projects/PROJECT_ID/locations/LOCATION_ID`\n\nThe list of allowed locations can be obtained by calling Cloud\nTasks' implementation of\ngoogle.cloud.location.Locations.ListLocations.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "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",
+ "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."
+ }
}
}
+ },
+ "methods": {
+ "list": {
+ "response": {
+ "$ref": "ListLocationsResponse"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "pageSize": {
+ "description": "The standard list page size.",
+ "format": "int32",
+ "type": "integer",
+ "location": "query"
+ },
+ "filter": {
+ "description": "The standard list filter.",
+ "type": "string",
+ "location": "query"
+ },
+ "name": {
+ "location": "path",
+ "description": "The resource that owns the locations collection, if applicable.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+$"
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "The standard list page token.",
+ "type": "string"
+ }
+ },
+ "flatPath": "v2beta2/projects/{projectsId}/locations",
+ "path": "v2beta2/{+name}/locations",
+ "id": "cloudtasks.projects.locations.list",
+ "description": "Lists information about the supported locations for this service."
+ },
+ "get": {
+ "path": "v2beta2/{+name}",
+ "id": "cloudtasks.projects.locations.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": "v2beta2/projects/{projectsId}/locations/{locationsId}"
+ }
}
}
}
}
},
"parameters": {
+ "alt": {
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query",
+ "description": "Data format for response.",
+ "default": "json",
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
+ "type": "string"
+ },
+ "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": {
+ "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\").",
@@ -1509,18 +1479,11 @@
"type": "string"
},
"fields": {
+ "location": "query",
"description": "Selector specifying which fields to include in a partial response.",
- "type": "string",
- "location": "query"
- },
- "callback": {
- "description": "JSONP",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"$.xgafv": {
- "description": "V1 error format.",
- "type": "string",
"enumDescriptions": [
"v1 error format",
"v2 error format"
@@ -1529,52 +1492,12 @@
"enum": [
"1",
"2"
- ]
- },
- "alt": {
- "type": "string",
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
],
- "location": "query",
- "description": "Data format for response.",
- "default": "json",
- "enum": [
- "json",
- "media",
- "proto"
- ]
- },
- "key": {
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string",
- "location": "query"
- },
- "access_token": {
- "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": "V1 error format.",
"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.",
+ "callback": {
+ "description": "JSONP",
"type": "string",
"location": "query"
}
diff --git a/cloudtasks/v2beta2/cloudtasks-gen.go b/cloudtasks/v2beta2/cloudtasks-gen.go
index 8329bf3..fff7aee 100644
--- a/cloudtasks/v2beta2/cloudtasks-gen.go
+++ b/cloudtasks/v2beta2/cloudtasks-gen.go
@@ -128,9 +128,8 @@
//
// The task's current schedule time, available in the
// Task.schedule_time
- // returned in PullTasksResponse.tasks or
+ // returned in LeaseTasksResponse.tasks or
// CloudTasks.RenewLease. This restriction is to ensure that your
- // task
// worker currently holds the lease.
ScheduleTime string `json:"scheduleTime,omitempty"`
@@ -728,9 +727,8 @@
//
// The task's current schedule time, available in the
// Task.schedule_time
- // returned in PullTasksResponse.tasks or
+ // returned in LeaseTasksResponse.tasks or
// CloudTasks.RenewLease. This restriction is to ensure that your
- // task
// worker currently holds the lease.
ScheduleTime string `json:"scheduleTime,omitempty"`
@@ -927,14 +925,14 @@
// the
// Task.schedule_time.
//
- // After the pull worker has successfully finished the work
- // associated with the task, the pull worker must
+ // After the worker has successfully finished the work
+ // associated with the task, the worker must
// call
// CloudTasks.AcknowledgeTask. If the task is not acknowledged
// via CloudTasks.AcknowledgeTask before the
// Task.schedule_time then it will be returned in a
// later
- // LeaseTasksResponse so that another pull worker can process
+ // LeaseTasksResponse so that another worker can process
// it.
//
// The maximum lease duration is 1 week.
@@ -1248,7 +1246,7 @@
// }
//
// For a description of IAM and its features, see the
-// [IAM developer's guide](https://cloud.google.com/iam).
+// [IAM developer's guide](https://cloud.google.com/iam/docs).
type Policy struct {
// Bindings: Associates a list of `members` to a `role`.
// `bindings` with no members will result in an error.
@@ -1274,7 +1272,7 @@
// policy is overwritten blindly.
Etag string `json:"etag,omitempty"`
- // Version: Version of the `Policy`. The default version is 0.
+ // Version: Deprecated.
Version int64 `json:"version,omitempty"`
// ServerResponse contains the HTTP response code and headers from the
@@ -1306,22 +1304,21 @@
// PullMessage: The pull message contains data that can be used by the
// caller of
-// CloudTasks.PullTasks to process the task.
+// CloudTasks.LeaseTasks to process the task.
//
// This proto can only be used for tasks in a queue which
// has
// Queue.pull_target set.
type PullMessage struct {
- // Payload: A data payload consumed by the task worker to execute the
- // task.
+ // Payload: A data payload consumed by the worker to execute the task.
Payload string `json:"payload,omitempty"`
// Tag: The task's tag.
//
// Tags allow similar tasks to be processed in a batch. If you
// label
- // tasks with a tag, your task worker can pull tasks
- // with the same tag using PullTasksRequest.filter. For example,
+ // tasks with a tag, your worker can lease tasks
+ // with the same tag using LeaseTasksRequest.filter. For example,
// if you want to aggregate the events associated with a specific
// user once a day, you could tag tasks with the user ID.
//
@@ -1358,158 +1355,6 @@
type PullTarget struct {
}
-// PullTasksRequest: Request message for pulling tasks using
-// CloudTasks.PullTasks.
-type PullTasksRequest struct {
- // Filter: `filter` can be used to specify a subset of tasks to
- // lease.
- //
- // When `filter` is set to `tag=<my-tag>` then the
- // PullTasksResponse will contain only tasks whose
- // PullMessage.tag is equal to `<my-tag>`. `<my-tag>` must be less
- // than
- // 500 bytes.
- //
- // When `filter` is set to `tag_function=oldest_tag()`, only tasks which
- // have
- // the same tag as the task with the oldest schedule_time will be
- // returned.
- //
- // Grammar Syntax:
- //
- // * `filter = "tag=" tag | "tag_function=" function`
- //
- // * `tag = string | bytes`
- //
- // * `function = "oldest_tag()"
- //
- // The `oldest_tag()` function returns tasks which have the same tag as
- // the
- // oldest task (ordered by schedule time).
- Filter string `json:"filter,omitempty"`
-
- // LeaseDuration: The duration of the lease.
- //
- // Each task returned in the PullTasksResponse will have
- // its
- // Task.schedule_time set to the current time plus the
- // `lease_duration`. A task that has been returned in
- // a
- // PullTasksResponse is leased -- that task will not be
- // returned in a different PullTasksResponse before
- // the
- // Task.schedule_time.
- //
- // After the pull worker has successfully finished the work
- // associated with the task, the pull worker must
- // call
- // CloudTasks.AcknowledgeTask. If the task is not acknowledged
- // via CloudTasks.AcknowledgeTask before the
- // Task.schedule_time then it will be returned in a
- // later
- // PullTasksResponse so that another pull worker can process
- // it.
- //
- // The maximum lease duration is 1 week.
- // `lease_duration` will be truncated to the nearest second.
- LeaseDuration string `json:"leaseDuration,omitempty"`
-
- // MaxTasks: The maximum number of tasks to lease. The maximum that can
- // be
- // requested is 1000.
- MaxTasks int64 `json:"maxTasks,omitempty"`
-
- // ResponseView: The response_view specifies which subset of the Task
- // will be
- // returned.
- //
- // By default response_view is Task.View.BASIC; not all
- // information is retrieved by default because some data, such
- // as
- // payloads, might be desirable to return only when needed because
- // of its large size or because of the sensitivity of data that
- // it
- // contains.
- //
- // Authorization for Task.View.FULL requires
- // `cloudtasks.tasks.fullView`
- // [Google IAM](/iam/) permission on the
- // Task.name resource.
- //
- // Possible values:
- // "VIEW_UNSPECIFIED" - Unspecified. Defaults to BASIC.
- // "BASIC" - The basic view omits fields which can be large or can
- // contain
- // sensitive data.
- //
- // This view does not include (AppEngineHttpRequest.payload
- // and PullMessage.payload). These payloads are desirable to
- // return only when needed, because they can be large and because
- // of the sensitivity of the data that you choose to store in it.
- // "FULL" - All information is returned.
- //
- // Authorization for Task.View.FULL requires
- // `cloudtasks.tasks.fullView` [Google
- // IAM](https://cloud.google.com/iam/)
- // permission on the Queue.name resource.
- ResponseView string `json:"responseView,omitempty"`
-
- // ForceSendFields is a list of field names (e.g. "Filter") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-
- // NullFields is a list of field names (e.g. "Filter") to include in API
- // requests with the JSON null value. By default, fields with empty
- // values are omitted from API requests. However, any field with an
- // empty value appearing in NullFields will be sent to the server as
- // null. It is an error if a field in this list has a non-empty value.
- // This may be used to include null fields in Patch requests.
- NullFields []string `json:"-"`
-}
-
-func (s *PullTasksRequest) MarshalJSON() ([]byte, error) {
- type NoMethod PullTasksRequest
- raw := NoMethod(*s)
- return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
-}
-
-// PullTasksResponse: Response message for pulling tasks using
-// CloudTasks.PullTasks.
-type PullTasksResponse struct {
- // Tasks: The leased tasks.
- Tasks []*Task `json:"tasks,omitempty"`
-
- // ServerResponse contains the HTTP response code and headers from the
- // server.
- googleapi.ServerResponse `json:"-"`
-
- // ForceSendFields is a list of field names (e.g. "Tasks") to
- // unconditionally include in API requests. By default, fields with
- // empty values are omitted from API requests. However, any non-pointer,
- // non-interface field appearing in ForceSendFields will be sent to the
- // server regardless of whether the field is empty or not. This may be
- // used to include empty fields in Patch requests.
- ForceSendFields []string `json:"-"`
-
- // NullFields is a list of field names (e.g. "Tasks") to include in API
- // requests with the JSON null value. By default, fields with empty
- // values are omitted from API requests. However, any field with an
- // empty value appearing in NullFields will be sent to the server as
- // null. It is an error if a field in this list has a non-empty value.
- // This may be used to include null fields in Patch requests.
- NullFields []string `json:"-"`
-}
-
-func (s *PullTasksResponse) MarshalJSON() ([]byte, error) {
- type NoMethod PullTasksResponse
- raw := NoMethod(*s)
- return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
-}
-
// PurgeQueueRequest: Request message for CloudTasks.PurgeQueue.
type PurgeQueueRequest struct {
}
@@ -1632,7 +1477,7 @@
// then Cloud
// Tasks will stop delivering tasks from it, but more tasks can
// still be added to it by the user. When a pull queue is paused,
- // all CloudTasks.PullTasks calls will return a
+ // all CloudTasks.LeaseTasks calls will return a
// `FAILED_PRECONDITION` error.
// "DISABLED" - The queue is disabled.
//
@@ -1646,7 +1491,7 @@
// queue.
//
// When a queue is disabled, tasks can still be added to a queue
- // but the tasks are not dispatched and CloudTasks.PullTasks
+ // but the tasks are not dispatched and CloudTasks.LeaseTasks
// calls
// return a `FAILED_PRECONDITION` error.
//
@@ -1748,7 +1593,7 @@
// * For pull queues, this field is output only and always 10,000.
// In addition to the `max_tasks_dispatched_per_second` limit, a
// maximum of
- // 10 QPS of CloudTasks.PullTasks requests are allowed per
+ // 10 QPS of CloudTasks.LeaseTasks requests are allowed per
// queue.
//
// This field has the same meaning as
@@ -1844,9 +1689,8 @@
//
// The task's current schedule time, available in the
// Task.schedule_time
- // returned in PullTasksResponse.tasks or
+ // returned in LeaseTasksResponse.tasks or
// CloudTasks.RenewLease. This restriction is to ensure that your
- // task
// worker currently holds the lease.
ScheduleTime string `json:"scheduleTime,omitempty"`
@@ -2269,7 +2113,7 @@
// PullMessage: Pull message contains data that should be used by the
// caller of
- // CloudTasks.PullTasks to process the task. Can be set only
+ // CloudTasks.LeaseTasks to process the task. Can be set only
// if
// Queue.pull_target is set.
//
@@ -2285,7 +2129,7 @@
// For pull queues, this is the time when the task is available to
// be leased; if a task is currently leased, this is the time when
// the current lease expires, that is, the time that the task was
- // leased plus the PullTasksRequest.lease_duration.
+ // leased plus the LeaseTasksRequest.lease_duration.
//
// `schedule_time` will be truncated to the nearest microsecond.
ScheduleTime string `json:"scheduleTime,omitempty"`
@@ -4516,17 +4360,17 @@
// Acknowledge: Acknowledges a pull task.
//
-// The pull worker, that is, the entity that received this task in
-// a PullTasksResponse, must call this method to indicate that
+// The worker, that is, the entity that received this task in
+// a LeaseTasksResponse, must call this method to indicate that
// the work associated with the task has finished.
//
-// The pull worker must acknowledge a task within
+// The worker must acknowledge a task within
// the
-// PullTasksRequest.lease_duration or the lease will expire and
+// LeaseTasksRequest.lease_duration or the lease will expire and
// the task will become ready to be returned in a
// different
-// PullTasksResponse. After the task is acknowledged, it will
-// not be returned by a later CloudTasks.PullTasks,
+// LeaseTasksResponse. After the task is acknowledged, it will
+// not be returned by a later CloudTasks.LeaseTasks,
// CloudTasks.GetTask, or CloudTasks.ListTasks.
//
// To acknowledge multiple tasks at the same time, use
@@ -4628,7 +4472,7 @@
}
return ret, nil
// {
- // "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.",
+ // "description": "Acknowledges a pull task.\n\nThe worker, that is, the entity that received this task in\na LeaseTasksResponse, must call this method to indicate that\nthe work associated with the task has finished.\n\nThe worker must acknowledge a task within the\nLeaseTasksRequest.lease_duration or the lease will expire and\nthe task will become ready to be returned in a different\nLeaseTasksResponse. After the task is acknowledged, it will\nnot be returned by a later CloudTasks.LeaseTasks,\nCloudTasks.GetTask, or CloudTasks.ListTasks.\n\nTo acknowledge multiple tasks at the same time, use\n[HTTP batching](/storage/docs/json_api/v1/how-tos/batch)\nor the batching documentation for your client library, for example\nhttps://developers.google.com/api-client-library/python/guide/batch.",
// "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}/tasks/{tasksId}:acknowledge",
// "httpMethod": "POST",
// "id": "cloudtasks.projects.locations.queues.tasks.acknowledge",
@@ -4671,10 +4515,10 @@
// CancelLease: Cancel a pull task's lease.
//
-// The pull worker can use this method to cancel a task's lease
+// The worker can use this method to cancel a task's lease
// by setting Task.schedule_time to now. This will make the
// task
-// available to be leased to the next caller of CloudTasks.PullTasks.
+// available to be leased to the next caller of CloudTasks.LeaseTasks.
func (r *ProjectsLocationsQueuesTasksService) CancelLease(name string, cancelleaserequest *CancelLeaseRequest) *ProjectsLocationsQueuesTasksCancelLeaseCall {
c := &ProjectsLocationsQueuesTasksCancelLeaseCall{s: r.s, urlParams_: make(gensupport.URLParams)}
c.name = name
@@ -4768,7 +4612,7 @@
}
return ret, nil
// {
- // "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.",
+ // "description": "Cancel a pull task's lease.\n\nThe worker can use this method to cancel a task's lease\nby setting Task.schedule_time to now. This will make the task\navailable to be leased to the next caller of CloudTasks.LeaseTasks.",
// "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}/tasks/{tasksId}:cancelLease",
// "httpMethod": "POST",
// "id": "cloudtasks.projects.locations.queues.tasks.cancelLease",
@@ -5270,14 +5114,14 @@
// Leases tasks from a pull queue for
// LeaseTasksRequest.lease_duration.
//
-// This method is invoked by the pull worker to obtain a
-// lease. The pull worker must acknowledge the task
+// This method is invoked by the worker to obtain a
+// lease. The worker must acknowledge the task
// via
// CloudTasks.AcknowledgeTask after they have performed the
// work
// associated with the task.
//
-// The payload is intended to store data that the pull worker needs
+// The payload is intended to store data that the worker needs
// to perform the work associated with the task. To return the
// payloads in the LeaseTasksResponse,
// set
@@ -5383,7 +5227,7 @@
}
return ret, nil
// {
- // "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.",
+ // "description": "\nLeases tasks from a pull queue for LeaseTasksRequest.lease_duration.\n\nThis method is invoked by the worker to obtain a\nlease. The 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 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.",
// "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}/tasks:lease",
// "httpMethod": "POST",
// "id": "cloudtasks.projects.locations.queues.tasks.lease",
@@ -5673,164 +5517,6 @@
}
}
-// method id "cloudtasks.projects.locations.queues.tasks.pull":
-
-type ProjectsLocationsQueuesTasksPullCall struct {
- s *Service
- name string
- pulltasksrequest *PullTasksRequest
- urlParams_ gensupport.URLParams
- ctx_ context.Context
- header_ http.Header
-}
-
-// Pull:
-// Pulls tasks from a pull queue and acquires a lease on them for
-// a
-// specified PullTasksRequest.lease_duration.
-//
-// This method is invoked by the pull worker to obtain the
-// lease. The pull worker must acknowledge the task
-// via
-// CloudTasks.AcknowledgeTask after they have performed the
-// work
-// associated with the task.
-//
-// The payload is intended to store data that the pull worker needs
-// to perform the work associated with the task. To return the
-// payloads in the PullTasksResponse, set
-// PullTasksRequest.response_view to Task.View.FULL.
-//
-// A maximum of 10 qps of CloudTasks.PullTasks requests are allowed
-// per
-// queue. google.rpc.Code.RESOURCE_EXHAUSTED is returned when this
-// limit
-// is exceeded. google.rpc.Code.RESOURCE_EXHAUSTED is also returned
-// when
-// RateLimits.max_tasks_dispatched_per_second is exceeded.
-func (r *ProjectsLocationsQueuesTasksService) Pull(name string, pulltasksrequest *PullTasksRequest) *ProjectsLocationsQueuesTasksPullCall {
- c := &ProjectsLocationsQueuesTasksPullCall{s: r.s, urlParams_: make(gensupport.URLParams)}
- c.name = name
- c.pulltasksrequest = pulltasksrequest
- return c
-}
-
-// Fields allows partial responses to be retrieved. See
-// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
-// for more information.
-func (c *ProjectsLocationsQueuesTasksPullCall) Fields(s ...googleapi.Field) *ProjectsLocationsQueuesTasksPullCall {
- c.urlParams_.Set("fields", googleapi.CombineFields(s))
- return c
-}
-
-// Context sets the context to be used in this call's Do method. Any
-// pending HTTP request will be aborted if the provided context is
-// canceled.
-func (c *ProjectsLocationsQueuesTasksPullCall) Context(ctx context.Context) *ProjectsLocationsQueuesTasksPullCall {
- c.ctx_ = ctx
- return c
-}
-
-// Header returns an http.Header that can be modified by the caller to
-// add HTTP headers to the request.
-func (c *ProjectsLocationsQueuesTasksPullCall) Header() http.Header {
- if c.header_ == nil {
- c.header_ = make(http.Header)
- }
- return c.header_
-}
-
-func (c *ProjectsLocationsQueuesTasksPullCall) doRequest(alt string) (*http.Response, error) {
- reqHeaders := make(http.Header)
- for k, v := range c.header_ {
- reqHeaders[k] = v
- }
- reqHeaders.Set("User-Agent", c.s.userAgent())
- var body io.Reader = nil
- body, err := googleapi.WithoutDataWrapper.JSONReader(c.pulltasksrequest)
- if err != nil {
- return nil, err
- }
- reqHeaders.Set("Content-Type", "application/json")
- c.urlParams_.Set("alt", alt)
- urls := googleapi.ResolveRelative(c.s.BasePath, "v2beta2/{+name}/tasks:pull")
- urls += "?" + c.urlParams_.Encode()
- req, _ := http.NewRequest("POST", urls, body)
- req.Header = reqHeaders
- googleapi.Expand(req.URL, map[string]string{
- "name": c.name,
- })
- return gensupport.SendRequest(c.ctx_, c.s.client, req)
-}
-
-// Do executes the "cloudtasks.projects.locations.queues.tasks.pull" call.
-// Exactly one of *PullTasksResponse or error will be non-nil. Any
-// non-2xx status code is an error. Response headers are in either
-// *PullTasksResponse.ServerResponse.Header or (if a response was
-// returned at all) in error.(*googleapi.Error).Header. Use
-// googleapi.IsNotModified to check whether the returned error was
-// because http.StatusNotModified was returned.
-func (c *ProjectsLocationsQueuesTasksPullCall) Do(opts ...googleapi.CallOption) (*PullTasksResponse, error) {
- gensupport.SetOptions(c.urlParams_, opts...)
- res, err := c.doRequest("json")
- if res != nil && res.StatusCode == http.StatusNotModified {
- if res.Body != nil {
- res.Body.Close()
- }
- return nil, &googleapi.Error{
- Code: res.StatusCode,
- Header: res.Header,
- }
- }
- if err != nil {
- return nil, err
- }
- defer googleapi.CloseBody(res)
- if err := googleapi.CheckResponse(res); err != nil {
- return nil, err
- }
- ret := &PullTasksResponse{
- ServerResponse: googleapi.ServerResponse{
- Header: res.Header,
- HTTPStatusCode: res.StatusCode,
- },
- }
- target := &ret
- if err := gensupport.DecodeResponse(target, res); err != nil {
- return nil, err
- }
- return ret, nil
- // {
- // "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.",
- // "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}/tasks:pull",
- // "httpMethod": "POST",
- // "id": "cloudtasks.projects.locations.queues.tasks.pull",
- // "parameterOrder": [
- // "name"
- // ],
- // "parameters": {
- // "name": {
- // "description": "Required.\n\nThe queue name. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`",
- // "location": "path",
- // "pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+$",
- // "required": true,
- // "type": "string"
- // }
- // },
- // "path": "v2beta2/{+name}/tasks:pull",
- // "request": {
- // "$ref": "PullTasksRequest"
- // },
- // "response": {
- // "$ref": "PullTasksResponse"
- // },
- // "scopes": [
- // "https://www.googleapis.com/auth/cloud-platform"
- // ]
- // }
-
-}
-
// method id "cloudtasks.projects.locations.queues.tasks.renewLease":
type ProjectsLocationsQueuesTasksRenewLeaseCall struct {
@@ -5844,8 +5530,7 @@
// RenewLease: Renew the current lease of a pull task.
//
-// The pull worker can use this method to extend the lease by a
-// new
+// The worker can use this method to extend the lease by a new
// duration, starting from now. The new task lease will be
// returned in Task.schedule_time.
func (r *ProjectsLocationsQueuesTasksService) RenewLease(name string, renewleaserequest *RenewLeaseRequest) *ProjectsLocationsQueuesTasksRenewLeaseCall {
@@ -5941,7 +5626,7 @@
}
return ret, nil
// {
- // "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.",
+ // "description": "Renew the current lease of a pull task.\n\nThe 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.",
// "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}/tasks/{tasksId}:renewLease",
// "httpMethod": "POST",
// "id": "cloudtasks.projects.locations.queues.tasks.renewLease",
diff --git a/cloudtrace/v1/cloudtrace-api.json b/cloudtrace/v1/cloudtrace-api.json
index 55541a6..8fc92f8 100644
--- a/cloudtrace/v1/cloudtrace-api.json
+++ b/cloudtrace/v1/cloudtrace-api.json
@@ -1,49 +1,256 @@
{
- "version_module": true,
- "schemas": {
- "Traces": {
- "description": "List of new or updated traces.",
- "type": "object",
- "properties": {
- "traces": {
- "description": "List of traces.",
- "type": "array",
- "items": {
- "$ref": "Trace"
- }
+ "ownerName": "Google",
+ "resources": {
+ "projects": {
+ "methods": {
+ "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.",
+ "httpMethod": "PATCH",
+ "parameterOrder": [
+ "projectId"
+ ],
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameters": {
+ "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.append"
+ ],
+ "flatPath": "v1/projects/{projectId}/traces",
+ "id": "cloudtrace.projects.patchTraces",
+ "path": "v1/projects/{projectId}/traces"
}
},
- "id": "Traces"
+ "resources": {
+ "traces": {
+ "methods": {
+ "list": {
+ "description": "Returns of a list of traces that match the specified filter conditions.",
+ "response": {
+ "$ref": "ListTracesResponse"
+ },
+ "parameterOrder": [
+ "projectId"
+ ],
+ "httpMethod": "GET",
+ "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": {
+ "description": "An optional filter against labels for the request.\n\nBy default, searches use prefix matching. To specify exact match, prepend\na plus symbol (`+`) to the search term.\nMultiple terms are ANDed. Syntax:\n\n* `root:NAME_PREFIX` or `NAME_PREFIX`: Return traces where any root\n span starts with `NAME_PREFIX`.\n* `+root:NAME` or `+NAME`: Return traces where any root span's name is\n exactly `NAME`.\n* `span:NAME_PREFIX`: Return traces where any span starts with\n `NAME_PREFIX`.\n* `+span:NAME`: Return traces where any span's name is exactly\n `NAME`.\n* `latency:DURATION`: Return traces whose overall latency is\n greater or equal to than `DURATION`. Accepted units are nanoseconds\n (`ns`), milliseconds (`ms`), and seconds (`s`). Default is `ms`. For\n example, `latency:24ms` returns traces whose overall latency\n is greater than or equal to 24 milliseconds.\n* `label:LABEL_KEY`: Return all traces containing the specified\n label key (exact match, case-sensitive) regardless of the key:value\n pair's value (including empty values).\n* `LABEL_KEY:VALUE_PREFIX`: Return all traces containing the specified\n label key (exact match, case-sensitive) whose value starts with\n `VALUE_PREFIX`. Both a key and a value must be specified.\n* `+LABEL_KEY:VALUE`: Return all traces containing a key:value pair\n exactly matching the specified text. Both a key and a value must be\n specified.\n* `method:VALUE`: Equivalent to `/http/method:VALUE`.\n* `url:VALUE`: Equivalent to `/http/url:VALUE`.",
+ "type": "string",
+ "location": "query"
+ },
+ "endTime": {
+ "location": "query",
+ "description": "End of the time interval (inclusive) during which the trace data was\ncollected from the application.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "pageToken": {
+ "description": "Token identifying the page of results to return. If provided, use the\nvalue of the `next_page_token` field from a previous request. Optional.",
+ "type": "string",
+ "location": "query"
+ },
+ "startTime": {
+ "description": "Start of the time interval (inclusive) during which the trace data was\ncollected from the application.",
+ "format": "google-datetime",
+ "type": "string",
+ "location": "query"
+ },
+ "pageSize": {
+ "location": "query",
+ "description": "Maximum number of traces to return. If not specified or \u003c= 0, the\nimplementation selects a reasonable value. The implementation may\nreturn fewer traces than the requested page size. Optional.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "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"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/trace.readonly"
+ ],
+ "flatPath": "v1/projects/{projectId}/traces",
+ "path": "v1/projects/{projectId}/traces",
+ "id": "cloudtrace.projects.traces.list"
+ },
+ "get": {
+ "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": {
+ "projectId": {
+ "description": "ID of the Cloud project where the trace data is stored.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "traceId": {
+ "description": "ID of the trace to return.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/trace.readonly"
+ ],
+ "flatPath": "v1/projects/{projectId}/traces/{traceId}"
+ }
+ }
+ }
+ }
+ }
+ },
+ "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"
+ },
+ "callback": {
+ "description": "JSONP",
+ "type": "string",
+ "location": "query"
+ },
+ "$.xgafv": {
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query",
+ "enum": [
+ "1",
+ "2"
+ ],
+ "description": "V1 error format.",
+ "type": "string"
+ },
+ "alt": {
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query",
+ "description": "Data format for response.",
+ "default": "json",
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
+ "type": "string"
+ },
+ "key": {
+ "location": "query",
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "type": "string"
+ },
+ "access_token": {
+ "location": "query",
+ "description": "OAuth access token.",
+ "type": "string"
+ },
+ "quotaUser": {
+ "location": "query",
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "type": "string"
+ },
+ "pp": {
+ "location": "query",
+ "description": "Pretty-print response.",
+ "type": "boolean",
+ "default": "true"
+ },
+ "bearer_token": {
+ "description": "OAuth bearer token.",
+ "type": "string",
+ "location": "query"
+ },
+ "oauth_token": {
+ "location": "query",
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string"
+ }
+ },
+ "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",
+ "discoveryVersion": "v1",
+ "version_module": true,
+ "schemas": {
"TraceSpan": {
"description": "A span represents a single timed event within a trace. Spans can be nested\nand form a trace tree. Often, a trace contains a root span that describes the\nend-to-end latency of an operation and, optionally, one or more subspans for\nits suboperations. Spans do not need to be contiguous. There may be gaps\nbetween spans in a trace.",
"type": "object",
"properties": {
- "startTime": {
- "description": "Start time of the span in nanoseconds from the UNIX epoch.",
- "format": "google-datetime",
- "type": "string"
- },
- "kind": {
- "enumDescriptions": [
- "Unspecified.",
- "Indicates that the span covers server-side handling of an RPC or other\nremote network request.",
- "Indicates that the span covers the client-side wrapper around an RPC or\nother remote request."
- ],
- "enum": [
- "SPAN_KIND_UNSPECIFIED",
- "RPC_SERVER",
- "RPC_CLIENT"
- ],
- "description": "Distinguishes between spans generated in a particular context. For example,\ntwo spans with the same name may be distinguished using `RPC_CLIENT`\nand `RPC_SERVER` to identify queueing latency associated with the span.",
- "type": "string"
- },
"labels": {
+ "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"
- },
- "description": "Collection of labels associated with the span. Label keys must be less than\n128 bytes. Label values must be less than 16 kilobytes (10MB for\n`/stacktrace` values).\n\nSome predefined label keys exist, or you may create your own. When creating\nyour own, we recommend the following formats:\n\n* `/category/product/key` for agents of well-known products (e.g.\n `/db/mongodb/read_size`).\n* `short_host/path/key` for domain-specific keys (e.g.\n `foo.com/myproduct/bar`)\n\nPredefined labels include:\n\n* `/agent`\n* `/component`\n* `/error/message`\n* `/error/name`\n* `/http/client_city`\n* `/http/client_country`\n* `/http/client_protocol`\n* `/http/client_region`\n* `/http/host`\n* `/http/method`\n* `/http/redirected_url`\n* `/http/request/size`\n* `/http/response/size`\n* `/http/status_code`\n* `/http/url`\n* `/http/user_agent`\n* `/pid`\n* `/stacktrace`\n* `/tid`",
- "type": "object"
+ }
},
"name": {
"description": "Name of the span. Must be less than 128 bytes. The span name is sanitized\nand displayed in the Stackdriver Trace tool in the\n{% dynamic print site_values.console_name %}.\nThe name may be a method name or some other per-call site name.\nFor the same executable and the same call point, a best practice is\nto use a consistent name, which makes it easier to correlate\ncross-trace spans.",
@@ -63,6 +270,25 @@
"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"
+ ]
}
},
"id": "TraceSpan"
@@ -86,10 +312,10 @@
"id": "ListTracesResponse"
},
"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": {}
},
"Trace": {
"id": "Trace",
@@ -112,25 +338,39 @@
"type": "string"
}
}
+ },
+ "Traces": {
+ "id": "Traces",
+ "description": "List of new or updated traces.",
+ "type": "object",
+ "properties": {
+ "traces": {
+ "description": "List of traces.",
+ "type": "array",
+ "items": {
+ "$ref": "Trace"
+ }
+ }
+ }
}
},
+ "protocol": "rest",
"icons": {
"x16": "http://www.google.com/images/icons/product/search-16.gif",
"x32": "http://www.google.com/images/icons/product/search-32.gif"
},
- "protocol": "rest",
"canonicalName": "Cloud Trace",
"auth": {
"oauth2": {
"scopes": {
+ "https://www.googleapis.com/auth/trace.readonly": {
+ "description": "Read Trace data for a project or application"
+ },
"https://www.googleapis.com/auth/trace.append": {
"description": "Write Trace data for a project or application"
},
"https://www.googleapis.com/auth/cloud-platform": {
"description": "View and manage your data across Google Cloud Platform services"
- },
- "https://www.googleapis.com/auth/trace.readonly": {
- "description": "Read Trace data for a project or application"
}
}
}
@@ -140,245 +380,5 @@
"name": "cloudtrace",
"batchPath": "batch",
"fullyEncodeReservedExpansion": true,
- "title": "Stackdriver Trace API",
- "ownerName": "Google",
- "resources": {
- "projects": {
- "methods": {
- "patchTraces": {
- "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": {
- "description": "ID of the Cloud project where the trace data is stored.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "flatPath": "v1/projects/{projectId}/traces"
- }
- },
- "resources": {
- "traces": {
- "methods": {
- "list": {
- "path": "v1/projects/{projectId}/traces",
- "id": "cloudtrace.projects.traces.list",
- "description": "Returns of a list of traces that match the specified filter conditions.",
- "response": {
- "$ref": "ListTracesResponse"
- },
- "parameterOrder": [
- "projectId"
- ],
- "httpMethod": "GET",
- "parameters": {
- "orderBy": {
- "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.",
- "type": "string"
- },
- "projectId": {
- "location": "path",
- "description": "ID of the Cloud project where the trace data is stored.",
- "required": true,
- "type": "string"
- },
- "filter": {
- "description": "An optional filter against labels for the request.\n\nBy default, searches use prefix matching. To specify exact match, prepend\na plus symbol (`+`) to the search term.\nMultiple terms are ANDed. Syntax:\n\n* `root:NAME_PREFIX` or `NAME_PREFIX`: Return traces where any root\n span starts with `NAME_PREFIX`.\n* `+root:NAME` or `+NAME`: Return traces where any root span's name is\n exactly `NAME`.\n* `span:NAME_PREFIX`: Return traces where any span starts with\n `NAME_PREFIX`.\n* `+span:NAME`: Return traces where any span's name is exactly\n `NAME`.\n* `latency:DURATION`: Return traces whose overall latency is\n greater or equal to than `DURATION`. Accepted units are nanoseconds\n (`ns`), milliseconds (`ms`), and seconds (`s`). Default is `ms`. For\n example, `latency:24ms` returns traces whose overall latency\n is greater than or equal to 24 milliseconds.\n* `label:LABEL_KEY`: Return all traces containing the specified\n label key (exact match, case-sensitive) regardless of the key:value\n pair's value (including empty values).\n* `LABEL_KEY:VALUE_PREFIX`: Return all traces containing the specified\n label key (exact match, case-sensitive) whose value starts with\n `VALUE_PREFIX`. Both a key and a value must be specified.\n* `+LABEL_KEY:VALUE`: Return all traces containing a key:value pair\n exactly matching the specified text. Both a key and a value must be\n specified.\n* `method:VALUE`: Equivalent to `/http/method:VALUE`.\n* `url:VALUE`: Equivalent to `/http/url:VALUE`.",
- "type": "string",
- "location": "query"
- },
- "endTime": {
- "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": {
- "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"
- },
- "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"
- },
- "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": {
- "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"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/trace.readonly"
- ],
- "flatPath": "v1/projects/{projectId}/traces"
- },
- "get": {
- "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": {
- "location": "path",
- "description": "ID of the Cloud project where the trace data is stored.",
- "required": true,
- "type": "string"
- },
- "traceId": {
- "location": "path",
- "description": "ID of the trace to return.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1/projects/{projectId}/traces/{traceId}"
- }
- }
- }
- }
- }
- },
- "parameters": {
- "key": {
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string",
- "location": "query"
- },
- "access_token": {
- "description": "OAuth access token.",
- "type": "string",
- "location": "query"
- },
- "quotaUser": {
- "location": "query",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string"
- },
- "pp": {
- "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": {
- "location": "query",
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string"
- },
- "fields": {
- "location": "query",
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string"
- },
- "callback": {
- "description": "JSONP",
- "type": "string",
- "location": "query"
- },
- "$.xgafv": {
- "description": "V1 error format.",
- "type": "string",
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query",
- "enum": [
- "1",
- "2"
- ]
- },
- "alt": {
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query",
- "description": "Data format for response.",
- "default": "json",
- "enum": [
- "json",
- "media",
- "proto"
- ],
- "type": "string"
- }
- },
- "version": "v1",
- "baseUrl": "https://cloudtrace.googleapis.com/",
- "kind": "discovery#restDescription",
- "description": "Sends application trace data to Stackdriver Trace for viewing. Trace data is collected for all App Engine applications by default. Trace data from other applications can be provided using this API.\n",
- "servicePath": "",
- "basePath": "",
- "id": "cloudtrace:v1",
- "documentationLink": "https://cloud.google.com/trace",
- "revision": "20171214",
- "discoveryVersion": "v1"
+ "title": "Stackdriver Trace API"
}
diff --git a/cloudtrace/v2/cloudtrace-api.json b/cloudtrace/v2/cloudtrace-api.json
index b1350cf..4b2ceec 100644
--- a/cloudtrace/v2/cloudtrace-api.json
+++ b/cloudtrace/v2/cloudtrace-api.json
@@ -1,32 +1,310 @@
{
- "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",
+ "fullyEncodeReservedExpansion": true,
+ "title": "Stackdriver Trace API",
+ "ownerName": "Google",
+ "resources": {
+ "projects": {
+ "resources": {
+ "traces": {
+ "methods": {
+ "batchWrite": {
+ "description": "Sends new spans to new or existing traces. You cannot update\nexisting spans.",
+ "request": {
+ "$ref": "BatchWriteSpansRequest"
+ },
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/trace.append"
+ ],
+ "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"
+ }
+ },
+ "flatPath": "v2/projects/{projectsId}/traces:batchWrite",
+ "path": "v2/{+name}/traces:batchWrite",
+ "id": "cloudtrace.projects.traces.batchWrite"
+ }
+ },
+ "resources": {
+ "spans": {
+ "methods": {
+ "createSpan": {
+ "response": {
+ "$ref": "Span"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/trace.append"
+ ],
+ "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"
+ }
+ },
+ "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"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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": {
+ "location": "query",
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string"
+ },
+ "$.xgafv": {
+ "enum": [
+ "1",
+ "2"
+ ],
+ "description": "V1 error format.",
+ "type": "string",
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query"
+ },
+ "callback": {
+ "description": "JSONP",
+ "type": "string",
+ "location": "query"
+ },
+ "alt": {
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query",
+ "description": "Data format for response.",
+ "default": "json",
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
+ "type": "string"
+ },
+ "access_token": {
+ "description": "OAuth access token.",
+ "type": "string",
+ "location": "query"
+ },
+ "key": {
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "type": "string",
+ "location": "query"
+ },
+ "quotaUser": {
+ "location": "query",
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "type": "string"
+ },
+ "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": "v2",
+ "baseUrl": "https://cloudtrace.googleapis.com/",
"kind": "discovery#restDescription",
+ "description": "Sends application trace data to Stackdriver Trace for viewing. Trace data is collected for all App Engine applications by default. Trace data from other applications can be provided using this API.\n",
+ "servicePath": "",
"basePath": "",
- "revision": "20171214",
- "documentationLink": "https://cloud.google.com/trace",
"id": "cloudtrace:v2",
+ "documentationLink": "https://cloud.google.com/trace",
+ "revision": "20171214",
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
- "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.",
+ "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": {
+ "properties": {
+ "truncatedByteCount": {
+ "description": "The number of bytes removed from the original string. If this\nvalue is 0, then the string was not shortened.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "value": {
+ "description": "The shortened string. For example, if the original string is 500\nbytes long and the limit of the string is 128 bytes, then\n`value` contains the first 128 bytes of the 500-byte string.\n\nTruncation always happens on a UTF8 character boundary. If there\nare multi-byte characters in the string, then the length of the\nshortened string might be less than the size limit.",
+ "type": "string"
+ }
+ },
+ "id": "TruncatableString",
+ "description": "Represents a string that might be shortened to a specified length.",
+ "type": "object"
+ },
+ "TimeEvent": {
+ "properties": {
+ "messageEvent": {
+ "$ref": "MessageEvent",
+ "description": "An event describing a message sent/received between Spans."
+ },
+ "time": {
+ "description": "The timestamp indicating the time the event occurred.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "annotation": {
+ "description": "Text annotation with a set of attributes.",
+ "$ref": "Annotation"
+ }
+ },
+ "id": "TimeEvent",
+ "description": "A time-stamped annotation or message event in the Span.",
+ "type": "object"
+ },
+ "MessageEvent": {
+ "description": "An event describing a message sent/received between Spans.",
"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."
+ "Unknown event type.",
+ "Indicates a sent message.",
+ "Indicates a received message."
],
"enum": [
"TYPE_UNSPECIFIED",
- "CHILD_LINKED_SPAN",
- "PARENT_LINKED_SPAN"
+ "SENT",
+ "RECEIVED"
],
- "description": "The relationship of the current span relative to the linked span.",
+ "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",
+ "type": "string"
+ },
+ "compressedSizeBytes": {
+ "description": "The number of compressed bytes sent or received. If missing assumed to\nbe the same size as uncompressed.",
+ "format": "int64",
+ "type": "string"
+ },
+ "uncompressedSizeBytes": {
+ "description": "The number of uncompressed bytes sent or received.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "id": "MessageEvent"
+ },
+ "StackFrame": {
+ "description": "Represents a single stack frame in a stack trace.",
+ "type": "object",
+ "properties": {
+ "functionName": {
+ "description": "The fully-qualified name that uniquely identifies the function or\nmethod that is active in this frame (up to 1024 bytes).",
+ "$ref": "TruncatableString"
+ },
+ "lineNumber": {
+ "description": "The line number in `file_name` where the function call appears.",
+ "format": "int64",
+ "type": "string"
+ },
+ "loadModule": {
+ "description": "The binary module from where the code was loaded.",
+ "$ref": "Module"
+ },
+ "columnNumber": {
+ "description": "The column number where the function call appears, if available.\nThis is important in JavaScript because of its anonymous functions.",
+ "format": "int64",
+ "type": "string"
+ },
+ "fileName": {
+ "$ref": "TruncatableString",
+ "description": "The name of the source file where the function call appears (up to 256\nbytes)."
+ },
+ "sourceVersion": {
+ "description": "The version of the deployed source code (up to 128 bytes).",
+ "$ref": "TruncatableString"
+ },
+ "originalFunctionName": {
+ "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).",
+ "$ref": "TruncatableString"
+ }
+ },
+ "id": "StackFrame"
+ },
+ "Link": {
+ "description": "A pointer from the current span to another span in the same trace or in a\ndifferent trace. For example, this can be used in batching operations,\nwhere a single batch handler processes multiple requests from different\ntraces or when the handler receives a request from a different project.",
+ "type": "object",
+ "properties": {
"traceId": {
"description": "The [TRACE_ID] for a trace within a project.",
"type": "string"
@@ -38,6 +316,20 @@
"spanId": {
"description": "The [SPAN_ID] for a span within a trace.",
"type": "string"
+ },
+ "type": {
+ "description": "The relationship of the current span relative to the linked span.",
+ "type": "string",
+ "enumDescriptions": [
+ "The relationship of the two spans is unknown.",
+ "The linked span is a child of the current span.",
+ "The linked span is a parent of the current span."
+ ],
+ "enum": [
+ "TYPE_UNSPECIFIED",
+ "CHILD_LINKED_SPAN",
+ "PARENT_LINKED_SPAN"
+ ]
}
},
"id": "Link"
@@ -51,8 +343,8 @@
"$ref": "TruncatableString"
},
"attributes": {
- "$ref": "Attributes",
- "description": "A set of attributes on the annotation. You can have up to 4 attributes\nper Annotation."
+ "description": "A set of attributes on the annotation. You can have up to 4 attributes\nper Annotation.",
+ "$ref": "Attributes"
}
},
"id": "Annotation"
@@ -61,30 +353,23 @@
"description": "A collection of stack frames, which can be truncated.",
"type": "object",
"properties": {
+ "droppedFramesCount": {
+ "description": "The number of stack frames that were dropped because there\nwere too many stack frames.\nIf this value is 0, then no stack frames were dropped.",
+ "format": "int32",
+ "type": "integer"
+ },
"frame": {
"description": "Stack frames in this call stack.",
"type": "array",
"items": {
"$ref": "StackFrame"
}
- },
- "droppedFramesCount": {
- "description": "The number of stack frames that were dropped because there\nwere too many stack frames.\nIf this value is 0, then no stack frames were dropped.",
- "format": "int32",
- "type": "integer"
}
},
"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": {
- "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",
@@ -96,9 +381,16 @@
"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"
+ "id": "TimeEvents",
+ "description": "A collection of `TimeEvent`s. A `TimeEvent` is a time-stamped annotation\non the span, consisting of either user-supplied key:value pairs, or\ndetails of a message sent/received between Spans.",
+ "type": "object"
},
"Module": {
"properties": {
@@ -107,8 +399,8 @@
"$ref": "TruncatableString"
},
"buildId": {
- "description": "A unique identifier for the module, usually a hash of its\ncontents (up to 128 bytes).",
- "$ref": "TruncatableString"
+ "$ref": "TruncatableString",
+ "description": "A unique identifier for the module, usually a hash of its\ncontents (up to 128 bytes)."
}
},
"id": "Module",
@@ -119,11 +411,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": {
- "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"
@@ -132,17 +419,24 @@
"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"
},
"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.",
@@ -152,17 +446,44 @@
}
}
},
- "id": "BatchWriteSpansRequest",
- "description": "The request message for the `BatchWriteSpans` method.",
- "type": "object"
+ "id": "BatchWriteSpansRequest"
},
"Span": {
"description": "A span represents a single operation within a trace. Spans can be\nnested to form a trace tree. Often, a trace contains a root span\nthat describes the end-to-end latency, and one or more subspans for\nits sub-operations. A trace can also contain multiple root spans,\nor none at all. Spans do not need to be contiguous—there may be\ngaps or overlaps between spans in a trace.",
"type": "object",
"properties": {
+ "links": {
+ "description": "Links associated with the span. You can have up to 128 links per Span.",
+ "$ref": "Links"
+ },
+ "attributes": {
+ "$ref": "Attributes",
+ "description": "A set of attributes on the span. You can have up to 32 attributes per\nspan."
+ },
+ "spanId": {
+ "description": "The [SPAN_ID] portion of the span's resource name.",
+ "type": "string"
+ },
+ "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",
+ "type": "integer"
+ },
+ "sameProcessAsParentSpan": {
+ "description": "(Optional) Set this parameter to indicate whether this span is in\nthe same process as its parent. If you do not set this parameter,\nStackdriver Trace is unable to take advantage of this helpful\ninformation.",
+ "type": "boolean"
+ },
+ "status": {
+ "$ref": "Status",
+ "description": "An optional final status for this span."
+ },
+ "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.",
+ "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.",
@@ -185,35 +506,6 @@
"timeEvents": {
"description": "A set of time events. You can have up to 32 annotations and 128 message\nevents per span.",
"$ref": "TimeEvents"
- },
- "links": {
- "description": "Links associated with the span. You can have up to 128 links per Span.",
- "$ref": "Links"
- },
- "attributes": {
- "description": "A set of attributes on the span. You can have up to 32 attributes per\nspan.",
- "$ref": "Attributes"
- },
- "spanId": {
- "description": "The [SPAN_ID] portion of the span's resource name.",
- "type": "string"
- },
- "childSpanCount": {
- "description": "An optional number of child spans that were generated while this span\nwas active. If set, allows implementation to detect missing child spans.",
- "format": "int32",
- "type": "integer"
- },
- "sameProcessAsParentSpan": {
- "description": "(Optional) Set this parameter to indicate whether this span is in\nthe same process as its parent. If you do not set this parameter,\nStackdriver Trace is unable to take advantage of this helpful\ninformation.",
- "type": "boolean"
- },
- "status": {
- "$ref": "Status",
- "description": "An optional final status for this span."
- },
- "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.",
- "type": "string"
}
},
"id": "Span"
@@ -234,8 +526,8 @@
"type": "string"
},
"stringValue": {
- "description": "A string up to 256 bytes long.",
- "$ref": "TruncatableString"
+ "$ref": "TruncatableString",
+ "description": "A string up to 256 bytes long."
},
"boolValue": {
"description": "A Boolean value represented by `true` or `false`.",
@@ -245,8 +537,6 @@
"id": "AttributeValue"
},
"Attributes": {
- "description": "A set of attributes, each in the format `[KEY]:[VALUE]`.",
- "type": "object",
"properties": {
"droppedAttributesCount": {
"description": "The number of attributes that were discarded. Attributes can be discarded\nbecause their keys are too long or because there are too many attributes.\nIf this value is 0 then all attributes are valid.",
@@ -261,157 +551,34 @@
"type": "object"
}
},
- "id": "Attributes"
+ "id": "Attributes",
+ "description": "A set of attributes, each in the format `[KEY]:[VALUE]`.",
+ "type": "object"
},
"Links": {
"description": "A collection of links, which are references from this span to a span\nin the same or different trace.",
"type": "object",
"properties": {
+ "droppedLinksCount": {
+ "description": "The number of dropped links after the maximum size was enforced. If\nthis value is 0, then no links were dropped.",
+ "format": "int32",
+ "type": "integer"
+ },
"link": {
"description": "A collection of links.",
"type": "array",
"items": {
"$ref": "Link"
}
- },
- "droppedLinksCount": {
- "description": "The number of dropped links after the maximum size was enforced. If\nthis value is 0, then no links were dropped.",
- "format": "int32",
- "type": "integer"
}
},
"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",
- "properties": {
- "truncatedByteCount": {
- "description": "The number of bytes removed from the original string. If this\nvalue is 0, then the string was not shortened.",
- "format": "int32",
- "type": "integer"
- },
- "value": {
- "description": "The shortened string. For example, if the original string is 500\nbytes long and the limit of the string is 128 bytes, then\n`value` contains the first 128 bytes of the 500-byte string.\n\nTruncation always happens on a UTF8 character boundary. If there\nare multi-byte characters in the string, then the length of the\nshortened string might be less than the size limit.",
- "type": "string"
- }
- },
- "id": "TruncatableString"
- },
- "TimeEvent": {
- "description": "A time-stamped annotation or message event in the Span.",
- "type": "object",
- "properties": {
- "annotation": {
- "$ref": "Annotation",
- "description": "Text annotation with a set of attributes."
- },
- "messageEvent": {
- "description": "An event describing a message sent/received between Spans.",
- "$ref": "MessageEvent"
- },
- "time": {
- "description": "The timestamp indicating the time the event occurred.",
- "format": "google-datetime",
- "type": "string"
- }
- },
- "id": "TimeEvent"
- },
- "MessageEvent": {
- "description": "An event describing a message sent/received between Spans.",
- "type": "object",
- "properties": {
- "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",
- "type": "string"
- },
- "compressedSizeBytes": {
- "description": "The number of compressed bytes sent or received. If missing assumed to\nbe the same size as uncompressed.",
- "format": "int64",
- "type": "string"
- },
- "uncompressedSizeBytes": {
- "description": "The number of uncompressed bytes sent or received.",
- "format": "int64",
- "type": "string"
- },
- "type": {
- "enum": [
- "TYPE_UNSPECIFIED",
- "SENT",
- "RECEIVED"
- ],
- "description": "Type of MessageEvent. Indicates whether the message was sent or\nreceived.",
- "type": "string",
- "enumDescriptions": [
- "Unknown event type.",
- "Indicates a sent message.",
- "Indicates a received message."
- ]
- }
- },
- "id": "MessageEvent"
- },
- "StackFrame": {
- "description": "Represents a single stack frame in a stack trace.",
- "type": "object",
- "properties": {
- "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)."
- },
- "lineNumber": {
- "description": "The line number in `file_name` where the function call appears.",
- "format": "int64",
- "type": "string"
- },
- "loadModule": {
- "description": "The binary module from where the code was loaded.",
- "$ref": "Module"
- },
- "columnNumber": {
- "description": "The column number where the function call appears, if available.\nThis is important in JavaScript because of its anonymous functions.",
- "format": "int64",
- "type": "string"
- },
- "fileName": {
- "description": "The name of the source file where the function call appears (up to 256\nbytes).",
- "$ref": "TruncatableString"
- },
- "sourceVersion": {
- "$ref": "TruncatableString",
- "description": "The version of the deployed source code (up to 128 bytes)."
- },
- "originalFunctionName": {
- "$ref": "TruncatableString",
- "description": "An un-mangled function name, if `function_name` is\n[mangled](http://www.avabodh.com/cxxin/namemangling.html). The name can\nbe fully-qualified (up to 1024 bytes)."
- }
- },
- "id": "StackFrame"
}
},
"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": {
@@ -429,172 +596,5 @@
"rootUrl": "https://cloudtrace.googleapis.com/",
"ownerDomain": "google.com",
"name": "cloudtrace",
- "batchPath": "batch",
- "fullyEncodeReservedExpansion": true,
- "title": "Stackdriver Trace API",
- "ownerName": "Google",
- "resources": {
- "projects": {
- "resources": {
- "traces": {
- "methods": {
- "batchWrite": {
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "POST",
- "parameters": {
- "name": {
- "description": "Required. The name of the project where the spans belong. The format is\n`projects/[PROJECT_ID]`.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/trace.append"
- ],
- "flatPath": "v2/projects/{projectsId}/traces:batchWrite",
- "path": "v2/{+name}/traces:batchWrite",
- "id": "cloudtrace.projects.traces.batchWrite",
- "request": {
- "$ref": "BatchWriteSpansRequest"
- },
- "description": "Sends new spans to new or existing traces. You cannot update\nexisting spans."
- }
- },
- "resources": {
- "spans": {
- "methods": {
- "createSpan": {
- "response": {
- "$ref": "Span"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/trace.append"
- ],
- "parameters": {
- "name": {
- "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",
- "pattern": "^projects/[^/]+/traces/[^/]+/spans/[^/]+$"
- }
- },
- "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"
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "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": {
- "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": {
- "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": "v2",
- "baseUrl": "https://cloudtrace.googleapis.com/"
+ "batchPath": "batch"
}
diff --git a/container/v1/container-api.json b/container/v1/container-api.json
index 938a37c..50e0a63 100644
--- a/container/v1/container-api.json
+++ b/container/v1/container-api.json
@@ -1,13 +1,657 @@
{
+ "version": "v1",
+ "baseUrl": "https://container.googleapis.com/",
+ "servicePath": "",
+ "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.",
+ "basePath": "",
+ "revision": "20171127",
+ "documentationLink": "https://cloud.google.com/container-engine/",
+ "id": "container:v1",
"discoveryVersion": "v1",
"schemas": {
+ "AutoUpgradeOptions": {
+ "description": "AutoUpgradeOptions defines the set of options for the user to control how\nthe Auto Upgrades will proceed.",
+ "type": "object",
+ "properties": {
+ "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"
+ },
+ "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": {
+ "description": "Whether the HTTP Load Balancing controller is enabled in the cluster.\nWhen enabled, it runs a small pod in the cluster that manages the load\nbalancers.",
+ "type": "boolean"
+ }
+ },
+ "id": "HttpLoadBalancing"
+ },
+ "SetMasterAuthRequest": {
+ "properties": {
+ "update": {
+ "description": "A description of the update.",
+ "$ref": "MasterAuth"
+ },
+ "action": {
+ "enum": [
+ "UNKNOWN",
+ "SET_PASSWORD",
+ "GENERATE_PASSWORD",
+ "SET_USERNAME"
+ ],
+ "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."
+ ]
+ }
+ },
+ "id": "SetMasterAuthRequest",
+ "description": "SetMasterAuthRequest updates the admin password of a cluster.",
+ "type": "object"
+ },
+ "SetNetworkPolicyRequest": {
+ "type": "object",
+ "properties": {
+ "networkPolicy": {
+ "description": "Configuration options for the NetworkPolicy feature.",
+ "$ref": "NetworkPolicy"
+ }
+ },
+ "id": "SetNetworkPolicyRequest",
+ "description": "SetNetworkPolicyRequest enables/disables network policy for a cluster."
+ },
+ "NodePoolAutoscaling": {
+ "description": "NodePoolAutoscaling contains information required by cluster autoscaler to\nadjust the size of the node pool to the current cluster usage.",
+ "type": "object",
+ "properties": {
+ "maxNodeCount": {
+ "description": "Maximum number of nodes in the NodePool. Must be \u003e= min_node_count. There\nhas to enough quota to scale up the cluster.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "minNodeCount": {
+ "description": "Minimum number of nodes in the NodePool. Must be \u003e= 1 and \u003c=\nmax_node_count.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "enabled": {
+ "type": "boolean",
+ "description": "Is autoscaling enabled for this node pool."
+ }
+ },
+ "id": "NodePoolAutoscaling"
+ },
+ "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": {
+ "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": "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"
+ },
+ "desiredImageType": {
+ "description": "The desired image type for the node pool.\nNOTE: Set the \"desired_node_pool\" field as well.",
+ "type": "string"
+ },
+ "desiredAddonsConfig": {
+ "$ref": "AddonsConfig",
+ "description": "Configurations for the various addons available to run in the cluster."
+ },
+ "desiredNodePoolId": {
+ "description": "The node pool to be upgraded. This field is mandatory if\n\"desired_node_version\", \"desired_image_family\" or\n\"desired_node_pool_autoscaling\" is specified and there is more than one\nnode pool on the cluster.",
+ "type": "string"
+ },
+ "desiredNodeVersion": {
+ "description": "The Kubernetes version to change the nodes to (typically an\nupgrade). Use `-` to upgrade to the latest version supported by\nthe server.",
+ "type": "string"
+ }
+ }
+ },
+ "IPAllocationPolicy": {
+ "description": "Configuration for controlling how IPs are allocated in the cluster.",
+ "type": "object",
+ "properties": {
+ "servicesIpv4CidrBlock": {
+ "description": "The IP address range of the services IPs in this cluster. If blank, a range\nwill be automatically chosen with the default size.\n\nThis field is only applicable when `use_ip_aliases` is true.\n\nSet to blank to have a range chosen with the default size.\n\nSet to /netmask (e.g. `/14`) to have a range chosen with a specific\nnetmask.\n\nSet to a\n[CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)\nnotation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g.\n`10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range\nto use.",
+ "type": "string"
+ },
+ "subnetworkName": {
+ "description": "A custom subnetwork name to be used if `create_subnetwork` is true. If\nthis field is empty, then an automatic name will be chosen for the new\nsubnetwork.",
+ "type": "string"
+ },
+ "clusterIpv4Cidr": {
+ "description": "This field is deprecated, use cluster_ipv4_cidr_block.",
+ "type": "string"
+ },
+ "nodeIpv4Cidr": {
+ "description": "This field is deprecated, use node_ipv4_cidr_block.",
+ "type": "string"
+ },
+ "clusterSecondaryRangeName": {
+ "description": "The name of the secondary range to be used for the cluster CIDR\nblock. The secondary range will be used for pod IP\naddresses. This must be an existing secondary range associated\nwith the cluster subnetwork.\n\nThis field is only applicable with use_ip_aliases is true and\ncreate_subnetwork is false.",
+ "type": "string"
+ },
+ "clusterIpv4CidrBlock": {
+ "description": "The IP address range for the cluster pod IPs. If this field is set, then\n`cluster.cluster_ipv4_cidr` must be left blank.\n\nThis field is only applicable when `use_ip_aliases` is true.\n\nSet to blank to have a range chosen with the default size.\n\nSet to /netmask (e.g. `/14`) to have a range chosen with a specific\nnetmask.\n\nSet to a\n[CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)\nnotation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g.\n`10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range\nto use.",
+ "type": "string"
+ },
+ "nodeIpv4CidrBlock": {
+ "description": "The IP address range of the instance IPs in this cluster.\n\nThis is applicable only if `create_subnetwork` is true.\n\nSet to blank to have a range chosen with the default size.\n\nSet to /netmask (e.g. `/14`) to have a range chosen with a specific\nnetmask.\n\nSet to a\n[CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)\nnotation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g.\n`10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range\nto use.",
+ "type": "string"
+ },
+ "servicesIpv4Cidr": {
+ "description": "This field is deprecated, use services_ipv4_cidr_block.",
+ "type": "string"
+ },
+ "servicesSecondaryRangeName": {
+ "description": "The name of the secondary range to be used as for the services\nCIDR block. The secondary range will be used for service\nClusterIPs. This must be an existing secondary range associated\nwith the cluster subnetwork.\n\nThis field is only applicable with use_ip_aliases is true and\ncreate_subnetwork is false.",
+ "type": "string"
+ },
+ "useIpAliases": {
+ "description": "Whether alias IPs will be used for pod IPs in the cluster.",
+ "type": "boolean"
+ },
+ "createSubnetwork": {
+ "description": "Whether a new subnetwork will be created automatically for the cluster.\n\nThis field is only applicable when `use_ip_aliases` is true.",
+ "type": "boolean"
+ }
+ },
+ "id": "IPAllocationPolicy"
+ },
+ "HorizontalPodAutoscaling": {
+ "properties": {
+ "disabled": {
+ "type": "boolean",
+ "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."
+ }
+ },
+ "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"
+ },
+ "SetNodePoolManagementRequest": {
+ "id": "SetNodePoolManagementRequest",
+ "description": "SetNodePoolManagementRequest sets the node management properties of a node\npool.",
+ "type": "object",
+ "properties": {
+ "management": {
+ "$ref": "NodeManagement",
+ "description": "NodeManagement configuration for the node pool."
+ }
+ }
+ },
+ "MasterAuthorizedNetworksConfig": {
+ "description": "Master authorized networks is a Beta feature.\nConfiguration options for the master authorized networks feature. Enabled\nmaster authorized networks will disallow all external traffic to access\nKubernetes master through HTTPS except traffic from the given CIDR blocks,\nGoogle Compute Engine Public IPs and Google Prod IPs.",
+ "type": "object",
+ "properties": {
+ "enabled": {
+ "description": "Whether or not master authorized networks is enabled.",
+ "type": "boolean"
+ },
+ "cidrBlocks": {
+ "type": "array",
+ "items": {
+ "$ref": "CidrBlock"
+ },
+ "description": "cidr_blocks define up to 10 external networks that could access\nKubernetes master through HTTPS."
+ }
+ },
+ "id": "MasterAuthorizedNetworksConfig"
+ },
+ "SetNodePoolAutoscalingRequest": {
+ "description": "SetNodePoolAutoscalingRequest sets the autoscaler settings of a node pool.",
+ "type": "object",
+ "properties": {
+ "autoscaling": {
+ "$ref": "NodePoolAutoscaling",
+ "description": "Autoscaling configuration for the node pool."
+ }
+ },
+ "id": "SetNodePoolAutoscalingRequest"
+ },
+ "CreateClusterRequest": {
+ "description": "CreateClusterRequest creates a cluster.",
+ "type": "object",
+ "properties": {
+ "cluster": {
+ "$ref": "Cluster",
+ "description": "A [cluster\nresource](/container-engine/reference/rest/v1/projects.zones.clusters)"
+ }
+ },
+ "id": "CreateClusterRequest"
+ },
+ "LegacyAbac": {
+ "description": "Configuration for the legacy Attribute Based Access Control authorization\nmode.",
+ "type": "object",
+ "properties": {
+ "enabled": {
+ "type": "boolean",
+ "description": "Whether the ABAC authorizer is enabled for this cluster. When enabled,\nidentities in the system, including service accounts, nodes, and\ncontrollers, will have statically granted permissions beyond those\nprovided by the RBAC configuration or IAM."
+ }
+ },
+ "id": "LegacyAbac"
+ },
+ "AcceleratorConfig": {
+ "description": "AcceleratorConfig represents a Hardware Accelerator request.",
+ "type": "object",
+ "properties": {
+ "acceleratorCount": {
+ "description": "The number of the accelerator cards exposed to an instance.",
+ "format": "int64",
+ "type": "string"
+ },
+ "acceleratorType": {
+ "description": "The accelerator type resource name. List of supported accelerators\n[here](/compute/docs/gpus/#Introduction)",
+ "type": "string"
+ }
+ },
+ "id": "AcceleratorConfig"
+ },
+ "UpdateNodePoolRequest": {
+ "description": "UpdateNodePoolRequests update a node pool's image and/or version.",
+ "type": "object",
+ "properties": {
+ "imageType": {
+ "description": "The desired image type for the node pool.",
+ "type": "string"
+ },
+ "nodeVersion": {
+ "description": "The Kubernetes version to change the nodes to (typically an\nupgrade). Use `-` to upgrade to the latest version supported by\nthe server.",
+ "type": "string"
+ }
+ },
+ "id": "UpdateNodePoolRequest"
+ },
+ "SetAddonsConfigRequest": {
+ "description": "SetAddonsConfigRequest sets the addons associated with the cluster.",
+ "type": "object",
+ "properties": {
+ "addonsConfig": {
+ "description": "The desired configurations for the various addons available to run in the\ncluster.",
+ "$ref": "AddonsConfig"
+ }
+ },
+ "id": "SetAddonsConfigRequest"
+ },
+ "SetLegacyAbacRequest": {
+ "description": "SetLegacyAbacRequest enables or disables the ABAC authorization mechanism for\na cluster.",
+ "type": "object",
+ "properties": {
+ "enabled": {
+ "description": "Whether ABAC authorization will be enabled in the cluster.",
+ "type": "boolean"
+ }
+ },
+ "id": "SetLegacyAbacRequest"
+ },
+ "AddonsConfig": {
+ "properties": {
+ "networkPolicyConfig": {
+ "$ref": "NetworkPolicyConfig",
+ "description": "Configuration for NetworkPolicy. This only tracks whether the addon\nis enabled or not on the Master, it does not track whether network policy\nis enabled for the nodes."
+ },
+ "horizontalPodAutoscaling": {
+ "$ref": "HorizontalPodAutoscaling",
+ "description": "Configuration for the horizontal pod autoscaling feature, which\nincreases or decreases the number of replica pods a replication controller\nhas based on the resource usage of the existing pods."
+ },
+ "httpLoadBalancing": {
+ "description": "Configuration for the HTTP (L7) load balancing controller addon, which\nmakes it easy to set up HTTP load balancers for services in a cluster.",
+ "$ref": "HttpLoadBalancing"
+ },
+ "kubernetesDashboard": {
+ "$ref": "KubernetesDashboard",
+ "description": "Configuration for the Kubernetes Dashboard."
+ }
+ },
+ "id": "AddonsConfig",
+ "description": "Configuration for the addons that can be automatically spun up in the\ncluster, enabling additional functionality.",
+ "type": "object"
+ },
+ "SetLocationsRequest": {
+ "description": "SetLocationsRequest sets the locations of the cluster.",
+ "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"
+ }
+ }
+ },
+ "id": "SetLocationsRequest"
+ },
+ "SetNodePoolSizeRequest": {
+ "description": "SetNodePoolSizeRequest sets the size a node\npool.",
+ "type": "object",
+ "properties": {
+ "nodeCount": {
+ "description": "The desired node count for the pool.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "SetNodePoolSizeRequest"
+ },
+ "UpdateClusterRequest": {
+ "description": "UpdateClusterRequest updates the settings of a cluster.",
+ "type": "object",
+ "properties": {
+ "update": {
+ "$ref": "ClusterUpdate",
+ "description": "A description of the update."
+ }
+ },
+ "id": "UpdateClusterRequest"
+ },
+ "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."
+ },
+ "Cluster": {
+ "description": "A Google Kubernetes Engine cluster.",
+ "type": "object",
+ "properties": {
+ "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"
+ },
+ "labelFingerprint": {
+ "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.",
+ "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"
+ },
+ "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": {
+ "description": "Master authorized networks is a Beta feature.\nThe 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"
+ },
+ "currentMasterVersion": {
+ "description": "[Output only] The current software version of the master endpoint.",
+ "type": "string"
+ },
+ "nodeConfig": {
+ "description": "Parameters used in creating the cluster's nodes.\nSee `nodeConfig` for the description of its properties.\nFor requests, this field should only be used in lieu of a\n\"node_pool\" object, since this configuration (along with the\n\"initial_node_count\") will be used to create a \"NodePool\" object with an\nauto-generated name. Do not use this and a node_pool at the same time.\nFor responses, this field will be populated with the node configuration of\nthe first node pool.\n\nIf unspecified, the defaults are used.",
+ "$ref": "NodeConfig"
+ },
+ "addonsConfig": {
+ "$ref": "AddonsConfig",
+ "description": "Configurations for the various addons available to run in the cluster."
+ },
+ "status": {
+ "description": "[Output only] The current status of this cluster.",
+ "type": "string",
+ "enumDescriptions": [
+ "Not set.",
+ "The PROVISIONING state indicates the cluster is being created.",
+ "The RUNNING state indicates the cluster has been created and is fully\nusable.",
+ "The RECONCILING state indicates that some work is actively being done on\nthe cluster, such as upgrading the master or node software. Details can\nbe found in the `statusMessage` field.",
+ "The STOPPING state indicates the cluster is being deleted.",
+ "The ERROR state indicates the cluster may be unusable. Details\ncan be found in the `statusMessage` field."
+ ],
+ "enum": [
+ "STATUS_UNSPECIFIED",
+ "PROVISIONING",
+ "RUNNING",
+ "RECONCILING",
+ "STOPPING",
+ "ERROR"
+ ]
+ },
+ "subnetwork": {
+ "type": "string",
+ "description": "The name of the Google Compute Engine\n[subnetwork](/compute/docs/subnetworks) to which the\ncluster is connected."
+ },
+ "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"
+ },
+ "resourceLabels": {
+ "description": "The resource labels for the cluster to use to annotate any related\nGoogle Compute Engine resources.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "name": {
+ "type": "string",
+ "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."
+ },
+ "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."
+ },
+ "legacyAbac": {
+ "description": "Configuration for the legacy ABAC authorization mode.",
+ "$ref": "LegacyAbac"
+ },
+ "endpoint": {
+ "type": "string",
+ "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."
+ },
+ "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"
+ }
+ },
+ "networkPolicy": {
+ "description": "Configuration options for the NetworkPolicy feature.",
+ "$ref": "NetworkPolicy"
+ },
+ "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. 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"
+ },
+ "description": {
+ "description": "An optional description of this cluster.",
+ "type": "string"
+ },
+ "currentNodeCount": {
+ "description": "[Output only] The number of nodes currently in the cluster.",
+ "format": "int32",
+ "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"
+ }
+ },
+ "id": "Cluster"
+ },
+ "CreateNodePoolRequest": {
+ "id": "CreateNodePoolRequest",
+ "description": "CreateNodePoolRequest creates a node pool for a cluster.",
+ "type": "object",
+ "properties": {
+ "nodePool": {
+ "$ref": "NodePool",
+ "description": "The node pool to create."
+ }
+ }
+ },
+ "MasterAuth": {
+ "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": {
+ "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",
+ "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\".",
+ "type": "string"
+ },
+ "startTime": {
+ "description": "Time within the maintenance window to start the maintenance operations.\nTime format should be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt)\nformat \"HH:MM”, where HH : [00-23] and MM : [00-59] GMT.",
+ "type": "string"
+ }
+ },
+ "id": "DailyMaintenanceWindow"
+ },
"ClientCertificateConfig": {
"description": "Configuration for client certificates on the cluster.",
"type": "object",
"properties": {
"issueClientCertificate": {
- "type": "boolean",
- "description": "Issue a client certificate."
+ "description": "Issue a client certificate.",
+ "type": "boolean"
}
},
"id": "ClientCertificateConfig"
@@ -28,60 +672,61 @@
"type": "object",
"properties": {
"loggingService": {
- "type": "string",
- "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"
+ "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"
}
},
"id": "SetLoggingServiceRequest"
},
"SetMaintenancePolicyRequest": {
- "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",
- "description": "SetMaintenancePolicyRequest sets the maintenance policy for a cluster."
+ "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",
- "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`."
+ "id": "Empty"
},
"ListNodePoolsResponse": {
"description": "ListNodePoolsResponse is the result of ListNodePoolsRequest.",
"type": "object",
"properties": {
"nodePools": {
+ "description": "A list of node pools for a cluster.",
"type": "array",
"items": {
"$ref": "NodePool"
- },
- "description": "A list of node pools for a cluster."
+ }
}
},
"id": "ListNodePoolsResponse"
},
"CompleteIPRotationRequest": {
- "type": "object",
"properties": {},
"id": "CompleteIPRotationRequest",
- "description": "CompleteIPRotationRequest moves the cluster master back into single-IP mode."
+ "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": {},
- "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."
+ "id": "StartIPRotationRequest"
},
"NodePool": {
"description": "NodePool contains the name and configuration for a cluster's node pool.\nNode pools are a set of nodes (i.e. VM's), with a common configuration and\nspecification, under the control of the cluster master. They may have a set\nof Kubernetes labels applied to them, which may be used to reference them\nduring pod scheduling. They may also be resized up or down, to accommodate\nthe workload.",
"type": "object",
"properties": {
"status": {
+ "description": "[Output only] The status of the nodes in this pool instance.",
"type": "string",
"enumDescriptions": [
"Not set.",
@@ -100,88 +745,87 @@
"RECONCILING",
"STOPPING",
"ERROR"
- ],
- "description": "[Output only] The status of the nodes in this pool instance."
+ ]
},
"config": {
- "$ref": "NodeConfig",
- "description": "The node configuration of the pool."
+ "description": "The node configuration of the pool.",
+ "$ref": "NodeConfig"
+ },
+ "name": {
+ "description": "The name of the node pool.",
+ "type": "string"
},
"statusMessage": {
"description": "[Output only] Additional information about the current status of this\nnode pool instance, if available.",
"type": "string"
},
- "name": {
- "type": "string",
- "description": "The name of the node pool."
- },
"autoscaling": {
"$ref": "NodePoolAutoscaling",
"description": "Autoscaler configuration for this NodePool. Autoscaler is enabled\nonly if a valid configuration is present."
},
"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"
+ "format": "int32",
+ "type": "integer"
},
"management": {
"$ref": "NodeManagement",
"description": "NodeManagement configuration for this NodePool."
},
"selfLink": {
- "type": "string",
- "description": "[Output only] Server-defined URL for the resource."
+ "description": "[Output only] Server-defined URL for the resource.",
+ "type": "string"
+ },
+ "instanceGroupUrls": {
+ "description": "[Output only] The resource URLs of the [managed instance\ngroups](/compute/docs/instance-groups/creating-groups-of-managed-instances)\nassociated with this node pool.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
},
"version": {
"description": "The version of the Kubernetes of this node.",
"type": "string"
- },
- "instanceGroupUrls": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "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."
}
},
"id": "NodePool"
},
"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",
"type": "object",
"properties": {
"resourceLabels": {
- "type": "object",
"additionalProperties": {
"type": "string"
},
- "description": "The labels to set for that cluster."
+ "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",
- "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"
+ }
},
"NodeManagement": {
+ "id": "NodeManagement",
"description": "NodeManagement defines the set of node management services turned on for the\nnode pool.",
"type": "object",
"properties": {
"autoUpgrade": {
- "type": "boolean",
- "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."
+ "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.",
+ "type": "boolean"
},
"autoRepair": {
"description": "A flag that specifies whether the node auto-repair is enabled for the node\npool. If enabled, the nodes in this node pool will be monitored and, if\nthey fail health checks too many times, an automatic repair action will be\ntriggered.",
"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"
+ }
},
"CancelOperationRequest": {
"description": "CancelOperationRequest cancels a single operation.",
@@ -194,42 +838,15 @@
"type": "object",
"properties": {
"disabled": {
- "description": "Whether the Kubernetes Dashboard is enabled for this cluster.",
- "type": "boolean"
+ "type": "boolean",
+ "description": "Whether the Kubernetes Dashboard is enabled for this cluster."
}
},
"id": "KubernetesDashboard"
},
"Operation": {
- "description": "This operation resource represents operations that may have happened or are\nhappening on the cluster. All fields are output only.",
"type": "object",
"properties": {
- "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"
@@ -239,34 +856,14 @@
"type": "string"
},
"targetLink": {
- "type": "string",
- "description": "Server-defined URL for the target of the operation."
+ "description": "Server-defined URL for the target of the operation.",
+ "type": "string"
},
"endTime": {
- "type": "string",
- "description": "[Output only] The time the operation completed, in\n[RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format."
+ "description": "[Output only] The time the operation completed, in\n[RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.",
+ "type": "string"
},
"operationType": {
- "type": "string",
- "enumDescriptions": [
- "Not set.",
- "Cluster create.",
- "Cluster delete.",
- "A master upgrade.",
- "A node upgrade.",
- "Cluster repair.",
- "Cluster update.",
- "Node pool create.",
- "Node pool delete.",
- "Set node pool management.",
- "Automatic node pool repair.",
- "Automatic node upgrade.",
- "Set labels.",
- "Set/generate master auth materials",
- "Set node pool size.",
- "Updates network policy for a cluster.",
- "Set the maintenance policy."
- ],
"enum": [
"TYPE_UNSPECIFIED",
"CREATE_CLUSTER",
@@ -286,7 +883,27 @@
"SET_NETWORK_POLICY",
"SET_MAINTENANCE_POLICY"
],
- "description": "The operation type."
+ "description": "The operation type.",
+ "type": "string",
+ "enumDescriptions": [
+ "Not set.",
+ "Cluster create.",
+ "Cluster delete.",
+ "A master upgrade.",
+ "A node upgrade.",
+ "Cluster repair.",
+ "Cluster update.",
+ "Node pool create.",
+ "Node pool delete.",
+ "Set node pool management.",
+ "Automatic node pool repair.",
+ "Automatic node upgrade.",
+ "Set labels.",
+ "Set/generate master auth materials",
+ "Set node pool size.",
+ "Updates network policy for a cluster.",
+ "Set the maintenance policy."
+ ]
},
"startTime": {
"type": "string",
@@ -295,11 +912,39 @@
"zone": {
"description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the operation\nis taking place.",
"type": "string"
+ },
+ "status": {
+ "enumDescriptions": [
+ "Not set.",
+ "The operation has been created.",
+ "The operation is currently running.",
+ "The operation is done, either cancelled or completed.",
+ "The operation is aborting."
+ ],
+ "enum": [
+ "STATUS_UNSPECIFIED",
+ "PENDING",
+ "RUNNING",
+ "DONE",
+ "ABORTING"
+ ],
+ "description": "The current status of the operation.",
+ "type": "string"
+ },
+ "statusMessage": {
+ "description": "If an error has occurred, a textual description of the error.",
+ "type": "string"
+ },
+ "name": {
+ "description": "The server-assigned ID for the operation.",
+ "type": "string"
}
},
- "id": "Operation"
+ "id": "Operation",
+ "description": "This operation resource represents operations that may have happened or are\nhappening on the cluster. All fields are output only."
},
"MaintenanceWindow": {
+ "description": "MaintenanceWindow defines the maintenance window to be used for the cluster.",
"type": "object",
"properties": {
"dailyMaintenanceWindow": {
@@ -307,20 +952,24 @@
"description": "DailyMaintenanceWindow specifies a daily maintenance operation window."
}
},
- "id": "MaintenanceWindow",
- "description": "MaintenanceWindow defines the maintenance window to be used for the cluster."
+ "id": "MaintenanceWindow"
},
"RollbackNodePoolUpgradeRequest": {
- "description": "RollbackNodePoolUpgradeRequest rollbacks the previously Aborted or Failed\nNodePool upgrade. This will be an no-op if the last upgrade successfully\ncompleted.",
- "type": "object",
"properties": {},
- "id": "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"
},
"NetworkPolicy": {
"description": "Configuration options for the NetworkPolicy feature.\nhttps://kubernetes.io/docs/concepts/services-networking/networkpolicies/",
"type": "object",
"properties": {
+ "enabled": {
+ "description": "Whether network policy is enabled on the cluster.",
+ "type": "boolean"
+ },
"provider": {
+ "description": "The selected network policy provider.",
"type": "string",
"enumDescriptions": [
"Not set",
@@ -329,12 +978,7 @@
"enum": [
"PROVIDER_UNSPECIFIED",
"CALICO"
- ],
- "description": "The selected network policy provider."
- },
- "enabled": {
- "type": "boolean",
- "description": "Whether network policy is enabled on the cluster."
+ ]
}
},
"id": "NetworkPolicy"
@@ -351,6 +995,7 @@
"description": "UpdateMasterRequest updates the master of the cluster."
},
"ListOperationsResponse": {
+ "description": "ListOperationsResponse is the result of ListOperationsRequest.",
"type": "object",
"properties": {
"operations": {
@@ -368,10 +1013,10 @@
}
}
},
- "id": "ListOperationsResponse",
- "description": "ListOperationsResponse is the result of ListOperationsRequest."
+ "id": "ListOperationsResponse"
},
"CidrBlock": {
+ "id": "CidrBlock",
"description": "CidrBlock contains an optional name and one CIDR block.",
"type": "object",
"properties": {
@@ -380,32 +1025,32 @@
"type": "string"
},
"cidrBlock": {
- "type": "string",
- "description": "cidr_block must be specified in CIDR notation."
+ "description": "cidr_block must be specified in CIDR notation.",
+ "type": "string"
}
- },
- "id": "CidrBlock"
+ }
},
"SetMonitoringServiceRequest": {
- "description": "SetMonitoringServiceRequest sets the monitoring service of a cluster.",
"type": "object",
"properties": {
"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"
+ "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"
+ "id": "SetMonitoringServiceRequest",
+ "description": "SetMonitoringServiceRequest sets the monitoring service of a cluster."
},
"ServerConfig": {
+ "description": "Kubernetes Engine service configuration.",
"type": "object",
"properties": {
"validMasterVersions": {
+ "description": "List of valid master versions.",
"type": "array",
"items": {
"type": "string"
- },
- "description": "List of valid master versions."
+ }
},
"defaultClusterVersion": {
"description": "Version of Kubernetes the service deploys by default.",
@@ -416,22 +1061,21 @@
"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.",
"type": "array",
"items": {
"type": "string"
- },
- "description": "List of valid image types."
+ }
}
},
- "id": "ServerConfig",
- "description": "Kubernetes Engine service configuration."
+ "id": "ServerConfig"
},
"NodeConfig": {
"description": "Parameters that describe the nodes in a cluster.",
@@ -465,11 +1109,11 @@
"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"
- },
- "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."
+ }
},
"labels": {
"additionalProperties": {
@@ -479,9 +1123,9 @@
"type": "object"
},
"diskSizeGb": {
- "type": "integer",
"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"
+ "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.",
@@ -491,661 +1135,26 @@
}
},
"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`."
+ "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."
+ "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.",
+ "type": "boolean"
}
},
"id": "NodeConfig"
- },
- "AutoUpgradeOptions": {
- "description": "AutoUpgradeOptions defines the set of options for the user to control how\nthe Auto Upgrades will proceed.",
- "type": "object",
- "properties": {
- "autoUpgradeStartTime": {
- "type": "string",
- "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."
- },
- "description": {
- "description": "[Output only] This field is set when upgrades are about to commence\nwith the description of the upgrade.",
- "type": "string"
- }
- },
- "id": "AutoUpgradeOptions"
- },
- "ListClustersResponse": {
- "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": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "description": "If any zones are listed here, the list of clusters returned\nmay be missing those zones."
- }
- },
- "id": "ListClustersResponse",
- "description": "ListClustersResponse is the result of ListClustersRequest."
- },
- "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."
- }
- },
- "id": "HttpLoadBalancing"
- },
- "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"
- },
- "NodePoolAutoscaling": {
- "type": "object",
- "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"
- },
- "minNodeCount": {
- "type": "integer",
- "description": "Minimum number of nodes in the NodePool. Must be \u003e= 1 and \u003c=\nmax_node_count.",
- "format": "int32"
- },
- "enabled": {
- "type": "boolean",
- "description": "Is autoscaling enabled for this node pool."
- }
- },
- "id": "NodePoolAutoscaling",
- "description": "NodePoolAutoscaling contains information required by cluster autoscaler to\nadjust the size of the node pool to the current cluster usage."
- },
- "SetMasterAuthRequest": {
- "type": "object",
- "properties": {
- "update": {
- "$ref": "MasterAuth",
- "description": "A description of the update."
- },
- "action": {
- "enum": [
- "UNKNOWN",
- "SET_PASSWORD",
- "GENERATE_PASSWORD",
- "SET_USERNAME"
- ],
- "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."
- ]
- }
- },
- "id": "SetMasterAuthRequest",
- "description": "SetMasterAuthRequest updates the admin password of a cluster."
- },
- "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": {
- "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": {
- "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."
- },
- "desiredMasterVersion": {
- "type": "string",
- "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."
- },
- "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": {
- "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"
- }
- },
- "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"
- },
- "IPAllocationPolicy": {
- "type": "object",
- "properties": {
- "nodeIpv4CidrBlock": {
- "type": "string",
- "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."
- },
- "servicesIpv4Cidr": {
- "description": "This field is deprecated, use services_ipv4_cidr_block.",
- "type": "string"
- },
- "createSubnetwork": {
- "description": "Whether a new subnetwork will be created automatically for the cluster.\n\nThis field is only applicable when `use_ip_aliases` is true.",
- "type": "boolean"
- },
- "useIpAliases": {
- "type": "boolean",
- "description": "Whether alias IPs will be used for pod IPs in the cluster."
- },
- "servicesSecondaryRangeName": {
- "description": "The name of the secondary range to be used as for the services\nCIDR block. The secondary range will be used for service\nClusterIPs. This must be an existing secondary range associated\nwith the cluster subnetwork.\n\nThis field is only applicable with use_ip_aliases is true and\ncreate_subnetwork is false.",
- "type": "string"
- },
- "subnetworkName": {
- "description": "A custom subnetwork name to be used if `create_subnetwork` is true. If\nthis field is empty, then an automatic name will be chosen for the new\nsubnetwork.",
- "type": "string"
- },
- "servicesIpv4CidrBlock": {
- "description": "The IP address range of the services IPs in this cluster. If blank, a range\nwill be automatically chosen with the default size.\n\nThis field is only applicable when `use_ip_aliases` is true.\n\nSet to blank to have a range chosen with the default size.\n\nSet to /netmask (e.g. `/14`) to have a range chosen with a specific\nnetmask.\n\nSet to a\n[CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)\nnotation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g.\n`10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range\nto use.",
- "type": "string"
- },
- "clusterIpv4Cidr": {
- "description": "This field is deprecated, use cluster_ipv4_cidr_block.",
- "type": "string"
- },
- "nodeIpv4Cidr": {
- "type": "string",
- "description": "This field is deprecated, use node_ipv4_cidr_block."
- },
- "clusterIpv4CidrBlock": {
- "type": "string",
- "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."
- },
- "clusterSecondaryRangeName": {
- "type": "string",
- "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."
- }
- },
- "id": "IPAllocationPolicy",
- "description": "Configuration for controlling how IPs are allocated in the cluster."
- },
- "HorizontalPodAutoscaling": {
- "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",
- "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."
- },
- "SetNodePoolManagementRequest": {
- "type": "object",
- "properties": {
- "management": {
- "$ref": "NodeManagement",
- "description": "NodeManagement configuration for the node pool."
- }
- },
- "id": "SetNodePoolManagementRequest",
- "description": "SetNodePoolManagementRequest sets the node management properties of a node\npool."
- },
- "MasterAuthorizedNetworksConfig": {
- "type": "object",
- "properties": {
- "cidrBlocks": {
- "description": "cidr_blocks define up to 10 external networks that could access\nKubernetes master through HTTPS.",
- "type": "array",
- "items": {
- "$ref": "CidrBlock"
- }
- },
- "enabled": {
- "description": "Whether or not master authorized networks is enabled.",
- "type": "boolean"
- }
- },
- "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."
- },
- "SetNodePoolAutoscalingRequest": {
- "type": "object",
- "properties": {
- "autoscaling": {
- "$ref": "NodePoolAutoscaling",
- "description": "Autoscaling configuration for the node pool."
- }
- },
- "id": "SetNodePoolAutoscalingRequest",
- "description": "SetNodePoolAutoscalingRequest sets the autoscaler settings of a node pool."
- },
- "CreateClusterRequest": {
- "description": "CreateClusterRequest creates a cluster.",
- "type": "object",
- "properties": {
- "cluster": {
- "$ref": "Cluster",
- "description": "A [cluster\nresource](/container-engine/reference/rest/v1/projects.zones.clusters)"
- }
- },
- "id": "CreateClusterRequest"
- },
- "LegacyAbac": {
- "description": "Configuration for the legacy Attribute Based Access Control authorization\nmode.",
- "type": "object",
- "properties": {
- "enabled": {
- "description": "Whether the ABAC authorizer is enabled for this cluster. When enabled,\nidentities in the system, including service accounts, nodes, and\ncontrollers, will have statically granted permissions beyond those\nprovided by the RBAC configuration or IAM.",
- "type": "boolean"
- }
- },
- "id": "LegacyAbac"
- },
- "AcceleratorConfig": {
- "description": "AcceleratorConfig represents a Hardware Accelerator request.",
- "type": "object",
- "properties": {
- "acceleratorCount": {
- "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"
- },
- "UpdateNodePoolRequest": {
- "type": "object",
- "properties": {
- "nodeVersion": {
- "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."
- },
- "imageType": {
- "type": "string",
- "description": "The desired image type for the node pool."
- }
- },
- "id": "UpdateNodePoolRequest",
- "description": "UpdateNodePoolRequests update a node pool's image and/or version."
- },
- "SetAddonsConfigRequest": {
- "type": "object",
- "properties": {
- "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."
- },
- "SetLegacyAbacRequest": {
- "description": "SetLegacyAbacRequest enables or disables the ABAC authorization mechanism for\na cluster.",
- "type": "object",
- "properties": {
- "enabled": {
- "description": "Whether ABAC authorization will be enabled in the cluster.",
- "type": "boolean"
- }
- },
- "id": "SetLegacyAbacRequest"
- },
- "AddonsConfig": {
- "type": "object",
- "properties": {
- "networkPolicyConfig": {
- "$ref": "NetworkPolicyConfig",
- "description": "Configuration for NetworkPolicy. This only tracks whether the addon\nis enabled or not on the Master, it does not track whether network policy\nis enabled for the nodes."
- },
- "horizontalPodAutoscaling": {
- "$ref": "HorizontalPodAutoscaling",
- "description": "Configuration for the horizontal pod autoscaling feature, which\nincreases or decreases the number of replica pods a replication controller\nhas based on the resource usage of the existing pods."
- },
- "httpLoadBalancing": {
- "$ref": "HttpLoadBalancing",
- "description": "Configuration for the HTTP (L7) load balancing controller addon, which\nmakes it easy to set up HTTP load balancers for services in a cluster."
- },
- "kubernetesDashboard": {
- "$ref": "KubernetesDashboard",
- "description": "Configuration for the Kubernetes Dashboard."
- }
- },
- "id": "AddonsConfig",
- "description": "Configuration for the addons that can be automatically spun up in the\ncluster, enabling additional functionality."
- },
- "SetLocationsRequest": {
- "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"
- }
- }
- },
- "id": "SetLocationsRequest",
- "description": "SetLocationsRequest sets the locations of the cluster."
- },
- "SetNodePoolSizeRequest": {
- "description": "SetNodePoolSizeRequest sets the size a node\npool.",
- "type": "object",
- "properties": {
- "nodeCount": {
- "type": "integer",
- "description": "The desired node count for the pool.",
- "format": "int32"
- }
- },
- "id": "SetNodePoolSizeRequest"
- },
- "UpdateClusterRequest": {
- "type": "object",
- "properties": {
- "update": {
- "$ref": "ClusterUpdate",
- "description": "A description of the update."
- }
- },
- "id": "UpdateClusterRequest",
- "description": "UpdateClusterRequest updates the settings of a cluster."
- },
- "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": {
- "description": "Whether NetworkPolicy is enabled for this cluster.",
- "type": "boolean"
- }
- },
- "id": "NetworkPolicyConfig"
- },
- "Cluster": {
- "type": "object",
- "properties": {
- "currentMasterVersion": {
- "type": "string",
- "description": "[Output only] The current software version of the master endpoint."
- },
- "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."
- },
- "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."
- },
- "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": {
- "type": "string",
- "description": "The name of the Google Compute Engine\n[subnetwork](/compute/docs/subnetworks) to which the\ncluster is connected."
- },
- "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": {
- "type": "string",
- "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."
- },
- "ipAllocationPolicy": {
- "$ref": "IPAllocationPolicy",
- "description": "Configuration for cluster IP allocation."
- },
- "endpoint": {
- "type": "string",
- "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."
- },
- "legacyAbac": {
- "$ref": "LegacyAbac",
- "description": "Configuration for the legacy ABAC authorization mode."
- },
- "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": {
- "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": {
- "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": {
- "description": "[Output only] Server-defined URL for the resource.",
- "type": "string"
- },
- "locations": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "description": "The list of Google Compute Engine\n[locations](/compute/docs/zones#available) in which the cluster's nodes\nshould be located."
- },
- "nodePools": {
- "description": "The node pools associated with this cluster.\nThis field should not be set if \"node_config\" or \"initial_node_count\" are\nspecified.",
- "type": "array",
- "items": {
- "$ref": "NodePool"
- }
- },
- "instanceGroupUrls": {
- "description": "Deprecated. Use node_pools.instance_group_urls.",
- "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. 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"
- },
- "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": {
- "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"
- },
- "labelFingerprint": {
- "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": {
- "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": {
- "type": "string",
- "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."
- },
- "masterAuthorizedNetworksConfig": {
- "$ref": "MasterAuthorizedNetworksConfig",
- "description": "Master authorized networks is a Beta feature.\nThe configuration options for master authorized networks feature."
- },
- "statusMessage": {
- "description": "[Output only] Additional information about the current status of this\ncluster, if available.",
- "type": "string"
- },
- "masterAuth": {
- "$ref": "MasterAuth",
- "description": "The authentication information for accessing the master endpoint."
- }
- },
- "id": "Cluster",
- "description": "A Google Kubernetes Engine cluster."
- },
- "CreateNodePoolRequest": {
- "description": "CreateNodePoolRequest creates a node pool for a cluster.",
- "type": "object",
- "properties": {
- "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": {
- "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": {
- "type": "string",
- "description": "[Output only] Base64-encoded private key used by clients to authenticate\nto the cluster endpoint."
- },
- "clusterCaCertificate": {
- "type": "string",
- "description": "[Output only] Base64-encoded public certificate that is the root of\ntrust for the cluster."
- },
- "clientCertificate": {
- "type": "string",
- "description": "[Output only] Base64-encoded public certificate used by clients to\nauthenticate to the cluster endpoint."
- },
- "username": {
- "type": "string",
- "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."
- }
- },
- "id": "MasterAuth"
- },
- "DailyMaintenanceWindow": {
- "description": "Time window specified for daily maintenance operations.",
- "type": "object",
- "properties": {
- "startTime": {
- "description": "Time within the maintenance window to start the maintenance operations.\nTime format should be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt)\nformat \"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.\nDuration will be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt)\nformat \"PTnHnMnS\".",
- "type": "string"
- }
- },
- "id": "DailyMaintenanceWindow"
}
},
- "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": "Container",
"auth": {
"oauth2": {
@@ -1167,43 +1176,788 @@
"projects": {
"resources": {
"zones": {
- "methods": {
- "getServerconfig": {
- "flatPath": "v1/projects/{projectId}/zones/{zone}/serverconfig",
- "path": "v1/projects/{projectId}/zones/{zone}/serverconfig",
- "id": "container.projects.zones.getServerconfig",
- "description": "Returns configuration info about the Kubernetes Engine service.",
- "response": {
- "$ref": "ServerConfig"
- },
- "parameterOrder": [
- "projectId",
- "zone"
- ],
- "httpMethod": "GET",
- "parameters": {
- "projectId": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840)."
+ "resources": {
+ "operations": {
+ "methods": {
+ "cancel": {
+ "description": "Cancels the specified operation.",
+ "request": {
+ "$ref": "CancelOperationRequest"
+ },
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "projectId",
+ "zone",
+ "operationId"
+ ],
+ "response": {
+ "$ref": "Empty"
+ },
+ "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": {
+ "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",
+ "id": "container.projects.zones.operations.cancel",
+ "path": "v1/projects/{projectId}/zones/{zone}/operations/{operationId}:cancel"
},
- "zone": {
- "location": "path",
- "description": "The name of the Google Compute Engine [zone](/compute/docs/zones#available)\nto return operations for.",
- "required": true,
- "type": "string"
+ "list": {
+ "description": "Lists all operations in a project in a specific zone or all zones.",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "ListOperationsResponse"
+ },
+ "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": {
+ "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",
+ "id": "container.projects.zones.operations.list",
+ "path": "v1/projects/{projectId}/zones/{zone}/operations"
+ },
+ "get": {
+ "flatPath": "v1/projects/{projectId}/zones/{zone}/operations/{operationId}",
+ "id": "container.projects.zones.operations.get",
+ "path": "v1/projects/{projectId}/zones/{zone}/operations/{operationId}",
+ "description": "Gets the specified operation.",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "projectId",
+ "zone",
+ "operationId"
+ ],
+ "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 cluster\nresides.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ }
+ }
+ },
+ "clusters": {
+ "resources": {
+ "nodePools": {
+ "methods": {
+ "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": {
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "clusterId": {
+ "location": "path",
+ "description": "The name of the cluster.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools",
+ "id": "container.projects.zones.clusters.nodePools.create",
+ "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools"
+ },
+ "autoscaling": {
+ "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/autoscaling",
+ "id": "container.projects.zones.clusters.nodePools.autoscaling",
+ "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/autoscaling",
+ "request": {
+ "$ref": "SetNodePoolAutoscalingRequest"
+ },
+ "description": "Sets the autoscaling settings of a specific node pool.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "projectId",
+ "zone",
+ "clusterId",
+ "nodePoolId"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameters": {
+ "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": {
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "description": "The name of the cluster to upgrade."
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "get": {
+ "description": "Retrieves the node pool requested.",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "NodePool"
+ },
+ "parameterOrder": [
+ "projectId",
+ "zone",
+ "clusterId",
+ "nodePoolId"
+ ],
+ "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": {
+ "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"
+ },
+ "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}"
+ },
+ "update": {
+ "id": "container.projects.zones.clusters.nodePools.update",
+ "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/update",
+ "request": {
+ "$ref": "UpdateNodePoolRequest"
+ },
+ "description": "Updates the version and/or image 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).",
+ "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"
+ },
+ "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}/update"
+ },
+ "setSize": {
+ "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/setSize",
+ "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/setSize",
+ "id": "container.projects.zones.clusters.nodePools.setSize",
+ "request": {
+ "$ref": "SetNodePoolSizeRequest"
+ },
+ "description": "Sets the size of a specific node pool.",
+ "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": {
+ "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"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "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": {
+ "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"
+ }
+ },
+ "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/setManagement",
+ "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/setManagement",
+ "id": "container.projects.zones.clusters.nodePools.setManagement"
+ },
+ "delete": {
+ "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}",
+ "id": "container.projects.zones.clusters.nodePools.delete",
+ "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}",
+ "description": "Deletes a node pool from a cluster.",
+ "httpMethod": "DELETE",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "projectId",
+ "zone",
+ "clusterId",
+ "nodePoolId"
+ ],
+ "parameters": {
+ "projectId": {
+ "location": "path",
+ "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).",
+ "required": true,
+ "type": "string"
+ },
+ "zone": {
+ "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"
+ },
+ "nodePoolId": {
+ "description": "The name of the node pool to delete.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "list": {
+ "id": "container.projects.zones.clusters.nodePools.list",
+ "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools",
+ "description": "Lists the node pools for a cluster.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "projectId",
+ "zone",
+ "clusterId"
+ ],
+ "response": {
+ "$ref": "ListNodePoolsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "projectId": {
+ "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "zone": {
+ "location": "path",
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.",
+ "required": true,
+ "type": "string"
+ },
+ "clusterId": {
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "description": "The name of the cluster."
+ }
+ },
+ "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/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"
+ },
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "projectId",
+ "zone",
+ "clusterId",
+ "nodePoolId"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "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 rollback.",
+ "required": true,
+ "type": "string"
+ },
+ "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",
+ "id": "container.projects.zones.clusters.nodePools.rollback",
+ "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}:rollback"
+ }
+ }
}
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- }
- },
- "resources": {
- "clusters": {
"methods": {
+ "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"
+ },
+ "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": {
+ "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}/locations"
+ },
+ "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": {
+ "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"
+ },
+ "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."
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "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": {
+ "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"
+ }
+ },
+ "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": {
+ "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}/master",
+ "id": "container.projects.zones.clusters.master",
+ "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/master",
+ "request": {
+ "$ref": "UpdateMasterRequest"
+ },
+ "description": "Updates the master of a specific cluster."
+ },
+ "setMasterAuth": {
+ "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}:setMasterAuth",
+ "id": "container.projects.zones.clusters.setMasterAuth",
+ "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}: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 the password."
+ },
+ "logging": {
+ "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/logging",
+ "id": "container.projects.zones.clusters.logging",
+ "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/logging",
+ "request": {
+ "$ref": "SetLoggingServiceRequest"
+ },
+ "description": "Sets the logging service of a specific cluster.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "projectId",
+ "zone",
+ "clusterId"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameters": {
+ "clusterId": {
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "description": "The name of the cluster to upgrade."
+ },
+ "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."
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
"list": {
+ "path": "v1/projects/{projectId}/zones/{zone}/clusters",
+ "id": "container.projects.zones.clusters.list",
+ "description": "Lists all clusters owned by a project in either the specified zone or all\nzones.",
"response": {
"$ref": "ListClustersResponse"
},
@@ -1229,16 +1983,54 @@
"description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides, or \"-\" for all zones."
}
},
- "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters",
- "path": "v1/projects/{projectId}/zones/{zone}/clusters",
- "id": "container.projects.zones.clusters.list",
- "description": "Lists all clusters owned by a project in either the specified zone or all\nzones."
+ "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters"
+ },
+ "resourceLabels": {
+ "description": "Sets labels on a cluster.",
+ "request": {
+ "$ref": "SetLabelsRequest"
+ },
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "projectId",
+ "zone",
+ "clusterId"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "projectId": {
+ "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "zone": {
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "clusterId": {
+ "location": "path",
+ "description": "The name of the cluster.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/resourceLabels",
+ "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/resourceLabels",
+ "id": "container.projects.zones.clusters.resourceLabels"
},
"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"
},
- "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.",
"httpMethod": "POST",
"parameterOrder": [
"projectId",
@@ -1247,12 +2039,15 @@
"response": {
"$ref": "Operation"
},
+ "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"
+ "type": "string",
+ "location": "path"
},
"zone": {
"location": "path",
@@ -1261,35 +2056,35 @@
"type": "string"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
"flatPath": "v1/projects/{projectId}/zones/{zone}/clusters",
"id": "container.projects.zones.clusters.create",
"path": "v1/projects/{projectId}/zones/{zone}/clusters"
},
- "resourceLabels": {
- "response": {
- "$ref": "Operation"
- },
+ "completeIpRotation": {
+ "httpMethod": "POST",
"parameterOrder": [
"projectId",
"zone",
"clusterId"
],
- "httpMethod": "POST",
+ "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).",
"required": true,
"type": "string",
- "location": "path",
- "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber)."
+ "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",
- "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides."
+ "location": "path"
},
"clusterId": {
"location": "path",
@@ -1298,59 +2093,16 @@
"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",
- "request": {
- "$ref": "SetLabelsRequest"
- },
- "description": "Sets labels on a cluster."
- },
- "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",
+ "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}: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": {
- "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"
- }
}
},
"get": {
+ "description": "Gets the details of a specific cluster.",
"response": {
"$ref": "Cluster"
},
@@ -1360,48 +2112,16 @@
"clusterId"
],
"httpMethod": "GET",
+ "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 retrieve."
- }
- },
- "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",
- "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).",
@@ -1413,26 +2133,59 @@
"type": "string",
"location": "path",
"description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides."
- },
- "clusterId": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "The name of the cluster to update."
}
},
- "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/legacyAbac",
- "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/legacyAbac",
+ "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}",
+ "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}",
+ "id": "container.projects.zones.clusters.get"
+ },
+ "setNetworkPolicy": {
+ "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": {
+ "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",
+ "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:setNetworkPolicy",
+ "id": "container.projects.zones.clusters.setNetworkPolicy",
+ "request": {
+ "$ref": "SetNetworkPolicyRequest"
+ },
+ "description": "Enables/Disables Network Policy for a cluster."
+ },
+ "legacyAbac": {
"id": "container.projects.zones.clusters.legacyAbac",
+ "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/legacyAbac",
"description": "Enables or disables the ABAC authorization mechanism on a cluster.",
"request": {
"$ref": "SetLegacyAbacRequest"
- }
- },
- "setNetworkPolicy": {
- "description": "Enables/Disables Network Policy for a cluster.",
- "request": {
- "$ref": "SetNetworkPolicyRequest"
},
"httpMethod": "POST",
"parameterOrder": [
@@ -1451,53 +2204,42 @@
"required": true,
"type": "string",
"location": "path",
- "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber)."
+ "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": {
+ "location": "path",
+ "description": "The name of the cluster to update.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/legacyAbac"
+ },
+ "startIpRotation": {
+ "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."
},
"clusterId": {
+ "description": "The name of the cluster.",
"required": true,
"type": "string",
- "location": "path",
- "description": "The name of the cluster."
- }
- },
- "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:setNetworkPolicy",
- "id": "container.projects.zones.clusters.setNetworkPolicy",
- "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:setNetworkPolicy"
- },
- "startIpRotation": {
- "httpMethod": "POST",
- "parameterOrder": [
- "projectId",
- "zone",
- "clusterId"
- ],
- "response": {
- "$ref": "Operation"
- },
- "parameters": {
+ "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": {
- "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": [
@@ -1509,9 +2251,22 @@
"request": {
"$ref": "StartIPRotationRequest"
},
- "description": "Start master IP rotation."
+ "description": "Start master IP rotation.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "projectId",
+ "zone",
+ "clusterId"
+ ],
+ "response": {
+ "$ref": "Operation"
+ }
},
"addons": {
+ "request": {
+ "$ref": "SetAddonsConfigRequest"
+ },
+ "description": "Sets the addons of a specific cluster.",
"response": {
"$ref": "Operation"
},
@@ -1529,10 +2284,10 @@
"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",
- "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides."
+ "location": "path"
},
"clusterId": {
"location": "path",
@@ -1546,25 +2301,22 @@
],
"flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/addons",
"path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/addons",
- "id": "container.projects.zones.clusters.addons",
- "request": {
- "$ref": "SetAddonsConfigRequest"
- },
- "description": "Sets the addons of a specific cluster."
+ "id": "container.projects.zones.clusters.addons"
},
"setMaintenancePolicy": {
- "response": {
- "$ref": "Operation"
+ "request": {
+ "$ref": "SetMaintenancePolicyRequest"
},
+ "description": "Sets the maintenance policy for a cluster.",
+ "httpMethod": "POST",
"parameterOrder": [
"projectId",
"zone",
"clusterId"
],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
+ "response": {
+ "$ref": "Operation"
+ },
"parameters": {
"projectId": {
"location": "path",
@@ -1573,30 +2325,26 @@
"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."
+ "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 update."
+ "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}: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"
- }
+ "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:setMaintenancePolicy"
},
"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"
@@ -1624,789 +2372,50 @@
"type": "string"
},
"clusterId": {
+ "description": "The name of the cluster to delete.",
"required": true,
"type": "string",
- "location": "path",
- "description": "The name of the cluster to delete."
- }
- }
- },
- "locations": {
- "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://support.google.com/cloud/answer/6158840)."
- },
- "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": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "The name of the cluster to upgrade."
+ "location": "path"
}
},
- "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": {
"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.",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "projectId",
- "zone",
- "clusterId"
- ],
- "httpMethod": "PUT",
- "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": {
- "location": "path",
- "description": "The name of the cluster to upgrade.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
+ "id": "container.projects.zones.clusters.delete"
+ }
+ }
+ }
+ },
+ "methods": {
+ "getServerconfig": {
+ "parameters": {
+ "zone": {
+ "location": "path",
+ "description": "The name of the Google Compute Engine [zone](/compute/docs/zones#available)\nto return operations for.",
+ "required": true,
+ "type": "string"
},
- "monitoring": {
- "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": {
- "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": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "The name of the cluster to upgrade."
- }
- },
- "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": {
- "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": {
- "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": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "The name of the cluster to upgrade."
- }
- },
- "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/master",
- "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/master",
- "id": "container.projects.zones.clusters.master",
- "description": "Updates the master of a specific cluster.",
- "request": {
- "$ref": "UpdateMasterRequest"
- }
- },
- "setMasterAuth": {
- "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:setMasterAuth",
- "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:setMasterAuth",
- "id": "container.projects.zones.clusters.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": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840)."
- },
- "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": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "The name of the cluster to upgrade."
- }
- }
- },
- "logging": {
- "description": "Sets the logging service of a specific cluster.",
- "request": {
- "$ref": "SetLoggingServiceRequest"
- },
- "httpMethod": "POST",
- "parameterOrder": [
- "projectId",
- "zone",
- "clusterId"
- ],
- "response": {
- "$ref": "Operation"
- },
- "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": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "The name of the cluster to upgrade."
- }
- },
- "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/logging",
- "id": "container.projects.zones.clusters.logging",
- "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/logging"
+ "projectId": {
+ "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).",
+ "required": true,
+ "type": "string",
+ "location": "path"
}
},
- "resources": {
- "nodePools": {
- "methods": {
- "get": {
- "response": {
- "$ref": "NodePool"
- },
- "parameterOrder": [
- "projectId",
- "zone",
- "clusterId",
- "nodePoolId"
- ],
- "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": {
- "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."
- },
- "nodePoolId": {
- "location": "path",
- "description": "The name of the node pool.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}",
- "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}",
- "id": "container.projects.zones.clusters.nodePools.get",
- "description": "Retrieves the node pool requested."
- },
- "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": {
- "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": {
- "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"
- },
- "nodePoolId": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "The name of the node pool to upgrade."
- }
- },
- "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"
- },
- "delete": {
- "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}",
- "id": "container.projects.zones.clusters.nodePools.delete",
- "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}",
- "description": "Deletes a node pool from a cluster.",
- "httpMethod": "DELETE",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "projectId",
- "zone",
- "clusterId",
- "nodePoolId"
- ],
- "parameters": {
- "projectId": {
- "location": "path",
- "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).",
- "required": true,
- "type": "string"
- },
- "zone": {
- "location": "path",
- "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.",
- "required": true,
- "type": "string"
- },
- "clusterId": {
- "location": "path",
- "description": "The name of the cluster.",
- "required": true,
- "type": "string"
- },
- "nodePoolId": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "The name of the node pool to delete."
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- },
- "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": {
- "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 update.",
- "required": true,
- "type": "string"
- },
- "nodePoolId": {
- "location": "path",
- "description": "The name of the node pool to update.",
- "required": true,
- "type": "string"
- }
- }
- },
- "setSize": {
- "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": {
- "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 update.",
- "required": true,
- "type": "string"
- },
- "nodePoolId": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "The name of the node pool to update."
- }
- },
- "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"
- }
- },
- "list": {
- "description": "Lists the node pools for a cluster.",
- "response": {
- "$ref": "ListNodePoolsResponse"
- },
- "parameterOrder": [
- "projectId",
- "zone",
- "clusterId"
- ],
- "httpMethod": "GET",
- "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": {
- "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": {
- "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",
- "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools",
- "id": "container.projects.zones.clusters.nodePools.list"
- },
- "rollback": {
- "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": {
- "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": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "The name of the node pool to rollback."
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}:rollback",
- "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}:rollback",
- "id": "container.projects.zones.clusters.nodePools.rollback",
- "request": {
- "$ref": "RollbackNodePoolUpgradeRequest"
- },
- "description": "Roll back the previously Aborted or Failed NodePool upgrade.\nThis will be an no-op if the last upgrade successfully completed."
- },
- "create": {
- "description": "Creates a node pool for a cluster.",
- "request": {
- "$ref": "CreateNodePoolRequest"
- },
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "projectId",
- "zone",
- "clusterId"
- ],
- "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://developers.google.com/console/help/new/#projectnumber)."
- },
- "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."
- }
- },
- "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"
- },
- "autoscaling": {
- "description": "Sets the autoscaling settings of a specific node pool.",
- "request": {
- "$ref": "SetNodePoolAutoscalingRequest"
- },
- "httpMethod": "POST",
- "parameterOrder": [
- "projectId",
- "zone",
- "clusterId",
- "nodePoolId"
- ],
- "response": {
- "$ref": "Operation"
- },
- "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": {
- "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"
- },
- "nodePoolId": {
- "location": "path",
- "description": "The name of the node pool to upgrade.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/autoscaling",
- "id": "container.projects.zones.clusters.nodePools.autoscaling",
- "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/autoscaling"
- }
- }
- }
- }
- },
- "operations": {
- "methods": {
- "cancel": {
- "httpMethod": "POST",
- "parameterOrder": [
- "projectId",
- "zone",
- "operationId"
- ],
- "response": {
- "$ref": "Empty"
- },
- "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": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the operation resides."
- },
- "operationId": {
- "location": "path",
- "description": "The server-assigned `name` of the operation.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1/projects/{projectId}/zones/{zone}/operations/{operationId}:cancel",
- "id": "container.projects.zones.operations.cancel",
- "path": "v1/projects/{projectId}/zones/{zone}/operations/{operationId}:cancel",
- "description": "Cancels the specified operation.",
- "request": {
- "$ref": "CancelOperationRequest"
- }
- },
- "list": {
- "description": "Lists all operations in a project in a specific zone or all zones.",
- "response": {
- "$ref": "ListOperationsResponse"
- },
- "parameterOrder": [
- "projectId",
- "zone"
- ],
- "httpMethod": "GET",
- "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": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "The name of the Google Compute Engine [zone](/compute/docs/zones#available)\nto return operations for, or `-` for all zones."
- }
- },
- "flatPath": "v1/projects/{projectId}/zones/{zone}/operations",
- "path": "v1/projects/{projectId}/zones/{zone}/operations",
- "id": "container.projects.zones.operations.list"
- },
- "get": {
- "flatPath": "v1/projects/{projectId}/zones/{zone}/operations/{operationId}",
- "id": "container.projects.zones.operations.get",
- "path": "v1/projects/{projectId}/zones/{zone}/operations/{operationId}",
- "description": "Gets the specified operation.",
- "httpMethod": "GET",
- "parameterOrder": [
- "projectId",
- "zone",
- "operationId"
- ],
- "response": {
- "$ref": "Operation"
- },
- "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": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840)."
- },
- "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."
- }
- }
- }
- }
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "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"
+ ]
}
}
}
@@ -2414,50 +2423,28 @@
}
},
"parameters": {
- "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": {
+ "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": {
+ "description": "Returns response with indentations and line breaks.",
"type": "boolean",
"default": "true",
- "location": "query",
- "description": "Returns response with indentations and line breaks."
+ "location": "query"
},
"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": {
"type": "string",
"location": "query",
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")."
},
- "callback": {
- "location": "query",
- "description": "JSONP",
- "type": "string"
- },
"$.xgafv": {
- "location": "query",
"enum": [
"1",
"2"
@@ -2467,7 +2454,13 @@
"enumDescriptions": [
"v1 error format",
"v2 error format"
- ]
+ ],
+ "location": "query"
+ },
+ "callback": {
+ "description": "JSONP",
+ "type": "string",
+ "location": "query"
},
"alt": {
"type": "string",
@@ -2486,28 +2479,35 @@
]
},
"access_token": {
- "type": "string",
"location": "query",
- "description": "OAuth access token."
- },
- "key": {
- "location": "query",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "description": "OAuth access token.",
"type": "string"
},
- "quotaUser": {
+ "key": {
"type": "string",
"location": "query",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters."
+ "description": "API key. 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"
+ },
+ "oauth_token": {
+ "location": "query",
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string"
+ },
+ "bearer_token": {
+ "description": "OAuth bearer token.",
+ "type": "string",
+ "location": "query"
}
- },
- "version": "v1",
- "baseUrl": "https://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": "",
- "revision": "20171127",
- "documentationLink": "https://cloud.google.com/container-engine/",
- "id": "container:v1"
+ }
}
diff --git a/container/v1beta1/container-api.json b/container/v1beta1/container-api.json
index 62063a7..3b7d3fc 100644
--- a/container/v1beta1/container-api.json
+++ b/container/v1beta1/container-api.json
@@ -1,13 +1,814 @@
{
- "basePath": "",
- "documentationLink": "https://cloud.google.com/container-engine/",
"id": "container:v1beta1",
+ "documentationLink": "https://cloud.google.com/container-engine/",
"revision": "20171127",
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
+ "SetNetworkPolicyRequest": {
+ "description": "SetNetworkPolicyRequest enables/disables network policy for a cluster.",
+ "type": "object",
+ "properties": {
+ "projectId": {
+ "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": {
+ "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"
+ },
+ "networkPolicy": {
+ "$ref": "NetworkPolicy",
+ "description": "Configuration options for the NetworkPolicy feature."
+ },
+ "name": {
+ "description": "The name (project, location, cluster id) of the cluster to set networking policy.\nSpecified in the format 'projects/*/locations/*/clusters/*'.",
+ "type": "string"
+ }
+ },
+ "id": "SetNetworkPolicyRequest"
+ },
+ "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": {
+ "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"
+ },
+ "minNodeCount": {
+ "type": "integer",
+ "description": "Minimum number of nodes in the NodePool. Must be \u003e= 1 and \u003c=\nmax_node_count.",
+ "format": "int32"
+ },
+ "enabled": {
+ "description": "Is autoscaling enabled for this node pool.",
+ "type": "boolean"
+ }
+ },
+ "id": "NodePoolAutoscaling"
+ },
+ "SetMasterAuthRequest": {
+ "type": "object",
+ "properties": {
+ "update": {
+ "$ref": "MasterAuth",
+ "description": "A description of the update."
+ },
+ "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."
+ },
+ "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": {
+ "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."
+ },
+ "clusterId": {
+ "description": "The name of the cluster to upgrade.\nThis field is deprecated, use name instead.",
+ "type": "string"
+ }
+ },
+ "id": "SetMasterAuthRequest",
+ "description": "SetMasterAuthRequest updates the admin password of a cluster."
+ },
+ "IPAllocationPolicy": {
+ "type": "object",
+ "properties": {
+ "servicesIpv4Cidr": {
+ "type": "string",
+ "description": "This field is deprecated, use services_ipv4_cidr_block."
+ },
+ "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."
+ },
+ "allowRouteOverlap": {
+ "type": "boolean",
+ "description": "If true, allow allocation of cluster CIDR ranges that overlap with certain\nkinds of network routes. By default we do not allow cluster CIDR ranges to\nintersect with any user declared routes. With allow_route_overlap == true,\nwe allow overlapping with CIDR ranges that are larger than the cluster CIDR\nrange.\n\nIf this field is set to true, then cluster and services CIDRs must be\nfully-specified (e.g. `10.96.0.0/14`, but not `/14`), which means:\n1) When `use_ip_aliases` is true, `cluster_ipv4_cidr_block` and\n `services_ipv4_cidr_block` must be fully-specified.\n2) When `use_ip_aliases` is false, `cluster.cluster_ipv4_cidr` muse be\n fully-specified."
+ },
+ "nodeIpv4Cidr": {
+ "type": "string",
+ "description": "This field is deprecated, use node_ipv4_cidr_block."
+ },
+ "clusterIpv4CidrBlock": {
+ "type": "string",
+ "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."
+ },
+ "clusterSecondaryRangeName": {
+ "type": "string",
+ "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 and\ncreate_subnetwork is false."
+ },
+ "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"
+ },
+ "createSubnetwork": {
+ "type": "boolean",
+ "description": "Whether a new subnetwork will be created automatically for the cluster.\n\nThis field is only applicable when `use_ip_aliases` is true."
+ },
+ "useIpAliases": {
+ "type": "boolean",
+ "description": "Whether alias IPs will be used for pod IPs in the cluster."
+ },
+ "servicesSecondaryRangeName": {
+ "type": "string",
+ "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 and\ncreate_subnetwork is false."
+ },
+ "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"
+ }
+ },
+ "id": "IPAllocationPolicy",
+ "description": "Configuration for controlling how IPs are allocated in the cluster."
+ },
+ "ClusterUpdate": {
+ "type": "object",
+ "properties": {
+ "desiredImageType": {
+ "type": "string",
+ "description": "The desired image type for the node pool.\nNOTE: Set the \"desired_node_pool\" field as well."
+ },
+ "desiredAddonsConfig": {
+ "$ref": "AddonsConfig",
+ "description": "Configurations for the various addons available to run in the cluster."
+ },
+ "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": {
+ "$ref": "PodSecurityPolicyConfig",
+ "description": "The desired configuration options for the PodSecurityPolicy feature."
+ },
+ "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": {
+ "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."
+ },
+ "desiredNodePoolAutoscaling": {
+ "$ref": "NodePoolAutoscaling",
+ "description": "Autoscaler configuration for the node pool specified in\ndesired_node_pool_id. If there is only one pool in the\ncluster and desired_node_pool_id is not provided then\nthe change applies to that single node pool."
+ },
+ "desiredMonitoringService": {
+ "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"
+ }
+ },
+ "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."
+ },
+ "HorizontalPodAutoscaling": {
+ "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",
+ "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."
+ },
+ "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": {
+ "cidrBlocks": {
+ "description": "cidr_blocks define up to 10 external networks that could access\nKubernetes master through HTTPS.",
+ "type": "array",
+ "items": {
+ "$ref": "CidrBlock"
+ }
+ },
+ "enabled": {
+ "description": "Whether or not master authorized networks is enabled.",
+ "type": "boolean"
+ }
+ },
+ "id": "MasterAuthorizedNetworksConfig"
+ },
+ "SetNodePoolManagementRequest": {
+ "description": "SetNodePoolManagementRequest sets the node management properties of a node\npool.",
+ "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."
+ },
+ "management": {
+ "$ref": "NodeManagement",
+ "description": "NodeManagement configuration for the node pool."
+ },
+ "clusterId": {
+ "type": "string",
+ "description": "The name of the cluster to update.\nThis field is deprecated, use name instead."
+ },
+ "nodePoolId": {
+ "type": "string",
+ "description": "The name of the node pool to update.\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"
+ },
+ "name": {
+ "description": "The name (project, location, cluster, node pool id) of the node pool to set\nmanagement properties. Specified in the format\n'projects/*/locations/*/clusters/*/nodePools/*'.",
+ "type": "string"
+ }
+ },
+ "id": "SetNodePoolManagementRequest"
+ },
+ "SetNodePoolAutoscalingRequest": {
+ "type": "object",
+ "properties": {
+ "projectId": {
+ "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use name instead.",
+ "type": "string"
+ },
+ "clusterId": {
+ "description": "The name of the cluster to upgrade.\nThis field is deprecated, use name instead.",
+ "type": "string"
+ },
+ "nodePoolId": {
+ "type": "string",
+ "description": "The name of the node pool to upgrade.\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"
+ },
+ "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"
+ },
+ "autoscaling": {
+ "$ref": "NodePoolAutoscaling",
+ "description": "Autoscaling configuration for the node pool."
+ }
+ },
+ "id": "SetNodePoolAutoscalingRequest",
+ "description": "SetNodePoolAutoscalingRequest sets the autoscaler settings of a node pool."
+ },
+ "CreateClusterRequest": {
+ "description": "CreateClusterRequest creates a cluster.",
+ "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 parent instead."
+ },
+ "cluster": {
+ "$ref": "Cluster",
+ "description": "A [cluster\nresource](/container-engine/reference/rest/v1beta1/projects.zones.clusters)"
+ },
+ "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": {
+ "type": "string",
+ "description": "The parent (project and location) where the cluster will be created.\nSpecified in the format 'projects/*/locations/*'."
+ }
+ },
+ "id": "CreateClusterRequest"
+ },
+ "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": {
+ "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"
+ },
+ "nodeVersion": {
+ "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."
+ },
+ "name": {
+ "description": "The name (project, location, cluster, node pool) of the node pool to update.\nSpecified in the format 'projects/*/locations/*/clusters/*/nodePools/*'.",
+ "type": "string"
+ },
+ "projectId": {
+ "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use name instead.",
+ "type": "string"
+ },
+ "clusterId": {
+ "description": "The name of the cluster to upgrade.\nThis field is deprecated, use name instead.",
+ "type": "string"
+ },
+ "nodePoolId": {
+ "type": "string",
+ "description": "The name of the node pool to upgrade.\nThis field is deprecated, use name instead."
+ }
+ },
+ "id": "UpdateNodePoolRequest",
+ "description": "SetNodePoolVersionRequest updates the version of a node pool."
+ },
+ "SetAddonsConfigRequest": {
+ "description": "SetAddonsRequest sets the addons associated with the cluster.",
+ "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": {
+ "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 upgrade.\nThis field is deprecated, use name instead."
+ },
+ "addonsConfig": {
+ "$ref": "AddonsConfig",
+ "description": "The desired configurations for the various addons available to run in the\ncluster."
+ },
+ "name": {
+ "type": "string",
+ "description": "The name (project, location, cluster) of the cluster to set addons.\nSpecified in the format 'projects/*/locations/*/clusters/*'."
+ }
+ },
+ "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": {
+ "key": {
+ "description": "Key for taint.",
+ "type": "string"
+ },
+ "value": {
+ "type": "string",
+ "description": "Value for taint."
+ },
+ "effect": {
+ "type": "string",
+ "enumDescriptions": [
+ "Not set",
+ "NoSchedule",
+ "PreferNoSchedule",
+ "NoExecute"
+ ],
+ "enum": [
+ "EFFECT_UNSPECIFIED",
+ "NO_SCHEDULE",
+ "PREFER_NO_SCHEDULE",
+ "NO_EXECUTE"
+ ],
+ "description": "Effect for taint."
+ }
+ },
+ "id": "NodeTaint"
+ },
+ "SetLegacyAbacRequest": {
+ "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 update.\nThis field is deprecated, use name instead.",
+ "type": "string"
+ },
+ "name": {
+ "type": "string",
+ "description": "The name (project, location, cluster id) of the cluster to set legacy abac.\nSpecified in the format 'projects/*/locations/*/clusters/*'."
+ },
+ "enabled": {
+ "description": "Whether ABAC authorization will be enabled in the cluster.",
+ "type": "boolean"
+ }
+ },
+ "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": {
+ "networkPolicyConfig": {
+ "$ref": "NetworkPolicyConfig",
+ "description": "Configuration for NetworkPolicy. This only tracks whether the addon\nis enabled or not on the Master, it does not track whether network policy\nis enabled for the nodes."
+ },
+ "horizontalPodAutoscaling": {
+ "$ref": "HorizontalPodAutoscaling",
+ "description": "Configuration for the horizontal pod autoscaling feature, which\nincreases or decreases the number of replica pods a replication controller\nhas based on the resource usage of the existing pods."
+ },
+ "httpLoadBalancing": {
+ "$ref": "HttpLoadBalancing",
+ "description": "Configuration for the HTTP (L7) load balancing controller addon, which\nmakes it easy to set up HTTP load balancers for services in a cluster."
+ },
+ "kubernetesDashboard": {
+ "$ref": "KubernetesDashboard",
+ "description": "Configuration for the Kubernetes Dashboard."
+ }
+ },
+ "id": "AddonsConfig"
+ },
+ "SetLocationsRequest": {
+ "description": "SetLocationsRequest sets the locations of the cluster.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "The name (project, location, cluster) of the cluster to set locations.\nSpecified in the format 'projects/*/locations/*/clusters/*'."
+ },
+ "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"
+ },
+ "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."
+ },
+ "clusterId": {
+ "type": "string",
+ "description": "The name of the cluster to upgrade.\nThis field is deprecated, use name instead."
+ }
+ },
+ "id": "SetLocationsRequest"
+ },
+ "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": {
+ "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"
+ },
+ "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"
+ }
+ },
+ "id": "UpdateClusterRequest",
+ "description": "UpdateClusterRequest updates the settings of a cluster."
+ },
+ "NetworkPolicyConfig": {
+ "type": "object",
+ "properties": {
+ "disabled": {
+ "description": "Whether NetworkPolicy is enabled for this cluster.",
+ "type": "boolean"
+ }
+ },
+ "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."
+ },
+ "Cluster": {
+ "type": "object",
+ "properties": {
+ "clusterIpv4Cidr": {
+ "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.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "selfLink": {
+ "type": "string",
+ "description": "[Output only] Server-defined URL for the resource."
+ },
+ "locations": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "The list of Google Compute Engine\n[locations](/compute/docs/zones#available) in which the cluster's nodes\nshould be located."
+ },
+ "nodePools": {
+ "type": "array",
+ "items": {
+ "$ref": "NodePool"
+ },
+ "description": "The node pools associated with this cluster.\nThis field should not be set if \"node_config\" or \"initial_node_count\" are\nspecified."
+ },
+ "instanceGroupUrls": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "Deprecated. Use node_pools.instance_group_urls."
+ },
+ "networkPolicy": {
+ "$ref": "NetworkPolicy",
+ "description": "Configuration options for the NetworkPolicy feature."
+ },
+ "servicesIpv4Cidr": {
+ "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. 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": {
+ "description": "[Output only] The number of nodes currently in the cluster.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "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": {
+ "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."
+ },
+ "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": {
+ "type": "string",
+ "description": "[Output only] Additional information about the current status of this\ncluster, if available."
+ },
+ "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."
+ },
+ "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."
+ },
+ "podSecurityPolicyConfig": {
+ "$ref": "PodSecurityPolicyConfig",
+ "description": "Configuration for the PodSecurityPolicy feature."
+ },
+ "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."
+ },
+ "currentNodeVersion": {
+ "type": "string",
+ "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."
+ },
+ "subnetwork": {
+ "type": "string",
+ "description": "The name of the Google Compute Engine\n[subnetwork](/compute/docs/subnetworks) to which the\ncluster is connected."
+ },
+ "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": {
+ "type": "string",
+ "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."
+ },
+ "ipAllocationPolicy": {
+ "$ref": "IPAllocationPolicy",
+ "description": "Configuration for cluster IP allocation."
+ },
+ "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."
+ },
+ "endpoint": {
+ "type": "string",
+ "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."
+ },
+ "createTime": {
+ "type": "string",
+ "description": "[Output only] The time the cluster was created, in\n[RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format."
+ }
+ },
+ "id": "Cluster",
+ "description": "A Google Kubernetes Engine cluster."
+ },
+ "CreateNodePoolRequest": {
+ "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": {
+ "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"
+ },
+ "clusterId": {
+ "type": "string",
+ "description": "The name of the cluster.\nThis field is deprecated, use parent instead."
+ },
+ "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",
+ "description": "CreateNodePoolRequest creates a node pool for a cluster."
+ },
+ "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": {
+ "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": {
+ "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": {
+ "type": "string",
+ "description": "[Output only] Base64-encoded private key used by clients to authenticate\nto the cluster endpoint."
+ },
+ "clusterCaCertificate": {
+ "type": "string",
+ "description": "[Output only] Base64-encoded public certificate that is the root of\ntrust for the cluster."
+ }
+ },
+ "id": "MasterAuth"
+ },
+ "DailyMaintenanceWindow": {
+ "type": "object",
+ "properties": {
+ "duration": {
+ "description": "[Output only] Duration of the time window, automatically chosen to be\nsmallest possible in the given scenario.",
+ "type": "string"
+ },
+ "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"
+ }
+ },
+ "id": "DailyMaintenanceWindow",
+ "description": "Time window specified for daily maintenance operations."
+ },
+ "MaintenancePolicy": {
+ "type": "object",
+ "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."
+ },
+ "ClientCertificateConfig": {
+ "type": "object",
+ "properties": {
+ "issueClientCertificate": {
+ "type": "boolean",
+ "description": "Issue a client certificate."
+ }
+ },
+ "id": "ClientCertificateConfig",
+ "description": "Configuration for client certificates on the cluster."
+ },
"SetLoggingServiceRequest": {
- "description": "SetLoggingServiceRequest sets the logging service of a cluster.",
"type": "object",
"properties": {
"projectId": {
@@ -15,28 +816,41 @@
"type": "string"
},
"zone": {
- "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.",
- "type": "string"
+ "type": "string",
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides."
},
"clusterId": {
- "type": "string",
- "description": "The name of the cluster to upgrade.\nThis field is deprecated, use name instead."
+ "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"
+ "type": "string",
+ "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"
},
"name": {
"description": "The name (project, location, cluster) of the cluster to set logging.\nSpecified in the format 'projects/*/locations/*/clusters/*'.",
"type": "string"
}
},
- "id": "SetLoggingServiceRequest"
+ "id": "SetLoggingServiceRequest",
+ "description": "SetLoggingServiceRequest sets the logging service of a cluster."
},
"SetMaintenancePolicyRequest": {
"description": "SetMaintenancePolicyRequest sets the maintenance policy for a cluster.",
"type": "object",
"properties": {
+ "projectId": {
+ "type": "string",
+ "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.",
+ "type": "string"
+ },
+ "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."
@@ -44,18 +858,6 @@
"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": {
- "type": "string",
- "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 update.",
- "type": "string"
}
},
"id": "SetMaintenancePolicyRequest"
@@ -71,23 +873,18 @@
"type": "object",
"properties": {
"nodePools": {
- "description": "A list of node pools for a cluster.",
"type": "array",
"items": {
"$ref": "NodePool"
- }
+ },
+ "description": "A list of node pools for a cluster."
}
},
"id": "ListNodePoolsResponse"
},
"CompleteIPRotationRequest": {
- "description": "CompleteIPRotationRequest moves the cluster master back into single-IP mode.",
"type": "object",
"properties": {
- "name": {
- "type": "string",
- "description": "The name (project, location, cluster id) of the cluster to complete IP rotation.\nSpecified in the format 'projects/*/locations/*/clusters/*'."
- },
"projectId": {
"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."
@@ -97,50 +894,79 @@
"type": "string"
},
"clusterId": {
- "description": "The name of the cluster.\nThis field is deprecated, use name instead.",
+ "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."
},
"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"
+ "type": "string",
+ "description": "The name (project, location, cluster id) of the cluster to start IP rotation.\nSpecified in the format 'projects/*/locations/*/clusters/*'."
},
"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",
"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",
+ "description": "The name of the cluster.\nThis field is deprecated, use name instead."
+ }
+ },
+ "id": "StartIPRotationRequest"
+ },
+ "SetLabelsRequest": {
+ "type": "object",
+ "properties": {
+ "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"
+ },
+ "projectId": {
+ "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."
+ },
+ "clusterId": {
+ "type": "string",
+ "description": "The name of the cluster.\nThis field is deprecated, use name instead."
+ },
+ "labelFingerprint": {
+ "type": "string",
+ "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."
+ },
+ "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": "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"
+ "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": {
"status": {
- "enum": [
- "STATUS_UNSPECIFIED",
- "PROVISIONING",
- "RUNNING",
- "RUNNING_WITH_ERROR",
- "RECONCILING",
- "STOPPING",
- "ERROR"
- ],
- "description": "[Output only] The status of the nodes in this pool instance.",
"type": "string",
"enumDescriptions": [
"Not set.",
@@ -150,11 +976,21 @@
"The RECONCILING state indicates that some work is actively being done on\nthe node pool, such as upgrading node software. Details can\nbe found in the `statusMessage` field.",
"The STOPPING state indicates the node pool is being deleted.",
"The ERROR state indicates the node pool may be unusable. Details\ncan be found in the `statusMessage` field."
- ]
+ ],
+ "enum": [
+ "STATUS_UNSPECIFIED",
+ "PROVISIONING",
+ "RUNNING",
+ "RUNNING_WITH_ERROR",
+ "RECONCILING",
+ "STOPPING",
+ "ERROR"
+ ],
+ "description": "[Output only] The status of the nodes in this pool instance."
},
"config": {
- "description": "The node configuration of the pool.",
- "$ref": "NodeConfig"
+ "$ref": "NodeConfig",
+ "description": "The node configuration of the pool."
},
"statusMessage": {
"description": "[Output only] Additional information about the current status of this\nnode pool instance, if available.",
@@ -174,16 +1010,16 @@
"type": "integer"
},
"management": {
- "description": "NodeManagement configuration for this NodePool.",
- "$ref": "NodeManagement"
+ "$ref": "NodeManagement",
+ "description": "NodeManagement configuration for this NodePool."
},
"selfLink": {
- "description": "[Output only] Server-defined URL for the resource.",
- "type": "string"
+ "type": "string",
+ "description": "[Output only] Server-defined URL for the resource."
},
"version": {
- "description": "The version of the Kubernetes of this node.",
- "type": "string"
+ "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.",
@@ -195,42 +1031,7 @@
},
"id": "NodePool"
},
- "SetLabelsRequest": {
- "description": "SetLabelsRequest sets the Google Cloud Platform labels on a Google Container\nEngine cluster, which will in turn set them for Google Compute Engine\nresources used by that cluster",
- "type": "object",
- "properties": {
- "name": {
- "type": "string",
- "description": "The name (project, location, cluster id) of the cluster to set labels.\nSpecified in the format 'projects/*/locations/*/clusters/*'."
- },
- "resourceLabels": {
- "description": "The labels to set for that cluster.",
- "type": "object",
- "additionalProperties": {
- "type": "string"
- }
- },
- "projectId": {
- "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."
- },
- "clusterId": {
- "description": "The name of the cluster.\nThis field is deprecated, use name instead.",
- "type": "string"
- },
- "labelFingerprint": {
- "description": "The fingerprint of the previous set of labels for this resource,\nused to detect conflicts. The fingerprint is initially generated by\nKubernetes Engine and changes after every request to modify or update\nlabels. You must always provide an up-to-date fingerprint hash when\nupdating or changing labels. Make a \u003ccode\u003eget()\u003c/code\u003e request to the\nresource to get the latest fingerprint.",
- "type": "string"
- },
- "zone": {
- "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."
- }
- },
- "id": "SetLabelsRequest"
- },
"NodeManagement": {
- "description": "NodeManagement defines the set of node management services turned on for the\nnode pool.",
"type": "object",
"properties": {
"autoUpgrade": {
@@ -246,73 +1047,91 @@
"description": "Specifies the Auto Upgrade knobs for the node pool."
}
},
- "id": "NodeManagement"
+ "id": "NodeManagement",
+ "description": "NodeManagement defines the set of node management services turned on for the\nnode pool."
},
"CancelOperationRequest": {
"type": "object",
"properties": {
- "name": {
- "description": "The name (project, location, operation id) of the operation to cancel.\nSpecified in the format 'projects/*/locations/*/operations/*'.",
- "type": "string"
- },
- "operationId": {
- "description": "The server-assigned `name` of the operation.\nThis field is deprecated, use name instead.",
- "type": "string"
- },
"projectId": {
- "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use name instead.",
- "type": "string"
+ "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 operation resides.\nThis field is deprecated, use name instead.",
"type": "string"
+ },
+ "name": {
+ "type": "string",
+ "description": "The name (project, location, operation id) of the operation to cancel.\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"
}
},
"id": "CancelOperationRequest",
"description": "CancelOperationRequest cancels a single operation."
},
"KubernetesDashboard": {
- "id": "KubernetesDashboard",
- "description": "Configuration for the Kubernetes Dashboard.",
"type": "object",
"properties": {
"disabled": {
"description": "Whether the Kubernetes Dashboard is enabled for this cluster.",
"type": "boolean"
}
- }
+ },
+ "id": "KubernetesDashboard",
+ "description": "Configuration for the Kubernetes Dashboard."
},
"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": {
- "statusMessage": {
- "description": "If an error has occurred, a textual description of the error.",
- "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"
},
- "selfLink": {
- "description": "Server-defined URL for the resource.",
- "type": "string"
- },
- "detail": {
- "description": "Detailed operation progress, if available.",
- "type": "string"
- },
- "targetLink": {
+ "statusMessage": {
"type": "string",
- "description": "Server-defined URL for the target of the operation."
+ "description": "If an error has occurred, a textual description of the error."
+ },
+ "selfLink": {
+ "type": "string",
+ "description": "Server-defined URL for the resource."
+ },
+ "endTime": {
+ "type": "string",
+ "description": "[Output only] The time the operation completed, in\n[RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format."
},
"location": {
"description": "[Output only] The name of the Google Compute Engine\n[zone](/compute/docs/regions-zones/regions-zones#available) or\n[region](/compute/docs/regions-zones/regions-zones#available) in which\nthe cluster resides.",
"type": "string"
},
- "endTime": {
- "description": "[Output only] The time the operation completed, in\n[RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.",
+ "targetLink": {
+ "description": "Server-defined URL for the target of the operation.",
+ "type": "string"
+ },
+ "detail": {
+ "description": "Detailed operation progress, if available.",
"type": "string"
},
"operationType": {
@@ -358,43 +1177,26 @@
]
},
"startTime": {
- "description": "[Output only] The time the operation started, in\n[RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.",
- "type": "string"
+ "type": "string",
+ "description": "[Output only] The time the operation started, in\n[RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format."
},
"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": {
- "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."
- ]
}
- }
+ },
+ "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",
- "description": "MaintenanceWindow defines the maintenance window to be used for the cluster.",
- "type": "object"
+ "id": "MaintenanceWindow"
},
"RollbackNodePoolUpgradeRequest": {
"description": "RollbackNodePoolUpgradeRequest rollbacks the previously Aborted or Failed\nNodePool upgrade. This will be an no-op if the last upgrade successfully\ncompleted.",
@@ -405,33 +1207,33 @@
"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"
+ "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 rollback.\nThis field is deprecated, use name instead.",
- "type": "string"
+ "type": "string",
+ "description": "The name of the cluster to rollback.\nThis field is deprecated, use name instead."
},
"nodePoolId": {
- "description": "The name of the node pool to rollback.\nThis field is deprecated, use name instead.",
- "type": "string"
+ "type": "string",
+ "description": "The name of the node pool to rollback.\nThis field is deprecated, use name instead."
}
},
"id": "RollbackNodePoolUpgradeRequest"
},
"NetworkPolicy": {
- "description": "Configuration options for the NetworkPolicy feature.\nhttps://kubernetes.io/docs/concepts/services-networking/networkpolicies/",
"type": "object",
"properties": {
"enabled": {
- "description": "Whether network policy is enabled on the cluster.",
- "type": "boolean"
+ "type": "boolean",
+ "description": "Whether network policy is enabled on the cluster."
},
"provider": {
+ "type": "string",
"enumDescriptions": [
"Not set",
"Tigera (Calico Felix)."
@@ -440,41 +1242,40 @@
"PROVIDER_UNSPECIFIED",
"CALICO"
],
- "description": "The selected network policy provider.",
- "type": "string"
+ "description": "The selected network policy provider."
}
},
- "id": "NetworkPolicy"
+ "id": "NetworkPolicy",
+ "description": "Configuration options for the NetworkPolicy feature.\nhttps://kubernetes.io/docs/concepts/services-networking/networkpolicies/"
},
"UpdateMasterRequest": {
"description": "UpdateMasterRequest updates the master of the cluster.",
"type": "object",
"properties": {
- "name": {
- "type": "string",
- "description": "The name (project, location, cluster) of the cluster to update.\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).",
"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"
+ "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."
},
"masterVersion": {
- "type": "string",
- "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."
+ "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"
},
"clusterId": {
- "description": "The name of the cluster to upgrade.\nThis field is deprecated, use name instead.",
+ "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"
}
},
"id": "UpdateMasterRequest"
},
"ListOperationsResponse": {
- "description": "ListOperationsResponse is the result of ListOperationsRequest.",
"type": "object",
"properties": {
"operations": {
@@ -492,22 +1293,23 @@
}
}
},
- "id": "ListOperationsResponse"
+ "id": "ListOperationsResponse",
+ "description": "ListOperationsResponse is the result of ListOperationsRequest."
},
"CidrBlock": {
+ "description": "CidrBlock contains an optional name and one CIDR block.",
"type": "object",
"properties": {
"displayName": {
- "description": "display_name is an optional field for users to identify CIDR blocks.",
- "type": "string"
+ "type": "string",
+ "description": "display_name is an optional field for users to identify CIDR blocks."
},
"cidrBlock": {
"description": "cidr_block must be specified in CIDR notation.",
"type": "string"
}
},
- "id": "CidrBlock",
- "description": "CidrBlock contains an optional name and one CIDR block."
+ "id": "CidrBlock"
},
"SetMonitoringServiceRequest": {
"description": "SetMonitoringServiceRequest sets the monitoring service of a cluster.",
@@ -518,16 +1320,16 @@
"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"
+ "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"
},
"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"
+ "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"
},
"name": {
"description": "The name (project, location, cluster) of the cluster to set monitoring.\nSpecified in the format 'projects/*/locations/*/clusters/*'.",
@@ -537,49 +1339,44 @@
"id": "SetMonitoringServiceRequest"
},
"ServerConfig": {
- "id": "ServerConfig",
"description": "Kubernetes Engine service configuration.",
"type": "object",
"properties": {
"validMasterVersions": {
- "description": "List of valid master versions.",
"type": "array",
"items": {
"type": "string"
- }
+ },
+ "description": "List of valid master versions."
},
"defaultClusterVersion": {
- "type": "string",
- "description": "Version of Kubernetes the service deploys by default."
+ "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"
- }
+ },
+ "description": "List of valid node upgrade target versions."
},
"validImageTypes": {
- "description": "List of valid image types.",
"type": "array",
"items": {
"type": "string"
- }
+ },
+ "description": "List of valid image types."
}
- }
+ },
+ "id": "ServerConfig"
},
"NodeConfig": {
- "description": "Parameters that describe the nodes in a cluster.",
"type": "object",
"properties": {
- "imageType": {
- "type": "string",
- "description": "The image type to use for this node. Note that for a given image type,\nthe latest version of it will be used."
- },
"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",
@@ -588,11 +1385,11 @@
}
},
"taints": {
- "description": "List of kubernetes taints to be applied to each node.\n\nFor more information, including usage and the valid values, see:\nhttps://kubernetes.io/docs/concepts/configuration/taint-and-toleration/",
"type": "array",
"items": {
"$ref": "NodeTaint"
- }
+ },
+ "description": "List of kubernetes taints to be applied to each node.\n\nFor more information, including usage and the valid values, see:\nhttps://kubernetes.io/docs/concepts/configuration/taint-and-toleration/"
},
"labels": {
"additionalProperties": {
@@ -602,20 +1399,20 @@
"type": "object"
},
"diskSizeGb": {
+ "type": "integer",
"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"
+ "format": "int32"
},
"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"
- }
+ },
+ "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."
},
"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"
+ "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)",
@@ -626,79 +1423,85 @@
"type": "boolean"
},
"localSsdCount": {
+ "type": "integer",
"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"
+ "format": "int32"
},
"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.",
"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"
}
},
- "id": "NodeConfig"
+ "id": "NodeConfig",
+ "description": "Parameters that describe the nodes in a cluster."
},
"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"
+ },
+ "description": {
+ "type": "string",
+ "description": "[Output only] This field is set when upgrades are about to commence\nwith the description of the upgrade."
}
},
- "id": "AutoUpgradeOptions",
- "description": "AutoUpgradeOptions defines the set of options for the user to control how\nthe Auto Upgrades will proceed.",
- "type": "object"
+ "id": "AutoUpgradeOptions"
},
"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"
+ "id": "ListClustersResponse",
+ "description": "ListClustersResponse is the result of ListClustersRequest."
},
"PodSecurityPolicyConfig": {
- "description": "Configuration for the PodSecurityPolicy feature.",
"type": "object",
"properties": {
"enabled": {
- "description": "Enable the PodSecurityPolicy controller for this cluster. If enabled, pods\nmust be valid under a PodSecurityPolicy to be created.",
- "type": "boolean"
+ "type": "boolean",
+ "description": "Enable the PodSecurityPolicy controller for this cluster. If enabled, pods\nmust be valid under a PodSecurityPolicy to be created."
}
},
- "id": "PodSecurityPolicyConfig"
+ "id": "PodSecurityPolicyConfig",
+ "description": "Configuration for the PodSecurityPolicy feature."
},
"HttpLoadBalancing": {
+ "type": "object",
"properties": {
"disabled": {
"type": "boolean",
@@ -706,811 +1509,7 @@
}
},
"id": "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"
- },
- "SetMasterAuthRequest": {
- "description": "SetMasterAuthRequest updates the admin password of a cluster.",
- "type": "object",
- "properties": {
- "update": {
- "$ref": "MasterAuth",
- "description": "A description of the update."
- },
- "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": {
- "enum": [
- "UNKNOWN",
- "SET_PASSWORD",
- "GENERATE_PASSWORD",
- "SET_USERNAME"
- ],
- "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."
- ]
- },
- "projectId": {
- "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use name instead.",
- "type": "string"
- },
- "clusterId": {
- "description": "The name of the cluster to upgrade.\nThis field is deprecated, use name instead.",
- "type": "string"
- }
- },
- "id": "SetMasterAuthRequest"
- },
- "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": {
- "minNodeCount": {
- "description": "Minimum number of nodes in the NodePool. Must be \u003e= 1 and \u003c=\nmax_node_count.",
- "format": "int32",
- "type": "integer"
- },
- "enabled": {
- "description": "Is autoscaling enabled for this node pool.",
- "type": "boolean"
- },
- "maxNodeCount": {
- "description": "Maximum number of nodes in the NodePool. Must be \u003e= min_node_count. There\nhas to enough quota to scale up the cluster.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "NodePoolAutoscaling"
- },
- "SetNetworkPolicyRequest": {
- "description": "SetNetworkPolicyRequest enables/disables network policy for a cluster.",
- "type": "object",
- "properties": {
- "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"
- },
- "projectId": {
- "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": {
- "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": {
- "type": "string",
- "description": "The name of the cluster.\nThis field is deprecated, use name instead."
- }
- },
- "id": "SetNetworkPolicyRequest"
- },
- "ClusterUpdate": {
- "description": "ClusterUpdate describes an update to the cluster. Exactly one update can\nbe applied to a cluster with each request, so at most one field can be\nprovided.",
- "type": "object",
- "properties": {
- "desiredImageType": {
- "description": "The desired image type for the node pool.\nNOTE: Set the \"desired_node_pool\" field as well.",
- "type": "string"
- },
- "desiredAddonsConfig": {
- "$ref": "AddonsConfig",
- "description": "Configurations for the various addons available to run in the cluster."
- },
- "desiredNodePoolId": {
- "description": "The node pool to be upgraded. This field is mandatory if\n\"desired_node_version\", \"desired_image_family\" or\n\"desired_node_pool_autoscaling\" is specified and there is more than one\nnode pool on the cluster.",
- "type": "string"
- },
- "desiredNodeVersion": {
- "description": "The Kubernetes version to change the nodes to (typically an\nupgrade). Use `-` to upgrade to the latest version supported by\nthe server.",
- "type": "string"
- },
- "desiredMasterVersion": {
- "description": "The Kubernetes version to change the master to. The only valid value is the\nlatest supported version. Use \"-\" to have the server automatically select\nthe latest version.",
- "type": "string"
- },
- "desiredPodSecurityPolicyConfig": {
- "$ref": "PodSecurityPolicyConfig",
- "description": "The desired configuration options for the PodSecurityPolicy feature."
- },
- "desiredMasterAuthorizedNetworksConfig": {
- "$ref": "MasterAuthorizedNetworksConfig",
- "description": "The 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": {
- "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"
- }
- },
- "desiredMonitoringService": {
- "description": "The monitoring service the cluster should use to write metrics.\nCurrently available options:\n\n* \"monitoring.googleapis.com\" - the Google Cloud Monitoring service\n* \"none\" - no metrics will be exported from the cluster",
- "type": "string"
- }
- },
- "id": "ClusterUpdate"
- },
- "IPAllocationPolicy": {
- "properties": {
- "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"
- },
- "servicesIpv4Cidr": {
- "description": "This field is deprecated, use services_ipv4_cidr_block.",
- "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"
- },
- "allowRouteOverlap": {
- "description": "If true, allow allocation of cluster CIDR ranges that overlap with certain\nkinds of network routes. By default we do not allow cluster CIDR ranges to\nintersect with any user declared routes. With allow_route_overlap == true,\nwe allow overlapping with CIDR ranges that are larger than the cluster CIDR\nrange.\n\nIf this field is set to true, then cluster and services CIDRs must be\nfully-specified (e.g. `10.96.0.0/14`, but not `/14`), which means:\n1) When `use_ip_aliases` is true, `cluster_ipv4_cidr_block` and\n `services_ipv4_cidr_block` must be fully-specified.\n2) When `use_ip_aliases` is false, `cluster.cluster_ipv4_cidr` muse be\n fully-specified.",
- "type": "boolean"
- },
- "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 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"
- },
- "createSubnetwork": {
- "description": "Whether a new subnetwork will be created automatically for the cluster.\n\nThis field is only applicable when `use_ip_aliases` is true.",
- "type": "boolean"
- },
- "useIpAliases": {
- "description": "Whether alias IPs will be used for pod IPs in the cluster.",
- "type": "boolean"
- },
- "servicesSecondaryRangeName": {
- "type": "string",
- "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 and\ncreate_subnetwork is false."
- }
- },
- "id": "IPAllocationPolicy",
- "description": "Configuration for controlling how IPs are allocated in the cluster.",
- "type": "object"
- },
- "HorizontalPodAutoscaling": {
- "description": "Configuration options for the horizontal pod autoscaling feature, which\nincreases or decreases the number of replica pods a replication controller\nhas based on the resource usage of the existing pods.",
- "type": "object",
- "properties": {
- "disabled": {
- "description": "Whether the Horizontal Pod Autoscaling feature is enabled in the cluster.\nWhen enabled, it ensures that a Heapster pod is running in the cluster,\nwhich is also used by the Cloud Monitoring service.",
- "type": "boolean"
- }
- },
- "id": "HorizontalPodAutoscaling"
- },
- "SetNodePoolManagementRequest": {
- "properties": {
- "name": {
- "description": "The name (project, location, cluster, node pool id) of the node pool to set\nmanagement properties. Specified in the format\n'projects/*/locations/*/clusters/*/nodePools/*'.",
- "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"
- },
- "management": {
- "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.",
- "type": "string"
- },
- "nodePoolId": {
- "description": "The name of the node pool to update.\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."
- }
- },
- "id": "SetNodePoolManagementRequest",
- "description": "SetNodePoolManagementRequest sets the node management properties of a node\npool.",
- "type": "object"
- },
- "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"
- },
- "SetNodePoolAutoscalingRequest": {
- "properties": {
- "clusterId": {
- "description": "The name of the cluster to upgrade.\nThis field is deprecated, use name instead.",
- "type": "string"
- },
- "nodePoolId": {
- "description": "The name of the node pool to upgrade.\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."
- },
- "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"
- },
- "autoscaling": {
- "$ref": "NodePoolAutoscaling",
- "description": "Autoscaling configuration for the node pool."
- },
- "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."
- }
- },
- "id": "SetNodePoolAutoscalingRequest",
- "description": "SetNodePoolAutoscalingRequest sets the autoscaler settings of a node pool.",
- "type": "object"
- },
- "CreateClusterRequest": {
- "id": "CreateClusterRequest",
- "description": "CreateClusterRequest creates a 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 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"
- },
- "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"
- },
- "cluster": {
- "description": "A [cluster\nresource](/container-engine/reference/rest/v1beta1/projects.zones.clusters)",
- "$ref": "Cluster"
- }
- }
- },
- "AcceleratorConfig": {
- "description": "AcceleratorConfig represents a Hardware Accelerator request.",
- "type": "object",
- "properties": {
- "acceleratorCount": {
- "description": "The number of the accelerator cards exposed to an instance.",
- "format": "int64",
- "type": "string"
- },
- "acceleratorType": {
- "description": "The accelerator type resource name. List of supported accelerators\n[here](/compute/docs/gpus/#Introduction)",
- "type": "string"
- }
- },
- "id": "AcceleratorConfig"
- },
- "UpdateNodePoolRequest": {
- "properties": {
- "nodeVersion": {
- "description": "The Kubernetes version to change the nodes to (typically an\nupgrade). Use `-` to upgrade to the latest version supported by\nthe server.",
- "type": "string"
- },
- "name": {
- "description": "The name (project, location, cluster, node pool) of the node pool to update.\nSpecified in the format 'projects/*/locations/*/clusters/*/nodePools/*'.",
- "type": "string"
- },
- "projectId": {
- "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use name instead.",
- "type": "string"
- },
- "clusterId": {
- "description": "The name of the cluster to upgrade.\nThis field is deprecated, use name instead.",
- "type": "string"
- },
- "nodePoolId": {
- "description": "The name of the node pool to upgrade.\nThis field is deprecated, use name instead.",
- "type": "string"
- },
- "imageType": {
- "type": "string",
- "description": "The desired image type for the node pool."
- },
- "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."
- }
- },
- "id": "UpdateNodePoolRequest",
- "description": "SetNodePoolVersionRequest updates the version of a node pool.",
- "type": "object"
- },
- "SetAddonsConfigRequest": {
- "description": "SetAddonsRequest sets the addons associated with the cluster.",
- "type": "object",
- "properties": {
- "name": {
- "description": "The name (project, location, cluster) of the cluster to set addons.\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"
- },
- "clusterId": {
- "type": "string",
- "description": "The name of the cluster to upgrade.\nThis field is deprecated, use name instead."
- },
- "addonsConfig": {
- "$ref": "AddonsConfig",
- "description": "The desired configurations for the various addons available to run in the\ncluster."
- }
- },
- "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": {
- "key": {
- "description": "Key for taint.",
- "type": "string"
- },
- "value": {
- "description": "Value for taint.",
- "type": "string"
- },
- "effect": {
- "enum": [
- "EFFECT_UNSPECIFIED",
- "NO_SCHEDULE",
- "PREFER_NO_SCHEDULE",
- "NO_EXECUTE"
- ],
- "description": "Effect for taint.",
- "type": "string",
- "enumDescriptions": [
- "Not set",
- "NoSchedule",
- "PreferNoSchedule",
- "NoExecute"
- ]
- }
- },
- "id": "NodeTaint"
- },
- "SetLegacyAbacRequest": {
- "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",
- "description": "SetLegacyAbacRequest enables or disables the ABAC authorization mechanism for\na cluster.",
- "type": "object"
- },
- "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": {
- "description": "Configuration for the HTTP (L7) load balancing controller addon, which\nmakes it easy to set up HTTP load balancers for services in a cluster.",
- "$ref": "HttpLoadBalancing"
- },
- "kubernetesDashboard": {
- "$ref": "KubernetesDashboard",
- "description": "Configuration for the Kubernetes Dashboard."
- },
- "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": {
- "id": "SetLocationsRequest",
- "description": "SetLocationsRequest sets the locations of the cluster.",
- "type": "object",
- "properties": {
- "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": {
- "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": {
- "description": "The name of the cluster to upgrade.\nThis field is deprecated, use name instead.",
- "type": "string"
- }
- }
- },
- "NetworkPolicyConfig": {
- "properties": {
- "disabled": {
- "description": "Whether NetworkPolicy is enabled for this cluster.",
- "type": "boolean"
- }
- },
- "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"
- },
- "UpdateClusterRequest": {
- "description": "UpdateClusterRequest updates the settings of a cluster.",
- "type": "object",
- "properties": {
- "update": {
- "$ref": "ClusterUpdate",
- "description": "A description of the update."
- },
- "name": {
- "description": "The name (project, location, cluster) of the cluster to update.\nSpecified in the format 'projects/*/locations/*/clusters/*'.",
- "type": "string"
- },
- "projectId": {
- "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use name instead.",
- "type": "string"
- },
- "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"
- }
- },
- "id": "UpdateClusterRequest"
- },
- "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": {
- "type": "string",
- "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."
- },
- "loggingService": {
- "type": "string",
- "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."
- },
- "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": {
- "$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": {
- "type": "string",
- "description": "[Output only] The current software version of the master endpoint."
- },
- "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."
- },
- "podSecurityPolicyConfig": {
- "description": "Configuration for the PodSecurityPolicy feature.",
- "$ref": "PodSecurityPolicyConfig"
- },
- "status": {
- "enum": [
- "STATUS_UNSPECIFIED",
- "PROVISIONING",
- "RUNNING",
- "RECONCILING",
- "STOPPING",
- "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."
- ]
- },
- "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": {
- "description": "Configure the maintenance policy for this cluster.",
- "$ref": "MaintenancePolicy"
- },
- "initialClusterVersion": {
- "description": "The initial Kubernetes version for this cluster. Valid versions are those\nfound in validMasterVersions returned by getServerConfig. The version can\nbe upgraded over time; such upgrades are reflected in\ncurrentMasterVersion and currentNodeVersion.",
- "type": "string"
- },
- "ipAllocationPolicy": {
- "$ref": "IPAllocationPolicy",
- "description": "Configuration for cluster IP allocation."
- },
- "endpoint": {
- "description": "[Output only] The IP address of this cluster's master endpoint.\nThe endpoint can be accessed from the internet at\n`https://username:password@endpoint/`.\n\nSee the `masterAuth` property of this resource for username and\npassword information.",
- "type": "string"
- },
- "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": {
- "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.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "nodePools": {
- "description": "The node pools associated with this cluster.\nThis field should not be set if \"node_config\" or \"initial_node_count\" are\nspecified.",
- "type": "array",
- "items": {
- "$ref": "NodePool"
- }
- },
- "instanceGroupUrls": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "description": "Deprecated. Use node_pools.instance_group_urls."
- },
- "networkPolicy": {
- "description": "Configuration options for the NetworkPolicy feature.",
- "$ref": "NetworkPolicy"
- },
- "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": {
- "description": "An optional description of this cluster.",
- "type": "string"
- },
- "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": {
- "clusterId": {
- "description": "The name of the cluster.\nThis field is deprecated, use parent instead.",
- "type": "string"
- },
- "nodePool": {
- "description": "The node pool to create.",
- "$ref": "NodePool"
- },
- "parent": {
- "description": "The parent (project, location, cluster id) where the node pool will be created.\nSpecified in the format 'projects/*/locations/*/clusters/*/nodePools/*'.",
- "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": {
- "properties": {
- "startTime": {
- "type": "string",
- "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."
- },
- "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"
- },
- "MaintenancePolicy": {
- "description": "MaintenancePolicy defines the maintenance policy to be used for the cluster.",
- "type": "object",
- "properties": {
- "window": {
- "description": "Specifies the maintenance window in which maintenance may be performed.",
- "$ref": "MaintenanceWindow"
- }
- },
- "id": "MaintenancePolicy"
- },
- "ClientCertificateConfig": {
- "properties": {
- "issueClientCertificate": {
- "description": "Issue a client certificate.",
- "type": "boolean"
- }
- },
- "id": "ClientCertificateConfig",
- "description": "Configuration for client certificates on the cluster.",
- "type": "object"
+ "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."
}
},
"protocol": "rest",
@@ -1538,55 +1537,78 @@
"resources": {
"projects": {
"resources": {
- "locations": {
+ "zones": {
+ "methods": {
+ "getServerconfig": {
+ "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/serverconfig",
+ "id": "container.projects.zones.getServerconfig",
+ "path": "v1beta1/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).\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."
+ },
+ "name": {
+ "location": "query",
+ "description": "The name (project and location) of the server config to get\nSpecified in the format 'projects/*/locations/*'.",
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ }
+ },
"resources": {
- "clusters": {
+ "operations": {
"methods": {
- "setLogging": {
- "path": "v1beta1/{+name}:setLogging",
- "id": "container.projects.locations.clusters.setLogging",
- "description": "Sets the logging service of a specific cluster.",
+ "cancel": {
"request": {
- "$ref": "SetLoggingServiceRequest"
+ "$ref": "CancelOperationRequest"
},
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "name"
- ],
+ "description": "Cancels the specified operation.",
"httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
+ "parameterOrder": [
+ "projectId",
+ "zone",
+ "operationId"
],
+ "response": {
+ "$ref": "Empty"
+ },
"parameters": {
- "name": {
+ "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",
- "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$",
"location": "path",
- "description": "The name (project, location, cluster) of the cluster to set logging.\nSpecified in the format 'projects/*/locations/*/clusters/*'."
- }
- },
- "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:setLogging"
- },
- "setMasterAuth": {
- "request": {
- "$ref": "SetMasterAuthRequest"
- },
- "description": "Used to set master auth materials. Currently supports :-\nChanging the admin password of a specific cluster.\nThis can be either via password generation or explicitly set.\nModify basic_auth.csv and reset the K8S API server.",
- "httpMethod": "POST",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Operation"
- },
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$",
+ "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."
+ },
+ "operationId": {
"location": "path",
- "description": "The name (project, location, cluster) of the cluster to set auth.\nSpecified in the format 'projects/*/locations/*/clusters/*'.",
+ "description": "The server-assigned `name` of the operation.\nThis field is deprecated, use name instead.",
"required": true,
"type": "string"
}
@@ -1594,106 +1616,103 @@
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
- "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:setMasterAuth",
- "id": "container.projects.locations.clusters.setMasterAuth",
- "path": "v1beta1/{+name}:setMasterAuth"
+ "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": {
- "description": "Lists all clusters owned by a project in either the specified zone or all\nzones.",
"httpMethod": "GET",
"parameterOrder": [
- "parent"
+ "projectId",
+ "zone"
],
"response": {
- "$ref": "ListClustersResponse"
+ "$ref": "ListOperationsResponse"
},
"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.",
- "type": "string",
- "location": "query"
- },
- "zone": {
- "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides, or \"-\" for all zones.\nThis field is deprecated, use parent instead.",
- "type": "string",
- "location": "query"
- },
- "parent": {
- "location": "path",
- "description": "The parent (project and location) where the clusters will be listed.\nSpecified in the format 'projects/*/locations/*'.\nLocation \"-\" matches all zones and all regions.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+$"
- }
- },
- "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters",
- "id": "container.projects.locations.clusters.list",
- "path": "v1beta1/{+parent}/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"
- },
- "httpMethod": "POST",
- "parameterOrder": [
- "parent"
- ],
- "response": {
- "$ref": "Operation"
- },
- "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"
+ },
+ "zone": {
+ "required": true,
+ "type": "string",
+ "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."
+ },
+ "parent": {
+ "type": "string",
+ "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."
}
},
- "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters",
- "id": "container.projects.locations.clusters.create",
- "path": "v1beta1/{+parent}/clusters"
+ "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/operations",
+ "id": "container.projects.zones.operations.list",
+ "path": "v1beta1/projects/{projectId}/zones/{zone}/operations",
+ "description": "Lists all operations in a project in a specific zone or all zones."
},
- "completeIpRotation": {
- "description": "Completes master IP rotation.",
- "request": {
- "$ref": "CompleteIPRotationRequest"
- },
- "httpMethod": "POST",
- "parameterOrder": [
- "name"
- ],
+ "get": {
"response": {
"$ref": "Operation"
},
+ "parameterOrder": [
+ "projectId",
+ "zone",
+ "operationId"
+ ],
+ "httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
"name": {
+ "type": "string",
+ "location": "query",
+ "description": "The name (project, location, operation id) of the operation to get.\nSpecified in the format 'projects/*/locations/*/operations/*'."
+ },
+ "operationId": {
"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/*'."
+ "description": "The server-assigned `name` of the operation.\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"
+ },
+ "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/{projectsId}/locations/{locationsId}/clusters/{clustersId}:completeIpRotation",
- "id": "container.projects.locations.clusters.completeIpRotation",
- "path": "v1beta1/{+name}:completeIpRotation"
- },
+ "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."
+ }
+ }
+ },
+ "clusters": {
+ "methods": {
"get": {
+ "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.",
"httpMethod": "GET",
"parameterOrder": [
- "name"
+ "projectId",
+ "zone",
+ "clusterId"
],
"response": {
"$ref": "Cluster"
@@ -1702,906 +1721,159 @@
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
- "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"
- },
"name": {
- "required": true,
"type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$",
- "location": "path",
+ "location": "query",
"description": "The name (project, location, cluster) of the cluster to retrieve.\nSpecified in the format 'projects/*/locations/*/clusters/*'."
},
"projectId": {
- "location": "query",
+ "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.",
- "type": "string"
- }
- },
- "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}",
- "id": "container.projects.locations.clusters.get",
- "path": "v1beta1/{+name}"
- },
- "setNetworkPolicy": {
- "request": {
- "$ref": "SetNetworkPolicyRequest"
- },
- "description": "Enables/Disables Network Policy for a cluster.",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "POST",
- "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",
- "path": "v1beta1/{+name}:setNetworkPolicy",
- "id": "container.projects.locations.clusters.setNetworkPolicy"
- },
- "setAddons": {
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "POST",
- "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"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:setAddons",
- "path": "v1beta1/{+name}:setAddons",
- "id": "container.projects.locations.clusters.setAddons",
- "request": {
- "$ref": "SetAddonsConfigRequest"
- },
- "description": "Sets the addons of a specific cluster."
- },
- "setMonitoring": {
- "httpMethod": "POST",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Operation"
- },
- "parameters": {
- "name": {
- "location": "path",
- "description": "The name (project, location, cluster) of the cluster to set monitoring.\nSpecified in the format 'projects/*/locations/*/clusters/*'.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:setMonitoring",
- "id": "container.projects.locations.clusters.setMonitoring",
- "path": "v1beta1/{+name}:setMonitoring",
- "request": {
- "$ref": "SetMonitoringServiceRequest"
- },
- "description": "Sets the monitoring service of a specific cluster."
- },
- "startIpRotation": {
- "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 start IP rotation.\nSpecified in the format 'projects/*/locations/*/clusters/*'.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$"
- }
- },
- "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": {
- "id": "container.projects.locations.clusters.setMaintenancePolicy",
- "path": "v1beta1/{+name}:setMaintenancePolicy",
- "description": "Sets the maintenance policy for a cluster.",
- "request": {
- "$ref": "SetMaintenancePolicyRequest"
- },
- "httpMethod": "POST",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Operation"
- },
- "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 set maintenance\npolicy.\nSpecified in the format 'projects/*/locations/*/clusters/*'."
- }
- },
- "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}: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.",
- "httpMethod": "DELETE",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "name"
- ],
- "parameters": {
- "projectId": {
- "location": "query",
- "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use name instead.",
"type": "string"
},
"zone": {
- "location": "query",
+ "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": "query",
- "description": "The name of the cluster to delete.\nThis field is deprecated, use name instead.",
- "type": "string"
- },
- "name": {
- "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$",
"location": "path",
- "description": "The name (project, location, cluster) of the cluster to delete.\nSpecified in the format 'projects/*/locations/*/clusters/*'.",
+ "description": "The name of the cluster to retrieve.\nThis field is deprecated, use name instead.",
"required": true,
"type": "string"
}
- },
- "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}"
- },
- "setResourceLabels": {
- "httpMethod": "POST",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "location": "path",
- "description": "The name (project, location, cluster id) of the cluster to set labels.\nSpecified in the format 'projects/*/locations/*/clusters/*'.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$"
- }
- },
- "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:setResourceLabels",
- "id": "container.projects.locations.clusters.setResourceLabels",
- "path": "v1beta1/{+name}:setResourceLabels",
- "description": "Sets labels on a cluster.",
- "request": {
- "$ref": "SetLabelsRequest"
}
},
- "setLegacyAbac": {
- "request": {
- "$ref": "SetLegacyAbacRequest"
- },
- "description": "Enables or disables the ABAC authorization mechanism on a cluster.",
+ "legacyAbac": {
"response": {
"$ref": "Operation"
},
"parameterOrder": [
- "name"
- ],
- "httpMethod": "POST",
- "parameters": {
- "name": {
- "description": "The name (project, location, cluster id) of the cluster to set legacy abac.\nSpecified in the format 'projects/*/locations/*/clusters/*'.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:setLegacyAbac",
- "path": "v1beta1/{+name}:setLegacyAbac",
- "id": "container.projects.locations.clusters.setLegacyAbac"
- },
- "updateMaster": {
- "httpMethod": "POST",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Operation"
- },
- "parameters": {
- "name": {
- "description": "The name (project, location, cluster) of the cluster to update.\nSpecified in the format 'projects/*/locations/*/clusters/*'.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:updateMaster",
- "id": "container.projects.locations.clusters.updateMaster",
- "path": "v1beta1/{+name}:updateMaster",
- "request": {
- "$ref": "UpdateMasterRequest"
- },
- "description": "Updates the master of a specific cluster."
- },
- "setLocations": {
- "description": "Sets the locations of a specific cluster.",
- "request": {
- "$ref": "SetLocationsRequest"
- },
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "name"
+ "projectId",
+ "zone",
+ "clusterId"
],
"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 locations.\nSpecified in the format 'projects/*/locations/*/clusters/*'.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:setLocations",
- "path": "v1beta1/{+name}:setLocations",
- "id": "container.projects.locations.clusters.setLocations"
- },
- "update": {
- "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}",
- "id": "container.projects.locations.clusters.update",
- "path": "v1beta1/{+name}",
- "request": {
- "$ref": "UpdateClusterRequest"
- },
- "description": "Updates the settings of a specific cluster.",
- "httpMethod": "PUT",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Operation"
- },
- "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"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- }
- },
- "resources": {
- "nodePools": {
- "methods": {
- "get": {
- "description": "Retrieves the node pool requested.",
- "response": {
- "$ref": "NodePool"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "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": {
- "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"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/nodePools/{nodePoolsId}",
- "path": "v1beta1/{+name}",
- "id": "container.projects.locations.clusters.nodePools.get"
- },
- "update": {
- "request": {
- "$ref": "UpdateNodePoolRequest"
- },
- "description": "Updates the version and/or iamge type of a specific node pool.",
- "httpMethod": "PUT",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Operation"
- },
- "parameters": {
- "name": {
- "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}"
- },
- "setAutoscaling": {
- "request": {
- "$ref": "SetNodePoolAutoscalingRequest"
- },
- "description": "Sets the autoscaling settings of a specific node pool.",
- "httpMethod": "POST",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Operation"
- },
- "parameters": {
- "name": {
- "location": "path",
- "description": "The name (project, location, cluster, node pool) of the node pool to set\nautoscaler settings. Specified in the format\n'projects/*/locations/*/clusters/*/nodePools/*'.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+/nodePools/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/nodePools/{nodePoolsId}:setAutoscaling",
- "id": "container.projects.locations.clusters.nodePools.setAutoscaling",
- "path": "v1beta1/{+name}:setAutoscaling"
- },
- "delete": {
- "httpMethod": "DELETE",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "name"
- ],
- "parameters": {
- "zone": {
- "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.",
- "type": "string",
- "location": "query"
- },
- "clusterId": {
- "location": "query",
- "description": "The name of the cluster.\nThis field is deprecated, use name instead.",
- "type": "string"
- },
- "nodePoolId": {
- "location": "query",
- "description": "The name of the node pool to delete.\nThis field is deprecated, use name instead.",
- "type": "string"
- },
- "name": {
- "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": {
- "type": "string",
- "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."
- }
- },
- "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}",
- "description": "Deletes a node pool from a cluster."
- },
- "setManagement": {
- "id": "container.projects.locations.clusters.nodePools.setManagement",
- "path": "v1beta1/{+name}:setManagement",
- "request": {
- "$ref": "SetNodePoolManagementRequest"
- },
- "description": "Sets the NodeManagement options for a node pool.",
- "httpMethod": "POST",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Operation"
- },
- "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"
- },
- "list": {
- "path": "v1beta1/{+parent}/nodePools",
- "id": "container.projects.locations.clusters.nodePools.list",
- "description": "Lists the node pools for a cluster.",
- "response": {
- "$ref": "ListNodePoolsResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "GET",
- "parameters": {
- "projectId": {
- "location": "query",
- "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).\nThis field is deprecated, use parent instead.",
- "type": "string"
- },
- "zone": {
- "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"
- },
- "parent": {
- "location": "path",
- "description": "The parent (project, location, cluster id) where the node pools will be listed.\nSpecified in the format 'projects/*/locations/*/clusters/*'.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$"
- },
- "clusterId": {
- "location": "query",
- "description": "The name of the cluster.\nThis field is deprecated, use parent instead.",
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/nodePools"
- },
- "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": {
- "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/[^/]+$"
- }
- },
- "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": {
- "path": "v1beta1/{+parent}/nodePools",
- "id": "container.projects.locations.clusters.nodePools.create",
- "description": "Creates a node pool for a cluster.",
- "request": {
- "$ref": "CreateNodePoolRequest"
- },
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "parent": {
- "location": "path",
- "description": "The parent (project, location, cluster id) where the node pool will be created.\nSpecified in the format 'projects/*/locations/*/clusters/*/nodePools/*'.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$"
- }
- },
- "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/nodePools"
- }
- }
- }
- }
- },
- "operations": {
- "methods": {
- "cancel": {
- "path": "v1beta1/{+name}:cancel",
- "id": "container.projects.locations.operations.cancel",
- "description": "Cancels the specified operation.",
- "request": {
- "$ref": "CancelOperationRequest"
- },
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$",
- "location": "path",
- "description": "The name (project, location, operation id) of the operation to cancel.\nSpecified in the format 'projects/*/locations/*/operations/*'.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel"
- },
- "list": {
- "path": "v1beta1/{+parent}/operations",
- "id": "container.projects.locations.operations.list",
- "description": "Lists all operations in a project in a specific zone or all zones.",
- "response": {
- "$ref": "ListOperationsResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "GET",
- "parameters": {
"projectId": {
- "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use parent instead.",
- "type": "string",
- "location": "query"
- },
- "zone": {
- "location": "query",
- "description": "The name of the Google Compute Engine [zone](/compute/docs/zones#available)\nto return operations for, or `-` for all zones.\nThis field is deprecated, use parent instead.",
- "type": "string"
- },
- "parent": {
- "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/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/operations"
- },
- "get": {
- "description": "Gets the specified operation.",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "parameters": {
- "name": {
- "description": "The name (project, location, operation id) of the operation to get.\nSpecified in the format 'projects/*/locations/*/operations/*'.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$",
- "location": "path"
- },
- "operationId": {
- "location": "query",
- "description": "The server-assigned `name` of the operation.\nThis field is deprecated, use name instead.",
- "type": "string"
- },
- "projectId": {
- "type": "string",
- "location": "query",
+ "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": "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"
+ "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."
}
},
+ "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/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"
+ }
+ },
+ "setNetworkPolicy": {
+ "description": "Enables/Disables Network Policy for a cluster.",
+ "request": {
+ "$ref": "SetNetworkPolicyRequest"
+ },
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "projectId",
+ "zone",
+ "clusterId"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
"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"
- }
- }
- }
- },
- "methods": {
- "getServerConfig": {
- "httpMethod": "GET",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "ServerConfig"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+$",
- "location": "path",
- "description": "The name (project and location) of the server config to get\nSpecified in the format 'projects/*/locations/*'."
+ "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).\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.\nThis field is deprecated, use name instead."
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:setNetworkPolicy",
+ "id": "container.projects.zones.clusters.setNetworkPolicy",
+ "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:setNetworkPolicy"
},
- "projectId": {
- "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use name instead.",
- "type": "string",
- "location": "query"
- },
- "zone": {
- "location": "query",
- "description": "The name of the Google Compute Engine [zone](/compute/docs/zones#available)\nto return operations for.\nThis field is deprecated, use name instead.",
- "type": "string"
- }
- },
- "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/serverConfig",
- "id": "container.projects.locations.getServerConfig",
- "path": "v1beta1/{+name}/serverConfig",
- "description": "Returns configuration info about the Kubernetes Engine service."
- }
- }
- },
- "zones": {
- "methods": {
- "getServerconfig": {
- "response": {
- "$ref": "ServerConfig"
- },
- "parameterOrder": [
- "projectId",
- "zone"
- ],
- "httpMethod": "GET",
- "parameters": {
- "name": {
- "description": "The name (project and location) of the server config to get\nSpecified in the format 'projects/*/locations/*'.",
- "type": "string",
- "location": "query"
- },
- "projectId": {
- "location": "path",
- "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use name instead.",
- "required": true,
- "type": "string"
- },
- "zone": {
- "location": "path",
- "description": "The name of the Google Compute Engine [zone](/compute/docs/zones#available)\nto return operations for.\nThis field is deprecated, use name instead.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/serverconfig",
- "path": "v1beta1/projects/{projectId}/zones/{zone}/serverconfig",
- "id": "container.projects.zones.getServerconfig",
- "description": "Returns configuration info about the Kubernetes Engine service."
- }
- },
- "resources": {
- "clusters": {
- "methods": {
"startIpRotation": {
- "id": "container.projects.zones.clusters.startIpRotation",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "projectId",
+ "zone",
+ "clusterId"
+ ],
+ "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://developers.google.com/console/help/new/#projectnumber).\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.\nThis field is deprecated, use name instead."
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:startIpRotation",
"path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:startIpRotation",
+ "id": "container.projects.zones.clusters.startIpRotation",
"description": "Start master IP rotation.",
"request": {
"$ref": "StartIPRotationRequest"
- },
- "httpMethod": "POST",
- "parameterOrder": [
- "projectId",
- "zone",
- "clusterId"
- ],
- "response": {
- "$ref": "Operation"
- },
- "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"
- },
- "setMaintenancePolicy": {
- "parameters": {
- "clusterId": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "The name of the cluster to update."
- },
- "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": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:setMaintenancePolicy",
- "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:setMaintenancePolicy",
- "id": "container.projects.zones.clusters.setMaintenancePolicy",
- "request": {
- "$ref": "SetMaintenancePolicyRequest"
- },
- "description": "Sets the maintenance policy for a cluster.",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "projectId",
- "zone",
- "clusterId"
- ],
- "httpMethod": "POST"
+ }
},
"addons": {
+ "description": "Sets the addons of a specific cluster.",
"request": {
"$ref": "SetAddonsConfigRequest"
},
- "description": "Sets the addons of a specific cluster.",
"httpMethod": "POST",
"parameterOrder": [
"projectId",
@@ -2611,18 +1883,21 @@
"response": {
"$ref": "Operation"
},
+ "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",
- "location": "path"
+ "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"
+ "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",
@@ -2631,14 +1906,55 @@
"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": {
+ "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": {
+ "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 update.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:setMaintenancePolicy",
+ "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:setMaintenancePolicy",
+ "id": "container.projects.zones.clusters.setMaintenancePolicy",
+ "description": "Sets the maintenance policy for a cluster.",
+ "request": {
+ "$ref": "SetMaintenancePolicyRequest"
+ }
+ },
"delete": {
+ "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}",
+ "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}",
+ "id": "container.projects.zones.clusters.delete",
"description": "Deletes the cluster, including the Kubernetes endpoint and all worker\nnodes.\n\nFirewalls and routes that were configured during cluster creation\nare also deleted.\n\nOther Google Compute Engine resources that might be in use by the cluster\n(e.g. load balancer resources) will not be deleted if they weren't present\nat the initial create time.",
"response": {
"$ref": "Operation"
@@ -2653,36 +1969,6 @@
"https://www.googleapis.com/auth/cloud-platform"
],
"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": {
- "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"
- }
- },
- "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}",
- "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}",
- "id": "container.projects.zones.clusters.delete"
- },
- "locations": {
- "parameters": {
"projectId": {
"required": true,
"type": "string",
@@ -2696,10 +1982,46 @@
"type": "string"
},
"clusterId": {
- "description": "The name of the cluster to upgrade.\nThis field is deprecated, use name instead.",
+ "location": "path",
+ "description": "The name of the cluster to delete.\nThis field is deprecated, use name instead.",
+ "required": true,
+ "type": "string"
+ },
+ "name": {
+ "location": "query",
+ "description": "The name (project, location, cluster) of the cluster to delete.\nSpecified in the format 'projects/*/locations/*/clusters/*'.",
+ "type": "string"
+ }
+ }
+ },
+ "locations": {
+ "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": {
"required": true,
"type": "string",
- "location": "path"
+ "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": [
@@ -2711,34 +2033,22 @@
"request": {
"$ref": "SetLocationsRequest"
},
- "description": "Sets the locations of a specific cluster.",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "projectId",
- "zone",
- "clusterId"
- ],
- "httpMethod": "POST"
+ "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"
- },
+ "httpMethod": "PUT",
"parameterOrder": [
"projectId",
"zone",
"clusterId"
],
- "httpMethod": "PUT",
+ "response": {
+ "$ref": "Operation"
+ },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
@@ -2750,65 +2060,68 @@
"type": "string"
},
"zone": {
- "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "clusterId": {
- "description": "The name of the cluster to upgrade.\nThis field is deprecated, use name instead.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- }
- },
- "monitoring": {
- "request": {
- "$ref": "SetMonitoringServiceRequest"
- },
- "description": "Sets the monitoring service of a specific cluster.",
- "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": {
"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"
+ "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}",
+ "id": "container.projects.zones.clusters.update",
+ "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}"
+ },
+ "monitoring": {
+ "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": {
+ "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."
+ }
+ },
"flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/monitoring",
+ "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/monitoring",
"id": "container.projects.zones.clusters.monitoring",
- "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/monitoring"
+ "description": "Sets the monitoring service of a specific cluster.",
+ "request": {
+ "$ref": "SetMonitoringServiceRequest"
+ }
},
"master": {
+ "description": "Updates the master of a specific cluster.",
"request": {
"$ref": "UpdateMasterRequest"
},
- "description": "Updates the master of a specific cluster.",
"httpMethod": "POST",
"parameterOrder": [
"projectId",
@@ -2818,6 +2131,9 @@
"response": {
"$ref": "Operation"
},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
"parameters": {
"projectId": {
"location": "path",
@@ -2826,21 +2142,18 @@
"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",
- "location": "path"
+ "type": "string"
},
"clusterId": {
+ "location": "path",
"description": "The name of the cluster to upgrade.\nThis field is deprecated, use name instead.",
"required": true,
- "type": "string",
- "location": "path"
+ "type": "string"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
"flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/master",
"id": "container.projects.zones.clusters.master",
"path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/master"
@@ -2887,22 +2200,29 @@
}
},
"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"
},
- "description": "Sets the logging service of a specific cluster.",
- "response": {
- "$ref": "Operation"
- },
+ "httpMethod": "POST",
"parameterOrder": [
"projectId",
"zone",
"clusterId"
],
- "httpMethod": "POST",
+ "response": {
+ "$ref": "Operation"
+ },
+ "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.",
@@ -2910,98 +2230,53 @@
"type": "string"
},
"clusterId": {
- "location": "path",
- "description": "The name of the cluster to upgrade.\nThis field is deprecated, use name instead.",
"required": true,
- "type": "string"
- },
- "projectId": {
+ "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.",
- "required": true,
- "type": "string"
+ "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}/logging"
+ "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/logging",
+ "id": "container.projects.zones.clusters.logging",
+ "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/logging"
},
"list": {
"httpMethod": "GET",
+ "response": {
+ "$ref": "ListClustersResponse"
+ },
"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).\nThis field is deprecated, use parent 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, or \"-\" for all zones.\nThis field is deprecated, use parent instead."
+ },
+ "parent": {
+ "type": "string",
+ "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."
+ }
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
- "parameters": {
- "projectId": {
- "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use parent instead.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "zone": {
- "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides, or \"-\" for all zones.\nThis field is deprecated, use parent instead.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "parent": {
- "location": "query",
- "description": "The parent (project and location) where the clusters will be listed.\nSpecified in the format 'projects/*/locations/*'.\nLocation \"-\" matches all zones and all regions.",
- "type": "string"
- }
- },
"flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters",
"id": "container.projects.zones.clusters.list",
"path": "v1beta1/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.",
- "httpMethod": "POST",
- "parameterOrder": [
- "projectId",
- "zone"
- ],
- "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 parent instead.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "zone": {
- "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use parent instead.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters",
- "id": "container.projects.zones.clusters.create",
- "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters"
- },
"resourceLabels": {
- "request": {
- "$ref": "SetLabelsRequest"
- },
- "description": "Sets labels on a cluster.",
"response": {
"$ref": "Operation"
},
@@ -3012,23 +2287,23 @@
],
"httpMethod": "POST",
"parameters": {
- "clusterId": {
- "description": "The name of the cluster.\nThis field is deprecated, use name instead.",
+ "projectId": {
"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"
+ "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": {
"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."
}
},
"scopes": [
@@ -3036,229 +2311,142 @@
],
"flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/resourceLabels",
"path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/resourceLabels",
- "id": "container.projects.zones.clusters.resourceLabels"
+ "id": "container.projects.zones.clusters.resourceLabels",
+ "request": {
+ "$ref": "SetLabelsRequest"
+ },
+ "description": "Sets labels on a cluster."
+ },
+ "create": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "projectId",
+ "zone"
+ ],
+ "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 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."
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters",
+ "id": "container.projects.zones.clusters.create",
+ "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters",
+ "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."
},
"completeIpRotation": {
+ "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": {
+ "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.\nThis field is deprecated, use name instead."
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:completeIpRotation",
"id": "container.projects.zones.clusters.completeIpRotation",
"path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:completeIpRotation",
- "description": "Completes master IP rotation.",
"request": {
"$ref": "CompleteIPRotationRequest"
},
- "httpMethod": "POST",
- "parameterOrder": [
- "projectId",
- "zone",
- "clusterId"
- ],
- "response": {
- "$ref": "Operation"
- },
- "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}:completeIpRotation"
- },
- "setNetworkPolicy": {
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "projectId",
- "zone",
- "clusterId"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "clusterId": {
- "location": "path",
- "description": "The name of the cluster.\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://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"
- }
- },
- "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"
- }
- },
- "legacyAbac": {
- "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": {
- "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",
- "id": "container.projects.zones.clusters.legacyAbac",
- "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/legacyAbac",
- "request": {
- "$ref": "SetLegacyAbacRequest"
- },
- "description": "Enables or disables the ABAC authorization mechanism on a cluster."
- },
- "get": {
- "description": "Gets the details of a specific cluster.",
- "httpMethod": "GET",
- "parameterOrder": [
- "projectId",
- "zone",
- "clusterId"
- ],
- "response": {
- "$ref": "Cluster"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "location": "query",
- "description": "The name (project, location, cluster) of the cluster to retrieve.\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": {
- "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 retrieve.\nThis field is deprecated, use name instead."
- }
- },
- "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}",
- "id": "container.projects.zones.clusters.get",
- "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}"
+ "description": "Completes master IP rotation."
}
},
"resources": {
"nodePools": {
"methods": {
- "get": {
- "description": "Retrieves the node pool requested.",
+ "list": {
+ "description": "Lists the node pools for a cluster.",
"httpMethod": "GET",
"parameterOrder": [
"projectId",
"zone",
- "clusterId",
- "nodePoolId"
+ "clusterId"
],
"response": {
- "$ref": "NodePool"
+ "$ref": "ListNodePoolsResponse"
},
"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"
+ "type": "string",
+ "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."
},
"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"
+ "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": {
+ "required": true,
+ "type": "string",
"location": "path",
- "description": "The name of the cluster.\nThis field is deprecated, use name instead.",
- "required": true,
+ "description": "The name of the cluster.\nThis field is deprecated, use parent instead."
+ },
+ "parent": {
+ "location": "query",
+ "description": "The parent (project, location, cluster id) where the node pools will be listed.\nSpecified in the format 'projects/*/locations/*/clusters/*'.",
"type": "string"
- },
- "nodePoolId": {
- "description": "The name of the node pool.\nThis field is deprecated, use name instead.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "name": {
- "description": "The name (project, location, cluster, node pool id) of the node pool to get.\nSpecified in the format 'projects/*/locations/*/clusters/*/nodePools/*'.",
- "type": "string",
- "location": "query"
}
},
- "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}",
- "id": "container.projects.zones.clusters.nodePools.get",
- "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}"
+ "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"
},
- "update": {
+ "rollback": {
+ "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",
+ "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"
+ },
"httpMethod": "POST",
"parameterOrder": [
"projectId",
@@ -3274,16 +2462,99 @@
],
"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": {
+ "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 rollback.\nThis field is deprecated, use name instead."
+ },
+ "nodePoolId": {
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "description": "The name of the node pool to rollback.\nThis field is deprecated, use name instead."
+ }
+ }
+ },
+ "create": {
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "projectId",
+ "zone",
+ "clusterId"
+ ],
+ "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://developers.google.com/console/help/new/#projectnumber).\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"
+ },
+ "clusterId": {
+ "location": "path",
+ "description": "The name of the cluster.\nThis field is deprecated, use parent instead.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools",
+ "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools",
+ "id": "container.projects.zones.clusters.nodePools.create",
+ "description": "Creates a node pool for a cluster.",
+ "request": {
+ "$ref": "CreateNodePoolRequest"
+ }
+ },
+ "autoscaling": {
+ "request": {
+ "$ref": "SetNodePoolAutoscalingRequest"
+ },
+ "description": "Sets the autoscaling settings of a specific node pool.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "projectId",
+ "zone",
+ "clusterId",
+ "nodePoolId"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameters": {
+ "projectId": {
"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",
- "location": "path"
+ "type": "string"
},
"clusterId": {
"location": "path",
@@ -3298,22 +2569,16 @@
"description": "The name of the node pool to upgrade.\nThis field is deprecated, use name instead."
}
},
- "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",
- "description": "Updates the version and/or iamge type of a specific node pool.",
- "request": {
- "$ref": "UpdateNodePoolRequest"
- }
+ "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"
},
- "delete": {
- "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}",
- "id": "container.projects.zones.clusters.nodePools.delete",
- "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}",
- "description": "Deletes a node pool from a cluster.",
- "httpMethod": "DELETE",
+ "get": {
"response": {
- "$ref": "Operation"
+ "$ref": "NodePool"
},
"parameterOrder": [
"projectId",
@@ -3321,6 +2586,10 @@
"clusterId",
"nodePoolId"
],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
"parameters": {
"projectId": {
"location": "path",
@@ -3329,48 +2598,97 @@
"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"
+ "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"
+ "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"
+ "type": "string",
+ "location": "path",
+ "description": "The name of the node pool.\nThis field is deprecated, use name instead."
},
"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"
+ "location": "query",
+ "description": "The name (project, location, cluster, node pool id) of the node pool to get.\nSpecified in the format 'projects/*/locations/*/clusters/*/nodePools/*'."
}
},
- "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."
},
- "setManagement": {
- "request": {
- "$ref": "SetNodePoolManagementRequest"
+ "update": {
+ "response": {
+ "$ref": "Operation"
},
- "description": "Sets the NodeManagement options for a node pool.",
- "httpMethod": "POST",
"parameterOrder": [
"projectId",
"zone",
"clusterId",
"nodePoolId"
],
+ "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": {
+ "location": "path",
+ "description": "The name of the cluster to upgrade.\nThis field is deprecated, use name instead.",
+ "required": true,
+ "type": "string"
+ },
+ "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",
+ "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/update",
+ "id": "container.projects.zones.clusters.nodePools.update",
+ "request": {
+ "$ref": "UpdateNodePoolRequest"
+ },
+ "description": "Updates the version and/or iamge type of a specific node pool."
+ },
+ "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": {
"required": true,
@@ -3391,290 +2709,199 @@
"description": "The name of the cluster to update.\nThis field is deprecated, use name instead."
},
"nodePoolId": {
- "description": "The name of the node pool to update.\nThis field is deprecated, use name instead.",
"required": true,
"type": "string",
- "location": "path"
+ "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"
],
"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"
+ "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/setManagement",
+ "id": "container.projects.zones.clusters.nodePools.setManagement"
},
- "list": {
- "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools",
- "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools",
- "id": "container.projects.zones.clusters.nodePools.list",
- "description": "Lists the node pools for a cluster.",
- "response": {
- "$ref": "ListNodePoolsResponse"
- },
+ "delete": {
+ "httpMethod": "DELETE",
"parameterOrder": [
"projectId",
"zone",
- "clusterId"
+ "clusterId",
+ "nodePoolId"
],
- "httpMethod": "GET",
+ "response": {
+ "$ref": "Operation"
+ },
+ "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 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": {
- "description": "The name of the cluster.\nThis field is deprecated, use parent instead.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "parent": {
- "type": "string",
+ "name": {
"location": "query",
- "description": "The parent (project, location, cluster id) where the node pools will be listed.\nSpecified in the format 'projects/*/locations/*/clusters/*'."
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- },
- "rollback": {
- "httpMethod": "POST",
- "parameterOrder": [
- "projectId",
- "zone",
- "clusterId",
- "nodePoolId"
- ],
- "response": {
- "$ref": "Operation"
- },
- "parameters": {
+ "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"
+ },
"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."
+ "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": {
- "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"
+ "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 to rollback.\nThis field is deprecated, use name instead.",
+ "location": "path",
+ "description": "The name of the cluster.\nThis field is deprecated, use name instead.",
"required": true,
- "type": "string",
- "location": "path"
+ "type": "string"
},
"nodePoolId": {
- "location": "path",
- "description": "The name of the node pool to rollback.\nThis field is deprecated, use name instead.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}:rollback",
- "id": "container.projects.zones.clusters.nodePools.rollback",
- "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}:rollback",
- "request": {
- "$ref": "RollbackNodePoolUpgradeRequest"
- },
- "description": "Roll back the previously Aborted or Failed NodePool upgrade.\nThis will be an no-op if the last upgrade successfully completed."
- },
- "create": {
- "parameters": {
- "projectId": {
- "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).\nThis field is deprecated, use parent instead.",
"required": true,
"type": "string",
- "location": "path"
- },
- "zone": {
"location": "path",
- "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use parent instead.",
- "required": true,
- "type": "string"
- },
- "clusterId": {
- "location": "path",
- "description": "The name of the cluster.\nThis field is deprecated, use parent instead.",
- "required": true,
- "type": "string"
+ "description": "The name of the node pool to delete.\nThis field is deprecated, use name instead."
}
},
- "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",
- "request": {
- "$ref": "CreateNodePoolRequest"
- },
- "description": "Creates a node pool for a cluster.",
- "httpMethod": "POST",
- "parameterOrder": [
- "projectId",
- "zone",
- "clusterId"
- ],
- "response": {
- "$ref": "Operation"
- }
- },
- "autoscaling": {
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "projectId",
- "zone",
- "clusterId",
- "nodePoolId"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "nodePoolId": {
- "location": "path",
- "description": "The name of the node pool to upgrade.\nThis field is deprecated, use name instead.",
- "required": true,
- "type": "string"
- },
- "projectId": {
- "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"
- }
- },
- "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",
- "description": "Sets the autoscaling settings of a specific node pool.",
- "request": {
- "$ref": "SetNodePoolAutoscalingRequest"
- }
+ "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}",
+ "id": "container.projects.zones.clusters.nodePools.delete",
+ "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}",
+ "description": "Deletes a node pool from a cluster."
}
}
}
}
- },
+ }
+ }
+ },
+ "locations": {
+ "methods": {
+ "getServerConfig": {
+ "description": "Returns configuration info about the Kubernetes Engine service.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "ServerConfig"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "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": {
+ "type": "string",
+ "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."
+ },
+ "name": {
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+$",
+ "location": "path",
+ "description": "The name (project and location) of the server config to get\nSpecified in the format 'projects/*/locations/*'."
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/serverConfig",
+ "id": "container.projects.locations.getServerConfig",
+ "path": "v1beta1/{+name}/serverConfig"
+ }
+ },
+ "resources": {
"operations": {
"methods": {
"list": {
- "description": "Lists all operations in a project in a specific zone or all zones.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "parent"
+ ],
"response": {
"$ref": "ListOperationsResponse"
},
- "parameterOrder": [
- "projectId",
- "zone"
- ],
- "httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
"projectId": {
+ "location": "query",
"description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use parent instead.",
- "required": true,
- "type": "string",
- "location": "path"
+ "type": "string"
},
"zone": {
- "location": "path",
- "description": "The name of the Google Compute Engine [zone](/compute/docs/zones#available)\nto return operations for, or `-` for all zones.\nThis field is deprecated, use parent instead.",
- "required": true,
- "type": "string"
+ "type": "string",
+ "location": "query",
+ "description": "The name of the Google Compute Engine [zone](/compute/docs/zones#available)\nto return operations for, or `-` for all zones.\nThis field is deprecated, use parent instead."
},
"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",
- "location": "query"
+ "pattern": "^projects/[^/]+/locations/[^/]+$"
}
},
- "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/operations",
- "path": "v1beta1/projects/{projectId}/zones/{zone}/operations",
- "id": "container.projects.zones.operations.list"
+ "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/operations",
+ "id": "container.projects.locations.operations.list",
+ "path": "v1beta1/{+parent}/operations",
+ "description": "Lists all operations in a project in a specific zone or all zones."
},
"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": {
- "location": "path",
- "description": "The server-assigned `name` of the operation.\nThis field is deprecated, use name instead.",
- "required": true,
- "type": "string"
- },
- "projectId": {
- "location": "path",
- "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use name instead.",
- "required": true,
- "type": "string"
- },
- "zone": {
- "location": "path",
- "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "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.",
+ "httpMethod": "GET",
"response": {
"$ref": "Operation"
},
"parameterOrder": [
- "projectId",
- "zone",
- "operationId"
+ "name"
],
- "httpMethod": "GET"
+ "parameters": {
+ "projectId": {
+ "location": "query",
+ "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use 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."
+ },
+ "name": {
+ "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",
+ "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$"
+ },
+ "operationId": {
+ "location": "query",
+ "description": "The server-assigned `name` of the operation.\nThis field is deprecated, use name instead.",
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}",
+ "id": "container.projects.locations.operations.get",
+ "path": "v1beta1/{+name}",
+ "description": "Gets the specified operation."
},
"cancel": {
+ "description": "Cancels the specified operation.",
+ "request": {
+ "$ref": "CancelOperationRequest"
+ },
"httpMethod": "POST",
"parameterOrder": [
- "projectId",
- "zone",
- "operationId"
+ "name"
],
"response": {
"$ref": "Empty"
@@ -3683,31 +2910,803 @@
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
- "operationId": {
- "location": "path",
- "description": "The server-assigned `name` of the operation.\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.",
+ "name": {
"required": true,
"type": "string",
- "location": "path"
- },
- "zone": {
+ "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$",
"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"
+ "description": "The name (project, location, operation id) of the operation to cancel.\nSpecified in the format 'projects/*/locations/*/operations/*'."
}
},
- "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/operations/{operationId}:cancel",
- "id": "container.projects.zones.operations.cancel",
- "path": "v1beta1/projects/{projectId}/zones/{zone}/operations/{operationId}:cancel",
- "description": "Cancels the specified operation.",
+ "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel",
+ "id": "container.projects.locations.operations.cancel",
+ "path": "v1beta1/{+name}:cancel"
+ }
+ }
+ },
+ "clusters": {
+ "methods": {
+ "setMasterAuth": {
+ "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 auth.\nSpecified in the format 'projects/*/locations/*/clusters/*'.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$"
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:setMasterAuth",
+ "path": "v1beta1/{+name}:setMasterAuth",
+ "id": "container.projects.locations.clusters.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": "CancelOperationRequest"
+ "$ref": "SetMasterAuthRequest"
+ }
+ },
+ "setLogging": {
+ "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}: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"
+ ]
+ },
+ "list": {
+ "description": "Lists all clusters owned by a project in either the specified zone or all\nzones.",
+ "response": {
+ "$ref": "ListClustersResponse"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "projectId": {
+ "location": "query",
+ "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use parent instead.",
+ "type": "string"
+ },
+ "zone": {
+ "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"
+ },
+ "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."
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters",
+ "path": "v1beta1/{+parent}/clusters",
+ "id": "container.projects.locations.clusters.list"
+ },
+ "create": {
+ "request": {
+ "$ref": "CreateClusterRequest"
+ },
+ "description": "Creates a cluster, consisting of the specified number and type of Google\nCompute Engine instances.\n\nBy default, the cluster is created in the project's\n[default network](/compute/docs/networks-and-firewalls#networks).\n\nOne firewall is added for the cluster. After cluster creation,\nthe cluster creates routes for each node to allow the containers\non that node to communicate with all other instances in the\ncluster.\n\nFinally, an entry is added to the project's global metadata indicating\nwhich CIDR range is being used by the cluster.",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "parent": {
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+$",
+ "location": "path",
+ "description": "The parent (project and location) where the cluster will be created.\nSpecified in the format 'projects/*/locations/*'."
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters",
+ "path": "v1beta1/{+parent}/clusters",
+ "id": "container.projects.locations.clusters.create"
+ },
+ "completeIpRotation": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "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/*'."
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:completeIpRotation",
+ "id": "container.projects.locations.clusters.completeIpRotation",
+ "path": "v1beta1/{+name}:completeIpRotation",
+ "request": {
+ "$ref": "CompleteIPRotationRequest"
+ },
+ "description": "Completes master IP rotation."
+ },
+ "setNetworkPolicy": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "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 set networking policy.\nSpecified in the format 'projects/*/locations/*/clusters/*'."
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:setNetworkPolicy",
+ "id": "container.projects.locations.clusters.setNetworkPolicy",
+ "path": "v1beta1/{+name}:setNetworkPolicy",
+ "description": "Enables/Disables Network Policy for a cluster.",
+ "request": {
+ "$ref": "SetNetworkPolicyRequest"
+ }
+ },
+ "get": {
+ "description": "Gets the details of a specific cluster.",
+ "response": {
+ "$ref": "Cluster"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "name": {
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$",
+ "location": "path",
+ "description": "The name (project, location, cluster) of the cluster to retrieve.\nSpecified in the format 'projects/*/locations/*/clusters/*'."
+ },
+ "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": {
+ "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": {
+ "type": "string",
+ "location": "query",
+ "description": "The name of the cluster to retrieve.\nThis field is deprecated, use name instead."
+ }
+ },
+ "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"
+ },
+ "setAddons": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "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) of the cluster to set addons.\nSpecified in the format 'projects/*/locations/*/clusters/*'."
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:setAddons",
+ "id": "container.projects.locations.clusters.setAddons",
+ "path": "v1beta1/{+name}:setAddons",
+ "description": "Sets the addons of a specific cluster.",
+ "request": {
+ "$ref": "SetAddonsConfigRequest"
+ }
+ },
+ "startIpRotation": {
+ "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 start IP rotation.\nSpecified in the format 'projects/*/locations/*/clusters/*'.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$"
+ }
+ },
+ "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"
+ }
+ },
+ "setMonitoring": {
+ "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:setMonitoring",
+ "path": "v1beta1/{+name}:setMonitoring",
+ "id": "container.projects.locations.clusters.setMonitoring",
+ "request": {
+ "$ref": "SetMonitoringServiceRequest"
+ },
+ "description": "Sets the monitoring service of a specific cluster.",
+ "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 monitoring.\nSpecified in the format 'projects/*/locations/*/clusters/*'."
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "setMaintenancePolicy": {
+ "description": "Sets the maintenance policy for a cluster.",
+ "request": {
+ "$ref": "SetMaintenancePolicyRequest"
+ },
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "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 set maintenance\npolicy.\nSpecified in the format 'projects/*/locations/*/clusters/*'."
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:setMaintenancePolicy",
+ "id": "container.projects.locations.clusters.setMaintenancePolicy",
+ "path": "v1beta1/{+name}:setMaintenancePolicy"
+ },
+ "delete": {
+ "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}",
+ "path": "v1beta1/{+name}",
+ "id": "container.projects.locations.clusters.delete",
+ "description": "Deletes the cluster, including the Kubernetes endpoint and all worker\nnodes.\n\nFirewalls and routes that were configured during cluster creation\nare also deleted.\n\nOther Google Compute Engine resources that might be in use by the cluster\n(e.g. load balancer resources) will not be deleted if they weren't present\nat the initial create time.",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "DELETE",
+ "parameters": {
+ "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": {
+ "type": "string",
+ "location": "query",
+ "description": "The name of the cluster to delete.\nThis field is deprecated, use name instead."
+ },
+ "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/[^/]+$"
+ }
+ },
+ "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": {
+ "location": "path",
+ "description": "The name (project, location, cluster id) of the cluster to set labels.\nSpecified in the format 'projects/*/locations/*/clusters/*'.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$"
+ }
+ },
+ "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": {
+ "description": "Enables or disables the ABAC authorization mechanism on a cluster.",
+ "request": {
+ "$ref": "SetLegacyAbacRequest"
+ },
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "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 set legacy abac.\nSpecified in the format 'projects/*/locations/*/clusters/*'."
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:setLegacyAbac",
+ "id": "container.projects.locations.clusters.setLegacyAbac",
+ "path": "v1beta1/{+name}:setLegacyAbac"
+ },
+ "updateMaster": {
+ "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:updateMaster",
+ "path": "v1beta1/{+name}:updateMaster",
+ "id": "container.projects.locations.clusters.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": {
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$",
+ "location": "path",
+ "description": "The name (project, location, cluster) of the cluster to update.\nSpecified in the format 'projects/*/locations/*/clusters/*'."
+ }
+ }
+ },
+ "setLocations": {
+ "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:setLocations",
+ "id": "container.projects.locations.clusters.setLocations",
+ "path": "v1beta1/{+name}:setLocations",
+ "description": "Sets the locations of a specific cluster.",
+ "request": {
+ "$ref": "SetLocationsRequest"
+ },
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "location": "path",
+ "description": "The name (project, location, cluster) of the cluster to set locations.\nSpecified in the format 'projects/*/locations/*/clusters/*'.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$"
+ }
+ }
+ },
+ "update": {
+ "httpMethod": "PUT",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameters": {
+ "name": {
+ "location": "path",
+ "description": "The name (project, location, cluster) of the cluster to update.\nSpecified in the format 'projects/*/locations/*/clusters/*'.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}",
+ "id": "container.projects.locations.clusters.update",
+ "path": "v1beta1/{+name}",
+ "request": {
+ "$ref": "UpdateClusterRequest"
+ },
+ "description": "Updates the settings of a specific cluster."
+ }
+ },
+ "resources": {
+ "nodePools": {
+ "methods": {
+ "setManagement": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "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/[^/]+$"
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/nodePools/{nodePoolsId}:setManagement",
+ "id": "container.projects.locations.clusters.nodePools.setManagement",
+ "path": "v1beta1/{+name}:setManagement",
+ "description": "Sets the NodeManagement options for a node pool.",
+ "request": {
+ "$ref": "SetNodePoolManagementRequest"
+ }
+ },
+ "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": {
+ "name": {
+ "location": "path",
+ "description": "The name (project, location, cluster, node pool id) of the node pool to delete.\nSpecified in the format 'projects/*/locations/*/clusters/*/nodePools/*'.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+/nodePools/[^/]+$"
+ },
+ "projectId": {
+ "type": "string",
+ "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."
+ },
+ "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": {
+ "type": "string",
+ "location": "query",
+ "description": "The name of the cluster.\nThis field is deprecated, use name instead."
+ },
+ "nodePoolId": {
+ "type": "string",
+ "location": "query",
+ "description": "The name of the node pool to delete.\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"
+ },
+ "list": {
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "parent"
+ ],
+ "response": {
+ "$ref": "ListNodePoolsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "projectId": {
+ "location": "query",
+ "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).\nThis field is deprecated, use parent instead.",
+ "type": "string"
+ },
+ "zone": {
+ "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"
+ },
+ "parent": {
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$",
+ "location": "path",
+ "description": "The parent (project, location, cluster id) where the node pools will be listed.\nSpecified in the format 'projects/*/locations/*/clusters/*'."
+ },
+ "clusterId": {
+ "location": "query",
+ "description": "The name of the cluster.\nThis field is deprecated, use parent instead.",
+ "type": "string"
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/nodePools",
+ "id": "container.projects.locations.clusters.nodePools.list",
+ "path": "v1beta1/{+parent}/nodePools",
+ "description": "Lists the node pools for a cluster."
+ },
+ "rollback": {
+ "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/nodePools/{nodePoolsId}:rollback",
+ "id": "container.projects.locations.clusters.nodePools.rollback",
+ "path": "v1beta1/{+name}: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"
+ },
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "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/[^/]+$"
+ }
+ }
+ },
+ "create": {
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "parent": {
+ "location": "path",
+ "description": "The parent (project, location, cluster id) where the node pool will be created.\nSpecified in the format 'projects/*/locations/*/clusters/*/nodePools/*'.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$"
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/nodePools",
+ "path": "v1beta1/{+parent}/nodePools",
+ "id": "container.projects.locations.clusters.nodePools.create",
+ "description": "Creates a node pool for a cluster.",
+ "request": {
+ "$ref": "CreateNodePoolRequest"
+ }
+ },
+ "get": {
+ "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.",
+ "response": {
+ "$ref": "NodePool"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "name": {
+ "required": true,
+ "type": "string",
+ "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/*'."
+ },
+ "projectId": {
+ "type": "string",
+ "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."
+ },
+ "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"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "update": {
+ "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/nodePools/{nodePoolsId}",
+ "path": "v1beta1/{+name}",
+ "id": "container.projects.locations.clusters.nodePools.update",
+ "request": {
+ "$ref": "UpdateNodePoolRequest"
+ },
+ "description": "Updates the version and/or iamge type of a specific node pool.",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "PUT",
+ "parameters": {
+ "name": {
+ "location": "path",
+ "description": "The name (project, location, cluster, node pool) of the node pool to update.\nSpecified in the format 'projects/*/locations/*/clusters/*/nodePools/*'.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+/nodePools/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "setAutoscaling": {
+ "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/nodePools/{nodePoolsId}:setAutoscaling",
+ "path": "v1beta1/{+name}:setAutoscaling",
+ "id": "container.projects.locations.clusters.nodePools.setAutoscaling",
+ "description": "Sets the autoscaling settings of a specific node pool.",
+ "request": {
+ "$ref": "SetNodePoolAutoscalingRequest"
+ },
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "location": "path",
+ "description": "The name (project, location, cluster, node pool) of the node pool to set\nautoscaler settings. Specified in the format\n'projects/*/locations/*/clusters/*/nodePools/*'.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+/nodePools/[^/]+$"
+ }
+ }
+ }
}
}
}
@@ -3729,36 +3728,35 @@
"type": "boolean",
"default": "true"
},
+ "fields": {
+ "type": "string",
+ "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\")."
},
- "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"
+ "type": "string",
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ]
},
"callback": {
+ "location": "query",
"description": "JSONP",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"alt": {
- "description": "Data format for response.",
"default": "json",
"enum": [
"json",
@@ -3771,22 +3769,23 @@
"Media download with context-dependent Content-Type",
"Responses with Content-Type of application/x-protobuf"
],
- "location": "query"
+ "location": "query",
+ "description": "Data format for response."
+ },
+ "access_token": {
+ "type": "string",
+ "location": "query",
+ "description": "OAuth access token."
},
"key": {
"location": "query",
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
"type": "string"
},
- "access_token": {
- "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",
- "location": "query"
+ "type": "string"
},
"pp": {
"location": "query",
@@ -3795,19 +3794,20 @@
"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."
+ "description": "OAuth 2.0 token for the current user."
+ },
+ "bearer_token": {
+ "location": "query",
+ "description": "OAuth bearer token.",
+ "type": "string"
}
},
"version": "v1beta1",
"baseUrl": "https://container.googleapis.com/",
- "servicePath": "",
+ "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.",
- "kind": "discovery#restDescription"
+ "servicePath": "",
+ "basePath": ""
}
diff --git a/dataflow/v1b3/dataflow-api.json b/dataflow/v1b3/dataflow-api.json
index 74ece35..551447c 100644
--- a/dataflow/v1b3/dataflow-api.json
+++ b/dataflow/v1b3/dataflow-api.json
@@ -1,15 +1,10 @@
{
- "title": "Google Dataflow API",
"discoveryVersion": "v1",
"ownerName": "Google",
"resources": {
"projects": {
"methods": {
"workerMessages": {
- "request": {
- "$ref": "SendWorkerMessagesRequest"
- },
- "description": "Send a worker_message to the service.",
"response": {
"$ref": "SendWorkerMessagesResponse"
},
@@ -19,10 +14,10 @@
"httpMethod": "POST",
"parameters": {
"projectId": {
+ "location": "path",
"description": "The project to send the WorkerMessages to.",
"required": true,
- "type": "string",
- "location": "path"
+ "type": "string"
}
},
"scopes": [
@@ -33,19 +28,35 @@
],
"flatPath": "v1b3/projects/{projectId}/WorkerMessages",
"path": "v1b3/projects/{projectId}/WorkerMessages",
- "id": "dataflow.projects.workerMessages"
+ "id": "dataflow.projects.workerMessages",
+ "request": {
+ "$ref": "SendWorkerMessagesRequest"
+ },
+ "description": "Send a worker_message to the service."
}
},
"resources": {
"templates": {
"methods": {
- "launch": {
+ "create": {
+ "request": {
+ "$ref": "CreateJobFromTemplateRequest"
+ },
+ "description": "Creates a Cloud Dataflow job from a template.",
"httpMethod": "POST",
"parameterOrder": [
"projectId"
],
"response": {
- "$ref": "LaunchTemplateResponse"
+ "$ref": "Job"
+ },
+ "parameters": {
+ "projectId": {
+ "description": "Required. The ID of the Cloud Platform project that the job belongs to.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
@@ -53,6 +64,18 @@
"https://www.googleapis.com/auth/compute.readonly",
"https://www.googleapis.com/auth/userinfo.email"
],
+ "flatPath": "v1b3/projects/{projectId}/templates",
+ "id": "dataflow.projects.templates.create",
+ "path": "v1b3/projects/{projectId}/templates"
+ },
+ "launch": {
+ "response": {
+ "$ref": "LaunchTemplateResponse"
+ },
+ "parameterOrder": [
+ "projectId"
+ ],
+ "httpMethod": "POST",
"parameters": {
"validateOnly": {
"description": "If true, the request is validated but not actually executed.\nDefaults to false.",
@@ -66,25 +89,34 @@
"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",
"description": "The location to which to direct the request.",
- "type": "string"
+ "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}/templates:launch",
- "id": "dataflow.projects.templates.launch",
"path": "v1b3/projects/{projectId}/templates:launch",
- "description": "Launch a template.",
+ "id": "dataflow.projects.templates.launch",
"request": {
"$ref": "LaunchTemplateParameters"
- }
+ },
+ "description": "Launch a template."
},
"get": {
+ "path": "v1b3/projects/{projectId}/templates:get",
+ "id": "dataflow.projects.templates.get",
+ "description": "Get the template associated with a template.",
"response": {
"$ref": "GetTemplateResponse"
},
@@ -92,12 +124,6 @@
"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": {
"description": "Required. The ID of the Cloud Platform project that the job belongs to.",
@@ -106,12 +132,12 @@
"location": "path"
},
"view": {
- "description": "The view to retrieve. Defaults to METADATA_ONLY.",
- "type": "string",
- "location": "query",
"enum": [
"METADATA_ONLY"
- ]
+ ],
+ "description": "The view to retrieve. Defaults to METADATA_ONLY.",
+ "type": "string",
+ "location": "query"
},
"gcsPath": {
"location": "query",
@@ -124,73 +150,25 @@
"location": "query"
}
},
- "flatPath": "v1b3/projects/{projectId}/templates:get",
- "path": "v1b3/projects/{projectId}/templates:get",
- "id": "dataflow.projects.templates.get",
- "description": "Get the template associated with a template."
- },
- "create": {
- "response": {
- "$ref": "Job"
- },
- "parameterOrder": [
- "projectId"
- ],
- "httpMethod": "POST",
- "parameters": {
- "projectId": {
- "location": "path",
- "description": "Required. The ID of the Cloud Platform project that the job belongs to.",
- "required": true,
- "type": "string"
- }
- },
"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",
- "path": "v1b3/projects/{projectId}/templates",
- "id": "dataflow.projects.templates.create",
- "request": {
- "$ref": "CreateJobFromTemplateRequest"
- },
- "description": "Creates a Cloud Dataflow job from a template."
+ "flatPath": "v1b3/projects/{projectId}/templates:get"
}
}
},
"locations": {
"methods": {
"workerMessages": {
- "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": {
- "description": "The project to send the WorkerMessages to.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "flatPath": "v1b3/projects/{projectId}/locations/{location}/WorkerMessages",
"path": "v1b3/projects/{projectId}/locations/{location}/WorkerMessages",
"id": "dataflow.projects.locations.workerMessages",
- "description": "Send a worker_message to the service.",
"request": {
"$ref": "SendWorkerMessagesRequest"
},
+ "description": "Send a worker_message to the service.",
"response": {
"$ref": "SendWorkerMessagesResponse"
},
@@ -198,100 +176,81 @@
"projectId",
"location"
],
- "httpMethod": "POST"
+ "httpMethod": "POST",
+ "parameters": {
+ "projectId": {
+ "description": "The project to send the WorkerMessages to.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "location": {
+ "description": "The location which contains the job",
+ "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"
}
},
"resources": {
"templates": {
"methods": {
- "create": {
+ "launch": {
+ "path": "v1b3/projects/{projectId}/locations/{location}/templates:launch",
+ "id": "dataflow.projects.locations.templates.launch",
+ "description": "Launch a template.",
+ "request": {
+ "$ref": "LaunchTemplateParameters"
+ },
"response": {
- "$ref": "Job"
+ "$ref": "LaunchTemplateResponse"
},
"parameterOrder": [
"projectId",
"location"
],
"httpMethod": "POST",
- "parameters": {
- "projectId": {
- "location": "path",
- "description": "Required. The ID of the Cloud Platform project that the job belongs to.",
- "required": true,
- "type": "string"
- },
- "location": {
- "location": "path",
- "description": "The location to which to direct the request.",
- "required": true,
- "type": "string"
- }
- },
"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",
- "path": "v1b3/projects/{projectId}/locations/{location}/templates",
- "id": "dataflow.projects.locations.templates.create",
- "request": {
- "$ref": "CreateJobFromTemplateRequest"
- },
- "description": "Creates a Cloud Dataflow job from a template."
- },
- "launch": {
- "request": {
- "$ref": "LaunchTemplateParameters"
- },
- "description": "Launch a template.",
- "httpMethod": "POST",
- "parameterOrder": [
- "projectId",
- "location"
- ],
- "response": {
- "$ref": "LaunchTemplateResponse"
- },
"parameters": {
- "projectId": {
- "description": "Required. The ID of the Cloud Platform project that the job belongs to.",
+ "gcsPath": {
+ "location": "query",
+ "description": "Required. A Cloud Storage path to the template from which to create\nthe job.\nMust be valid Cloud Storage URL, beginning with 'gs://'.",
+ "type": "string"
+ },
+ "location": {
+ "description": "The location to which to direct the request.",
"required": true,
"type": "string",
"location": "path"
},
- "gcsPath": {
- "description": "Required. A Cloud Storage path to the template from which to create\nthe job.\nMust be valid Cloud Storage URL, beginning with 'gs://'.",
- "type": "string",
- "location": "query"
- },
- "location": {
- "location": "path",
- "description": "The location to which to direct the request.",
- "required": true,
- "type": "string"
- },
"validateOnly": {
"location": "query",
"description": "If true, the request is validated but not actually executed.\nDefaults to false.",
"type": "boolean"
+ },
+ "projectId": {
+ "location": "path",
+ "description": "Required. The ID of the Cloud Platform project that the job belongs to.",
+ "required": true,
+ "type": "string"
}
},
- "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:launch",
- "id": "dataflow.projects.locations.templates.launch",
- "path": "v1b3/projects/{projectId}/locations/{location}/templates:launch"
+ "flatPath": "v1b3/projects/{projectId}/locations/{location}/templates:launch"
},
"get": {
- "path": "v1b3/projects/{projectId}/locations/{location}/templates:get",
- "id": "dataflow.projects.locations.templates.get",
- "description": "Get the template associated with a template.",
"response": {
"$ref": "GetTemplateResponse"
},
@@ -307,11 +266,16 @@
"https://www.googleapis.com/auth/userinfo.email"
],
"parameters": {
+ "gcsPath": {
+ "description": "Required. A Cloud Storage path to the template from which to\ncreate the job.\nMust be a valid Cloud Storage URL, beginning with `gs://`.",
+ "type": "string",
+ "location": "query"
+ },
"location": {
- "location": "path",
"description": "The location to which to direct the request.",
"required": true,
- "type": "string"
+ "type": "string",
+ "location": "path"
},
"projectId": {
"description": "Required. The ID of the Cloud Platform project that the job belongs to.",
@@ -320,26 +284,207 @@
"location": "path"
},
"view": {
- "description": "The view to retrieve. Defaults to METADATA_ONLY.",
- "type": "string",
- "location": "query",
"enum": [
"METADATA_ONLY"
- ]
- },
- "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"
+ ],
+ "description": "The view to retrieve. Defaults to METADATA_ONLY.",
+ "type": "string",
+ "location": "query"
}
},
- "flatPath": "v1b3/projects/{projectId}/locations/{location}/templates:get"
+ "flatPath": "v1b3/projects/{projectId}/locations/{location}/templates:get",
+ "path": "v1b3/projects/{projectId}/locations/{location}/templates:get",
+ "id": "dataflow.projects.locations.templates.get",
+ "description": "Get the template associated with a template."
+ },
+ "create": {
+ "response": {
+ "$ref": "Job"
+ },
+ "parameterOrder": [
+ "projectId",
+ "location"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly",
+ "https://www.googleapis.com/auth/userinfo.email"
+ ],
+ "parameters": {
+ "projectId": {
+ "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",
+ "description": "Creates a Cloud Dataflow job from a template.",
+ "request": {
+ "$ref": "CreateJobFromTemplateRequest"
+ }
}
}
},
"jobs": {
"methods": {
+ "update": {
+ "request": {
+ "$ref": "Job"
+ },
+ "description": "Updates the state of an existing Cloud Dataflow job.",
+ "httpMethod": "PUT",
+ "parameterOrder": [
+ "projectId",
+ "location",
+ "jobId"
+ ],
+ "response": {
+ "$ref": "Job"
+ },
+ "parameters": {
+ "projectId": {
+ "location": "path",
+ "description": "The ID of the Cloud Platform project that the job belongs to.",
+ "required": true,
+ "type": "string"
+ },
+ "jobId": {
+ "location": "path",
+ "description": "The job ID.",
+ "required": true,
+ "type": "string"
+ },
+ "location": {
+ "description": "The location that contains this job.",
+ "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}",
+ "id": "dataflow.projects.locations.jobs.update",
+ "path": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}"
+ },
+ "create": {
+ "request": {
+ "$ref": "Job"
+ },
+ "description": "Creates a Cloud Dataflow job.",
+ "response": {
+ "$ref": "Job"
+ },
+ "parameterOrder": [
+ "projectId",
+ "location"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "replaceJobId": {
+ "description": "Deprecated. This field is now in the Job message.",
+ "type": "string",
+ "location": "query"
+ },
+ "projectId": {
+ "location": "path",
+ "description": "The ID of the Cloud Platform project that the job belongs to.",
+ "required": true,
+ "type": "string"
+ },
+ "view": {
+ "enum": [
+ "JOB_VIEW_UNKNOWN",
+ "JOB_VIEW_SUMMARY",
+ "JOB_VIEW_ALL",
+ "JOB_VIEW_DESCRIPTION"
+ ],
+ "description": "The level of information requested in response.",
+ "type": "string",
+ "location": "query"
+ },
+ "location": {
+ "location": "path",
+ "description": "The location that contains this 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",
+ "path": "v1b3/projects/{projectId}/locations/{location}/jobs",
+ "id": "dataflow.projects.locations.jobs.create"
+ },
+ "getMetrics": {
+ "path": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/metrics",
+ "id": "dataflow.projects.locations.jobs.getMetrics",
+ "description": "Request the job status.",
+ "response": {
+ "$ref": "JobMetrics"
+ },
+ "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": {
+ "startTime": {
+ "description": "Return only metric data that has changed since this time.\nDefault is to return all information about all metrics for the job.",
+ "format": "google-datetime",
+ "type": "string",
+ "location": "query"
+ },
+ "projectId": {
+ "location": "path",
+ "description": "A project id.",
+ "required": true,
+ "type": "string"
+ },
+ "jobId": {
+ "location": "path",
+ "description": "The job to get messages for.",
+ "required": true,
+ "type": "string"
+ },
+ "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"
+ },
"get": {
+ "path": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}",
+ "id": "dataflow.projects.locations.jobs.get",
"description": "Gets the state of the specified Cloud Dataflow job.",
"response": {
"$ref": "Job"
@@ -358,13 +503,12 @@
"location": "path"
},
"jobId": {
- "required": true,
- "type": "string",
"location": "path",
- "description": "The job ID."
+ "description": "The job ID.",
+ "required": true,
+ "type": "string"
},
"view": {
- "location": "query",
"enum": [
"JOB_VIEW_UNKNOWN",
"JOB_VIEW_SUMMARY",
@@ -372,7 +516,8 @@
"JOB_VIEW_DESCRIPTION"
],
"description": "The level of information requested in response.",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"location": {
"location": "path",
@@ -387,9 +532,7 @@
"https://www.googleapis.com/auth/compute.readonly",
"https://www.googleapis.com/auth/userinfo.email"
],
- "flatPath": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}",
- "path": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}",
- "id": "dataflow.projects.locations.jobs.get"
+ "flatPath": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}"
},
"list": {
"response": {
@@ -400,14 +543,21 @@
"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": {
"projectId": {
+ "location": "path",
"description": "The project which owns the jobs.",
"required": true,
- "type": "string",
- "location": "path"
+ "type": "string"
},
"filter": {
+ "location": "query",
"enum": [
"UNKNOWN",
"ALL",
@@ -415,223 +565,78 @@
"ACTIVE"
],
"description": "The kind of filter to use.",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"location": {
- "location": "path",
"description": "The location that contains this job.",
"required": true,
- "type": "string"
+ "type": "string",
+ "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"
- },
- "view": {
- "description": "Level of information requested in response. Default is `JOB_VIEW_SUMMARY`.",
- "type": "string",
- "location": "query",
- "enum": [
- "JOB_VIEW_UNKNOWN",
- "JOB_VIEW_SUMMARY",
- "JOB_VIEW_ALL",
- "JOB_VIEW_DESCRIPTION"
- ]
- }
- },
- "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",
- "path": "v1b3/projects/{projectId}/locations/{location}/jobs",
- "id": "dataflow.projects.locations.jobs.list",
- "description": "List the jobs of a project in a given region."
- },
- "update": {
- "response": {
- "$ref": "Job"
- },
- "parameterOrder": [
- "projectId",
- "location",
- "jobId"
- ],
- "httpMethod": "PUT",
- "parameters": {
- "projectId": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "The ID of the Cloud Platform project that the job belongs to."
- },
- "jobId": {
- "location": "path",
- "description": "The job ID.",
- "required": true,
- "type": "string"
- },
- "location": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "The location that contains this 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}",
- "path": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}",
- "id": "dataflow.projects.locations.jobs.update",
- "request": {
- "$ref": "Job"
- },
- "description": "Updates the state of an existing Cloud Dataflow job."
- },
- "create": {
- "path": "v1b3/projects/{projectId}/locations/{location}/jobs",
- "id": "dataflow.projects.locations.jobs.create",
- "description": "Creates a Cloud Dataflow job.",
- "request": {
- "$ref": "Job"
- },
- "response": {
- "$ref": "Job"
- },
- "parameterOrder": [
- "projectId",
- "location"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly",
- "https://www.googleapis.com/auth/userinfo.email"
- ],
- "parameters": {
- "location": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "The location that contains this job."
- },
- "replaceJobId": {
- "description": "Deprecated. This field is now in the Job message.",
- "type": "string",
+ "type": "integer",
"location": "query"
},
- "projectId": {
- "location": "path",
- "description": "The ID of the Cloud Platform project that the job belongs to.",
- "required": true,
- "type": "string"
- },
"view": {
- "location": "query",
"enum": [
"JOB_VIEW_UNKNOWN",
"JOB_VIEW_SUMMARY",
"JOB_VIEW_ALL",
"JOB_VIEW_DESCRIPTION"
],
- "description": "The level of information requested in response.",
- "type": "string"
- }
- },
- "flatPath": "v1b3/projects/{projectId}/locations/{location}/jobs"
- },
- "getMetrics": {
- "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": {
- "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",
+ "description": "Level of information requested in response. Default is `JOB_VIEW_SUMMARY`.",
"type": "string",
"location": "query"
- },
- "projectId": {
- "description": "A project id.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "jobId": {
- "location": "path",
- "description": "The job to get messages for.",
- "required": true,
- "type": "string"
}
},
- "flatPath": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/metrics",
- "path": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/metrics",
- "id": "dataflow.projects.locations.jobs.getMetrics",
- "description": "Request the job status.",
- "response": {
- "$ref": "JobMetrics"
- },
- "parameterOrder": [
- "projectId",
- "location",
- "jobId"
- ],
- "httpMethod": "GET"
+ "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."
}
},
"resources": {
"debug": {
"methods": {
"getConfig": {
- "response": {
- "$ref": "GetDebugConfigResponse"
+ "id": "dataflow.projects.locations.jobs.debug.getConfig",
+ "path": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/debug/getConfig",
+ "request": {
+ "$ref": "GetDebugConfigRequest"
},
+ "description": "Get encoded debug configuration for component. Not cacheable.",
+ "httpMethod": "POST",
"parameterOrder": [
"projectId",
"location",
"jobId"
],
- "httpMethod": "POST",
+ "response": {
+ "$ref": "GetDebugConfigResponse"
+ },
"parameters": {
- "location": {
- "description": "The location which contains the job specified by job_id.",
- "required": true,
- "type": "string",
- "location": "path"
- },
"projectId": {
+ "location": "path",
"description": "The project id.",
"required": true,
+ "type": "string"
+ },
+ "jobId": {
+ "description": "The job id.",
+ "required": true,
"type": "string",
"location": "path"
},
- "jobId": {
+ "location": {
"location": "path",
- "description": "The job id.",
+ "description": "The location which contains the job specified by job_id.",
"required": true,
"type": "string"
}
@@ -642,48 +647,15 @@
"https://www.googleapis.com/auth/compute.readonly",
"https://www.googleapis.com/auth/userinfo.email"
],
- "flatPath": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/debug/getConfig",
- "path": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/debug/getConfig",
- "id": "dataflow.projects.locations.jobs.debug.getConfig",
- "request": {
- "$ref": "GetDebugConfigRequest"
- },
- "description": "Get encoded debug configuration for component. Not cacheable."
+ "flatPath": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/debug/getConfig"
},
"sendCapture": {
- "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",
"path": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/debug/sendCapture",
"id": "dataflow.projects.locations.jobs.debug.sendCapture",
+ "description": "Send encoded debug capture data for component.",
"request": {
"$ref": "SendDebugCaptureRequest"
},
- "description": "Send encoded debug capture data for component.",
"response": {
"$ref": "SendDebugCaptureResponse"
},
@@ -692,22 +664,7 @@
"location",
"jobId"
],
- "httpMethod": "POST"
- }
- }
- },
- "workItems": {
- "methods": {
- "lease": {
"httpMethod": "POST",
- "parameterOrder": [
- "projectId",
- "location",
- "jobId"
- ],
- "response": {
- "$ref": "LeaseWorkItemResponse"
- },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
@@ -715,38 +672,32 @@
"https://www.googleapis.com/auth/userinfo.email"
],
"parameters": {
- "projectId": {
- "location": "path",
- "description": "Identifies the project this worker belongs to.",
+ "location": {
+ "description": "The location which contains the job specified by job_id.",
"required": true,
- "type": "string"
+ "type": "string",
+ "location": "path"
+ },
+ "projectId": {
+ "description": "The project id.",
+ "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.",
+ "description": "The job id.",
"required": true,
"type": "string"
}
},
- "flatPath": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/workItems:lease",
- "id": "dataflow.projects.locations.jobs.workItems.lease",
- "path": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/workItems:lease",
- "description": "Leases a dataflow WorkItem to run.",
- "request": {
- "$ref": "LeaseWorkItemRequest"
- }
- },
+ "flatPath": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/debug/sendCapture"
+ }
+ }
+ },
+ "workItems": {
+ "methods": {
"reportStatus": {
- "request": {
- "$ref": "ReportWorkItemStatusRequest"
- },
- "description": "Reports the status of dataflow WorkItems leased by a worker.",
"response": {
"$ref": "ReportWorkItemStatusResponse"
},
@@ -757,23 +708,23 @@
],
"httpMethod": "POST",
"parameters": {
- "location": {
- "description": "The location which contains the WorkItem's job.",
+ "projectId": {
+ "description": "The project which owns the WorkItem's job.",
"required": true,
"type": "string",
"location": "path"
},
- "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"
}
},
"scopes": [
@@ -784,16 +735,61 @@
],
"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"
+ "id": "dataflow.projects.locations.jobs.workItems.reportStatus",
+ "request": {
+ "$ref": "ReportWorkItemStatusRequest"
+ },
+ "description": "Reports the status of dataflow WorkItems leased by a worker."
+ },
+ "lease": {
+ "path": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/workItems:lease",
+ "id": "dataflow.projects.locations.jobs.workItems.lease",
+ "request": {
+ "$ref": "LeaseWorkItemRequest"
+ },
+ "description": "Leases a dataflow WorkItem to run.",
+ "response": {
+ "$ref": "LeaseWorkItemResponse"
+ },
+ "parameterOrder": [
+ "projectId",
+ "location",
+ "jobId"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "location": {
+ "location": "path",
+ "description": "The location which contains the WorkItem's job.",
+ "required": true,
+ "type": "string"
+ },
+ "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"
+ }
+ },
+ "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"
}
}
},
"messages": {
"methods": {
"list": {
- "path": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/messages",
- "id": "dataflow.projects.locations.jobs.messages.list",
- "description": "Request the job status.",
"response": {
"$ref": "ListJobMessagesResponse"
},
@@ -810,17 +806,41 @@
"https://www.googleapis.com/auth/userinfo.email"
],
"parameters": {
+ "jobId": {
+ "location": "path",
+ "description": "The job to get messages about.",
+ "required": true,
+ "type": "string"
+ },
+ "projectId": {
+ "location": "path",
+ "description": "A project id.",
+ "required": true,
+ "type": "string"
+ },
+ "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": {
+ "description": "The location which contains the job specified by job_id.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "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"
+ },
"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"
},
- "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"
- },
"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.",
@@ -828,8 +848,6 @@
"type": "integer"
},
"minimumImportance": {
- "description": "Filter to only get messages with importance \u003e= level",
- "type": "string",
"location": "query",
"enum": [
"JOB_MESSAGE_IMPORTANCE_UNKNOWN",
@@ -838,34 +856,15 @@
"JOB_MESSAGE_BASIC",
"JOB_MESSAGE_WARNING",
"JOB_MESSAGE_ERROR"
- ]
- },
- "projectId": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "A project id."
- },
- "jobId": {
- "location": "path",
- "description": "The job to get messages about.",
- "required": true,
- "type": "string"
- },
- "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,
+ ],
+ "description": "Filter to only get messages with importance \u003e= level",
"type": "string"
}
},
- "flatPath": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/messages"
+ "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."
}
}
}
@@ -874,337 +873,10 @@
}
},
"jobs": {
- "methods": {
- "create": {
- "description": "Creates a Cloud Dataflow job.",
- "request": {
- "$ref": "Job"
- },
- "response": {
- "$ref": "Job"
- },
- "parameterOrder": [
- "projectId"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly",
- "https://www.googleapis.com/auth/userinfo.email"
- ],
- "parameters": {
- "replaceJobId": {
- "description": "Deprecated. This field is now in the Job message.",
- "type": "string",
- "location": "query"
- },
- "projectId": {
- "description": "The ID of the Cloud Platform project that the job belongs to.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "view": {
- "location": "query",
- "enum": [
- "JOB_VIEW_UNKNOWN",
- "JOB_VIEW_SUMMARY",
- "JOB_VIEW_ALL",
- "JOB_VIEW_DESCRIPTION"
- ],
- "description": "The level of information requested in response.",
- "type": "string"
- },
- "location": {
- "description": "The location that contains this job.",
- "type": "string",
- "location": "query"
- }
- },
- "flatPath": "v1b3/projects/{projectId}/jobs",
- "path": "v1b3/projects/{projectId}/jobs",
- "id": "dataflow.projects.jobs.create"
- },
- "getMetrics": {
- "flatPath": "v1b3/projects/{projectId}/jobs/{jobId}/metrics",
- "path": "v1b3/projects/{projectId}/jobs/{jobId}/metrics",
- "id": "dataflow.projects.jobs.getMetrics",
- "description": "Request the job status.",
- "response": {
- "$ref": "JobMetrics"
- },
- "parameterOrder": [
- "projectId",
- "jobId"
- ],
- "httpMethod": "GET",
- "parameters": {
- "location": {
- "description": "The location which contains the job specified by job_id.",
- "type": "string",
- "location": "query"
- },
- "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"
- },
- "projectId": {
- "description": "A project id.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "jobId": {
- "location": "path",
- "description": "The job to get messages for.",
- "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"
- ]
- },
- "get": {
- "response": {
- "$ref": "Job"
- },
- "parameterOrder": [
- "projectId",
- "jobId"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly",
- "https://www.googleapis.com/auth/userinfo.email"
- ],
- "parameters": {
- "projectId": {
- "location": "path",
- "description": "The ID of the Cloud Platform project that the job belongs to.",
- "required": true,
- "type": "string"
- },
- "jobId": {
- "description": "The job ID.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "view": {
- "enum": [
- "JOB_VIEW_UNKNOWN",
- "JOB_VIEW_SUMMARY",
- "JOB_VIEW_ALL",
- "JOB_VIEW_DESCRIPTION"
- ],
- "description": "The level of information requested in response.",
- "type": "string",
- "location": "query"
- },
- "location": {
- "type": "string",
- "location": "query",
- "description": "The location that contains this job."
- }
- },
- "flatPath": "v1b3/projects/{projectId}/jobs/{jobId}",
- "path": "v1b3/projects/{projectId}/jobs/{jobId}",
- "id": "dataflow.projects.jobs.get",
- "description": "Gets the state of the specified Cloud Dataflow job."
- },
- "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": {
- "location": "query",
- "description": "The location that contains this job.",
- "type": "string"
- },
- "projectId": {
- "description": "The ID of the Cloud Platform project that the job belongs to.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "jobId": {
- "location": "path",
- "description": "The job ID.",
- "required": true,
- "type": "string"
- }
- },
- "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"
- }
- },
- "aggregated": {
- "httpMethod": "GET",
- "parameterOrder": [
- "projectId"
- ],
- "response": {
- "$ref": "ListJobsResponse"
- },
- "parameters": {
- "projectId": {
- "description": "The project which owns the jobs.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "filter": {
- "location": "query",
- "enum": [
- "UNKNOWN",
- "ALL",
- "TERMINATED",
- "ACTIVE"
- ],
- "description": "The kind of filter to use.",
- "type": "string"
- },
- "location": {
- "description": "The location that contains this job.",
- "type": "string",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "location": "query",
- "description": "Set this to the 'next_page_token' field of a previous response\nto request additional results in a long list."
- },
- "pageSize": {
- "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"
- },
- "view": {
- "location": "query",
- "enum": [
- "JOB_VIEW_UNKNOWN",
- "JOB_VIEW_SUMMARY",
- "JOB_VIEW_ALL",
- "JOB_VIEW_DESCRIPTION"
- ],
- "description": "Level of information requested in response. Default is `JOB_VIEW_SUMMARY`.",
- "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:aggregated",
- "id": "dataflow.projects.jobs.aggregated",
- "path": "v1b3/projects/{projectId}/jobs:aggregated",
- "description": "List the jobs of a project across all regions."
- },
- "list": {
- "path": "v1b3/projects/{projectId}/jobs",
- "id": "dataflow.projects.jobs.list",
- "description": "List the jobs of a project in a given region.",
- "response": {
- "$ref": "ListJobsResponse"
- },
- "parameterOrder": [
- "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": {
- "description": "The project which owns the jobs.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "filter": {
- "description": "The kind of filter to use.",
- "type": "string",
- "location": "query",
- "enum": [
- "UNKNOWN",
- "ALL",
- "TERMINATED",
- "ACTIVE"
- ]
- },
- "location": {
- "description": "The location that contains this job.",
- "type": "string",
- "location": "query"
- },
- "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"
- },
- "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"
- },
- "view": {
- "location": "query",
- "enum": [
- "JOB_VIEW_UNKNOWN",
- "JOB_VIEW_SUMMARY",
- "JOB_VIEW_ALL",
- "JOB_VIEW_DESCRIPTION"
- ],
- "description": "Level of information requested in response. Default is `JOB_VIEW_SUMMARY`.",
- "type": "string"
- }
- },
- "flatPath": "v1b3/projects/{projectId}/jobs"
- }
- },
"resources": {
"debug": {
"methods": {
"getConfig": {
- "flatPath": "v1b3/projects/{projectId}/jobs/{jobId}/debug/getConfig",
- "path": "v1b3/projects/{projectId}/jobs/{jobId}/debug/getConfig",
- "id": "dataflow.projects.jobs.debug.getConfig",
- "description": "Get encoded debug configuration for component. Not cacheable.",
- "request": {
- "$ref": "GetDebugConfigRequest"
- },
"response": {
"$ref": "GetDebugConfigResponse"
},
@@ -1213,12 +885,6 @@
"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 id.",
@@ -1232,9 +898,30 @@
"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}/debug/getConfig",
+ "path": "v1b3/projects/{projectId}/jobs/{jobId}/debug/getConfig",
+ "id": "dataflow.projects.jobs.debug.getConfig",
+ "request": {
+ "$ref": "GetDebugConfigRequest"
+ },
+ "description": "Get encoded debug configuration for component. Not cacheable."
},
"sendCapture": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "projectId",
+ "jobId"
+ ],
+ "response": {
+ "$ref": "SendDebugCaptureResponse"
+ },
"parameters": {
"projectId": {
"location": "path",
@@ -1261,15 +948,7 @@
"request": {
"$ref": "SendDebugCaptureRequest"
},
- "description": "Send encoded debug capture data for component.",
- "httpMethod": "POST",
- "parameterOrder": [
- "projectId",
- "jobId"
- ],
- "response": {
- "$ref": "SendDebugCaptureResponse"
- }
+ "description": "Send encoded debug capture data for component."
}
}
},
@@ -1284,18 +963,12 @@
"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",
- "location": "path"
+ "type": "string"
},
"jobId": {
"location": "path",
@@ -1304,29 +977,39 @@
"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",
- "description": "Reports the status of dataflow WorkItems leased by a worker.",
"request": {
"$ref": "ReportWorkItemStatusRequest"
- }
+ },
+ "description": "Reports the status of dataflow WorkItems leased by a worker."
},
"lease": {
- "httpMethod": "POST",
+ "request": {
+ "$ref": "LeaseWorkItemRequest"
+ },
+ "description": "Leases a dataflow WorkItem to run.",
+ "response": {
+ "$ref": "LeaseWorkItemResponse"
+ },
"parameterOrder": [
"projectId",
"jobId"
],
- "response": {
- "$ref": "LeaseWorkItemResponse"
- },
+ "httpMethod": "POST",
"parameters": {
"projectId": {
+ "location": "path",
"description": "Identifies the project this worker belongs to.",
"required": true,
- "type": "string",
- "location": "path"
+ "type": "string"
},
"jobId": {
"description": "Identifies the workflow job this worker belongs to.",
@@ -1342,20 +1025,14 @@
"https://www.googleapis.com/auth/userinfo.email"
],
"flatPath": "v1b3/projects/{projectId}/jobs/{jobId}/workItems:lease",
- "id": "dataflow.projects.jobs.workItems.lease",
"path": "v1b3/projects/{projectId}/jobs/{jobId}/workItems:lease",
- "request": {
- "$ref": "LeaseWorkItemRequest"
- },
- "description": "Leases a dataflow WorkItem to run."
+ "id": "dataflow.projects.jobs.workItems.lease"
}
}
},
"messages": {
"methods": {
"list": {
- "path": "v1b3/projects/{projectId}/jobs/{jobId}/messages",
- "id": "dataflow.projects.jobs.messages.list",
"description": "Request the job status.",
"response": {
"$ref": "ListJobMessagesResponse"
@@ -1366,25 +1043,6 @@
],
"httpMethod": "GET",
"parameters": {
- "pageSize": {
- "location": "query",
- "description": "If specified, determines the maximum number of messages to\nreturn. If unspecified, the service may choose an appropriate\ndefault, or may return an arbitrarily large number of results.",
- "format": "int32",
- "type": "integer"
- },
- "minimumImportance": {
- "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.",
@@ -1398,25 +1056,44 @@
"type": "string"
},
"location": {
- "location": "query",
"description": "The location which contains the job specified by job_id.",
- "type": "string"
- },
- "endTime": {
- "type": "string",
- "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"
- },
- "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": {
+ "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": {
+ "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"
+ },
+ "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"
}
},
@@ -1426,51 +1103,362 @@
"https://www.googleapis.com/auth/compute.readonly",
"https://www.googleapis.com/auth/userinfo.email"
],
- "flatPath": "v1b3/projects/{projectId}/jobs/{jobId}/messages"
+ "flatPath": "v1b3/projects/{projectId}/jobs/{jobId}/messages",
+ "path": "v1b3/projects/{projectId}/jobs/{jobId}/messages",
+ "id": "dataflow.projects.jobs.messages.list"
}
}
}
+ },
+ "methods": {
+ "update": {
+ "response": {
+ "$ref": "Job"
+ },
+ "parameterOrder": [
+ "projectId",
+ "jobId"
+ ],
+ "httpMethod": "PUT",
+ "parameters": {
+ "projectId": {
+ "description": "The ID of the Cloud Platform project that the job belongs to.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "jobId": {
+ "description": "The job ID.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "location": {
+ "location": "query",
+ "description": "The location that contains this job.",
+ "type": "string"
+ }
+ },
+ "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": {
+ "response": {
+ "$ref": "ListJobsResponse"
+ },
+ "parameterOrder": [
+ "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": "The project which owns the jobs.",
+ "required": true,
+ "type": "string"
+ },
+ "filter": {
+ "enum": [
+ "UNKNOWN",
+ "ALL",
+ "TERMINATED",
+ "ACTIVE"
+ ],
+ "description": "The kind of filter to use.",
+ "type": "string",
+ "location": "query"
+ },
+ "location": {
+ "description": "The location that contains this job.",
+ "type": "string",
+ "location": "query"
+ },
+ "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"
+ },
+ "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"
+ },
+ "view": {
+ "enum": [
+ "JOB_VIEW_UNKNOWN",
+ "JOB_VIEW_SUMMARY",
+ "JOB_VIEW_ALL",
+ "JOB_VIEW_DESCRIPTION"
+ ],
+ "description": "Level of information requested in response. Default is `JOB_VIEW_SUMMARY`.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "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."
+ },
+ "list": {
+ "description": "List the jobs of a project in a given region.",
+ "response": {
+ "$ref": "ListJobsResponse"
+ },
+ "parameterOrder": [
+ "projectId"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "filter": {
+ "enum": [
+ "UNKNOWN",
+ "ALL",
+ "TERMINATED",
+ "ACTIVE"
+ ],
+ "description": "The kind of filter to use.",
+ "type": "string",
+ "location": "query"
+ },
+ "location": {
+ "location": "query",
+ "description": "The location that contains this job.",
+ "type": "string"
+ },
+ "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"
+ },
+ "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"
+ },
+ "view": {
+ "location": "query",
+ "enum": [
+ "JOB_VIEW_UNKNOWN",
+ "JOB_VIEW_SUMMARY",
+ "JOB_VIEW_ALL",
+ "JOB_VIEW_DESCRIPTION"
+ ],
+ "description": "Level of information requested in response. Default is `JOB_VIEW_SUMMARY`.",
+ "type": "string"
+ },
+ "projectId": {
+ "location": "path",
+ "description": "The project which owns the jobs.",
+ "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",
+ "path": "v1b3/projects/{projectId}/jobs",
+ "id": "dataflow.projects.jobs.list"
+ },
+ "create": {
+ "request": {
+ "$ref": "Job"
+ },
+ "description": "Creates a Cloud Dataflow job.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "projectId"
+ ],
+ "response": {
+ "$ref": "Job"
+ },
+ "parameters": {
+ "replaceJobId": {
+ "description": "Deprecated. This field is now in the Job message.",
+ "type": "string",
+ "location": "query"
+ },
+ "projectId": {
+ "location": "path",
+ "description": "The ID of the Cloud Platform project that the job belongs to.",
+ "required": true,
+ "type": "string"
+ },
+ "view": {
+ "enum": [
+ "JOB_VIEW_UNKNOWN",
+ "JOB_VIEW_SUMMARY",
+ "JOB_VIEW_ALL",
+ "JOB_VIEW_DESCRIPTION"
+ ],
+ "description": "The level of information requested in response.",
+ "type": "string",
+ "location": "query"
+ },
+ "location": {
+ "description": "The location that contains this job.",
+ "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",
+ "id": "dataflow.projects.jobs.create",
+ "path": "v1b3/projects/{projectId}/jobs"
+ },
+ "getMetrics": {
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "projectId",
+ "jobId"
+ ],
+ "response": {
+ "$ref": "JobMetrics"
+ },
+ "parameters": {
+ "location": {
+ "description": "The location which contains the job specified by job_id.",
+ "type": "string",
+ "location": "query"
+ },
+ "startTime": {
+ "description": "Return only metric data that has changed since this time.\nDefault is to return all information about all metrics for the job.",
+ "format": "google-datetime",
+ "type": "string",
+ "location": "query"
+ },
+ "projectId": {
+ "location": "path",
+ "description": "A project id.",
+ "required": true,
+ "type": "string"
+ },
+ "jobId": {
+ "description": "The job to get messages for.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "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}/metrics",
+ "id": "dataflow.projects.jobs.getMetrics",
+ "path": "v1b3/projects/{projectId}/jobs/{jobId}/metrics",
+ "description": "Request the job status."
+ },
+ "get": {
+ "response": {
+ "$ref": "Job"
+ },
+ "parameterOrder": [
+ "projectId",
+ "jobId"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "projectId": {
+ "location": "path",
+ "description": "The ID of the Cloud Platform project that the job belongs to.",
+ "required": true,
+ "type": "string"
+ },
+ "jobId": {
+ "location": "path",
+ "description": "The job ID.",
+ "required": true,
+ "type": "string"
+ },
+ "view": {
+ "location": "query",
+ "enum": [
+ "JOB_VIEW_UNKNOWN",
+ "JOB_VIEW_SUMMARY",
+ "JOB_VIEW_ALL",
+ "JOB_VIEW_DESCRIPTION"
+ ],
+ "description": "The level of information requested in response.",
+ "type": "string"
+ },
+ "location": {
+ "description": "The location that contains this job.",
+ "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}",
+ "path": "v1b3/projects/{projectId}/jobs/{jobId}",
+ "id": "dataflow.projects.jobs.get",
+ "description": "Gets the state of the specified Cloud Dataflow job."
+ }
}
}
}
}
},
"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": {
- "location": "query",
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"prettyPrint": {
+ "location": "query",
"description": "Returns response with indentations and line breaks.",
"type": "boolean",
- "default": "true",
- "location": "query"
+ "default": "true"
},
"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",
+ "location": "query"
+ },
+ "callback": {
+ "location": "query",
+ "description": "JSONP",
"type": "string"
},
"$.xgafv": {
@@ -1486,14 +1474,7 @@
"description": "V1 error format.",
"type": "string"
},
- "callback": {
- "description": "JSONP",
- "type": "string",
- "location": "query"
- },
"alt": {
- "description": "Data format for response.",
- "default": "json",
"enum": [
"json",
"media",
@@ -1505,78 +1486,1375 @@
"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",
+ "description": "API key. 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"
},
- "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"
+ },
+ "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"
}
},
"schemas": {
- "Position": {
+ "CustomSourceLocation": {
"properties": {
- "shufflePosition": {
- "description": "CloudPosition is a base64 encoded BatchShufflePosition (with FIXED\nsharding).",
+ "stateful": {
+ "description": "Whether this source is stateful.",
+ "type": "boolean"
+ }
+ },
+ "id": "CustomSourceLocation",
+ "description": "Identifies the location of a custom souce.",
+ "type": "object"
+ },
+ "MapTask": {
+ "properties": {
+ "systemName": {
+ "description": "System-defined name of this MapTask.\nUnique across the workflow.",
"type": "string"
},
- "byteOffset": {
- "description": "Position is a byte offset.",
+ "stageName": {
+ "description": "System-defined name of the stage containing this MapTask.\nUnique across the workflow.",
+ "type": "string"
+ },
+ "instructions": {
+ "description": "The instructions in the MapTask.",
+ "type": "array",
+ "items": {
+ "$ref": "ParallelInstruction"
+ }
+ }
+ },
+ "id": "MapTask",
+ "description": "MapTask consists of an ordered set of instructions, each of which\ndescribes one particular low-level operation for the worker to\nperform in order to accomplish the MapTask's WorkItem.\n\nEach instruction must appear in the list before any instructions which\ndepends on its output.",
+ "type": "object"
+ },
+ "FloatingPointMean": {
+ "description": "A representation of a floating point mean metric contribution.",
+ "type": "object",
+ "properties": {
+ "sum": {
+ "description": "The sum of all values being aggregated.",
+ "format": "double",
+ "type": "number"
+ },
+ "count": {
+ "description": "The number of values being aggregated.",
+ "$ref": "SplitInt64"
+ }
+ },
+ "id": "FloatingPointMean"
+ },
+ "ReportWorkItemStatusResponse": {
+ "description": "Response from a request to report the status of WorkItems.",
+ "type": "object",
+ "properties": {
+ "workItemServiceStates": {
+ "description": "A set of messages indicating the service-side state for each\nWorkItem whose status was reported, in the same order as the\nWorkItemStatus messages in the ReportWorkItemStatusRequest which\nresulting in this response.",
+ "type": "array",
+ "items": {
+ "$ref": "WorkItemServiceState"
+ }
+ }
+ },
+ "id": "ReportWorkItemStatusResponse"
+ },
+ "InstructionOutput": {
+ "properties": {
+ "systemName": {
+ "description": "System-defined name of this output.\nUnique across the workflow.",
+ "type": "string"
+ },
+ "onlyCountKeyBytes": {
+ "description": "For system-generated byte and mean byte metrics, certain instructions\nshould only report the key size.",
+ "type": "boolean"
+ },
+ "onlyCountValueBytes": {
+ "description": "For system-generated byte and mean byte metrics, certain instructions\nshould only report the value size.",
+ "type": "boolean"
+ },
+ "codec": {
+ "additionalProperties": {
+ "description": "Properties of the object.",
+ "type": "any"
+ },
+ "description": "The codec to use to encode data being written via this output.",
+ "type": "object"
+ },
+ "name": {
+ "description": "The user-provided name of this output.",
+ "type": "string"
+ },
+ "originalName": {
+ "description": "System-defined name for this output in the original workflow graph.\nOutputs that do not contribute to an original instruction do not set this.",
+ "type": "string"
+ }
+ },
+ "id": "InstructionOutput",
+ "description": "An output of an instruction.",
+ "type": "object"
+ },
+ "CreateJobFromTemplateRequest": {
+ "description": "A request to create a Cloud Dataflow job from a template.",
+ "type": "object",
+ "properties": {
+ "gcsPath": {
+ "description": "Required. A Cloud Storage path to the template from which to\ncreate the job.\nMust be a valid Cloud Storage URL, beginning with `gs://`.",
+ "type": "string"
+ },
+ "environment": {
+ "description": "The runtime environment for the job.",
+ "$ref": "RuntimeEnvironment"
+ },
+ "location": {
+ "description": "The location to which to direct the request.",
+ "type": "string"
+ },
+ "parameters": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "The runtime parameters to pass to the job.",
+ "type": "object"
+ },
+ "jobName": {
+ "description": "Required. The job name to use for the created job.",
+ "type": "string"
+ }
+ },
+ "id": "CreateJobFromTemplateRequest"
+ },
+ "IntegerMean": {
+ "properties": {
+ "count": {
+ "$ref": "SplitInt64",
+ "description": "The number of values being aggregated."
+ },
+ "sum": {
+ "$ref": "SplitInt64",
+ "description": "The sum of all values being aggregated."
+ }
+ },
+ "id": "IntegerMean",
+ "description": "A representation of an integer mean metric contribution.",
+ "type": "object"
+ },
+ "ListJobsResponse": {
+ "properties": {
+ "nextPageToken": {
+ "description": "Set if there may be more results than fit in this response.",
+ "type": "string"
+ },
+ "failedLocation": {
+ "description": "Zero or more messages describing locations that failed to respond.",
+ "type": "array",
+ "items": {
+ "$ref": "FailedLocation"
+ }
+ },
+ "jobs": {
+ "description": "A subset of the requested job information.",
+ "type": "array",
+ "items": {
+ "$ref": "Job"
+ }
+ }
+ },
+ "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"
+ },
+ "computationId": {
+ "description": "The ID of the computation.",
+ "type": "string"
+ },
+ "inputs": {
+ "description": "The inputs to the computation.",
+ "type": "array",
+ "items": {
+ "$ref": "StreamLocation"
+ }
+ },
+ "keyRanges": {
+ "description": "The key ranges processed by the computation.",
+ "type": "array",
+ "items": {
+ "$ref": "KeyRangeLocation"
+ }
+ }
+ },
+ "id": "ComputationTopology",
+ "description": "All configuration data for a particular Computation.",
+ "type": "object"
+ },
+ "RuntimeEnvironment": {
+ "description": "The environment values to set at runtime.",
+ "type": "object",
+ "properties": {
+ "serviceAccountEmail": {
+ "description": "The email address of the service account to run the job as.",
+ "type": "string"
+ },
+ "tempLocation": {
+ "description": "The Cloud Storage path to use for temporary files.\nMust be a valid Cloud Storage URL, beginning with `gs://`.",
+ "type": "string"
+ },
+ "bypassTempDirValidation": {
+ "description": "Whether to bypass the safety checks for the job's temporary directory.\nUse with caution.",
+ "type": "boolean"
+ },
+ "machineType": {
+ "description": "The machine type to use for the job. Defaults to the value from the\ntemplate if not specified.",
+ "type": "string"
+ },
+ "zone": {
+ "description": "The Compute Engine [availability\nzone](https://cloud.google.com/compute/docs/regions-zones/regions-zones)\nfor launching worker instances to run your pipeline.",
+ "type": "string"
+ },
+ "additionalExperiments": {
+ "description": "Additional experiment flags for the job.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "maxWorkers": {
+ "description": "The maximum number of Google Compute Engine instances to be made\navailable to your pipeline during execution, from 1 to 1000.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "RuntimeEnvironment"
+ },
+ "MountedDataDisk": {
+ "description": "Describes mounted data disk.",
+ "type": "object",
+ "properties": {
+ "dataDisk": {
+ "description": "The name of the data disk.\nThis name is local to the Google Cloud Platform project and uniquely\nidentifies the disk within that project, for example\n\"myproject-1014-104817-4c2-harness-0-disk-1\".",
+ "type": "string"
+ }
+ },
+ "id": "MountedDataDisk"
+ },
+ "StreamingSideInputLocation": {
+ "properties": {
+ "stateFamily": {
+ "description": "Identifies the state family where this side input is stored.",
+ "type": "string"
+ },
+ "tag": {
+ "description": "Identifies the particular side input within the streaming Dataflow job.",
+ "type": "string"
+ }
+ },
+ "id": "StreamingSideInputLocation",
+ "description": "Identifies the location of a streaming side input.",
+ "type": "object"
+ },
+ "LaunchTemplateResponse": {
+ "description": "Response to the request to launch a template.",
+ "type": "object",
+ "properties": {
+ "job": {
+ "description": "The job that was launched, if the request was not a dry run and\nthe job was successfully launched.",
+ "$ref": "Job"
+ }
+ },
+ "id": "LaunchTemplateResponse"
+ },
+ "Job": {
+ "properties": {
+ "currentStateTime": {
+ "description": "The timestamp associated with the current state.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "transformNameMapping": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "The map of transform name prefixes of the job to be replaced to the\ncorresponding name prefixes of the new job.",
+ "type": "object"
+ },
+ "createTime": {
+ "description": "The timestamp when the job was initially created. Immutable and set by the\nCloud Dataflow service.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "environment": {
+ "description": "The environment for the job.",
+ "$ref": "Environment"
+ },
+ "labels": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "User-defined labels for this job.\n\nThe labels map can contain no more than 64 entries. Entries of the labels\nmap are UTF8 strings that comply with the following restrictions:\n\n* Keys must conform to regexp: \\p{Ll}\\p{Lo}{0,62}\n* Values must conform to regexp: [\\p{Ll}\\p{Lo}\\p{N}_-]{0,63}\n* Both keys and values are additionally constrained to be \u003c= 128 bytes in\nsize.",
+ "type": "object"
+ },
+ "stageStates": {
+ "description": "This field may be mutated by the Cloud Dataflow service;\ncallers cannot mutate it.",
+ "type": "array",
+ "items": {
+ "$ref": "ExecutionStageState"
+ }
+ },
+ "projectId": {
+ "description": "The ID of the Cloud Platform project that the job belongs to.",
+ "type": "string"
+ },
+ "type": {
+ "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"
+ },
+ "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.",
+ "$ref": "PipelineDescription"
+ },
+ "replaceJobId": {
+ "description": "If this job is an update of an existing job, this field is the job ID\nof the job it replaced.\n\nWhen sending a `CreateJobRequest`, you can update a job by specifying it\nhere. The job named here is stopped, and its intermediate state is\ntransferred to this job.",
+ "type": "string"
+ },
+ "requestedState": {
+ "enumDescriptions": [
+ "The job's run state isn't specified.",
+ "`JOB_STATE_STOPPED` indicates that the job has not\nyet started to run.",
+ "`JOB_STATE_RUNNING` indicates that the job is currently running.",
+ "`JOB_STATE_DONE` indicates that the job has successfully completed.\nThis is a terminal job state. This state may be set by the Cloud Dataflow\nservice, as a transition from `JOB_STATE_RUNNING`. It may also be set via a\nCloud Dataflow `UpdateJob` call, if the job has not yet reached a terminal\nstate.",
+ "`JOB_STATE_FAILED` indicates that the job has failed. This is a\nterminal job state. This state may only be set by the Cloud Dataflow\nservice, and only as a transition from `JOB_STATE_RUNNING`.",
+ "`JOB_STATE_CANCELLED` indicates that the job has been explicitly\ncancelled. This is a terminal job state. This state may only be\nset via a Cloud Dataflow `UpdateJob` call, and only if the job has not\nyet reached another terminal state.",
+ "`JOB_STATE_UPDATED` indicates that the job was successfully updated,\nmeaning that this job was stopped and another job was started, inheriting\nstate from this one. This is a terminal job state. This state may only be\nset by the Cloud Dataflow service, and only as a transition from\n`JOB_STATE_RUNNING`.",
+ "`JOB_STATE_DRAINING` indicates that the job is in the process of draining.\nA draining job has stopped pulling from its input sources and is processing\nany data that remains in-flight. This state may be set via a Cloud Dataflow\n`UpdateJob` call, but only as a transition from `JOB_STATE_RUNNING`. Jobs\nthat are draining may only transition to `JOB_STATE_DRAINED`,\n`JOB_STATE_CANCELLED`, or `JOB_STATE_FAILED`.",
+ "`JOB_STATE_DRAINED` indicates that the job has been drained.\nA drained job terminated by stopping pulling from its input sources and\nprocessing any data that remained in-flight when draining was requested.\nThis state is a terminal state, may only be set by the Cloud Dataflow\nservice, and only as a transition from `JOB_STATE_DRAINING`.",
+ "'JOB_STATE_PENDING' indicates that the job has been created but is not yet\nrunning. Jobs that are pending may only transition to `JOB_STATE_RUNNING`,\nor `JOB_STATE_FAILED`.",
+ "'JOB_STATE_CANCELLING' indicates that the job has been explicitly cancelled\nand is in the process of stopping. Jobs that are cancelling may only\ntransition to 'JOB_STATE_CANCELLED' or 'JOB_STATE_FAILED'."
+ ],
+ "enum": [
+ "JOB_STATE_UNKNOWN",
+ "JOB_STATE_STOPPED",
+ "JOB_STATE_RUNNING",
+ "JOB_STATE_DONE",
+ "JOB_STATE_FAILED",
+ "JOB_STATE_CANCELLED",
+ "JOB_STATE_UPDATED",
+ "JOB_STATE_DRAINING",
+ "JOB_STATE_DRAINED",
+ "JOB_STATE_PENDING",
+ "JOB_STATE_CANCELLING"
+ ],
+ "description": "The job's requested state.\n\n`UpdateJob` may be used to switch between the `JOB_STATE_STOPPED` and\n`JOB_STATE_RUNNING` states, by setting requested_state. `UpdateJob` may\nalso be used to directly set a job's requested state to\n`JOB_STATE_CANCELLED` or `JOB_STATE_DONE`, irrevocably terminating the\njob if it has not already reached a terminal state.",
+ "type": "string"
+ },
+ "tempFiles": {
+ "description": "A set of files the system should be aware of that are used\nfor temporary storage. These temporary files will be\nremoved on job completion.\nNo duplicates are allowed.\nNo file patterns are supported.\n\nThe supported files are:\n\nGoogle Cloud Storage:\n\n storage.googleapis.com/{bucket}/{object}\n bucket.storage.googleapis.com/{object}",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "clientRequestId": {
+ "description": "The client's unique identifier of the job, re-used across retried attempts.\nIf this field is set, the service will ensure its uniqueness.\nThe request to create a job will fail if the service has knowledge of a\npreviously submitted job with the same client's ID and job name.\nThe caller may use this field to ensure idempotence of job\ncreation across retried attempts to create a job.\nBy default, the field is empty and, in that case, the service ignores it.",
+ "type": "string"
+ },
+ "name": {
+ "description": "The user-specified Cloud Dataflow job name.\n\nOnly one Job with a given name may exist in a project at any\ngiven time. If a caller attempts to create a Job with the same\nname as an already-existing Job, the attempt returns the\nexisting Job.\n\nThe name must match the regular expression\n`[a-z]([-a-z0-9]{0,38}[a-z0-9])?`",
+ "type": "string"
+ },
+ "replacedByJobId": {
+ "description": "If another job is an update of this job (and thus, this job is in\n`JOB_STATE_UPDATED`), this field contains the ID of that job.",
+ "type": "string"
+ },
+ "steps": {
+ "description": "The top-level steps that constitute the entire job.",
+ "type": "array",
+ "items": {
+ "$ref": "Step"
+ }
+ },
+ "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": {
+ "enum": [
+ "JOB_STATE_UNKNOWN",
+ "JOB_STATE_STOPPED",
+ "JOB_STATE_RUNNING",
+ "JOB_STATE_DONE",
+ "JOB_STATE_FAILED",
+ "JOB_STATE_CANCELLED",
+ "JOB_STATE_UPDATED",
+ "JOB_STATE_DRAINING",
+ "JOB_STATE_DRAINED",
+ "JOB_STATE_PENDING",
+ "JOB_STATE_CANCELLING"
+ ],
+ "description": "The current state of the job.\n\nJobs are created in the `JOB_STATE_STOPPED` state unless otherwise\nspecified.\n\nA job in the `JOB_STATE_RUNNING` state may asynchronously enter a\nterminal state. After a job has reached a terminal state, no\nfurther state updates may be made.\n\nThis field may be mutated by the Cloud Dataflow service;\ncallers cannot mutate it.",
+ "type": "string",
+ "enumDescriptions": [
+ "The job's run state isn't specified.",
+ "`JOB_STATE_STOPPED` indicates that the job has not\nyet started to run.",
+ "`JOB_STATE_RUNNING` indicates that the job is currently running.",
+ "`JOB_STATE_DONE` indicates that the job has successfully completed.\nThis is a terminal job state. This state may be set by the Cloud Dataflow\nservice, as a transition from `JOB_STATE_RUNNING`. It may also be set via a\nCloud Dataflow `UpdateJob` call, if the job has not yet reached a terminal\nstate.",
+ "`JOB_STATE_FAILED` indicates that the job has failed. This is a\nterminal job state. This state may only be set by the Cloud Dataflow\nservice, and only as a transition from `JOB_STATE_RUNNING`.",
+ "`JOB_STATE_CANCELLED` indicates that the job has been explicitly\ncancelled. This is a terminal job state. This state may only be\nset via a Cloud Dataflow `UpdateJob` call, and only if the job has not\nyet reached another terminal state.",
+ "`JOB_STATE_UPDATED` indicates that the job was successfully updated,\nmeaning that this job was stopped and another job was started, inheriting\nstate from this one. This is a terminal job state. This state may only be\nset by the Cloud Dataflow service, and only as a transition from\n`JOB_STATE_RUNNING`.",
+ "`JOB_STATE_DRAINING` indicates that the job is in the process of draining.\nA draining job has stopped pulling from its input sources and is processing\nany data that remains in-flight. This state may be set via a Cloud Dataflow\n`UpdateJob` call, but only as a transition from `JOB_STATE_RUNNING`. Jobs\nthat are draining may only transition to `JOB_STATE_DRAINED`,\n`JOB_STATE_CANCELLED`, or `JOB_STATE_FAILED`.",
+ "`JOB_STATE_DRAINED` indicates that the job has been drained.\nA drained job terminated by stopping pulling from its input sources and\nprocessing any data that remained in-flight when draining was requested.\nThis state is a terminal state, may only be set by the Cloud Dataflow\nservice, and only as a transition from `JOB_STATE_DRAINING`.",
+ "'JOB_STATE_PENDING' indicates that the job has been created but is not yet\nrunning. Jobs that are pending may only transition to `JOB_STATE_RUNNING`,\nor `JOB_STATE_FAILED`.",
+ "'JOB_STATE_CANCELLING' indicates that the job has been explicitly cancelled\nand is in the process of stopping. Jobs that are cancelling may only\ntransition to 'JOB_STATE_CANCELLED' or 'JOB_STATE_FAILED'."
+ ]
+ },
+ "location": {
+ "description": "The location that contains this job.",
+ "type": "string"
+ }
+ },
+ "id": "Job",
+ "description": "Defines a job to be run by the Cloud Dataflow service.",
+ "type": "object"
+ },
+ "DynamicSourceSplit": {
+ "properties": {
+ "primary": {
+ "$ref": "DerivedSource",
+ "description": "Primary part (continued to be processed by worker).\nSpecified relative to the previously-current source.\nBecomes current."
+ },
+ "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"
+ },
+ "DerivedSource": {
+ "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": {
+ "description": "Specification of the source.",
+ "$ref": "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"
+ },
+ "SourceOperationResponse": {
+ "description": "The result of a SourceOperationRequest, specified in\nReportWorkItemStatusRequest.source_operation when the work item\nis completed.",
+ "type": "object",
+ "properties": {
+ "getMetadata": {
+ "$ref": "SourceGetMetadataResponse",
+ "description": "A response to a request to get metadata about a source."
+ },
+ "split": {
+ "description": "A response to a request to split a source.",
+ "$ref": "SourceSplitResponse"
+ }
+ },
+ "id": "SourceOperationResponse"
+ },
+ "SendDebugCaptureResponse": {
+ "description": "Response to a send capture request.\nnothing",
+ "type": "object",
+ "properties": {},
+ "id": "SendDebugCaptureResponse"
+ },
+ "SideInputInfo": {
+ "properties": {
+ "sources": {
+ "description": "The source(s) to read element(s) from to get the value of this side input.\nIf more than one source, then the elements are taken from the\nsources, in the specified order if order matters.\nAt least one source is required.",
+ "type": "array",
+ "items": {
+ "$ref": "Source"
+ }
+ },
+ "kind": {
+ "additionalProperties": {
+ "description": "Properties of the object.",
+ "type": "any"
+ },
+ "description": "How to interpret the source element(s) as a side input value.",
+ "type": "object"
+ },
+ "tag": {
+ "description": "The id of the tag the user code will access this side input by;\nthis should correspond to the tag of some MultiOutputInfo.",
+ "type": "string"
+ }
+ },
+ "id": "SideInputInfo",
+ "description": "Information about a side input of a DoFn or an input of a SeqDoFn.",
+ "type": "object"
+ },
+ "CounterStructuredNameAndMetadata": {
+ "properties": {
+ "name": {
+ "$ref": "CounterStructuredName",
+ "description": "Structured name of the counter."
+ },
+ "metadata": {
+ "$ref": "CounterMetadata",
+ "description": "Metadata associated with a counter"
+ }
+ },
+ "id": "CounterStructuredNameAndMetadata",
+ "description": "A single message which encapsulates structured name and metadata for a given\ncounter.",
+ "type": "object"
+ },
+ "ConcatPosition": {
+ "properties": {
+ "position": {
+ "$ref": "Position",
+ "description": "Position within the inner source."
+ },
+ "index": {
+ "description": "Index of the inner source.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "ConcatPosition",
+ "description": "A position that encapsulates an inner position and an index for the inner\nposition. A ConcatPosition can be used by a reader of a source that\nencapsulates a set of other sources.",
+ "type": "object"
+ },
+ "WriteInstruction": {
+ "properties": {
+ "input": {
+ "description": "The input.",
+ "$ref": "InstructionInput"
+ },
+ "sink": {
+ "$ref": "Sink",
+ "description": "The sink to write to."
+ }
+ },
+ "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": {
+ "computationId": {
+ "description": "The ID of the computation.",
+ "type": "string"
+ },
+ "rangeAssignments": {
+ "description": "Data disk assignments for ranges from this computation.",
+ "type": "array",
+ "items": {
+ "$ref": "KeyRangeDataDiskAssignment"
+ }
+ }
+ },
+ "id": "StreamingComputationRanges"
+ },
+ "AutoscalingSettings": {
+ "properties": {
+ "maxNumWorkers": {
+ "description": "The maximum number of workers to cap scaling at.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "algorithm": {
+ "enum": [
+ "AUTOSCALING_ALGORITHM_UNKNOWN",
+ "AUTOSCALING_ALGORITHM_NONE",
+ "AUTOSCALING_ALGORITHM_BASIC"
+ ],
+ "description": "The algorithm to use for autoscaling.",
+ "type": "string",
+ "enumDescriptions": [
+ "The algorithm is unknown, or unspecified.",
+ "Disable autoscaling.",
+ "Increase worker count over time to reduce job execution time."
+ ]
+ }
+ },
+ "id": "AutoscalingSettings",
+ "description": "Settings for WorkerPool autoscaling.",
+ "type": "object"
+ },
+ "ExecutionStageSummary": {
+ "description": "Description of the composing transforms, names/ids, and input/outputs of a\nstage of execution. Some composing transforms and sources may have been\ngenerated by the Dataflow service during execution planning.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "Dataflow service generated name for this stage.",
+ "type": "string"
+ },
+ "inputSource": {
+ "description": "Input sources for this stage.",
+ "type": "array",
+ "items": {
+ "$ref": "StageSource"
+ }
+ },
+ "id": {
+ "description": "Dataflow service generated id for this stage.",
+ "type": "string"
+ },
+ "componentTransform": {
+ "description": "Transforms that comprise this execution stage.",
+ "type": "array",
+ "items": {
+ "$ref": "ComponentTransform"
+ }
+ },
+ "componentSource": {
+ "description": "Collections produced and consumed by component transforms of this stage.",
+ "type": "array",
+ "items": {
+ "$ref": "ComponentSource"
+ }
+ },
+ "kind": {
+ "enum": [
+ "UNKNOWN_KIND",
+ "PAR_DO_KIND",
+ "GROUP_BY_KEY_KIND",
+ "FLATTEN_KIND",
+ "READ_KIND",
+ "WRITE_KIND",
+ "CONSTANT_KIND",
+ "SINGLETON_KIND",
+ "SHUFFLE_KIND"
+ ],
+ "description": "Type of tranform this stage is executing.",
+ "type": "string",
+ "enumDescriptions": [
+ "Unrecognized transform type.",
+ "ParDo transform.",
+ "Group By Key transform.",
+ "Flatten transform.",
+ "Read transform.",
+ "Write transform.",
+ "Constructs from a constant value, such as with Create.of.",
+ "Creates a Singleton view of a collection.",
+ "Opening or closing a shuffle session, often as part of a GroupByKey."
+ ]
+ },
+ "outputSource": {
+ "description": "Output sources for this stage.",
+ "type": "array",
+ "items": {
+ "$ref": "StageSource"
+ }
+ }
+ },
+ "id": "ExecutionStageSummary"
+ },
+ "SendWorkerMessagesRequest": {
+ "description": "A request for sending worker messages to the service.",
+ "type": "object",
+ "properties": {
+ "workerMessages": {
+ "description": "The WorkerMessages to send.",
+ "type": "array",
+ "items": {
+ "$ref": "WorkerMessage"
+ }
+ },
+ "location": {
+ "description": "The location which contains the job",
+ "type": "string"
+ }
+ },
+ "id": "SendWorkerMessagesRequest"
+ },
+ "SourceSplitShard": {
+ "description": "DEPRECATED in favor of DerivedSource.",
+ "type": "object",
+ "properties": {
+ "derivationMode": {
+ "enum": [
+ "SOURCE_DERIVATION_MODE_UNKNOWN",
+ "SOURCE_DERIVATION_MODE_INDEPENDENT",
+ "SOURCE_DERIVATION_MODE_CHILD_OF_CURRENT",
+ "SOURCE_DERIVATION_MODE_SIBLING_OF_CURRENT"
+ ],
+ "description": "DEPRECATED",
+ "type": "string",
+ "enumDescriptions": [
+ "The source derivation is unknown, or unspecified.",
+ "Produce a completely independent Source with no base.",
+ "Produce a Source based on the Source being split.",
+ "Produce a Source based on the base of the Source being split."
+ ]
+ },
+ "source": {
+ "$ref": "Source",
+ "description": "DEPRECATED"
+ }
+ },
+ "id": "SourceSplitShard"
+ },
+ "CPUTime": {
+ "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.",
+ "format": "uint64",
+ "type": "string"
+ },
+ "rate": {
+ "description": "Average CPU utilization rate (% non-idle cpu / second) since previous\nsample.",
+ "format": "double",
+ "type": "number"
+ },
+ "timestamp": {
+ "description": "Timestamp of the measurement.",
+ "format": "google-datetime",
+ "type": "string"
+ }
+ },
+ "id": "CPUTime"
+ },
+ "Environment": {
+ "properties": {
+ "experiments": {
+ "description": "The list of experiments to enable.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "version": {
+ "additionalProperties": {
+ "description": "Properties of the object.",
+ "type": "any"
+ },
+ "description": "A structure describing which components and their versions of the service\nare required in order to run the job.",
+ "type": "object"
+ },
+ "internalExperiments": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "description": "Experimental settings.",
+ "type": "object"
+ },
+ "serviceAccountEmail": {
+ "description": "Identity to run virtual machines as. Defaults to the default account.",
+ "type": "string"
+ },
+ "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"
+ },
+ "userAgent": {
+ "additionalProperties": {
+ "description": "Properties of the object.",
+ "type": "any"
+ },
+ "description": "A description of the process that generated the request.",
+ "type": "object"
+ },
+ "clusterManagerApiService": {
+ "description": "The type of cluster manager API to use. If unknown or\nunspecified, the service will attempt to choose a reasonable\ndefault. This should be in the form of the API service name,\ne.g. \"compute.googleapis.com\".",
+ "type": "string"
+ },
+ "tempStoragePrefix": {
+ "description": "The prefix of the resources the system should use for temporary\nstorage. The system will append the suffix \"/temp-{JOBNAME} to\nthis resource prefix, where {JOBNAME} is the value of the\njob_name field. The resulting bucket and object prefix is used\nas the prefix of the resources used to store temporary data\nneeded during the job execution. NOTE: This will override the\nvalue in taskrunner_settings.\nThe supported resource type is:\n\nGoogle Cloud Storage:\n\n storage.googleapis.com/{bucket}/{object}\n bucket.storage.googleapis.com/{object}",
+ "type": "string"
+ },
+ "workerPools": {
+ "description": "The worker pools. At least one \"harness\" worker pool must be\nspecified in order for the job to have workers.",
+ "type": "array",
+ "items": {
+ "$ref": "WorkerPool"
+ }
+ },
+ "dataset": {
+ "description": "The dataset for the current project where various workflow\nrelated tables are stored.\n\nThe supported resource type is:\n\nGoogle BigQuery:\n bigquery.googleapis.com/{dataset}",
+ "type": "string"
+ }
+ },
+ "id": "Environment",
+ "description": "Describes the environment in which a Dataflow Job runs.",
+ "type": "object"
+ },
+ "StreamingComputationTask": {
+ "properties": {
+ "computationRanges": {
+ "description": "Contains ranges of a streaming computation this task should apply to.",
+ "type": "array",
+ "items": {
+ "$ref": "StreamingComputationRanges"
+ }
+ },
+ "dataDisks": {
+ "description": "Describes the set of data disks this task should apply to.",
+ "type": "array",
+ "items": {
+ "$ref": "MountedDataDisk"
+ }
+ },
+ "taskType": {
+ "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"
+ },
+ "SendDebugCaptureRequest": {
+ "properties": {
+ "data": {
+ "description": "The encoded debug information.",
+ "type": "string"
+ },
+ "componentId": {
+ "description": "The internal component id for which debug information is sent.",
+ "type": "string"
+ },
+ "workerId": {
+ "description": "The worker id, i.e., VM hostname.",
+ "type": "string"
+ },
+ "location": {
+ "description": "The location which contains the job specified by job_id.",
+ "type": "string"
+ }
+ },
+ "id": "SendDebugCaptureRequest",
+ "description": "Request to send encoded debug information.",
+ "type": "object"
+ },
+ "GetDebugConfigResponse": {
+ "properties": {
+ "config": {
+ "description": "The encoded debug configuration for the requested component.",
+ "type": "string"
+ }
+ },
+ "id": "GetDebugConfigResponse",
+ "description": "Response to a get debug configuration request.",
+ "type": "object"
+ },
+ "ComponentTransform": {
+ "properties": {
+ "originalTransform": {
+ "description": "User name for the original user transform with which this transform is\nmost closely associated.",
+ "type": "string"
+ },
+ "name": {
+ "description": "Dataflow service generated name for this source.",
+ "type": "string"
+ },
+ "userName": {
+ "description": "Human-readable name for this transform; may be user or system generated.",
+ "type": "string"
+ }
+ },
+ "id": "ComponentTransform",
+ "description": "Description of a transform executed as part of an execution stage.",
+ "type": "object"
+ },
+ "StreamingSetupTask": {
+ "description": "A task which initializes part of a streaming Dataflow job.",
+ "type": "object",
+ "properties": {
+ "workerHarnessPort": {
+ "description": "The TCP port used by the worker to communicate with the Dataflow\nworker harness.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "drain": {
+ "description": "The user has requested drain.",
+ "type": "boolean"
+ },
+ "receiveWorkPort": {
+ "description": "The TCP port on which the worker should listen for messages from\nother streaming computation workers.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "streamingComputationTopology": {
+ "$ref": "TopologyConfig",
+ "description": "The global topology of the streaming Dataflow job."
+ }
+ },
+ "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"
+ },
+ "idLabel": {
+ "description": "If set, contains a pubsub label from which to extract record ids.\nIf left empty, record deduplication will be strictly best effort.",
+ "type": "string"
+ },
+ "topic": {
+ "description": "A pubsub topic, in the form of\n\"pubsub.googleapis.com/topics/\u003cproject-id\u003e/\u003ctopic-name\u003e\"",
+ "type": "string"
+ },
+ "timestampLabel": {
+ "description": "If set, contains a pubsub label from which to extract record timestamps.\nIf left empty, record timestamps will be generated upon arrival.",
+ "type": "string"
+ },
+ "subscription": {
+ "description": "A pubsub subscription, in the form of\n\"pubsub.googleapis.com/subscriptions/\u003cproject-id\u003e/\u003csubscription-name\u003e\"",
+ "type": "string"
+ },
+ "dropLateData": {
+ "description": "Indicates whether the pipeline allows late-arriving data.",
+ "type": "boolean"
+ }
+ },
+ "id": "PubsubLocation",
+ "description": "Identifies a pubsub location to use for transferring data into or\nout of a streaming Dataflow job.",
+ "type": "object"
+ },
+ "WorkerHealthReport": {
+ "description": "WorkerHealthReport contains information about the health of a worker.\n\nThe VM should be identified by the labels attached to the WorkerMessage that\nthis health ping belongs to.",
+ "type": "object",
+ "properties": {
+ "pods": {
+ "description": "The pods running on the worker. See:\nhttp://kubernetes.io/v1.1/docs/api-reference/v1/definitions.html#_v1_pod\n\nThis field is used by the worker to send the status of the indvidual\ncontainers running on each worker.",
+ "type": "array",
+ "items": {
+ "additionalProperties": {
+ "description": "Properties of the object.",
+ "type": "any"
+ },
+ "type": "object"
+ }
+ },
+ "vmStartupTime": {
+ "description": "The time the VM was booted.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "vmIsHealthy": {
+ "description": "Whether the VM is healthy.",
+ "type": "boolean"
+ },
+ "reportInterval": {
+ "description": "The interval at which the worker is sending health reports.\nThe default value of 0 should be interpreted as the field is not being\nexplicitly set by the worker.",
+ "format": "google-duration",
+ "type": "string"
+ }
+ },
+ "id": "WorkerHealthReport"
+ },
+ "JobMessage": {
+ "properties": {
+ "messageText": {
+ "description": "The text of the message.",
+ "type": "string"
+ },
+ "messageImportance": {
+ "enum": [
+ "JOB_MESSAGE_IMPORTANCE_UNKNOWN",
+ "JOB_MESSAGE_DEBUG",
+ "JOB_MESSAGE_DETAILED",
+ "JOB_MESSAGE_BASIC",
+ "JOB_MESSAGE_WARNING",
+ "JOB_MESSAGE_ERROR"
+ ],
+ "description": "Importance level of the message.",
+ "type": "string",
+ "enumDescriptions": [
+ "The message importance isn't specified, or is unknown.",
+ "The message is at the 'debug' level: typically only useful for\nsoftware engineers working on the code the job is running.\nTypically, Dataflow pipeline runners do not display log messages\nat this level by default.",
+ "The message is at the 'detailed' level: somewhat verbose, but\npotentially useful to users. Typically, Dataflow pipeline\nrunners do not display log messages at this level by default.\nThese messages are displayed by default in the Dataflow\nmonitoring UI.",
+ "The message is at the 'basic' level: useful for keeping\ntrack of the execution of a Dataflow pipeline. Typically,\nDataflow pipeline runners display log messages at this level by\ndefault, and these messages are displayed by default in the\nDataflow monitoring UI.",
+ "The message is at the 'warning' level: indicating a condition\npertaining to a job which may require human intervention.\nTypically, Dataflow pipeline runners display log messages at this\nlevel by default, and these messages are displayed by default in\nthe Dataflow monitoring UI.",
+ "The message is at the 'error' level: indicating a condition\npreventing a job from succeeding. Typically, Dataflow pipeline\nrunners display log messages at this level by default, and these\nmessages are displayed by default in the Dataflow monitoring UI."
+ ]
+ },
+ "time": {
+ "description": "The timestamp of the message.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "id": {
+ "description": "Deprecated.",
+ "type": "string"
+ }
+ },
+ "id": "JobMessage",
+ "description": "A particular message pertaining to a Dataflow job.",
+ "type": "object"
+ },
+ "ParameterMetadata": {
+ "properties": {
+ "label": {
+ "description": "Required. The label to display for the parameter.",
+ "type": "string"
+ },
+ "helpText": {
+ "description": "Required. The help text to display for the parameter.",
+ "type": "string"
+ },
+ "isOptional": {
+ "description": "Optional. Whether the parameter is optional. Defaults to false.",
+ "type": "boolean"
+ },
+ "name": {
+ "description": "Required. The name of the parameter.",
+ "type": "string"
+ },
+ "regexes": {
+ "description": "Optional. Regexes that the parameter must match.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "id": "ParameterMetadata",
+ "description": "Metadata for a specific parameter.",
+ "type": "object"
+ },
+ "MultiOutputInfo": {
+ "properties": {
+ "tag": {
+ "description": "The id of the tag the user code will emit to this output by; this\nshould correspond to the tag of some SideInputInfo.",
+ "type": "string"
+ }
+ },
+ "id": "MultiOutputInfo",
+ "description": "Information about an output of a multi-output DoFn.",
+ "type": "object"
+ },
+ "SourceSplitRequest": {
+ "properties": {
+ "source": {
+ "description": "Specification of the source to be split.",
+ "$ref": "Source"
+ },
+ "options": {
+ "$ref": "SourceSplitOptions",
+ "description": "Hints for tuning the splitting process."
+ }
+ },
+ "id": "SourceSplitRequest",
+ "description": "Represents the operation to split a high-level Source specification\ninto bundles (parts for parallel processing).\n\nAt a high level, splitting of a source into bundles happens as follows:\nSourceSplitRequest is applied to the source. If it returns\nSOURCE_SPLIT_OUTCOME_USE_CURRENT, no further splitting happens and the source\nis used \"as is\". Otherwise, splitting is applied recursively to each\nproduced DerivedSource.\n\nAs an optimization, for any Source, if its does_not_need_splitting is\ntrue, the framework assumes that splitting this source would return\nSOURCE_SPLIT_OUTCOME_USE_CURRENT, and doesn't initiate a SourceSplitRequest.\nThis applies both to the initial source being split and to bundles\nproduced from it.",
+ "type": "object"
+ },
+ "SourceGetMetadataResponse": {
+ "properties": {
+ "metadata": {
+ "description": "The computed metadata.",
+ "$ref": "SourceMetadata"
+ }
+ },
+ "id": "SourceGetMetadataResponse",
+ "description": "The result of a SourceGetMetadataOperation.",
+ "type": "object"
+ },
+ "ShellTask": {
+ "properties": {
+ "exitCode": {
+ "description": "Exit code for the task.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "command": {
+ "description": "The shell command to run.",
+ "type": "string"
+ }
+ },
+ "id": "ShellTask",
+ "description": "A task which consists of a shell command for the worker to execute.",
+ "type": "object"
+ },
+ "MetricShortId": {
+ "properties": {
+ "metricIndex": {
+ "description": "The index of the corresponding metric in\nthe ReportWorkItemStatusRequest. Required.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "shortId": {
+ "description": "The service-generated short identifier for the metric.",
"format": "int64",
"type": "string"
+ }
+ },
+ "id": "MetricShortId",
+ "description": "The metric short id is returned to the user alongside an offset into\nReportWorkItemStatusRequest",
+ "type": "object"
+ },
+ "AutoscalingEvent": {
+ "description": "A structured message reporting an autoscaling decision made by the Dataflow\nservice.",
+ "type": "object",
+ "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"
+ },
+ "TaskRunnerSettings": {
+ "description": "Taskrunner configuration settings.",
+ "type": "object",
+ "properties": {
+ "harnessCommand": {
+ "description": "The command to launch the worker harness.",
+ "type": "string"
+ },
+ "logDir": {
+ "description": "The directory on the VM to store logs.",
+ "type": "string"
+ },
+ "oauthScopes": {
+ "description": "The OAuth2 scopes to be requested by the taskrunner in order to\naccess the Cloud Dataflow API.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "dataflowApiVersion": {
+ "description": "The API version of endpoint, e.g. \"v1b3\"",
+ "type": "string"
+ },
+ "logUploadLocation": {
+ "description": "Indicates where to put logs. If this is not specified, the logs\nwill not be uploaded.\n\nThe supported resource type is:\n\nGoogle Cloud Storage:\n storage.googleapis.com/{bucket}/{object}\n bucket.storage.googleapis.com/{object}",
+ "type": "string"
+ },
+ "streamingWorkerMainClass": {
+ "description": "The streaming worker main class name.",
+ "type": "string"
+ },
+ "workflowFileName": {
+ "description": "The file to store the workflow in.",
+ "type": "string"
+ },
+ "baseTaskDir": {
+ "description": "The location on the worker for task-specific subdirectories.",
+ "type": "string"
+ },
+ "tempStoragePrefix": {
+ "description": "The prefix of the resources the taskrunner should use for\ntemporary storage.\n\nThe supported resource type is:\n\nGoogle Cloud Storage:\n storage.googleapis.com/{bucket}/{object}\n bucket.storage.googleapis.com/{object}",
+ "type": "string"
+ },
+ "commandlinesFileName": {
+ "description": "The file to store preprocessing commands in.",
+ "type": "string"
+ },
+ "languageHint": {
+ "description": "The suggested backend language.",
+ "type": "string"
+ },
+ "baseUrl": {
+ "description": "The base URL for the taskrunner to use when accessing Google Cloud APIs.\n\nWhen workers access Google Cloud APIs, they logically do so via\nrelative URLs. If this field is specified, it supplies the base\nURL to use for resolving these relative URLs. The normative\nalgorithm used is defined by RFC 1808, \"Relative Uniform Resource\nLocators\".\n\nIf not specified, the default value is \"http://www.googleapis.com/\"",
+ "type": "string"
+ },
+ "logToSerialconsole": {
+ "description": "Whether to send taskrunner log info to Google Compute Engine VM serial\nconsole.",
+ "type": "boolean"
+ },
+ "continueOnException": {
+ "description": "Whether to continue taskrunner if an exception is hit.",
+ "type": "boolean"
+ },
+ "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"
+ },
+ "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",
+ "properties": {
+ "recordIndex": {
+ "description": "Position is a record index.",
+ "format": "int64",
+ "type": "string"
+ },
+ "shufflePosition": {
+ "description": "CloudPosition is a base64 encoded BatchShufflePosition (with FIXED\nsharding).",
+ "type": "string"
},
"concatPosition": {
"$ref": "ConcatPosition",
"description": "CloudPosition is a concat position."
},
+ "byteOffset": {
+ "description": "Position is a byte offset.",
+ "format": "int64",
+ "type": "string"
+ },
"end": {
- "type": "boolean",
- "description": "Position is past all other positions. Also useful for the end\nposition of an unbounded range."
+ "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": {
- "description": "A representation of an int64, n, that is immune to precision loss when\nencoded in JSON.",
- "type": "object",
- "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"
+ "id": "Position"
},
"Source": {
+ "description": "A source that records can be read and decoded from.",
"type": "object",
"properties": {
+ "spec": {
+ "additionalProperties": {
+ "description": "Properties of the object.",
+ "type": "any"
+ },
+ "description": "The source to read from, plus its parameters.",
+ "type": "object"
+ },
"metadata": {
"$ref": "SourceMetadata",
"description": "Optionally, metadata for this source can be supplied right away,\navoiding a SourceGetMetadataOperation roundtrip\n(see SourceOperationRequest).\n\nThis field is meaningful only in the Source objects populated\nby the user (e.g. when filling in a DerivedSource).\nSource objects supplied by the framework to the user don't have\nthis field populated."
@@ -1603,23 +2881,36 @@
"doesNotNeedSplitting": {
"description": "Setting this value to true hints to the framework that the source\ndoesn't need splitting, and using SourceSplitRequest on it would\nyield SOURCE_SPLIT_OUTCOME_USE_CURRENT.\n\nE.g. a file splitter may set this to true when splitting a single file\ninto a set of byte ranges of appropriate size, and set this\nto false when splitting a filepattern into individual files.\nHowever, for efficiency, a file splitter may decide to produce\nfile subranges directly from the filepattern to avoid a splitting\nround-trip.\n\nSee SourceSplitRequest for an overview of the splitting process.\n\nThis field is meaningful only in the Source objects populated\nby the user (e.g. when filling in a DerivedSource).\nSource objects supplied by the framework to the user don't have\nthis field populated.",
"type": "boolean"
- },
- "spec": {
- "additionalProperties": {
- "description": "Properties of the object.",
- "type": "any"
- },
- "description": "The source to read from, plus its parameters.",
- "type": "object"
}
},
- "id": "Source",
- "description": "A source that records can be read and decoded from."
+ "id": "Source"
+ },
+ "SplitInt64": {
+ "description": "A representation of an int64, n, that is immune to precision loss when\nencoded in JSON.",
+ "type": "object",
+ "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"
},
"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": {
+ "diskSizeGb": {
+ "description": "Size of root disk for VMs, in GB. If zero or unspecified, the service will\nattempt to choose a reasonable default.",
+ "format": "int32",
+ "type": "integer"
+ },
"workerHarnessContainerImage": {
"description": "Required. Docker container image that executes the Cloud Dataflow worker\nharness, residing in Google Container Registry.",
"type": "string"
@@ -1648,41 +2939,39 @@
"type": "string"
},
"ipConfiguration": {
- "enumDescriptions": [
- "The configuration is unknown, or unspecified.",
- "Workers should have public IP addresses.",
- "Workers should have private IP addresses."
- ],
"enum": [
"WORKER_IP_UNSPECIFIED",
"WORKER_IP_PUBLIC",
"WORKER_IP_PRIVATE"
],
"description": "Configuration for VM IPs.",
- "type": "string"
- },
- "autoscalingSettings": {
- "description": "Settings for autoscaling of this WorkerPool.",
- "$ref": "AutoscalingSettings"
+ "type": "string",
+ "enumDescriptions": [
+ "The configuration is unknown, or unspecified.",
+ "Workers should have public IP addresses.",
+ "Workers should have private IP addresses."
+ ]
},
"taskrunnerSettings": {
"description": "Settings passed through to Google Compute Engine workers when\nusing the standard Dataflow task runner. Users should ignore\nthis field.",
"$ref": "TaskRunnerSettings"
},
+ "autoscalingSettings": {
+ "$ref": "AutoscalingSettings",
+ "description": "Settings for autoscaling of this WorkerPool."
+ },
"metadata": {
- "type": "object",
"additionalProperties": {
"type": "string"
},
- "description": "Metadata to set on the Google Compute Engine VMs."
+ "description": "Metadata to set on the Google Compute Engine VMs.",
+ "type": "object"
+ },
+ "network": {
+ "description": "Network to which VMs will be assigned. If empty or unspecified,\nthe service will use the network \"default\".",
+ "type": "string"
},
"defaultPackageSet": {
- "enumDescriptions": [
- "The default set of packages to stage is unknown, or unspecified.",
- "Indicates that no packages should be staged at the worker unless\nexplicitly specified by the job.",
- "Stage packages typically useful to workers written in Java.",
- "Stage pacakges typically useful to workers written in Python."
- ],
"enum": [
"DEFAULT_PACKAGE_SET_UNKNOWN",
"DEFAULT_PACKAGE_SET_NONE",
@@ -1690,25 +2979,27 @@
"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"
+ "type": "string",
+ "enumDescriptions": [
+ "The default set of packages to stage is unknown, or unspecified.",
+ "Indicates that no packages should be staged at the worker unless\nexplicitly specified by the job.",
+ "Stage packages typically useful to workers written in Java.",
+ "Stage pacakges typically useful to workers written in Python."
+ ]
},
- "network": {
- "description": "Network to which VMs will be assigned. If empty or unspecified,\nthe service will use the network \"default\".",
- "type": "string"
- },
- "zone": {
- "description": "Zone to run the worker pools in. If empty or unspecified, the service\nwill attempt to choose a reasonable default.",
- "type": "string"
+ "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"
},
"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"
},
- "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"
+ "zone": {
+ "description": "Zone to run the worker pools in. If empty or unspecified, the service\nwill attempt to choose a reasonable default.",
+ "type": "string"
},
"diskSourceImage": {
"description": "Fully qualified source image for disks.",
@@ -1722,8 +3013,6 @@
}
},
"teardownPolicy": {
- "description": "Sets the policy for determining when to turndown worker pool.\nAllowed values are: `TEARDOWN_ALWAYS`, `TEARDOWN_ON_SUCCESS`, and\n`TEARDOWN_NEVER`.\n`TEARDOWN_ALWAYS` means workers are always torn down regardless of whether\nthe job succeeds. `TEARDOWN_ON_SUCCESS` means workers are torn down\nif the job succeeds. `TEARDOWN_NEVER` means the workers are never torn\ndown.\n\nIf the workers are not torn down by the service, they will\ncontinue to run and use Google Compute Engine VM resources in the\nuser's project until they are explicitly terminated by the user.\nBecause of this, Google recommends using the `TEARDOWN_ALWAYS`\npolicy except for small, manually supervised test jobs.\n\nIf unknown or unspecified, the service will attempt to choose a reasonable\ndefault.",
- "type": "string",
"enumDescriptions": [
"The teardown policy isn't specified, or is unknown.",
"Always teardown the resource.",
@@ -1735,7 +3024,9 @@
"TEARDOWN_ALWAYS",
"TEARDOWN_ON_SUCCESS",
"TEARDOWN_NEVER"
- ]
+ ],
+ "description": "Sets the policy for determining when to turndown worker pool.\nAllowed values are: `TEARDOWN_ALWAYS`, `TEARDOWN_ON_SUCCESS`, and\n`TEARDOWN_NEVER`.\n`TEARDOWN_ALWAYS` means workers are always torn down regardless of whether\nthe job succeeds. `TEARDOWN_ON_SUCCESS` means workers are torn down\nif the job succeeds. `TEARDOWN_NEVER` means the workers are never torn\ndown.\n\nIf the workers are not torn down by the service, they will\ncontinue to run and use Google Compute Engine VM resources in the\nuser's project until they are explicitly terminated by the user.\nBecause of this, Google recommends using the `TEARDOWN_ALWAYS`\npolicy except for small, manually supervised test jobs.\n\nIf unknown or unspecified, the service will attempt to choose a reasonable\ndefault.",
+ "type": "string"
},
"onHostMaintenance": {
"description": "The action to take on host maintenance, as defined by the Google\nCompute Engine API.",
@@ -1748,27 +3039,12 @@
},
"description": "Extra arguments for this worker pool.",
"type": "object"
- },
- "diskSizeGb": {
- "type": "integer",
- "description": "Size of root disk for VMs, in GB. If zero or unspecified, the service will\nattempt to choose a reasonable default.",
- "format": "int32"
}
},
"id": "WorkerPool"
},
"SourceOperationRequest": {
- "description": "A work item that represents the different operations that can be\nperformed on a user-defined Source specification.",
- "type": "object",
"properties": {
- "name": {
- "description": "User-provided name of the Read instruction for this source.",
- "type": "string"
- },
- "originalName": {
- "description": "System-defined name for the Read instruction for this source\nin the original workflow graph.",
- "type": "string"
- },
"systemName": {
"description": "System-defined name of the Read instruction for this source.\nUnique across the workflow.",
"type": "string"
@@ -1782,46 +3058,59 @@
"$ref": "SourceGetMetadataRequest"
},
"split": {
- "description": "Information about a request to split a source.",
- "$ref": "SourceSplitRequest"
- }
- },
- "id": "SourceOperationRequest"
- },
- "StructuredMessage": {
- "properties": {
- "parameters": {
- "type": "array",
- "items": {
- "$ref": "Parameter"
- },
- "description": "The structured data associated with this message."
+ "$ref": "SourceSplitRequest",
+ "description": "Information about a request to split a source."
},
- "messageKey": {
- "description": "Idenfier for this message type. Used by external systems to\ninternationalize or personalize message.",
+ "name": {
+ "description": "User-provided name of the Read instruction for this source.",
"type": "string"
},
- "messageText": {
- "type": "string",
- "description": "Human-readable version of message."
+ "originalName": {
+ "description": "System-defined name for the Read instruction for this source\nin the original workflow graph.",
+ "type": "string"
}
},
- "id": "StructuredMessage",
- "description": "A rich message format, including a human readable string, a key for\nidentifying the message, and structured data associated with the message for\nprogrammatic consumption.",
+ "id": "SourceOperationRequest",
+ "description": "A work item that represents the different operations that can be\nperformed on a user-defined Source specification.",
"type": "object"
},
"WorkItem": {
- "description": "WorkItem represents basic information about a WorkItem to be executed\nin the cloud.",
- "type": "object",
"properties": {
- "streamingComputationTask": {
- "$ref": "StreamingComputationTask",
- "description": "Additional information for StreamingComputationTask WorkItems."
+ "sourceOperationTask": {
+ "description": "Additional information for source operation WorkItems.",
+ "$ref": "SourceOperationRequest"
+ },
+ "streamingSetupTask": {
+ "$ref": "StreamingSetupTask",
+ "description": "Additional information for StreamingSetupTask WorkItems."
+ },
+ "reportStatusInterval": {
+ "description": "Recommended reporting interval.",
+ "format": "google-duration",
+ "type": "string"
+ },
+ "streamingConfigTask": {
+ "description": "Additional information for StreamingConfigTask WorkItems.",
+ "$ref": "StreamingConfigTask"
+ },
+ "leaseExpireTime": {
+ "description": "Time when the lease on this Work will expire.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "initialReportIndex": {
+ "description": "The initial index to use when reporting the status of the WorkItem.",
+ "format": "int64",
+ "type": "string"
},
"shellTask": {
"description": "Additional information for ShellTask WorkItems.",
"$ref": "ShellTask"
},
+ "streamingComputationTask": {
+ "$ref": "StreamingComputationTask",
+ "description": "Additional information for StreamingComputationTask WorkItems."
+ },
"jobId": {
"description": "Identifies the workflow job this WorkItem belongs to.",
"type": "string"
@@ -1853,55 +3142,51 @@
"projectId": {
"description": "Identifies the cloud project this WorkItem belongs to.",
"type": "string"
- },
- "reportStatusInterval": {
- "description": "Recommended reporting interval.",
- "format": "google-duration",
+ }
+ },
+ "id": "WorkItem",
+ "description": "WorkItem represents basic information about a WorkItem to be executed\nin the cloud.",
+ "type": "object"
+ },
+ "StructuredMessage": {
+ "description": "A rich message format, including a human readable string, a key for\nidentifying the message, and structured data associated with the message for\nprogrammatic consumption.",
+ "type": "object",
+ "properties": {
+ "messageText": {
+ "description": "Human-readable version of message.",
"type": "string"
},
- "streamingSetupTask": {
- "$ref": "StreamingSetupTask",
- "description": "Additional information for StreamingSetupTask WorkItems."
+ "parameters": {
+ "description": "The structured data associated with this message.",
+ "type": "array",
+ "items": {
+ "$ref": "Parameter"
+ }
},
- "sourceOperationTask": {
- "$ref": "SourceOperationRequest",
- "description": "Additional information for source operation WorkItems."
- },
- "leaseExpireTime": {
- "description": "Time when the lease on this Work will expire.",
- "format": "google-datetime",
- "type": "string"
- },
- "streamingConfigTask": {
- "$ref": "StreamingConfigTask",
- "description": "Additional information for StreamingConfigTask WorkItems."
- },
- "initialReportIndex": {
- "description": "The initial index to use when reporting the status of the WorkItem.",
- "format": "int64",
+ "messageKey": {
+ "description": "Idenfier for this message type. Used by external systems to\ninternationalize or personalize message.",
"type": "string"
}
},
- "id": "WorkItem"
+ "id": "StructuredMessage"
},
"ReportedParallelism": {
- "description": "Represents the level of parallelism in a WorkItem's input,\nreported by the worker.",
- "type": "object",
"properties": {
- "isInfinite": {
- "description": "Specifies whether the parallelism is infinite. If true, \"value\" is\nignored.\nInfinite parallelism means the service will assume that the work item\ncan always be split into more non-empty work items by dynamic splitting.\nThis is a work-around for lack of support for infinity by the current\nJSON-based Java RPC stack.",
- "type": "boolean"
- },
"value": {
"description": "Specifies the level of parallelism in case it is finite.",
"format": "double",
"type": "number"
+ },
+ "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"
+ "id": "ReportedParallelism",
+ "description": "Represents the level of parallelism in a WorkItem's input,\nreported by the worker.",
+ "type": "object"
},
"ResourceUtilizationReport": {
- "type": "object",
"properties": {
"cpuTime": {
"description": "CPU utilization samples.",
@@ -1912,12 +3197,20 @@
}
},
"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."
+ "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"
},
"TopologyConfig": {
"description": "Global topology of the streaming Dataflow job, including all\ncomputations and their sharded locations.",
"type": "object",
"properties": {
+ "userStageToComputationNameMap": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Maps user stage names to stable computation names.",
+ "type": "object"
+ },
"computations": {
"description": "The computations associated with a streaming Dataflow job.",
"type": "array",
@@ -1938,16 +3231,9 @@
"type": "integer"
},
"forwardingKeyBits": {
- "type": "integer",
"description": "The size (in bits) of keys that will be assigned to source messages.",
- "format": "int32"
- },
- "userStageToComputationNameMap": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "Maps user stage names to stable computation names.",
- "type": "object"
+ "format": "int32",
+ "type": "integer"
}
},
"id": "TopologyConfig"
@@ -1956,13 +3242,13 @@
"description": "Hints for splitting a Source into bundles (parts for parallel\nprocessing) using SourceSplitRequest.",
"type": "object",
"properties": {
- "desiredShardSizeBytes": {
- "description": "DEPRECATED in favor of desired_bundle_size_bytes.",
+ "desiredBundleSizeBytes": {
+ "description": "The source should be split into a set of bundles where the estimated size\nof each is approximately this many bytes.",
"format": "int64",
"type": "string"
},
- "desiredBundleSizeBytes": {
- "description": "The source should be split into a set of bundles where the estimated size\nof each is approximately this many bytes.",
+ "desiredShardSizeBytes": {
+ "description": "DEPRECATED in favor of desired_bundle_size_bytes.",
"format": "int64",
"type": "string"
}
@@ -1981,13 +3267,7 @@
"id": "ReadInstruction"
},
"WorkerSettings": {
- "description": "Provides data to pass through to the worker harness.",
- "type": "object",
"properties": {
- "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"
@@ -2007,9 +3287,33 @@
"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"
+ "id": "WorkerSettings",
+ "description": "Provides data to pass through to the worker harness.",
+ "type": "object"
+ },
+ "DataDiskAssignment": {
+ "description": "Data disk assignment for a given VM instance.",
+ "type": "object",
+ "properties": {
+ "vmInstance": {
+ "description": "VM instance name the data disks mounted to, for example\n\"myproject-1014-104817-4c2-harness-0\".",
+ "type": "string"
+ },
+ "dataDisks": {
+ "description": "Mounted data disks. The order is important a data disk's 0-based index in\nthis list defines which persistent directory the disk is mounted to, for\nexample the list of { \"myproject-1014-104817-4c2-harness-0-disk-0\" },\n{ \"myproject-1014-104817-4c2-harness-0-disk-1\" }.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "id": "DataDiskAssignment"
},
"StreamingStageLocation": {
"properties": {
@@ -2022,24 +3326,6 @@
"description": "Identifies the location of a streaming computation stage, for\nstage-to-stage communication.",
"type": "object"
},
- "DataDiskAssignment": {
- "description": "Data disk assignment for a given VM instance.",
- "type": "object",
- "properties": {
- "dataDisks": {
- "description": "Mounted data disks. The order is important a data disk's 0-based index in\nthis list defines which persistent directory the disk is mounted to, for\nexample the list of { \"myproject-1014-104817-4c2-harness-0-disk-0\" },\n{ \"myproject-1014-104817-4c2-harness-0-disk-1\" }.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "vmInstance": {
- "description": "VM instance name the data disks mounted to, for example\n\"myproject-1014-104817-4c2-harness-0\".",
- "type": "string"
- }
- },
- "id": "DataDiskAssignment"
- },
"ApproximateSplitRequest": {
"description": "A suggestion by the service to the worker to dynamically split the WorkItem.",
"type": "object",
@@ -2057,54 +3343,35 @@
"id": "ApproximateSplitRequest"
},
"Status": {
- "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
- "type": "object",
"properties": {
- "code": {
- "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"
- }
- },
- "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use."
+ },
+ "type": "object"
+ }
+ },
+ "code": {
+ "description": "The status code, which should be an enum value of google.rpc.Code.",
+ "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"
},
"ExecutionStageState": {
- "type": "object",
"properties": {
- "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",
@@ -2119,15 +3386,34 @@
"JOB_STATE_CANCELLING"
],
"description": "Executions stage states allow the same set of values as JobState.",
- "type": "string"
+ "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'."
+ ]
},
"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",
- "description": "A message describing the state of a particular execution stage."
+ "description": "A message describing the state of a particular execution stage.",
+ "type": "object"
},
"StreamLocation": {
"description": "Describes a stream of data, either as input to be processed or as\noutput of a streaming Dataflow job.",
@@ -2146,15 +3432,13 @@
"description": "The stream is a streaming side input."
},
"customSourceLocation": {
- "$ref": "CustomSourceLocation",
- "description": "The stream is a custom source."
+ "description": "The stream is a custom source.",
+ "$ref": "CustomSourceLocation"
}
},
"id": "StreamLocation"
},
"SendWorkerMessagesResponse": {
- "description": "The response to the worker messages.",
- "type": "object",
"properties": {
"workerMessageResponses": {
"description": "The servers response to the worker messages.",
@@ -2164,7 +3448,9 @@
}
}
},
- "id": "SendWorkerMessagesResponse"
+ "id": "SendWorkerMessagesResponse",
+ "description": "The response to the worker messages.",
+ "type": "object"
},
"LeaseWorkItemResponse": {
"description": "Response to a request to lease WorkItems.",
@@ -2181,20 +3467,15 @@
"id": "LeaseWorkItemResponse"
},
"TransformSummary": {
- "description": "Description of the type, names/ids, and input/outputs for a transform.",
- "type": "object",
"properties": {
+ "name": {
+ "description": "User provided name for this transform instance.",
+ "type": "string"
+ },
"id": {
"description": "SDK generated id of this transform instance.",
"type": "string"
},
- "displayData": {
- "description": "Transform-specific display data.",
- "type": "array",
- "items": {
- "$ref": "DisplayData"
- }
- },
"outputCollectionName": {
"description": "User names for all collection outputs to this transform.",
"type": "array",
@@ -2202,6 +3483,13 @@
"type": "string"
}
},
+ "displayData": {
+ "description": "Transform-specific display data.",
+ "type": "array",
+ "items": {
+ "$ref": "DisplayData"
+ }
+ },
"kind": {
"enumDescriptions": [
"Unrecognized transform type.",
@@ -2234,19 +3522,22 @@
"items": {
"type": "string"
}
- },
- "name": {
- "description": "User provided name for this transform instance.",
- "type": "string"
}
},
- "id": "TransformSummary"
+ "id": "TransformSummary",
+ "description": "Description of the type, names/ids, and input/outputs for a transform.",
+ "type": "object"
},
"StreamingComputationConfig": {
- "id": "StreamingComputationConfig",
- "description": "Configuration information for a single streaming computation.",
- "type": "object",
"properties": {
+ "systemName": {
+ "description": "System defined name for this computation.",
+ "type": "string"
+ },
+ "stageName": {
+ "description": "Stage name of this computation.",
+ "type": "string"
+ },
"instructions": {
"description": "Instructions that comprise the computation.",
"type": "array",
@@ -2257,61 +3548,56 @@
"computationId": {
"description": "Unique identifier for this computation.",
"type": "string"
- },
- "systemName": {
- "description": "System defined name for this computation.",
- "type": "string"
- },
- "stageName": {
- "description": "Stage name of this computation.",
- "type": "string"
- }
- }
- },
- "Sink": {
- "description": "A sink that records can be encoded and written to.",
- "type": "object",
- "properties": {
- "codec": {
- "type": "object",
- "additionalProperties": {
- "type": "any",
- "description": "Properties of the object."
- },
- "description": "The codec to use to encode data written to the sink."
- },
- "spec": {
- "description": "The sink to write to, plus its parameters.",
- "type": "object",
- "additionalProperties": {
- "description": "Properties of the object.",
- "type": "any"
- }
}
},
- "id": "Sink"
+ "id": "StreamingComputationConfig",
+ "description": "Configuration information for a single streaming computation.",
+ "type": "object"
},
"LaunchTemplateParameters": {
- "description": "Parameters to provide to the template being launched.",
- "type": "object",
"properties": {
"parameters": {
- "description": "The runtime parameters to pass to the job.",
- "type": "object",
"additionalProperties": {
"type": "string"
- }
+ },
+ "description": "The runtime parameters to pass to the job.",
+ "type": "object"
},
"jobName": {
"description": "Required. The job name to use for the created job.",
"type": "string"
},
"environment": {
- "$ref": "RuntimeEnvironment",
- "description": "The runtime environment for the job."
+ "description": "The runtime environment for the job.",
+ "$ref": "RuntimeEnvironment"
}
},
- "id": "LaunchTemplateParameters"
+ "id": "LaunchTemplateParameters",
+ "description": "Parameters to provide to the template being launched.",
+ "type": "object"
+ },
+ "Sink": {
+ "description": "A sink that records can be encoded and written to.",
+ "type": "object",
+ "properties": {
+ "spec": {
+ "additionalProperties": {
+ "description": "Properties of the object.",
+ "type": "any"
+ },
+ "description": "The sink to write to, plus its parameters.",
+ "type": "object"
+ },
+ "codec": {
+ "additionalProperties": {
+ "description": "Properties of the object.",
+ "type": "any"
+ },
+ "description": "The codec to use to encode data written to the sink.",
+ "type": "object"
+ }
+ },
+ "id": "Sink"
},
"FlattenInstruction": {
"description": "An instruction that copies its inputs (zero or more) to its (single) output.",
@@ -2328,24 +3614,22 @@
"id": "FlattenInstruction"
},
"PartialGroupByKeyInstruction": {
- "description": "An instruction that does a partial group-by-key.\nOne input and one output.",
- "type": "object",
"properties": {
"valueCombiningFn": {
- "description": "The value combining function to invoke.",
- "type": "object",
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
- }
+ },
+ "description": "The value combining function to invoke.",
+ "type": "object"
},
"inputElementCodec": {
- "description": "The codec to use for interpreting an element in the input PTable.",
- "type": "object",
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
- }
+ },
+ "description": "The codec to use for interpreting an element in the input PTable.",
+ "type": "object"
},
"originalCombineValuesInputStoreName": {
"description": "If this instruction includes a combining function this is the name of the\nintermediate store between the GBK and the CombineValues.",
@@ -2367,36 +3651,14 @@
"$ref": "InstructionInput"
}
},
- "id": "PartialGroupByKeyInstruction"
- },
- "InstructionInput": {
- "description": "An input of an instruction, as a reference to an output of a\nproducer instruction.",
- "type": "object",
- "properties": {
- "outputNum": {
- "description": "The output index (origin zero) within the producer.",
- "format": "int32",
- "type": "integer"
- },
- "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.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "InstructionInput"
+ "id": "PartialGroupByKeyInstruction",
+ "description": "An instruction that does a partial group-by-key.\nOne input and one output.",
+ "type": "object"
},
"StageSource": {
+ "description": "Description of an input or output of an execution stage.",
"type": "object",
"properties": {
- "userName": {
- "description": "Human-readable name for this source; may be user or system generated.",
- "type": "string"
- },
- "originalTransformOrCollection": {
- "type": "string",
- "description": "User name for the original user transform or collection with which this\nsource is most closely associated."
- },
"name": {
"description": "Dataflow service generated name for this source.",
"type": "string"
@@ -2405,10 +3667,34 @@
"description": "Size of the source, if measurable.",
"format": "int64",
"type": "string"
+ },
+ "userName": {
+ "description": "Human-readable name for this source; may be user or system generated.",
+ "type": "string"
+ },
+ "originalTransformOrCollection": {
+ "description": "User name for the original user transform or collection with which this\nsource is most closely associated.",
+ "type": "string"
}
},
- "id": "StageSource",
- "description": "Description of an input or output of an execution stage."
+ "id": "StageSource"
+ },
+ "InstructionInput": {
+ "description": "An input of an instruction, as a reference to an output of a\nproducer instruction.",
+ "type": "object",
+ "properties": {
+ "producerInstructionIndex": {
+ "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.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "outputNum": {
+ "description": "The output index (origin zero) within the producer.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "InstructionInput"
},
"StringList": {
"description": "A metric value representing a list of strings.",
@@ -2425,17 +3711,12 @@
"id": "StringList"
},
"DisplayData": {
+ "description": "Data provided with a pipeline or transform to provide descriptive info.",
+ "type": "object",
"properties": {
- "javaClassValue": {
- "description": "Contains value if the data is of java class type.",
- "type": "string"
- },
- "boolValue": {
- "type": "boolean",
- "description": "Contains value if the data is of a boolean type."
- },
- "strValue": {
- "description": "Contains value if the data is of string type.",
+ "int64Value": {
+ "description": "Contains value if the data is of int64 type.",
+ "format": "int64",
"type": "string"
},
"durationValue": {
@@ -2443,11 +3724,6 @@
"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"
@@ -2465,23 +3741,33 @@
"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"
},
- "label": {
- "description": "An optional label to display in a dax UI for the element.",
- "type": "string"
- },
"url": {
"description": "An optional full URL.",
"type": "string"
},
+ "label": {
+ "description": "An optional label to display in a dax UI for the element.",
+ "type": "string"
+ },
"timestampValue": {
"description": "Contains value if the data is of timestamp type.",
"format": "google-datetime",
"type": "string"
+ },
+ "boolValue": {
+ "description": "Contains value if the data is of a boolean type.",
+ "type": "boolean"
+ },
+ "javaClassValue": {
+ "description": "Contains value if the data is of java class type.",
+ "type": "string"
+ },
+ "strValue": {
+ "description": "Contains value if the data is of string type.",
+ "type": "string"
}
},
- "id": "DisplayData",
- "description": "Data provided with a pipeline or transform to provide descriptive info.",
- "type": "object"
+ "id": "DisplayData"
},
"GetDebugConfigRequest": {
"description": "Request to get updated debug configuration for component.",
@@ -2506,6 +3792,10 @@
"description": "Request to lease WorkItems.",
"type": "object",
"properties": {
+ "workerId": {
+ "description": "Identifies the worker leasing work -- typically the ID of the\nvirtual machine running the worker.",
+ "type": "string"
+ },
"workerCapabilities": {
"description": "Worker capabilities. WorkItems might be limited to workers with specific\ncapabilities.",
"type": "array",
@@ -2513,10 +3803,6 @@
"type": "string"
}
},
- "workerId": {
- "description": "Identifies the worker leasing work -- typically the ID of the\nvirtual machine running the worker.",
- "type": "string"
- },
"requestedLeaseDuration": {
"description": "The initial lease period.",
"format": "google-duration",
@@ -2527,42 +3813,42 @@
"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"
},
"GetTemplateResponse": {
- "description": "The response to a GetTemplate request.",
- "type": "object",
"properties": {
- "status": {
- "$ref": "Status",
- "description": "The status of the get template request. Any problems with the\nrequest will be indicated in the error_details."
- },
"metadata": {
- "description": "The template metadata describing the template name, available\nparameters, etc.",
- "$ref": "TemplateMetadata"
+ "$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"
}
},
- "id": "GetTemplateResponse"
+ "id": "GetTemplateResponse",
+ "description": "The response to a GetTemplate request.",
+ "type": "object"
},
"Parameter": {
"description": "Structured data associated with this message.",
"type": "object",
"properties": {
"key": {
- "type": "string",
- "description": "Key or name for this parameter."
+ "description": "Key or name for this parameter.",
+ "type": "string"
},
"value": {
"description": "Value for this parameter.",
@@ -2572,6 +3858,7 @@
"id": "Parameter"
},
"ReportWorkItemStatusRequest": {
+ "description": "Request to report the status of WorkItems.",
"type": "object",
"properties": {
"workerId": {
@@ -2595,43 +3882,19 @@
}
}
},
- "id": "ReportWorkItemStatusRequest",
- "description": "Request to report the status of WorkItems."
- },
- "StreamingConfigTask": {
- "description": "A task that carries configuration information for streaming computations.",
- "type": "object",
- "properties": {
- "streamingComputationConfigs": {
- "description": "Set of computation configuration information.",
- "type": "array",
- "items": {
- "$ref": "StreamingComputationConfig"
- }
- },
- "windmillServiceEndpoint": {
- "type": "string",
- "description": "If present, the worker must use this endpoint to communicate with Windmill\nService dispatchers, otherwise the worker must continue to use whatever\nendpoint it had been using."
- },
- "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"
- }
- },
- "id": "StreamingConfigTask"
+ "id": "ReportWorkItemStatusRequest"
},
"PipelineDescription": {
"description": "A descriptive representation of submitted pipeline as well as the executed\nform. This data is provided by the Dataflow service for ease of visualizing\nthe pipeline and interpretting Dataflow provided metrics.",
"type": "object",
"properties": {
+ "displayData": {
+ "description": "Pipeline level display data.",
+ "type": "array",
+ "items": {
+ "$ref": "DisplayData"
+ }
+ },
"executionPipelineStage": {
"description": "Description of each stage of execution of the pipeline.",
"type": "array",
@@ -2645,28 +3908,56 @@
"items": {
"$ref": "TransformSummary"
}
- },
- "displayData": {
- "description": "Pipeline level display data.",
- "type": "array",
- "items": {
- "$ref": "DisplayData"
- }
}
},
"id": "PipelineDescription"
},
- "Step": {
- "type": "object",
+ "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.",
+ "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",
+ "description": "A task that carries configuration information for streaming computations.",
+ "type": "object"
+ },
+ "JobExecutionInfo": {
+ "properties": {
+ "stages": {
+ "additionalProperties": {
+ "$ref": "JobExecutionStageInfo"
+ },
+ "description": "A mapping from each stage to the information about that stage.",
+ "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"
+ },
+ "Step": {
+ "properties": {
"properties": {
"additionalProperties": {
"description": "Properties of the object.",
@@ -2674,24 +3965,19 @@
},
"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",
- "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."
- },
- "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": {
- "type": "object",
- "additionalProperties": {
- "$ref": "JobExecutionStageInfo"
- },
- "description": "A mapping from each stage to the information about that stage."
- }
- },
- "id": "JobExecutionInfo"
+ "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"
},
"FailedLocation": {
"description": "Indicates which location failed to respond to a request for data.",
@@ -2705,8 +3991,6 @@
"id": "FailedLocation"
},
"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.",
@@ -2722,43 +4006,15 @@
"type": "string"
}
},
- "id": "Disk"
- },
- "ListJobMessagesResponse": {
- "properties": {
- "autoscalingEvents": {
- "description": "Autoscaling events in ascending timestamp order.",
- "type": "array",
- "items": {
- "$ref": "AutoscalingEvent"
- }
- },
- "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"
- }
- },
- "id": "ListJobMessagesResponse",
- "description": "Response to a request to list job messages.",
+ "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": {
- "otherUnits": {
- "description": "A string referring to the unit type.",
- "type": "string"
- },
"kind": {
- "type": "string",
"enumDescriptions": [
"Counter aggregation kind was not set.",
"Aggregated value is the sum of all contributed values.",
@@ -2781,13 +4037,24 @@
"SET",
"DISTRIBUTION"
],
- "description": "Counter aggregation kind."
+ "description": "Counter aggregation kind.",
+ "type": "string"
},
"description": {
"description": "Human-readable description of the counter semantics.",
"type": "string"
},
"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",
@@ -2799,25 +4066,51 @@
"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.",
+ "type": "string"
}
},
"id": "CounterMetadata"
},
- "ApproximateReportedProgress": {
- "description": "A progress measurement of a WorkItem by a worker.",
- "type": "object",
+ "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": {
+ "properties": {
+ "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",
+ "type": "number"
+ },
+ "consumedParallelism": {
+ "description": "Total amount of parallelism in the portion of input of this task that has\nalready been consumed and is no longer active. In the first two examples\nabove (see remaining_parallelism), the value should be 29 or 2\nrespectively. The sum of remaining_parallelism and consumed_parallelism\nshould equal the total amount of parallelism in this work item. If\nspecified, must be finite.",
+ "$ref": "ReportedParallelism"
+ },
"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."
@@ -2825,38 +4118,13 @@
"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",
- "type": "number"
- },
- "consumedParallelism": {
- "$ref": "ReportedParallelism",
- "description": "Total amount of parallelism in the portion of input of this task that has\nalready been consumed and is no longer active. In the first two examples\nabove (see remaining_parallelism), the value should be 29 or 2\nrespectively. The sum of remaining_parallelism and consumed_parallelism\nshould equal the total amount of parallelism in this work item. If\nspecified, must be finite."
}
},
- "id": "ApproximateReportedProgress"
- },
- "StateFamilyConfig": {
- "description": "State family configuration.",
- "type": "object",
- "properties": {
- "isRead": {
- "type": "boolean",
- "description": "If true, this family corresponds to a read operation."
- },
- "stateFamily": {
- "description": "The state family value.",
- "type": "string"
- }
- },
- "id": "StateFamilyConfig"
+ "id": "ApproximateReportedProgress",
+ "description": "A progress measurement of a WorkItem by a worker.",
+ "type": "object"
},
"IntegerList": {
- "id": "IntegerList",
- "description": "A metric value representing a list of integers.",
- "type": "object",
"properties": {
"elements": {
"description": "Elements of the list.",
@@ -2865,7 +4133,25 @@
"$ref": "SplitInt64"
}
}
- }
+ },
+ "id": "IntegerList",
+ "description": "A metric value representing a list of integers.",
+ "type": "object"
+ },
+ "StateFamilyConfig": {
+ "properties": {
+ "isRead": {
+ "description": "If true, this family corresponds to a read operation.",
+ "type": "boolean"
+ },
+ "stateFamily": {
+ "description": "The state family value.",
+ "type": "string"
+ }
+ },
+ "id": "StateFamilyConfig",
+ "description": "State family configuration.",
+ "type": "object"
},
"ResourceUtilizationReportResponse": {
"description": "Service-side response to WorkerMessage reporting resource utilization.",
@@ -2878,8 +4164,6 @@
"type": "object",
"properties": {
"outcome": {
- "description": "Indicates whether splitting happened and produced a list of bundles.\nIf this is USE_CURRENT_SOURCE_AS_IS, the current source should\nbe processed \"as is\" without splitting. \"bundles\" is ignored in this case.\nIf this is SPLITTING_HAPPENED, then \"bundles\" contains a list of\nbundles into which the source was split.",
- "type": "string",
"enumDescriptions": [
"The source split outcome is unknown, or unspecified.",
"The current source should be processed \"as is\" without splitting.",
@@ -2889,7 +4173,9 @@
"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.",
@@ -2909,50 +4195,65 @@
"id": "SourceSplitResponse"
},
"ParallelInstruction": {
- "id": "ParallelInstruction",
"description": "Describes a particular operation comprising a MapTask.",
"type": "object",
"properties": {
- "name": {
- "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"
},
- "originalName": {
- "type": "string",
- "description": "System-defined name for the operation in the original workflow graph."
+ "parDo": {
+ "$ref": "ParDoInstruction",
+ "description": "Additional information for ParDo instructions."
},
"flatten": {
"$ref": "FlattenInstruction",
"description": "Additional information for Flatten instructions."
},
- "write": {
- "$ref": "WriteInstruction",
- "description": "Additional information for Write instructions."
+ "originalName": {
+ "description": "System-defined name for the operation in the original workflow graph.",
+ "type": "string"
},
"systemName": {
"description": "System-defined name of this operation.\nUnique across the workflow.",
"type": "string"
},
+ "write": {
+ "$ref": "WriteInstruction",
+ "description": "Additional information for Write instructions."
+ },
"partialGroupByKey": {
- "$ref": "PartialGroupByKeyInstruction",
- "description": "Additional information for PartialGroupByKey instructions."
+ "description": "Additional information for PartialGroupByKey instructions.",
+ "$ref": "PartialGroupByKeyInstruction"
},
"outputs": {
+ "description": "Describes the outputs of the instruction.",
"type": "array",
"items": {
"$ref": "InstructionOutput"
- },
- "description": "Describes the outputs of the instruction."
+ }
+ },
+ "name": {
+ "description": "User-provided name of this operation.",
+ "type": "string"
}
- }
+ },
+ "id": "ParallelInstruction"
+ },
+ "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": {
"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.",
@@ -2967,31 +4268,18 @@
"type": "string"
},
"end": {
- "type": "string",
- "description": "The end (exclusive) of the key range."
+ "description": "The end (exclusive) of the key range.",
+ "type": "string"
}
},
"id": "KeyRangeDataDiskAssignment"
},
- "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",
- "properties": {
- "name": {
- "description": "The name of the package.",
- "type": "string"
- },
- "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"
- }
- },
- "id": "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": {
+ "input": {
+ "$ref": "InstructionInput",
+ "description": "The input."
+ },
"numOutputs": {
"description": "The number of outputs.",
"format": "int32",
@@ -3018,52 +4306,73 @@
},
"description": "The user function to invoke.",
"type": "object"
- },
- "input": {
- "$ref": "InstructionInput",
- "description": "The input."
}
},
- "id": "ParDoInstruction"
+ "id": "ParDoInstruction",
+ "description": "An instruction that does a ParDo operation.\nTakes one main input and zero or more side inputs, and produces\nzero or more outputs.\nRuns user code.",
+ "type": "object"
},
- "WorkerShutdownNotice": {
- "description": "Shutdown notification from workers. This is to be sent by the shutdown\nscript of the worker VM so that the backend knows that the VM is being\nshut down.",
+ "MetricUpdate": {
+ "description": "Describes the state of a metric.",
"type": "object",
"properties": {
- "reason": {
- "description": "The reason for the worker shutdown.\nCurrent possible values are:\n \"UNKNOWN\": shutdown reason is unknown.\n \"PREEMPTION\": shutdown reason is preemption.\nOther possible reasons may be added in the future.",
+ "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"
+ },
+ "scalar": {
+ "description": "Worker-computed aggregate value for aggregation kinds \"Sum\", \"Max\", \"Min\",\n\"And\", and \"Or\". The possible value types are Long, Double, and Boolean.",
+ "type": "any"
+ },
+ "meanCount": {
+ "description": "Worker-computed aggregate value for the \"Mean\" aggregation kind.\nThis holds the count of the aggregated values and is used in combination\nwith mean_sum above to obtain the actual mean aggregate value.\nThe only possible value type is Long.",
+ "type": "any"
+ },
+ "meanSum": {
+ "description": "Worker-computed aggregate value for the \"Mean\" aggregation kind.\nThis holds the sum of the aggregated values and is used in combination\nwith mean_count below to obtain the actual mean aggregate value.\nThe only possible value types are Long and Double.",
+ "type": "any"
+ },
+ "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.",
+ "type": "any"
}
},
- "id": "WorkerShutdownNotice"
+ "id": "MetricUpdate"
},
"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.",
- "type": "object",
"properties": {
- "originalStepName": {
- "description": "System generated name of the original step in the user's graph, before\noptimization.",
- "type": "string"
- },
- "workerId": {
- "description": "ID of a particular worker.",
- "type": "string"
- },
- "originNamespace": {
- "description": "A string containing a more specific namespace of the counter's origin.",
- "type": "string"
- },
"origin": {
- "enumDescriptions": [
- "Counter was created by the Dataflow system.",
- "Counter was created by the user."
- ],
"enum": [
"SYSTEM",
"USER"
],
"description": "One of the standard Origins defined above.",
- "type": "string"
+ "type": "string",
+ "enumDescriptions": [
+ "Counter was created by the Dataflow system.",
+ "Counter was created by the user."
+ ]
},
"name": {
"description": "Counter name. Not necessarily globally-unique, but unique within the\ncontext of the other fields.\nRequired.",
@@ -3087,85 +4396,62 @@
"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"
- }
- },
- "id": "CounterStructuredName"
- },
- "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": {
- "$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"
- },
- "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": {
"type": "string",
- "description": "Metric aggregation kind. The possible metric aggregation kinds are\n\"Sum\", \"Max\", \"Min\", \"Mean\", \"Set\", \"And\", \"Or\", and \"Distribution\".\nThe specified aggregation kind is case-insensitive.\n\nIf omitted, this is not an aggregated value but instead\na single metric sample value."
+ "enumDescriptions": [
+ "Counter portion has not been set.",
+ "Counter reports a key.",
+ "Counter reports a value."
+ ]
},
- "scalar": {
- "description": "Worker-computed aggregate value for aggregation kinds \"Sum\", \"Max\", \"Min\",\n\"And\", and \"Or\". The possible value types are Long, Double, and Boolean.",
- "type": "any"
+ "originalStepName": {
+ "description": "System generated name of the original step in the user's graph, before\noptimization.",
+ "type": "string"
},
- "meanCount": {
- "description": "Worker-computed aggregate value for the \"Mean\" aggregation kind.\nThis holds the count of the aggregated values and is used in combination\nwith mean_sum above to obtain the actual mean aggregate value.\nThe only possible value type is Long.",
- "type": "any"
+ "workerId": {
+ "description": "ID of a particular worker.",
+ "type": "string"
},
- "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"
+ "originNamespace": {
+ "description": "A string containing a more specific namespace of the counter's origin.",
+ "type": "string"
}
},
- "id": "MetricUpdate"
+ "id": "CounterStructuredName",
+ "description": "Identifies a counter within a per-job namespace. Counters whose structured\nnames are the same get merged into a single value for the job.",
+ "type": "object"
+ },
+ "WorkerShutdownNotice": {
+ "properties": {
+ "reason": {
+ "description": "The reason for the worker shutdown.\nCurrent possible values are:\n \"UNKNOWN\": shutdown reason is unknown.\n \"PREEMPTION\": shutdown reason is preemption.\nOther possible reasons may be added in the future.",
+ "type": "string"
+ }
+ },
+ "id": "WorkerShutdownNotice",
+ "description": "Shutdown notification from workers. This is to be sent by the shutdown\nscript of the worker VM so that the backend knows that the VM is being\nshut down.",
+ "type": "object"
},
"ApproximateProgress": {
"properties": {
- "percentComplete": {
- "description": "Obsolete.",
- "format": "float",
- "type": "number"
- },
"remainingTime": {
"description": "Obsolete.",
"format": "google-duration",
"type": "string"
},
"position": {
- "$ref": "Position",
- "description": "Obsolete."
+ "description": "Obsolete.",
+ "$ref": "Position"
+ },
+ "percentComplete": {
+ "description": "Obsolete.",
+ "format": "float",
+ "type": "number"
}
},
"id": "ApproximateProgress",
@@ -3173,28 +4459,25 @@
"type": "object"
},
"WorkerMessageResponse": {
- "description": "A worker_message response allows the server to pass information to the\nsender.",
- "type": "object",
"properties": {
"workerMetricsResponse": {
"$ref": "ResourceUtilizationReportResponse",
"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."
}
},
- "id": "WorkerMessageResponse"
+ "id": "WorkerMessageResponse",
+ "description": "A worker_message response allows the server to pass information to the\nsender.",
+ "type": "object"
},
"TemplateMetadata": {
- "id": "TemplateMetadata",
- "description": "Metadata describing a template.",
- "type": "object",
"properties": {
"name": {
"description": "Required. The name of the template.",
@@ -3211,52 +4494,53 @@
"description": "Optional. A description of the template.",
"type": "string"
}
- }
+ },
+ "id": "TemplateMetadata",
+ "description": "Metadata describing a template.",
+ "type": "object"
},
"WorkerMessage": {
"description": "WorkerMessage provides information to the backend about a worker.",
"type": "object",
"properties": {
+ "workerShutdownNotice": {
+ "description": "Shutdown notice by workers.",
+ "$ref": "WorkerShutdownNotice"
+ },
"workerHealthReport": {
- "$ref": "WorkerHealthReport",
- "description": "The health of a worker."
+ "description": "The health of a worker.",
+ "$ref": "WorkerHealthReport"
},
"workerMessageCode": {
- "$ref": "WorkerMessageCode",
- "description": "A worker message code."
+ "description": "A worker message code.",
+ "$ref": "WorkerMessageCode"
},
"workerMetrics": {
"description": "Resource metrics reported by workers.",
"$ref": "ResourceUtilizationReport"
},
"labels": {
- "type": "object",
"additionalProperties": {
"type": "string"
},
- "description": "Labels are used to group WorkerMessages.\nFor example, a worker_message about a particular container\nmight have the labels:\n{ \"JOB_ID\": \"2015-04-22\",\n \"WORKER_ID\": \"wordcount-vm-2015…\"\n \"CONTAINER_TYPE\": \"worker\",\n \"CONTAINER_ID\": \"ac1234def\"}\nLabel tags typically correspond to Label enum values. However, for ease\nof development other strings can be used as tags. LABEL_UNSPECIFIED should\nnot be used here."
+ "description": "Labels are used to group WorkerMessages.\nFor example, a worker_message about a particular container\nmight have the labels:\n{ \"JOB_ID\": \"2015-04-22\",\n \"WORKER_ID\": \"wordcount-vm-2015…\"\n \"CONTAINER_TYPE\": \"worker\",\n \"CONTAINER_ID\": \"ac1234def\"}\nLabel tags typically correspond to Label enum values. However, for ease\nof development other strings can be used as tags. LABEL_UNSPECIFIED should\nnot be used here.",
+ "type": "object"
},
"time": {
"description": "The timestamp of the worker_message.",
"format": "google-datetime",
"type": "string"
- },
- "workerShutdownNotice": {
- "$ref": "WorkerShutdownNotice",
- "description": "Shutdown notice by workers."
}
},
"id": "WorkerMessage"
},
"WorkerShutdownNoticeResponse": {
+ "properties": {},
"id": "WorkerShutdownNoticeResponse",
"description": "Service-side response to WorkerMessage issuing shutdown notice.",
- "type": "object",
- "properties": {}
+ "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.",
@@ -3271,10 +4555,11 @@
}
}
},
- "id": "JobMetrics"
+ "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"
},
"FloatingPointList": {
- "type": "object",
"properties": {
"elements": {
"description": "Elements of the list.",
@@ -3286,20 +4571,18 @@
}
},
"id": "FloatingPointList",
- "description": "A metric value representing a list of floating point numbers."
+ "description": "A metric value representing a list of floating point numbers.",
+ "type": "object"
},
"CounterUpdate": {
- "id": "CounterUpdate",
- "description": "An update to a Counter sent from a worker.",
- "type": "object",
"properties": {
"nameAndKind": {
- "description": "Counter name and aggregation type.",
- "$ref": "NameAndKind"
+ "$ref": "NameAndKind",
+ "description": "Counter name and aggregation type."
},
"stringList": {
- "$ref": "StringList",
- "description": "List of strings, for Set."
+ "description": "List of strings, for Set.",
+ "$ref": "StringList"
},
"distribution": {
"description": "Distribution data",
@@ -3311,16 +4594,16 @@
"type": "string"
},
"floatingPointList": {
- "$ref": "FloatingPointList",
- "description": "List of floating point numbers, for Set."
+ "description": "List of floating point numbers, for Set.",
+ "$ref": "FloatingPointList"
},
"integer": {
"$ref": "SplitInt64",
"description": "Integer value for Sum, Max, Min."
},
"integerList": {
- "$ref": "IntegerList",
- "description": "List of integers, for Set."
+ "description": "List of integers, for Set.",
+ "$ref": "IntegerList"
},
"structuredNameAndMetadata": {
"$ref": "CounterStructuredNameAndMetadata",
@@ -3332,8 +4615,8 @@
"type": "number"
},
"integerMean": {
- "$ref": "IntegerMean",
- "description": "Integer mean aggregation value for Mean."
+ "description": "Integer mean aggregation value for Mean.",
+ "$ref": "IntegerMean"
},
"internal": {
"description": "Value for internally-defined counters used by the Dataflow service.",
@@ -3344,16 +4627,21 @@
"type": "boolean"
},
"floatingPointMean": {
- "description": "Floating point mean aggregation value for Mean.",
- "$ref": "FloatingPointMean"
+ "$ref": "FloatingPointMean",
+ "description": "Floating point mean aggregation value for Mean."
},
"boolean": {
"description": "Boolean value for And, Or.",
"type": "boolean"
}
- }
+ },
+ "id": "CounterUpdate",
+ "description": "An update to a Counter sent from a worker.",
+ "type": "object"
},
"SourceMetadata": {
+ "description": "Metadata about a Source useful for automatically optimizing\nand tuning the pipeline, etc.",
+ "type": "object",
"properties": {
"producesSortedKeys": {
"description": "Whether this source is known to produce key/value pairs with\nthe (encoded) keys in lexicographically sorted order.",
@@ -3369,14 +4657,16 @@
"type": "string"
}
},
- "id": "SourceMetadata",
- "description": "Metadata about a Source useful for automatically optimizing\nand tuning the pipeline, etc.",
- "type": "object"
+ "id": "SourceMetadata"
},
"DistributionUpdate": {
"description": "A metric value representing a distribution.",
"type": "object",
"properties": {
+ "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": {
"$ref": "Histogram",
"description": "(Optional) Histogram of value counts for the distribution."
@@ -3386,21 +4676,17 @@
"description": "The maximum value present in the distribution."
},
"count": {
- "$ref": "SplitInt64",
- "description": "The count of the number of elements present in the distribution."
- },
- "sumOfSquares": {
- "description": "Use a double since the sum of squares is likely to overflow int64.",
- "format": "double",
- "type": "number"
+ "description": "The count of the number of elements present in the distribution.",
+ "$ref": "SplitInt64"
},
"min": {
"description": "The minimum value present in the distribution.",
"$ref": "SplitInt64"
},
- "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."
+ "sumOfSquares": {
+ "description": "Use a double since the sum of squares is likely to overflow int64.",
+ "format": "double",
+ "type": "number"
}
},
"id": "DistributionUpdate"
@@ -3421,13 +4707,9 @@
"description": "DEPRECATED in favor of DynamicSourceSplit.",
"type": "object",
"properties": {
- "residualSource": {
- "$ref": "DerivedSource",
- "description": "DEPRECATED"
- },
"primary": {
- "$ref": "SourceSplitShard",
- "description": "DEPRECATED"
+ "description": "DEPRECATED",
+ "$ref": "SourceSplitShard"
},
"primarySource": {
"$ref": "DerivedSource",
@@ -3436,41 +4718,27 @@
"residual": {
"$ref": "SourceSplitShard",
"description": "DEPRECATED"
+ },
+ "residualSource": {
+ "description": "DEPRECATED",
+ "$ref": "DerivedSource"
}
},
"id": "SourceFork"
},
"WorkItemStatus": {
- "description": "Conveys a worker's progress through the work described by a WorkItem.",
- "type": "object",
"properties": {
- "stopPosition": {
- "$ref": "Position",
- "description": "A worker may split an active map task in two parts, \"primary\" and\n\"residual\", continuing to process the primary part and returning the\nresidual part into the pool of available work.\nThis event is called a \"dynamic split\" and is critical to the dynamic\nwork rebalancing feature. The two obtained sub-tasks are called\n\"parts\" of the split.\nThe parts, if concatenated, must represent the same input as would\nbe read by the current task if the split did not happen.\nThe exact way in which the original task is decomposed into the two\nparts is specified either as a position demarcating them\n(stop_position), or explicitly as two DerivedSources, if this\ntask consumes a user-defined source type (dynamic_source_split).\n\nThe \"current\" task is adjusted as a result of the split: after a task\nwith range [A, B) sends a stop_position update at C, its range is\nconsidered to be [A, C), e.g.:\n* Progress should be interpreted relative to the new range, e.g.\n \"75% completed\" means \"75% of [A, C) completed\"\n* The worker should interpret proposed_stop_position relative to the\n new range, e.g. \"split at 68%\" should be interpreted as\n \"split at 68% of [A, C)\".\n* If the worker chooses to split again using stop_position, only\n stop_positions in [A, C) will be accepted.\n* Etc.\ndynamic_source_split has similar semantics: e.g., if a task with\nsource S splits using dynamic_source_split into {P, R}\n(where P and R must be together equivalent to S), then subsequent\nprogress and proposed_stop_position should be interpreted relative\nto P, and in a potential subsequent dynamic_source_split into {P', R'},\nP' and R' must be together equivalent to P, etc."
- },
- "completed": {
- "description": "True if the WorkItem was completed (successfully or unsuccessfully).",
- "type": "boolean"
- },
- "reportedProgress": {
- "$ref": "ApproximateReportedProgress",
- "description": "The worker's progress through this WorkItem."
- },
- "sourceFork": {
- "description": "DEPRECATED in favor of dynamic_source_split.",
- "$ref": "SourceFork"
- },
"totalThrottlerWaitTimeSeconds": {
"description": "Total time the worker spent being throttled by external systems.",
"format": "double",
"type": "number"
},
"counterUpdates": {
+ "description": "Worker output counters for this WorkItem.",
"type": "array",
"items": {
"$ref": "CounterUpdate"
- },
- "description": "Worker output counters for this WorkItem."
+ }
},
"workItemId": {
"description": "Identifies the WorkItem.",
@@ -3491,8 +4759,8 @@
}
},
"dynamicSourceSplit": {
- "$ref": "DynamicSourceSplit",
- "description": "See documentation of stop_position."
+ "description": "See documentation of stop_position.",
+ "$ref": "DynamicSourceSplit"
},
"sourceOperationResponse": {
"$ref": "SourceOperationResponse",
@@ -3511,14 +4779,34 @@
"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": {
+ "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.",
+ "$ref": "Position"
+ },
+ "completed": {
+ "description": "True if the WorkItem was completed (successfully or unsuccessfully).",
+ "type": "boolean"
+ },
+ "reportedProgress": {
+ "$ref": "ApproximateReportedProgress",
+ "description": "The worker's progress through this WorkItem."
+ },
+ "sourceFork": {
+ "description": "DEPRECATED in favor of dynamic_source_split.",
+ "$ref": "SourceFork"
}
},
- "id": "WorkItemStatus"
+ "id": "WorkItemStatus",
+ "description": "Conveys a worker's progress through the work described by a WorkItem.",
+ "type": "object"
},
"ComponentSource": {
- "description": "Description of an interstitial value between transforms in an execution\nstage.",
- "type": "object",
"properties": {
+ "originalTransformOrCollection": {
+ "description": "User name for the original user transform or collection with which this\nsource is most closely associated.",
+ "type": "string"
+ },
"name": {
"description": "Dataflow service generated name for this source.",
"type": "string"
@@ -3526,17 +4814,13 @@
"userName": {
"description": "Human-readable name for this transform; may be user or system generated.",
"type": "string"
- },
- "originalTransformOrCollection": {
- "description": "User name for the original user transform or collection with which this\nsource is most closely associated.",
- "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": {
"firstBucketOffset": {
"description": "Starting index of first stored bucket. The non-inclusive upper-bound of\nthe ith bucket is given by:\n pow(10,(i-first_bucket_offset)/3) * (1,2,5)[(i-first_bucket_offset)%3]",
@@ -3547,25 +4831,28 @@
"description": "Counts of values in each bucket. For efficiency, prefix and trailing\nbuckets with count = 0 are elided. Buckets can store the full range of\nvalues of an unsigned long, with ULLONG_MAX falling into the 59th bucket\nwith range [1e19, 2e19).",
"type": "array",
"items": {
- "type": "string",
- "format": "int64"
+ "format": "int64",
+ "type": "string"
}
}
},
- "id": "Histogram"
+ "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"
},
"WorkItemServiceState": {
- "id": "WorkItemServiceState",
- "description": "The Dataflow service's idea of the current state of a WorkItem\nbeing processed by a worker.",
- "type": "object",
"properties": {
+ "suggestedStopPoint": {
+ "description": "DEPRECATED in favor of split_request.",
+ "$ref": "ApproximateProgress"
+ },
"splitRequest": {
- "$ref": "ApproximateSplitRequest",
- "description": "The progress point in the WorkItem where the Dataflow service\nsuggests that the worker truncate the task."
+ "description": "The progress point in the WorkItem where the Dataflow service\nsuggests that the worker truncate the task.",
+ "$ref": "ApproximateSplitRequest"
},
"suggestedStopPosition": {
- "$ref": "Position",
- "description": "Obsolete, always empty."
+ "description": "Obsolete, always empty.",
+ "$ref": "Position"
},
"reportStatusInterval": {
"description": "New recommended reporting interval.",
@@ -3596,51 +4883,51 @@
"description": "The index value to use for the next report sent by the worker.\nNote: If the report call fails for whatever reason, the worker should\nreuse this index for subsequent report attempts.",
"format": "int64",
"type": "string"
- },
- "suggestedStopPoint": {
- "$ref": "ApproximateProgress",
- "description": "DEPRECATED in favor of split_request."
}
- }
+ },
+ "id": "WorkItemServiceState",
+ "description": "The Dataflow service's idea of the current state of a WorkItem\nbeing processed by a worker.",
+ "type": "object"
},
"MetricStructuredName": {
- "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.",
"type": "string"
},
"name": {
- "type": "string",
- "description": "Worker-defined metric name."
+ "description": "Worker-defined metric name.",
+ "type": "string"
},
"context": {
- "type": "object",
"additionalProperties": {
"type": "string"
},
- "description": "Zero or more labeled fields which identify the part of the job this\nmetric is associated with, such as the name of a step or collection.\n\nFor example, built-in counters associated with steps will have\ncontext['step'] = \u003cstep-name\u003e. Counters associated with PCollections\nin the SDK will have context['pcollection'] = \u003cpcollection-name\u003e."
+ "description": "Zero or more labeled fields which identify the part of the job this\nmetric is associated with, such as the name of a step or collection.\n\nFor example, built-in counters associated with steps will have\ncontext['step'] = \u003cstep-name\u003e. Counters associated with PCollections\nin the SDK will have context['pcollection'] = \u003cpcollection-name\u003e.",
+ "type": "object"
}
},
"id": "MetricStructuredName",
- "description": "Identifies a metric, by describing the source which generated the\nmetric."
+ "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": {
- "$ref": "Sink",
- "description": "The sink to write the output value to."
- },
"tag": {
"description": "The id of the TupleTag the user code will tag the output value by.",
"type": "string"
+ },
+ "sink": {
+ "description": "The sink to write the output value to.",
+ "$ref": "Sink"
}
},
- "id": "SeqMapTaskOutputInfo",
- "description": "Information about an output of a SeqMapTask."
+ "id": "SeqMapTaskOutputInfo"
},
"JobExecutionStageInfo": {
+ "description": "Contains information about how a particular\ngoogle.dataflow.v1beta3.Step will be executed.",
"type": "object",
"properties": {
"stepName": {
@@ -3651,13 +4938,9 @@
}
}
},
- "id": "JobExecutionStageInfo",
- "description": "Contains information about how a particular\ngoogle.dataflow.v1beta3.Step will be executed."
+ "id": "JobExecutionStageInfo"
},
"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",
"properties": {
"start": {
"description": "The start (inclusive) of the key range.",
@@ -3679,23 +4962,28 @@
"description": "The physical location of this range assignment to be used for\nstreaming computation cross-worker message delivery.",
"type": "string"
}
- }
+ },
+ "id": "KeyRangeLocation",
+ "description": "Location information for a specific key-range of a sharded computation.\nCurrently we only support UTF-8 character splits to simplify encoding into\nJSON.",
+ "type": "object"
},
"SourceGetMetadataRequest": {
- "description": "A request to compute the SourceMetadata of a Source.",
- "type": "object",
"properties": {
"source": {
"description": "Specification of the source whose metadata should be computed.",
"$ref": "Source"
}
},
- "id": "SourceGetMetadataRequest"
+ "id": "SourceGetMetadataRequest",
+ "description": "A request to compute the SourceMetadata of a Source.",
+ "type": "object"
},
"NameAndKind": {
- "description": "Basic metadata about a counter.",
- "type": "object",
"properties": {
+ "name": {
+ "description": "Name of the counter.",
+ "type": "string"
+ },
"kind": {
"enumDescriptions": [
"Counter aggregation kind was not set.",
@@ -3721,18 +5009,25 @@
],
"description": "Counter aggregation kind.",
"type": "string"
- },
- "name": {
- "description": "Name of the counter.",
- "type": "string"
}
},
- "id": "NameAndKind"
+ "id": "NameAndKind",
+ "description": "Basic metadata about a counter.",
+ "type": "object"
},
"SeqMapTask": {
- "description": "Describes a particular function to invoke.",
- "type": "object",
"properties": {
+ "name": {
+ "description": "The user-provided name of the SeqDo operation.",
+ "type": "string"
+ },
+ "outputInfos": {
+ "description": "Information about each of the outputs.",
+ "type": "array",
+ "items": {
+ "$ref": "SeqMapTaskOutputInfo"
+ }
+ },
"inputs": {
"description": "Information about each of the inputs.",
"type": "array",
@@ -3749,1337 +5044,51 @@
"type": "string"
},
"userFn": {
- "description": "The user function to invoke.",
- "type": "object",
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
- }
- },
- "name": {
- "description": "The user-provided name of the SeqDo operation.",
- "type": "string"
- },
- "outputInfos": {
- "description": "Information about each of the outputs.",
- "type": "array",
- "items": {
- "$ref": "SeqMapTaskOutputInfo"
- }
+ },
+ "description": "The user function to invoke.",
+ "type": "object"
}
},
- "id": "SeqMapTask"
+ "id": "SeqMapTask",
+ "description": "Describes a particular function to invoke.",
+ "type": "object"
},
"WorkerMessageCode": {
- "description": "A message code is used to report status and error messages to the service.\nThe message codes are intended to be machine readable. The service will\ntake care of translating these into user understandable messages if\nnecessary.\n\nExample use cases:\n 1. Worker processes reporting successful startup.\n 2. Worker processes reporting specific errors (e.g. package staging\n failure).",
- "type": "object",
"properties": {
+ "parameters": {
+ "additionalProperties": {
+ "description": "Properties of the object.",
+ "type": "any"
+ },
+ "description": "Parameters contains specific information about the code.\n\nThis is a struct to allow parameters of different types.\n\nExamples:\n 1. For a \"HARNESS_STARTED\" message parameters might provide the name\n of the worker and additional data like timing information.\n 2. For a \"GCS_DOWNLOAD_ERROR\" parameters might contain fields listing\n the GCS objects being downloaded and fields containing errors.\n\nIn general complex data structures should be avoided. If a worker\nneeds to send a specific and complicated data structure then please\nconsider defining a new proto and adding it to the data oneof in\nWorkerMessageResponse.\n\nConventions:\n Parameters should only be used for information that isn't typically passed\n as a label.\n hostname and other worker identifiers should almost always be passed\n as labels since they will be included on most messages.",
+ "type": "object"
+ },
"code": {
"description": "The code is a string intended for consumption by a machine that identifies\nthe type of message being sent.\nExamples:\n 1. \"HARNESS_STARTED\" might be used to indicate the worker harness has\n started.\n 2. \"GCS_DOWNLOAD_ERROR\" might be used to indicate an error downloading\n a GCS file as part of the boot process of one of the worker containers.\n\nThis is a string and not an enum to make it easy to add new codes without\nwaiting for an API change.",
"type": "string"
- },
- "parameters": {
- "description": "Parameters contains specific information about the code.\n\nThis is a struct to allow parameters of different types.\n\nExamples:\n 1. For a \"HARNESS_STARTED\" message parameters might provide the name\n of the worker and additional data like timing information.\n 2. For a \"GCS_DOWNLOAD_ERROR\" parameters might contain fields listing\n the GCS objects being downloaded and fields containing errors.\n\nIn general complex data structures should be avoided. If a worker\nneeds to send a specific and complicated data structure then please\nconsider defining a new proto and adding it to the data oneof in\nWorkerMessageResponse.\n\nConventions:\n Parameters should only be used for information that isn't typically passed\n as a label.\n hostname and other worker identifiers should almost always be passed\n as labels since they will be included on most messages.",
- "type": "object",
- "additionalProperties": {
- "description": "Properties of the object.",
- "type": "any"
- }
}
},
- "id": "WorkerMessageCode"
- },
- "CustomSourceLocation": {
- "description": "Identifies the location of a custom souce.",
- "type": "object",
- "properties": {
- "stateful": {
- "description": "Whether this source is stateful.",
- "type": "boolean"
- }
- },
- "id": "CustomSourceLocation"
- },
- "MapTask": {
- "description": "MapTask consists of an ordered set of instructions, each of which\ndescribes one particular low-level operation for the worker to\nperform in order to accomplish the MapTask's WorkItem.\n\nEach instruction must appear in the list before any instructions which\ndepends on its output.",
- "type": "object",
- "properties": {
- "systemName": {
- "description": "System-defined name of this MapTask.\nUnique across the workflow.",
- "type": "string"
- },
- "stageName": {
- "description": "System-defined name of the stage containing this MapTask.\nUnique across the workflow.",
- "type": "string"
- },
- "instructions": {
- "description": "The instructions in the MapTask.",
- "type": "array",
- "items": {
- "$ref": "ParallelInstruction"
- }
- }
- },
- "id": "MapTask"
- },
- "FloatingPointMean": {
- "id": "FloatingPointMean",
- "description": "A representation of a floating point mean metric contribution.",
- "type": "object",
- "properties": {
- "sum": {
- "type": "number",
- "description": "The sum of all values being aggregated.",
- "format": "double"
- },
- "count": {
- "description": "The number of values being aggregated.",
- "$ref": "SplitInt64"
- }
- }
- },
- "ReportWorkItemStatusResponse": {
- "description": "Response from a request to report the status of WorkItems.",
- "type": "object",
- "properties": {
- "workItemServiceStates": {
- "description": "A set of messages indicating the service-side state for each\nWorkItem whose status was reported, in the same order as the\nWorkItemStatus messages in the ReportWorkItemStatusRequest which\nresulting in this response.",
- "type": "array",
- "items": {
- "$ref": "WorkItemServiceState"
- }
- }
- },
- "id": "ReportWorkItemStatusResponse"
- },
- "InstructionOutput": {
- "type": "object",
- "properties": {
- "codec": {
- "additionalProperties": {
- "description": "Properties of the object.",
- "type": "any"
- },
- "description": "The codec to use to encode data being written via this output.",
- "type": "object"
- },
- "name": {
- "description": "The user-provided name of this output.",
- "type": "string"
- },
- "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"
- },
- "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"
- }
- },
- "id": "InstructionOutput",
- "description": "An output of an instruction."
- },
- "CreateJobFromTemplateRequest": {
- "type": "object",
- "properties": {
- "gcsPath": {
- "description": "Required. A Cloud Storage path to the template from which to\ncreate the job.\nMust be a valid Cloud Storage URL, beginning with `gs://`.",
- "type": "string"
- },
- "environment": {
- "description": "The runtime environment for the job.",
- "$ref": "RuntimeEnvironment"
- },
- "location": {
- "description": "The location to which to direct the request.",
- "type": "string"
- },
- "parameters": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "The runtime parameters to pass to the job.",
- "type": "object"
- },
- "jobName": {
- "type": "string",
- "description": "Required. The job name to use for the created job."
- }
- },
- "id": "CreateJobFromTemplateRequest",
- "description": "A request to create a Cloud Dataflow job from a template."
- },
- "IntegerMean": {
- "description": "A representation of an integer mean metric contribution.",
- "type": "object",
- "properties": {
- "sum": {
- "$ref": "SplitInt64",
- "description": "The sum of all values being aggregated."
- },
- "count": {
- "$ref": "SplitInt64",
- "description": "The number of values being aggregated."
- }
- },
- "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": {
- "nextPageToken": {
- "description": "Set if there may be more results than fit in this response.",
- "type": "string"
- },
- "failedLocation": {
- "description": "Zero or more messages describing locations that failed to respond.",
- "type": "array",
- "items": {
- "$ref": "FailedLocation"
- }
- },
- "jobs": {
- "description": "A subset of the requested job information.",
- "type": "array",
- "items": {
- "$ref": "Job"
- }
- }
- },
- "id": "ListJobsResponse"
- },
- "ComputationTopology": {
- "description": "All configuration data for a particular Computation.",
- "type": "object",
- "properties": {
- "stateFamilies": {
- "type": "array",
- "items": {
- "$ref": "StateFamilyConfig"
- },
- "description": "The state family values."
- },
- "outputs": {
- "description": "The outputs from the computation.",
- "type": "array",
- "items": {
- "$ref": "StreamLocation"
- }
- },
- "systemStageName": {
- "description": "The system stage name.",
- "type": "string"
- },
- "computationId": {
- "description": "The ID of the computation.",
- "type": "string"
- },
- "inputs": {
- "description": "The inputs to the computation.",
- "type": "array",
- "items": {
- "$ref": "StreamLocation"
- }
- },
- "keyRanges": {
- "description": "The key ranges processed by the computation.",
- "type": "array",
- "items": {
- "$ref": "KeyRangeLocation"
- }
- }
- },
- "id": "ComputationTopology"
- },
- "RuntimeEnvironment": {
- "type": "object",
- "properties": {
- "serviceAccountEmail": {
- "description": "The email address of the service account to run the job as.",
- "type": "string"
- },
- "tempLocation": {
- "description": "The Cloud Storage path to use for temporary files.\nMust be a valid Cloud Storage URL, beginning with `gs://`.",
- "type": "string"
- },
- "bypassTempDirValidation": {
- "description": "Whether to bypass the safety checks for the job's temporary directory.\nUse with caution.",
- "type": "boolean"
- },
- "machineType": {
- "description": "The machine type to use for the job. Defaults to the value from the\ntemplate if not specified.",
- "type": "string"
- },
- "zone": {
- "description": "The Compute Engine [availability\nzone](https://cloud.google.com/compute/docs/regions-zones/regions-zones)\nfor launching worker instances to run your pipeline.",
- "type": "string"
- },
- "maxWorkers": {
- "description": "The maximum number of Google Compute Engine instances to be made\navailable to your pipeline during execution, from 1 to 1000.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "RuntimeEnvironment",
- "description": "The environment values to set at runtime."
- },
- "StreamingSideInputLocation": {
- "description": "Identifies the location of a streaming side input.",
- "type": "object",
- "properties": {
- "tag": {
- "description": "Identifies the particular side input within the streaming Dataflow job.",
- "type": "string"
- },
- "stateFamily": {
- "description": "Identifies the state family where this side input is stored.",
- "type": "string"
- }
- },
- "id": "StreamingSideInputLocation"
- },
- "MountedDataDisk": {
- "description": "Describes mounted data disk.",
- "type": "object",
- "properties": {
- "dataDisk": {
- "description": "The name of the data disk.\nThis name is local to the Google Cloud Platform project and uniquely\nidentifies the disk within that project, for example\n\"myproject-1014-104817-4c2-harness-0-disk-1\".",
- "type": "string"
- }
- },
- "id": "MountedDataDisk"
- },
- "LaunchTemplateResponse": {
- "id": "LaunchTemplateResponse",
- "description": "Response to the request to launch a template.",
- "type": "object",
- "properties": {
- "job": {
- "description": "The job that was launched, if the request was not a dry run and\nthe job was successfully launched.",
- "$ref": "Job"
- }
- }
- },
- "DerivedSource": {
- "description": "Specification of one of the bundles produced as a result of splitting\na Source (e.g. when executing a SourceSplitRequest, or when\nsplitting an active task using WorkItemStatus.dynamic_source_split),\nrelative to the source being split.",
- "type": "object",
- "properties": {
- "derivationMode": {
- "enum": [
- "SOURCE_DERIVATION_MODE_UNKNOWN",
- "SOURCE_DERIVATION_MODE_INDEPENDENT",
- "SOURCE_DERIVATION_MODE_CHILD_OF_CURRENT",
- "SOURCE_DERIVATION_MODE_SIBLING_OF_CURRENT"
- ],
- "description": "What source to base the produced source on (if any).",
- "type": "string",
- "enumDescriptions": [
- "The source derivation is unknown, or unspecified.",
- "Produce a completely independent Source with no base.",
- "Produce a Source based on the Source being split.",
- "Produce a Source based on the base of the Source being split."
- ]
- },
- "source": {
- "description": "Specification of the source.",
- "$ref": "Source"
- }
- },
- "id": "DerivedSource"
- },
- "DynamicSourceSplit": {
- "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": {
- "description": "Residual part (returned to the pool of work).\nSpecified relative to the previously-current source.",
- "$ref": "DerivedSource"
- },
- "primary": {
- "description": "Primary part (continued to be processed by worker).\nSpecified relative to the previously-current source.\nBecomes current.",
- "$ref": "DerivedSource"
- }
- },
- "id": "DynamicSourceSplit"
- },
- "Job": {
- "description": "Defines a job to be run by the Cloud Dataflow service.",
- "type": "object",
- "properties": {
- "tempFiles": {
- "description": "A set of files the system should be aware of that are used\nfor temporary storage. These temporary files will be\nremoved on job completion.\nNo duplicates are allowed.\nNo file patterns are supported.\n\nThe supported files are:\n\nGoogle Cloud Storage:\n\n storage.googleapis.com/{bucket}/{object}\n bucket.storage.googleapis.com/{object}",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "clientRequestId": {
- "description": "The client's unique identifier of the job, re-used across retried attempts.\nIf this field is set, the service will ensure its uniqueness.\nThe request to create a job will fail if the service has knowledge of a\npreviously submitted job with the same client's ID and job name.\nThe caller may use this field to ensure idempotence of job\ncreation across retried attempts to create a job.\nBy default, the field is empty and, in that case, the service ignores it.",
- "type": "string"
- },
- "name": {
- "description": "The user-specified Cloud Dataflow job name.\n\nOnly one Job with a given name may exist in a project at any\ngiven time. If a caller attempts to create a Job with the same\nname as an already-existing Job, the attempt returns the\nexisting Job.\n\nThe name must match the regular expression\n`[a-z]([-a-z0-9]{0,38}[a-z0-9])?`",
- "type": "string"
- },
- "replacedByJobId": {
- "description": "If another job is an update of this job (and thus, this job is in\n`JOB_STATE_UPDATED`), this field contains the ID of that job.",
- "type": "string"
- },
- "steps": {
- "description": "The top-level steps that constitute the entire job.",
- "type": "array",
- "items": {
- "$ref": "Step"
- }
- },
- "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": {
- "$ref": "JobExecutionInfo",
- "description": "Deprecated."
- },
- "currentState": {
- "description": "The current state of the job.\n\nJobs are created in the `JOB_STATE_STOPPED` state unless otherwise\nspecified.\n\nA job in the `JOB_STATE_RUNNING` state may asynchronously enter a\nterminal state. After a job has reached a terminal state, no\nfurther state updates may be made.\n\nThis field may be mutated by the Cloud Dataflow service;\ncallers cannot mutate it.",
- "type": "string",
- "enumDescriptions": [
- "The job's run state isn't specified.",
- "`JOB_STATE_STOPPED` indicates that the job has not\nyet started to run.",
- "`JOB_STATE_RUNNING` indicates that the job is currently running.",
- "`JOB_STATE_DONE` indicates that the job has successfully completed.\nThis is a terminal job state. This state may be set by the Cloud Dataflow\nservice, as a transition from `JOB_STATE_RUNNING`. It may also be set via a\nCloud Dataflow `UpdateJob` call, if the job has not yet reached a terminal\nstate.",
- "`JOB_STATE_FAILED` indicates that the job has failed. This is a\nterminal job state. This state may only be set by the Cloud Dataflow\nservice, and only as a transition from `JOB_STATE_RUNNING`.",
- "`JOB_STATE_CANCELLED` indicates that the job has been explicitly\ncancelled. This is a terminal job state. This state may only be\nset via a Cloud Dataflow `UpdateJob` call, and only if the job has not\nyet reached another terminal state.",
- "`JOB_STATE_UPDATED` indicates that the job was successfully updated,\nmeaning that this job was stopped and another job was started, inheriting\nstate from this one. This is a terminal job state. This state may only be\nset by the Cloud Dataflow service, and only as a transition from\n`JOB_STATE_RUNNING`.",
- "`JOB_STATE_DRAINING` indicates that the job is in the process of draining.\nA draining job has stopped pulling from its input sources and is processing\nany data that remains in-flight. This state may be set via a Cloud Dataflow\n`UpdateJob` call, but only as a transition from `JOB_STATE_RUNNING`. Jobs\nthat are draining may only transition to `JOB_STATE_DRAINED`,\n`JOB_STATE_CANCELLED`, or `JOB_STATE_FAILED`.",
- "`JOB_STATE_DRAINED` indicates that the job has been drained.\nA drained job terminated by stopping pulling from its input sources and\nprocessing any data that remained in-flight when draining was requested.\nThis state is a terminal state, may only be set by the Cloud Dataflow\nservice, and only as a transition from `JOB_STATE_DRAINING`.",
- "'JOB_STATE_PENDING' indicates that the job has been created but is not yet\nrunning. Jobs that are pending may only transition to `JOB_STATE_RUNNING`,\nor `JOB_STATE_FAILED`.",
- "'JOB_STATE_CANCELLING' indicates that the job has been explicitly cancelled\nand is in the process of stopping. Jobs that are cancelling may only\ntransition to 'JOB_STATE_CANCELLED' or 'JOB_STATE_FAILED'."
- ],
- "enum": [
- "JOB_STATE_UNKNOWN",
- "JOB_STATE_STOPPED",
- "JOB_STATE_RUNNING",
- "JOB_STATE_DONE",
- "JOB_STATE_FAILED",
- "JOB_STATE_CANCELLED",
- "JOB_STATE_UPDATED",
- "JOB_STATE_DRAINING",
- "JOB_STATE_DRAINED",
- "JOB_STATE_PENDING",
- "JOB_STATE_CANCELLING"
- ]
- },
- "location": {
- "description": "The location that contains this job.",
- "type": "string"
- },
- "currentStateTime": {
- "type": "string",
- "description": "The timestamp associated with the current state.",
- "format": "google-datetime"
- },
- "transformNameMapping": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "The map of transform name prefixes of the job to be replaced to the\ncorresponding name prefixes of the new job.",
- "type": "object"
- },
- "createTime": {
- "description": "The timestamp when the job was initially created. Immutable and set by the\nCloud Dataflow service.",
- "format": "google-datetime",
- "type": "string"
- },
- "environment": {
- "$ref": "Environment",
- "description": "The environment for the job."
- },
- "labels": {
- "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",
- "additionalProperties": {
- "type": "string"
- }
- },
- "stageStates": {
- "description": "This field may be mutated by the Cloud Dataflow service;\ncallers cannot mutate it.",
- "type": "array",
- "items": {
- "$ref": "ExecutionStageState"
- }
- },
- "projectId": {
- "description": "The ID of the Cloud Platform project that the job belongs to.",
- "type": "string"
- },
- "type": {
- "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"
- },
- "pipelineDescription": {
- "$ref": "PipelineDescription",
- "description": "Preliminary field: The format of this data may change at any time.\nA description of the user pipeline and stages through which it is executed.\nCreated by Cloud Dataflow service. Only retrieved with\nJOB_VIEW_DESCRIPTION or JOB_VIEW_ALL."
- },
- "replaceJobId": {
- "description": "If this job is an update of an existing job, this field is the job ID\nof the job it replaced.\n\nWhen sending a `CreateJobRequest`, you can update a job by specifying it\nhere. The job named here is stopped, and its intermediate state is\ntransferred to this job.",
- "type": "string"
- },
- "requestedState": {
- "type": "string",
- "enumDescriptions": [
- "The job's run state isn't specified.",
- "`JOB_STATE_STOPPED` indicates that the job has not\nyet started to run.",
- "`JOB_STATE_RUNNING` indicates that the job is currently running.",
- "`JOB_STATE_DONE` indicates that the job has successfully completed.\nThis is a terminal job state. This state may be set by the Cloud Dataflow\nservice, as a transition from `JOB_STATE_RUNNING`. It may also be set via a\nCloud Dataflow `UpdateJob` call, if the job has not yet reached a terminal\nstate.",
- "`JOB_STATE_FAILED` indicates that the job has failed. This is a\nterminal job state. This state may only be set by the Cloud Dataflow\nservice, and only as a transition from `JOB_STATE_RUNNING`.",
- "`JOB_STATE_CANCELLED` indicates that the job has been explicitly\ncancelled. This is a terminal job state. This state may only be\nset via a Cloud Dataflow `UpdateJob` call, and only if the job has not\nyet reached another terminal state.",
- "`JOB_STATE_UPDATED` indicates that the job was successfully updated,\nmeaning that this job was stopped and another job was started, inheriting\nstate from this one. This is a terminal job state. This state may only be\nset by the Cloud Dataflow service, and only as a transition from\n`JOB_STATE_RUNNING`.",
- "`JOB_STATE_DRAINING` indicates that the job is in the process of draining.\nA draining job has stopped pulling from its input sources and is processing\nany data that remains in-flight. This state may be set via a Cloud Dataflow\n`UpdateJob` call, but only as a transition from `JOB_STATE_RUNNING`. Jobs\nthat are draining may only transition to `JOB_STATE_DRAINED`,\n`JOB_STATE_CANCELLED`, or `JOB_STATE_FAILED`.",
- "`JOB_STATE_DRAINED` indicates that the job has been drained.\nA drained job terminated by stopping pulling from its input sources and\nprocessing any data that remained in-flight when draining was requested.\nThis state is a terminal state, may only be set by the Cloud Dataflow\nservice, and only as a transition from `JOB_STATE_DRAINING`.",
- "'JOB_STATE_PENDING' indicates that the job has been created but is not yet\nrunning. Jobs that are pending may only transition to `JOB_STATE_RUNNING`,\nor `JOB_STATE_FAILED`.",
- "'JOB_STATE_CANCELLING' indicates that the job has been explicitly cancelled\nand is in the process of stopping. Jobs that are cancelling may only\ntransition to 'JOB_STATE_CANCELLED' or 'JOB_STATE_FAILED'."
- ],
- "enum": [
- "JOB_STATE_UNKNOWN",
- "JOB_STATE_STOPPED",
- "JOB_STATE_RUNNING",
- "JOB_STATE_DONE",
- "JOB_STATE_FAILED",
- "JOB_STATE_CANCELLED",
- "JOB_STATE_UPDATED",
- "JOB_STATE_DRAINING",
- "JOB_STATE_DRAINED",
- "JOB_STATE_PENDING",
- "JOB_STATE_CANCELLING"
- ],
- "description": "The job's requested state.\n\n`UpdateJob` may be used to switch between the `JOB_STATE_STOPPED` and\n`JOB_STATE_RUNNING` states, by setting requested_state. `UpdateJob` may\nalso be used to directly set a job's requested state to\n`JOB_STATE_CANCELLED` or `JOB_STATE_DONE`, irrevocably terminating the\njob if it has not already reached a terminal state."
- }
- },
- "id": "Job"
- },
- "SourceOperationResponse": {
- "type": "object",
- "properties": {
- "split": {
- "$ref": "SourceSplitResponse",
- "description": "A response to a request to split a source."
- },
- "getMetadata": {
- "description": "A response to a request to get metadata about a source.",
- "$ref": "SourceGetMetadataResponse"
- }
- },
- "id": "SourceOperationResponse",
- "description": "The result of a SourceOperationRequest, specified in\nReportWorkItemStatusRequest.source_operation when the work item\nis completed."
- },
- "SideInputInfo": {
- "description": "Information about a side input of a DoFn or an input of a SeqDoFn.",
- "type": "object",
- "properties": {
- "sources": {
- "type": "array",
- "items": {
- "$ref": "Source"
- },
- "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."
- },
- "kind": {
- "additionalProperties": {
- "description": "Properties of the object.",
- "type": "any"
- },
- "description": "How to interpret the source element(s) as a side input value.",
- "type": "object"
- },
- "tag": {
- "description": "The id of the tag the user code will access this side input by;\nthis should correspond to the tag of some MultiOutputInfo.",
- "type": "string"
- }
- },
- "id": "SideInputInfo"
- },
- "SendDebugCaptureResponse": {
- "description": "Response to a send capture request.\nnothing",
- "type": "object",
- "properties": {},
- "id": "SendDebugCaptureResponse"
- },
- "WriteInstruction": {
- "type": "object",
- "properties": {
- "input": {
- "description": "The input.",
- "$ref": "InstructionInput"
- },
- "sink": {
- "$ref": "Sink",
- "description": "The sink to write to."
- }
- },
- "id": "WriteInstruction",
- "description": "An instruction that writes records.\nTakes one input, produces no outputs."
- },
- "ConcatPosition": {
- "properties": {
- "position": {
- "$ref": "Position",
- "description": "Position within the inner source."
- },
- "index": {
- "description": "Index of the inner source.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "ConcatPosition",
- "description": "A position that encapsulates an inner position and an index for the inner\nposition. A ConcatPosition can be used by a reader of a source that\nencapsulates a set of other sources.",
- "type": "object"
- },
- "CounterStructuredNameAndMetadata": {
- "description": "A single message which encapsulates structured name and metadata for a given\ncounter.",
- "type": "object",
- "properties": {
- "name": {
- "$ref": "CounterStructuredName",
- "description": "Structured name of the counter."
- },
- "metadata": {
- "$ref": "CounterMetadata",
- "description": "Metadata associated with a counter"
- }
- },
- "id": "CounterStructuredNameAndMetadata"
- },
- "AutoscalingSettings": {
- "properties": {
- "algorithm": {
- "description": "The algorithm to use for autoscaling.",
- "type": "string",
- "enumDescriptions": [
- "The algorithm is unknown, or unspecified.",
- "Disable autoscaling.",
- "Increase worker count over time to reduce job execution time."
- ],
- "enum": [
- "AUTOSCALING_ALGORITHM_UNKNOWN",
- "AUTOSCALING_ALGORITHM_NONE",
- "AUTOSCALING_ALGORITHM_BASIC"
- ]
- },
- "maxNumWorkers": {
- "description": "The maximum number of workers to cap scaling at.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "AutoscalingSettings",
- "description": "Settings for WorkerPool autoscaling.",
- "type": "object"
- },
- "StreamingComputationRanges": {
- "description": "Describes full or partial data disk assignment information of the computation\nranges.",
- "type": "object",
- "properties": {
- "computationId": {
- "description": "The ID of the computation.",
- "type": "string"
- },
- "rangeAssignments": {
- "description": "Data disk assignments for ranges from this computation.",
- "type": "array",
- "items": {
- "$ref": "KeyRangeDataDiskAssignment"
- }
- }
- },
- "id": "StreamingComputationRanges"
- },
- "ExecutionStageSummary": {
- "id": "ExecutionStageSummary",
- "description": "Description of the composing transforms, names/ids, and input/outputs of a\nstage of execution. Some composing transforms and sources may have been\ngenerated by the Dataflow service during execution planning.",
- "type": "object",
- "properties": {
- "outputSource": {
- "description": "Output sources for this stage.",
- "type": "array",
- "items": {
- "$ref": "StageSource"
- }
- },
- "name": {
- "description": "Dataflow service generated name for this stage.",
- "type": "string"
- },
- "inputSource": {
- "description": "Input sources for this stage.",
- "type": "array",
- "items": {
- "$ref": "StageSource"
- }
- },
- "id": {
- "description": "Dataflow service generated id for this stage.",
- "type": "string"
- },
- "componentTransform": {
- "description": "Transforms that comprise this execution stage.",
- "type": "array",
- "items": {
- "$ref": "ComponentTransform"
- }
- },
- "componentSource": {
- "description": "Collections produced and consumed by component transforms of this stage.",
- "type": "array",
- "items": {
- "$ref": "ComponentSource"
- }
- },
- "kind": {
- "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."
- ],
- "enum": [
- "UNKNOWN_KIND",
- "PAR_DO_KIND",
- "GROUP_BY_KEY_KIND",
- "FLATTEN_KIND",
- "READ_KIND",
- "WRITE_KIND",
- "CONSTANT_KIND",
- "SINGLETON_KIND",
- "SHUFFLE_KIND"
- ],
- "description": "Type of tranform this stage is executing."
- }
- }
- },
- "SendWorkerMessagesRequest": {
- "description": "A request for sending worker messages to the service.",
- "type": "object",
- "properties": {
- "workerMessages": {
- "description": "The WorkerMessages to send.",
- "type": "array",
- "items": {
- "$ref": "WorkerMessage"
- }
- },
- "location": {
- "description": "The location which contains the job",
- "type": "string"
- }
- },
- "id": "SendWorkerMessagesRequest"
- },
- "SourceSplitShard": {
- "properties": {
- "derivationMode": {
- "type": "string",
- "enumDescriptions": [
- "The source derivation is unknown, or unspecified.",
- "Produce a completely independent Source with no base.",
- "Produce a Source based on the Source being split.",
- "Produce a Source based on the base of the Source being split."
- ],
- "enum": [
- "SOURCE_DERIVATION_MODE_UNKNOWN",
- "SOURCE_DERIVATION_MODE_INDEPENDENT",
- "SOURCE_DERIVATION_MODE_CHILD_OF_CURRENT",
- "SOURCE_DERIVATION_MODE_SIBLING_OF_CURRENT"
- ],
- "description": "DEPRECATED"
- },
- "source": {
- "$ref": "Source",
- "description": "DEPRECATED"
- }
- },
- "id": "SourceSplitShard",
- "description": "DEPRECATED in favor of DerivedSource.",
- "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.",
- "format": "uint64",
- "type": "string"
- },
- "rate": {
- "description": "Average CPU utilization rate (% non-idle cpu / second) since previous\nsample.",
- "format": "double",
- "type": "number"
- },
- "timestamp": {
- "description": "Timestamp of the measurement.",
- "format": "google-datetime",
- "type": "string"
- }
- },
- "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"
- },
- "tempStoragePrefix": {
- "description": "The prefix of the resources the system should use for temporary\nstorage. The system will append the suffix \"/temp-{JOBNAME} to\nthis resource prefix, where {JOBNAME} is the value of the\njob_name field. The resulting bucket and object prefix is used\nas the prefix of the resources used to store temporary data\nneeded during the job execution. NOTE: This will override the\nvalue in taskrunner_settings.\nThe supported resource type is:\n\nGoogle Cloud Storage:\n\n storage.googleapis.com/{bucket}/{object}\n bucket.storage.googleapis.com/{object}",
- "type": "string"
- },
- "workerPools": {
- "description": "The worker pools. At least one \"harness\" worker pool must be\nspecified in order for the job to have workers.",
- "type": "array",
- "items": {
- "$ref": "WorkerPool"
- }
- },
- "dataset": {
- "description": "The dataset for the current project where various workflow\nrelated tables are stored.\n\nThe supported resource type is:\n\nGoogle BigQuery:\n bigquery.googleapis.com/{dataset}",
- "type": "string"
- },
- "experiments": {
- "description": "The list of experiments to enable.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "version": {
- "description": "A structure describing which components and their versions of the service\nare required in order to run the job.",
- "type": "object",
- "additionalProperties": {
- "description": "Properties of the object.",
- "type": "any"
- }
- },
- "internalExperiments": {
- "description": "Experimental settings.",
- "type": "object",
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- }
- },
- "serviceAccountEmail": {
- "description": "Identity to run virtual machines as. Defaults to the default account.",
- "type": "string"
- }
- },
- "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",
- "items": {
- "$ref": "StreamingComputationRanges"
- }
- },
- "dataDisks": {
- "description": "Describes the set of data disks this task should apply to.",
- "type": "array",
- "items": {
- "$ref": "MountedDataDisk"
- }
- }
- },
- "id": "StreamingComputationTask"
- },
- "SendDebugCaptureRequest": {
- "id": "SendDebugCaptureRequest",
- "description": "Request to send encoded debug information.",
- "type": "object",
- "properties": {
- "componentId": {
- "description": "The internal component id for which debug information is sent.",
- "type": "string"
- },
- "workerId": {
- "description": "The worker id, i.e., VM hostname.",
- "type": "string"
- },
- "location": {
- "description": "The location which contains the job specified by job_id.",
- "type": "string"
- },
- "data": {
- "description": "The encoded debug information.",
- "type": "string"
- }
- }
- },
- "GetDebugConfigResponse": {
- "description": "Response to a get debug configuration request.",
- "type": "object",
- "properties": {
- "config": {
- "description": "The encoded debug configuration for the requested component.",
- "type": "string"
- }
- },
- "id": "GetDebugConfigResponse"
- },
- "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.",
- "type": "string"
- },
- "name": {
- "description": "Dataflow service generated name for this source.",
- "type": "string"
- },
- "userName": {
- "description": "Human-readable name for this transform; may be user or system generated.",
- "type": "string"
- }
- },
- "id": "ComponentTransform"
- },
- "StreamingSetupTask": {
- "description": "A task which initializes part of a streaming Dataflow job.",
- "type": "object",
- "properties": {
- "streamingComputationTopology": {
- "description": "The global topology of the streaming Dataflow job.",
- "$ref": "TopologyConfig"
- },
- "workerHarnessPort": {
- "description": "The TCP port used by the worker to communicate with the Dataflow\nworker harness.",
- "format": "int32",
- "type": "integer"
- },
- "drain": {
- "description": "The user has requested drain.",
- "type": "boolean"
- },
- "receiveWorkPort": {
- "type": "integer",
- "description": "The TCP port on which the worker should listen for messages from\nother streaming computation workers.",
- "format": "int32"
- }
- },
- "id": "StreamingSetupTask"
- },
- "PubsubLocation": {
- "description": "Identifies a pubsub location to use for transferring data into or\nout of a streaming Dataflow job.",
- "type": "object",
- "properties": {
- "idLabel": {
- "description": "If set, contains a pubsub label from which to extract record ids.\nIf left empty, record deduplication will be strictly best effort.",
- "type": "string"
- },
- "timestampLabel": {
- "description": "If set, contains a pubsub label from which to extract record timestamps.\nIf left empty, record timestamps will be generated upon arrival.",
- "type": "string"
- },
- "topic": {
- "description": "A pubsub topic, in the form of\n\"pubsub.googleapis.com/topics/\u003cproject-id\u003e/\u003ctopic-name\u003e\"",
- "type": "string"
- },
- "subscription": {
- "description": "A pubsub subscription, in the form of\n\"pubsub.googleapis.com/subscriptions/\u003cproject-id\u003e/\u003csubscription-name\u003e\"",
- "type": "string"
- },
- "dropLateData": {
- "description": "Indicates whether the pipeline allows late-arriving data.",
- "type": "boolean"
- },
- "trackingSubscription": {
- "description": "If set, specifies the pubsub subscription that will be used for tracking\ncustom time timestamps for watermark estimation.",
- "type": "string"
- },
- "withAttributes": {
- "type": "boolean",
- "description": "If true, then the client has requested to get pubsub attributes."
- }
- },
- "id": "PubsubLocation"
- },
- "WorkerHealthReport": {
- "description": "WorkerHealthReport contains information about the health of a worker.\n\nThe VM should be identified by the labels attached to the WorkerMessage that\nthis health ping belongs to.",
- "type": "object",
- "properties": {
- "pods": {
- "description": "The pods running on the worker. See:\nhttp://kubernetes.io/v1.1/docs/api-reference/v1/definitions.html#_v1_pod\n\nThis field is used by the worker to send the status of the indvidual\ncontainers running on each worker.",
- "type": "array",
- "items": {
- "additionalProperties": {
- "type": "any",
- "description": "Properties of the object."
- },
- "type": "object"
- }
- },
- "vmStartupTime": {
- "description": "The time the VM was booted.",
- "format": "google-datetime",
- "type": "string"
- },
- "vmIsHealthy": {
- "description": "Whether the VM is healthy.",
- "type": "boolean"
- },
- "reportInterval": {
- "description": "The interval at which the worker is sending health reports.\nThe default value of 0 should be interpreted as the field is not being\nexplicitly set by the worker.",
- "format": "google-duration",
- "type": "string"
- }
- },
- "id": "WorkerHealthReport"
- },
- "JobMessage": {
- "id": "JobMessage",
- "description": "A particular message pertaining to a Dataflow job.",
- "type": "object",
- "properties": {
- "id": {
- "type": "string",
- "description": "Deprecated."
- },
- "messageText": {
- "description": "The text of the message.",
- "type": "string"
- },
- "messageImportance": {
- "description": "Importance level of the message.",
- "type": "string",
- "enumDescriptions": [
- "The message importance isn't specified, or is unknown.",
- "The message is at the 'debug' level: typically only useful for\nsoftware engineers working on the code the job is running.\nTypically, Dataflow pipeline runners do not display log messages\nat this level by default.",
- "The message is at the 'detailed' level: somewhat verbose, but\npotentially useful to users. Typically, Dataflow pipeline\nrunners do not display log messages at this level by default.\nThese messages are displayed by default in the Dataflow\nmonitoring UI.",
- "The message is at the 'basic' level: useful for keeping\ntrack of the execution of a Dataflow pipeline. Typically,\nDataflow pipeline runners display log messages at this level by\ndefault, and these messages are displayed by default in the\nDataflow monitoring UI.",
- "The message is at the 'warning' level: indicating a condition\npertaining to a job which may require human intervention.\nTypically, Dataflow pipeline runners display log messages at this\nlevel by default, and these messages are displayed by default in\nthe Dataflow monitoring UI.",
- "The message is at the 'error' level: indicating a condition\npreventing a job from succeeding. Typically, Dataflow pipeline\nrunners display log messages at this level by default, and these\nmessages are displayed by default in the Dataflow monitoring UI."
- ],
- "enum": [
- "JOB_MESSAGE_IMPORTANCE_UNKNOWN",
- "JOB_MESSAGE_DEBUG",
- "JOB_MESSAGE_DETAILED",
- "JOB_MESSAGE_BASIC",
- "JOB_MESSAGE_WARNING",
- "JOB_MESSAGE_ERROR"
- ]
- },
- "time": {
- "description": "The timestamp of the message.",
- "format": "google-datetime",
- "type": "string"
- }
- }
- },
- "ParameterMetadata": {
- "description": "Metadata for a specific parameter.",
- "type": "object",
- "properties": {
- "isOptional": {
- "description": "Optional. Whether the parameter is optional. Defaults to false.",
- "type": "boolean"
- },
- "name": {
- "description": "Required. The name of the parameter.",
- "type": "string"
- },
- "regexes": {
- "description": "Optional. Regexes that the parameter must match.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "label": {
- "description": "Required. The label to display for the parameter.",
- "type": "string"
- },
- "helpText": {
- "description": "Required. The help text to display for the parameter.",
- "type": "string"
- }
- },
- "id": "ParameterMetadata"
- },
- "MultiOutputInfo": {
- "properties": {
- "tag": {
- "description": "The id of the tag the user code will emit to this output by; this\nshould correspond to the tag of some SideInputInfo.",
- "type": "string"
- }
- },
- "id": "MultiOutputInfo",
- "description": "Information about an output of a multi-output DoFn.",
- "type": "object"
- },
- "SourceSplitRequest": {
- "properties": {
- "source": {
- "$ref": "Source",
- "description": "Specification of the source to be split."
- },
- "options": {
- "description": "Hints for tuning the splitting process.",
- "$ref": "SourceSplitOptions"
- }
- },
- "id": "SourceSplitRequest",
- "description": "Represents the operation to split a high-level Source specification\ninto bundles (parts for parallel processing).\n\nAt a high level, splitting of a source into bundles happens as follows:\nSourceSplitRequest is applied to the source. If it returns\nSOURCE_SPLIT_OUTCOME_USE_CURRENT, no further splitting happens and the source\nis used \"as is\". Otherwise, splitting is applied recursively to each\nproduced DerivedSource.\n\nAs an optimization, for any Source, if its does_not_need_splitting is\ntrue, the framework assumes that splitting this source would return\nSOURCE_SPLIT_OUTCOME_USE_CURRENT, and doesn't initiate a SourceSplitRequest.\nThis applies both to the initial source being split and to bundles\nproduced from it.",
- "type": "object"
- },
- "SourceGetMetadataResponse": {
- "id": "SourceGetMetadataResponse",
- "description": "The result of a SourceGetMetadataOperation.",
- "type": "object",
- "properties": {
- "metadata": {
- "$ref": "SourceMetadata",
- "description": "The computed metadata."
- }
- }
- },
- "AutoscalingEvent": {
- "description": "A structured message reporting an autoscaling decision made by the Dataflow\nservice.",
- "type": "object",
- "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": {
- "type": "string",
- "description": "The time this event was emitted to indicate a new target or current\nnum_workers value.",
- "format": "google-datetime"
- },
- "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"
- },
- "MetricShortId": {
- "type": "object",
- "properties": {
- "metricIndex": {
- "description": "The index of the corresponding metric in\nthe ReportWorkItemStatusRequest. Required.",
- "format": "int32",
- "type": "integer"
- },
- "shortId": {
- "description": "The service-generated short identifier for the metric.",
- "format": "int64",
- "type": "string"
- }
- },
- "id": "MetricShortId",
- "description": "The metric short id is returned to the user alongside an offset into\nReportWorkItemStatusRequest"
- },
- "ShellTask": {
- "description": "A task which consists of a shell command for the worker to execute.",
- "type": "object",
- "properties": {
- "command": {
- "description": "The shell command to run.",
- "type": "string"
- },
- "exitCode": {
- "description": "Exit code for the task.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "ShellTask"
- },
- "TaskRunnerSettings": {
- "properties": {
- "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"
- },
- "logDir": {
- "description": "The directory on the VM to store logs.",
- "type": "string"
- },
- "oauthScopes": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "description": "The OAuth2 scopes to be requested by the taskrunner in order to\naccess the Cloud Dataflow API."
- },
- "dataflowApiVersion": {
- "type": "string",
- "description": "The API version of endpoint, e.g. \"v1b3\""
- },
- "streamingWorkerMainClass": {
- "description": "The streaming worker main class name.",
- "type": "string"
- },
- "logUploadLocation": {
- "description": "Indicates where to put logs. If this is not specified, the logs\nwill not be uploaded.\n\nThe supported resource type is:\n\nGoogle Cloud Storage:\n storage.googleapis.com/{bucket}/{object}\n bucket.storage.googleapis.com/{object}",
- "type": "string"
- },
- "workflowFileName": {
- "description": "The file to store the workflow in.",
- "type": "string"
- },
- "languageHint": {
- "description": "The suggested backend language.",
- "type": "string"
- },
- "commandlinesFileName": {
- "description": "The file to store preprocessing commands in.",
- "type": "string"
- },
- "tempStoragePrefix": {
- "description": "The prefix of the resources the taskrunner should use for\ntemporary storage.\n\nThe supported resource type is:\n\nGoogle Cloud Storage:\n storage.googleapis.com/{bucket}/{object}\n bucket.storage.googleapis.com/{object}",
- "type": "string"
- },
- "baseTaskDir": {
- "description": "The location on the worker for task-specific subdirectories.",
- "type": "string"
- },
- "baseUrl": {
- "description": "The base URL for the taskrunner to use when accessing Google Cloud APIs.\n\nWhen workers access Google Cloud APIs, they logically do so via\nrelative URLs. If this field is specified, it supplies the base\nURL to use for resolving these relative URLs. The normative\nalgorithm used is defined by RFC 1808, \"Relative Uniform Resource\nLocators\".\n\nIf not specified, the default value is \"http://www.googleapis.com/\"",
- "type": "string"
- },
- "logToSerialconsole": {
- "description": "Whether to send taskrunner log info to Google Compute Engine VM serial\nconsole.",
- "type": "boolean"
- },
- "continueOnException": {
- "description": "Whether to continue taskrunner if an exception is hit.",
- "type": "boolean"
- },
- "parallelWorkerSettings": {
- "$ref": "WorkerSettings",
- "description": "The settings to pass to the parallel worker harness."
- },
- "taskUser": {
- "description": "The UNIX user ID on the worker VM to use for tasks launched by\ntaskrunner; e.g. \"root\".",
- "type": "string"
- },
- "vmId": {
- "description": "The ID string of the VM.",
- "type": "string"
- }
- },
- "id": "TaskRunnerSettings",
- "description": "Taskrunner configuration settings.",
+ "id": "WorkerMessageCode",
+ "description": "A message code is used to report status and error messages to the service.\nThe message codes are intended to be machine readable. The service will\ntake care of translating these into user understandable messages if\nnecessary.\n\nExample use cases:\n 1. Worker processes reporting successful startup.\n 2. Worker processes reporting specific errors (e.g. package staging\n failure).",
"type": "object"
}
},
- "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": "v1b3",
"baseUrl": "https://dataflow.googleapis.com/",
"auth": {
"oauth2": {
"scopes": {
+ "https://www.googleapis.com/auth/cloud-platform": {
+ "description": "View and manage your data across Google Cloud Platform services"
+ },
"https://www.googleapis.com/auth/userinfo.email": {
"description": "View your email address"
},
@@ -5088,22 +5097,20 @@
},
"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"
}
}
}
},
- "servicePath": "",
- "description": "Manages Google Cloud Dataflow projects on Google Cloud Platform.",
"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",
- "revision": "20171219",
+ "revision": "20171222",
"documentationLink": "https://cloud.google.com/dataflow",
- "id": "dataflow:v1b3"
+ "id": "dataflow:v1b3",
+ "title": "Google Dataflow API"
}
diff --git a/dataflow/v1b3/dataflow-gen.go b/dataflow/v1b3/dataflow-gen.go
index 6f50ec1..1720574 100644
--- a/dataflow/v1b3/dataflow-gen.go
+++ b/dataflow/v1b3/dataflow-gen.go
@@ -3928,6 +3928,9 @@
// RuntimeEnvironment: The environment values to set at runtime.
type RuntimeEnvironment struct {
+ // AdditionalExperiments: Additional experiment flags for the job.
+ AdditionalExperiments []string `json:"additionalExperiments,omitempty"`
+
// BypassTempDirValidation: Whether to bypass the safety checks for the
// job's temporary directory.
// Use with caution.
@@ -3959,18 +3962,18 @@
Zone string `json:"zone,omitempty"`
// ForceSendFields is a list of field names (e.g.
- // "BypassTempDirValidation") to unconditionally include in API
- // requests. By default, fields with empty values are omitted from API
- // requests. However, any non-pointer, non-interface field appearing in
+ // "AdditionalExperiments") to unconditionally include in API requests.
+ // By default, fields with empty values are omitted from API requests.
+ // However, any non-pointer, non-interface field appearing in
// ForceSendFields will be sent to the server regardless of whether the
// field is empty or not. This may be used to include empty fields in
// Patch requests.
ForceSendFields []string `json:"-"`
- // NullFields is a list of field names (e.g. "BypassTempDirValidation")
- // to include in API requests with the JSON null value. By default,
- // fields with empty values are omitted from API requests. However, any
- // field with an empty value appearing in NullFields will be sent to the
+ // NullFields is a list of field names (e.g. "AdditionalExperiments") to
+ // include in API requests with the JSON null value. By default, fields
+ // with empty values are omitted from API requests. However, any field
+ // with an empty value appearing in NullFields will be sent to the
// server as null. It is an error if a field in this list has a
// non-empty value. This may be used to include null fields in Patch
// requests.
diff --git a/dataproc/v1/dataproc-api.json b/dataproc/v1/dataproc-api.json
index 41116df..991e03d 100644
--- a/dataproc/v1/dataproc-api.json
+++ b/dataproc/v1/dataproc-api.json
@@ -1,4 +1,25 @@
{
+ "baseUrl": "https://dataproc.googleapis.com/",
+ "auth": {
+ "oauth2": {
+ "scopes": {
+ "https://www.googleapis.com/auth/cloud-platform": {
+ "description": "View and manage your data across Google Cloud Platform services"
+ }
+ }
+ }
+ },
+ "kind": "discovery#restDescription",
+ "description": "Manages Hadoop-based clusters and jobs on Google Cloud Platform.",
+ "servicePath": "",
+ "rootUrl": "https://dataproc.googleapis.com/",
+ "basePath": "",
+ "ownerDomain": "google.com",
+ "name": "dataproc",
+ "batchPath": "batch",
+ "revision": "20171212",
+ "documentationLink": "https://cloud.google.com/dataproc/",
+ "id": "dataproc:v1",
"fullyEncodeReservedExpansion": true,
"title": "Google Cloud Dataproc API",
"discoveryVersion": "v1",
@@ -10,92 +31,7 @@
"resources": {
"clusters": {
"methods": {
- "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": {
- "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"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectId}/regions/{region}/clusters",
- "id": "dataproc.projects.regions.clusters.list",
- "path": "v1/projects/{projectId}/regions/{region}/clusters"
- },
- "create": {
- "path": "v1/projects/{projectId}/regions/{region}/clusters",
- "id": "dataproc.projects.regions.clusters.create",
- "request": {
- "$ref": "Cluster"
- },
- "description": "Creates a cluster in a project.",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "projectId",
- "region"
- ],
- "httpMethod": "POST",
- "parameters": {
- "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 cluster belongs to.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectId}/regions/{region}/clusters"
- },
"patch": {
- "description": "Updates a cluster in a project.",
- "request": {
- "$ref": "Cluster"
- },
"response": {
"$ref": "Operation"
},
@@ -105,33 +41,30 @@
"clusterName"
],
"httpMethod": "PATCH",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
"parameters": {
"region": {
+ "location": "path",
"description": "Required. The Cloud Dataproc region in which to handle the request.",
"required": true,
+ "type": "string"
+ },
+ "updateMask": {
+ "description": "Required. Specifies the path, relative to Cluster, of the field to update. For example, to change the number of workers in a cluster to 5, the update_mask parameter would be specified as config.worker_config.num_instances, and the PATCH request body would specify the new value, as follows:\n{\n \"config\":{\n \"workerConfig\":{\n \"numInstances\":\"5\"\n }\n }\n}\nSimilarly, to change the number of preemptible workers in a cluster to 5, the update_mask parameter would be config.secondary_worker_config.num_instances, and the PATCH request body would be set as follows:\n{\n \"config\":{\n \"secondaryWorkerConfig\":{\n \"numInstances\":\"5\"\n }\n }\n}\n\u003cstrong\u003eNote:\u003c/strong\u003e Currently, only the following fields can be updated:\u003ctable\u003e \u003ctbody\u003e \u003ctr\u003e \u003ctd\u003e\u003cstrong\u003eMask\u003c/strong\u003e\u003c/td\u003e \u003ctd\u003e\u003cstrong\u003ePurpose\u003c/strong\u003e\u003c/td\u003e \u003c/tr\u003e \u003ctr\u003e \u003ctd\u003e\u003cstrong\u003e\u003cem\u003elabels\u003c/em\u003e\u003c/strong\u003e\u003c/td\u003e \u003ctd\u003eUpdate labels\u003c/td\u003e \u003c/tr\u003e \u003ctr\u003e \u003ctd\u003e\u003cstrong\u003e\u003cem\u003econfig.worker_config.num_instances\u003c/em\u003e\u003c/strong\u003e\u003c/td\u003e \u003ctd\u003eResize primary worker group\u003c/td\u003e \u003c/tr\u003e \u003ctr\u003e \u003ctd\u003e\u003cstrong\u003e\u003cem\u003econfig.secondary_worker_config.num_instances\u003c/em\u003e\u003c/strong\u003e\u003c/td\u003e \u003ctd\u003eResize secondary worker group\u003c/td\u003e \u003c/tr\u003e \u003c/tbody\u003e \u003c/table\u003e",
+ "format": "google-fieldmask",
+ "type": "string",
+ "location": "query"
+ },
+ "clusterName": {
+ "description": "Required. The cluster name.",
+ "required": true,
"type": "string",
"location": "path"
},
- "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"
- },
"gracefulDecommissionTimeout": {
- "location": "query",
"description": "Optional. Timeout for graceful YARN decomissioning. Graceful decommissioning allows removing nodes from the cluster without interrupting jobs in progress. Timeout specifies how long to wait for jobs in progress to finish before forcefully removing nodes (and potentially interrupting jobs). Default timeout is 0 (for forceful decommission), and the maximum allowed timeout is 1 day.Only supported on Dataproc image versions 1.2 and higher.",
"format": "google-duration",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"projectId": {
"description": "Required. The ID of the Google Cloud Platform project the cluster belongs to.",
@@ -140,11 +73,23 @@
"location": "path"
}
},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
"flatPath": "v1/projects/{projectId}/regions/{region}/clusters/{clusterName}",
"path": "v1/projects/{projectId}/regions/{region}/clusters/{clusterName}",
- "id": "dataproc.projects.regions.clusters.patch"
+ "id": "dataproc.projects.regions.clusters.patch",
+ "request": {
+ "$ref": "Cluster"
+ },
+ "description": "Updates a cluster in a project."
},
"get": {
+ "flatPath": "v1/projects/{projectId}/regions/{region}/clusters/{clusterName}",
+ "id": "dataproc.projects.regions.clusters.get",
+ "path": "v1/projects/{projectId}/regions/{region}/clusters/{clusterName}",
+ "description": "Gets the resource representation for a cluster in a project.",
+ "httpMethod": "GET",
"response": {
"$ref": "Cluster"
},
@@ -153,39 +98,31 @@
"region",
"clusterName"
],
- "httpMethod": "GET",
"parameters": {
- "projectId": {
- "location": "path",
- "description": "Required. The ID of the Google Cloud Platform project that the cluster belongs to.",
- "required": true,
- "type": "string"
- },
"region": {
+ "location": "path",
"description": "Required. The Cloud Dataproc region in which to handle the request.",
"required": true,
- "type": "string",
- "location": "path"
+ "type": "string"
},
"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": "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."
+ ]
},
"diagnose": {
- "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"
@@ -203,27 +140,31 @@
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
- "clusterName": {
- "location": "path",
- "description": "Required. The cluster name.",
- "required": true,
- "type": "string"
- },
"projectId": {
+ "location": "path",
"description": "Required. The ID of the Google Cloud Platform project that the cluster belongs to.",
"required": true,
- "type": "string",
- "location": "path"
+ "type": "string"
},
"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"
}
- }
+ },
+ "flatPath": "v1/projects/{projectId}/regions/{region}/clusters/{clusterName}:diagnose",
+ "path": "v1/projects/{projectId}/regions/{region}/clusters/{clusterName}:diagnose",
+ "id": "dataproc.projects.regions.clusters.diagnose"
},
"delete": {
+ "description": "Deletes a cluster in a project.",
"response": {
"$ref": "Operation"
},
@@ -233,6 +174,9 @@
"clusterName"
],
"httpMethod": "DELETE",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
"parameters": {
"projectId": {
"location": "path",
@@ -247,36 +191,109 @@
"type": "string"
},
"clusterName": {
- "location": "path",
"description": "Required. The cluster name.",
"required": true,
- "type": "string"
+ "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"
+ },
+ "list": {
+ "response": {
+ "$ref": "ListClustersResponse"
+ },
+ "parameterOrder": [
+ "projectId",
+ "region"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "region": {
+ "description": "Required. The Cloud Dataproc region in which to handle the request.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "filter": {
+ "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": {
+ "description": "Optional. The standard List page token.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageSize": {
+ "location": "query",
+ "description": "Optional. The standard List page size.",
+ "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"
+ }
+ },
+ "flatPath": "v1/projects/{projectId}/regions/{region}/clusters",
+ "path": "v1/projects/{projectId}/regions/{region}/clusters",
+ "id": "dataproc.projects.regions.clusters.list",
+ "description": "Lists all regions/{region}/clusters in a project."
+ },
+ "create": {
+ "request": {
+ "$ref": "Cluster"
+ },
+ "description": "Creates a cluster in a project.",
+ "response": {
+ "$ref": "Operation"
+ },
+ "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": {
+ "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}",
- "path": "v1/projects/{projectId}/regions/{region}/clusters/{clusterName}",
- "id": "dataproc.projects.regions.clusters.delete",
- "description": "Deletes a cluster in a project."
+ "flatPath": "v1/projects/{projectId}/regions/{region}/clusters",
+ "path": "v1/projects/{projectId}/regions/{region}/clusters",
+ "id": "dataproc.projects.regions.clusters.create"
}
}
},
"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"
],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
"parameters": {
"name": {
"location": "path",
@@ -286,9 +303,13 @@
"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",
- "id": "dataproc.projects.regions.operations.cancel"
+ "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED."
},
"delete": {
"response": {
@@ -298,76 +319,73 @@
"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/[^/]+$"
+ "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",
"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": {
- "httpMethod": "GET",
- "parameterOrder": [
- "name"
- ],
+ "flatPath": "v1/projects/{projectsId}/regions/{regionsId}/operations",
+ "path": "v1/{+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": {
+ "location": "path",
"description": "The name of the operation's parent resource.",
"required": true,
"type": "string",
- "pattern": "^projects/[^/]+/regions/[^/]+/operations$",
- "location": "path"
+ "pattern": "^projects/[^/]+/regions/[^/]+/operations$"
},
"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/projects/{projectsId}/regions/{regionsId}/operations",
- "id": "dataproc.projects.regions.operations.list",
- "path": "v1/{+name}",
- "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.NOTE: the name binding allows API services to override the binding to use different resource name schemes, such as users/*/operations. To override the binding, API services can add a binding such as \"/v1/{name=users/*}/operations\" to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id."
+ }
},
"get": {
- "flatPath": "v1/projects/{projectsId}/regions/{regionsId}/operations/{operationsId}",
- "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",
- "parameterOrder": [
- "name"
- ],
"response": {
"$ref": "Operation"
},
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
"parameters": {
"name": {
"description": "The name of the operation resource.",
@@ -379,17 +397,78 @@
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
- ]
+ ],
+ "flatPath": "v1/projects/{projectsId}/regions/{regionsId}/operations/{operationsId}",
+ "path": "v1/{+name}",
+ "id": "dataproc.projects.regions.operations.get"
}
}
},
"jobs": {
"methods": {
- "cancel": {
- "description": "Starts a job cancellation request. To access the job resource after cancellation, call regions/{region}/jobs.list or regions/{region}/jobs.get.",
- "request": {
- "$ref": "CancelJobRequest"
+ "list": {
+ "description": "Lists regions/{region}/jobs in a project.",
+ "response": {
+ "$ref": "ListJobsResponse"
},
+ "parameterOrder": [
+ "projectId",
+ "region"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "projectId": {
+ "location": "path",
+ "description": "Required. The ID of the Google Cloud Platform project that the job belongs to.",
+ "required": true,
+ "type": "string"
+ },
+ "filter": {
+ "location": "query",
+ "description": "Optional. A filter constraining the jobs to list. Filters are case-sensitive and have the following syntax:field = value AND field = value ...where field is status.state or labels.[KEY], and [KEY] is a label key. value can be * to match all values. status.state can be either ACTIVE or NON_ACTIVE. Only the logical AND operator is supported; space-separated items are treated as having an implicit AND operator.Example filter:status.state = ACTIVE AND labels.env = staging AND labels.starred = *",
+ "type": "string"
+ },
+ "jobStateMatcher": {
+ "description": "Optional. Specifies enumerated categories of jobs to list. (default = match ALL jobs).If filter is provided, jobStateMatcher will be ignored.",
+ "type": "string",
+ "location": "query",
+ "enum": [
+ "ALL",
+ "ACTIVE",
+ "NON_ACTIVE"
+ ]
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "Optional. The page token, returned by a previous call, to request the next page of results.",
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "Optional. The number of results to return in each response.",
+ "format": "int32",
+ "type": "integer",
+ "location": "query"
+ },
+ "region": {
+ "location": "path",
+ "description": "Required. The Cloud Dataproc region in which to handle the request.",
+ "required": true,
+ "type": "string"
+ },
+ "clusterName": {
+ "location": "query",
+ "description": "Optional. If set, the returned jobs list includes only jobs that were submitted to the named cluster.",
+ "type": "string"
+ }
+ },
+ "flatPath": "v1/projects/{projectId}/regions/{region}/jobs",
+ "path": "v1/projects/{projectId}/regions/{region}/jobs",
+ "id": "dataproc.projects.regions.jobs.list"
+ },
+ "cancel": {
"response": {
"$ref": "Job"
},
@@ -399,9 +478,6 @@
"jobId"
],
"httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
"parameters": {
"projectId": {
"location": "path",
@@ -410,74 +486,43 @@
"type": "string"
},
"jobId": {
- "location": "path",
"description": "Required. The job ID.",
"required": true,
- "type": "string"
- },
- "region": {
- "description": "Required. The Cloud Dataproc region in which to handle the request.",
- "required": true,
"type": "string",
"location": "path"
+ },
+ "region": {
+ "location": "path",
+ "description": "Required. The Cloud Dataproc region in which to handle the request.",
+ "required": true,
+ "type": "string"
}
},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
"flatPath": "v1/projects/{projectId}/regions/{region}/jobs/{jobId}:cancel",
"path": "v1/projects/{projectId}/regions/{region}/jobs/{jobId}:cancel",
- "id": "dataproc.projects.regions.jobs.cancel"
- },
- "get": {
- "description": "Gets the resource representation for a job in a project.",
- "response": {
- "$ref": "Job"
+ "id": "dataproc.projects.regions.jobs.cancel",
+ "request": {
+ "$ref": "CancelJobRequest"
},
- "parameterOrder": [
- "projectId",
- "region",
- "jobId"
- ],
- "httpMethod": "GET",
- "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": {
- "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}/jobs/{jobId}",
- "path": "v1/projects/{projectId}/regions/{region}/jobs/{jobId}",
- "id": "dataproc.projects.regions.jobs.get"
+ "description": "Starts a job cancellation request. To access the job resource after cancellation, call regions/{region}/jobs.list or regions/{region}/jobs.get."
},
"patch": {
"request": {
"$ref": "Job"
},
"description": "Updates a job in a project.",
- "response": {
- "$ref": "Job"
- },
+ "httpMethod": "PATCH",
"parameterOrder": [
"projectId",
"region",
"jobId"
],
- "httpMethod": "PATCH",
+ "response": {
+ "$ref": "Job"
+ },
"parameters": {
"region": {
"location": "path",
@@ -486,16 +531,16 @@
"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",
- "location": "query"
+ "type": "string"
},
"projectId": {
+ "location": "path",
"description": "Required. The ID of the Google Cloud Platform project that the job belongs to.",
"required": true,
- "type": "string",
- "location": "path"
+ "type": "string"
},
"jobId": {
"description": "Required. The job ID.",
@@ -508,14 +553,52 @@
"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.patch"
+ "id": "dataproc.projects.regions.jobs.patch",
+ "path": "v1/projects/{projectId}/regions/{region}/jobs/{jobId}"
+ },
+ "get": {
+ "description": "Gets the resource representation for a job in a project.",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "Job"
+ },
+ "parameterOrder": [
+ "projectId",
+ "region",
+ "jobId"
+ ],
+ "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"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectId}/regions/{region}/jobs/{jobId}",
+ "id": "dataproc.projects.regions.jobs.get",
+ "path": "v1/projects/{projectId}/regions/{region}/jobs/{jobId}"
},
"submit": {
+ "description": "Submits a job to a cluster.",
"request": {
"$ref": "SubmitJobRequest"
},
- "description": "Submits a job to a cluster.",
"response": {
"$ref": "Job"
},
@@ -524,6 +607,9 @@
"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.",
@@ -532,21 +618,17 @@
"location": "path"
},
"region": {
+ "location": "path",
"description": "Required. The Cloud Dataproc region in which to handle the request.",
"required": true,
- "type": "string",
- "location": "path"
+ "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"
},
@@ -556,7 +638,16 @@
"jobId"
],
"httpMethod": "DELETE",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
"parameters": {
+ "region": {
+ "location": "path",
+ "description": "Required. The Cloud Dataproc region in which to handle the request.",
+ "required": true,
+ "type": "string"
+ },
"projectId": {
"description": "Required. The ID of the Google Cloud Platform project that the job belongs to.",
"required": true,
@@ -564,86 +655,16 @@
"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"
+ "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": {
- "id": "dataproc.projects.regions.jobs.list",
- "path": "v1/projects/{projectId}/regions/{region}/jobs",
- "description": "Lists regions/{region}/jobs in a project.",
- "httpMethod": "GET",
- "parameterOrder": [
- "projectId",
- "region"
- ],
- "response": {
- "$ref": "ListJobsResponse"
- },
- "parameters": {
- "region": {
- "description": "Required. The Cloud Dataproc region in which to handle the request.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "clusterName": {
- "description": "Optional. If set, the returned jobs list includes only jobs that were submitted to the named cluster.",
- "type": "string",
- "location": "query"
- },
- "projectId": {
- "description": "Required. The ID of the Google Cloud Platform project that the job belongs to.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "filter": {
- "description": "Optional. A filter constraining the jobs to list. Filters are case-sensitive and have the following syntax:field = value AND field = value ...where field is status.state or labels.[KEY], and [KEY] is a label key. value can be * to match all values. status.state can be either ACTIVE or NON_ACTIVE. Only the logical AND operator is supported; space-separated items are treated as having an implicit AND operator.Example filter:status.state = ACTIVE AND labels.env = staging AND labels.starred = *",
- "type": "string",
- "location": "query"
- },
- "jobStateMatcher": {
- "location": "query",
- "enum": [
- "ALL",
- "ACTIVE",
- "NON_ACTIVE"
- ],
- "description": "Optional. Specifies enumerated categories of jobs to list. (default = match ALL jobs).If filter is provided, jobStateMatcher will be ignored.",
- "type": "string"
- },
- "pageToken": {
- "location": "query",
- "description": "Optional. The page token, returned by a previous call, to request the next page of results.",
- "type": "string"
- },
- "pageSize": {
- "location": "query",
- "description": "Optional. The number of results to return in each response.",
- "format": "int32",
- "type": "integer"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectId}/regions/{region}/jobs"
+ "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."
}
}
}
@@ -653,21 +674,10 @@
}
},
"parameters": {
- "upload_protocol": {
- "location": "query",
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string"
- },
- "prettyPrint": {
- "description": "Returns response with indentations and line breaks.",
- "type": "boolean",
- "default": "true",
- "location": "query"
- },
"uploadType": {
+ "location": "query",
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"fields": {
"location": "query",
@@ -675,17 +685,17 @@
"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"
- ],
- "location": "query"
+ "type": "string"
},
"callback": {
"description": "JSONP",
@@ -693,36 +703,36 @@
"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"
+ ],
+ "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"
},
- "quotaUser": {
+ "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": {
+ "description": "Available 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",
@@ -730,31 +740,357 @@
"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"
+ },
+ "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": {
+ "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": {
+ "args": {
+ "description": "Optional. The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "fileUris": {
+ "description": "Optional. HCFS URIs of files to be copied to the working directory of Python drivers and distributed tasks. Useful for naively parallel tasks.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "pythonFileUris": {
+ "description": "Optional. HCFS file URIs of Python files to pass to the PySpark framework. Supported file types: .py, .egg, and .zip.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "mainPythonFileUri": {
+ "description": "Required. The HCFS URI of the main Python file to use as the driver. Must be a .py file.",
+ "type": "string"
+ },
+ "archiveUris": {
+ "description": "Optional. HCFS URIs of archives to be extracted in the working directory of .jar, .tar, .tar.gz, .tgz, and .zip.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "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": {
+ "description": "Optional. A mapping of property names to values, used to configure PySpark. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ }
+ },
+ "id": "PySparkJob"
+ },
+ "GceClusterConfig": {
+ "description": "Common config settings for resources of Google Compute Engine cluster instances, applicable to all instances in the cluster.",
+ "type": "object",
+ "properties": {
+ "metadata": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "The Google Compute Engine metadata entries to add to all instances (see Project and instance metadata (https://cloud.google.com/compute/docs/storing-retrieving-metadata#project_and_instance_metadata)).",
+ "type": "object"
+ },
+ "internalIpOnly": {
+ "description": "Optional. If true, all instances in the cluster will only have internal IP addresses. By default, clusters are not restricted to internal IP addresses, and will have ephemeral external IP addresses assigned to each instance. This internal_ip_only restriction can only be enabled for subnetwork enabled networks, and all off-cluster dependencies must be configured to be accessible without external IP addresses.",
+ "type": "boolean"
+ },
+ "serviceAccountScopes": {
+ "description": "Optional. The URIs of service account scopes to be included in Google Compute Engine instances. The following base set of scopes is always included:\nhttps://www.googleapis.com/auth/cloud.useraccounts.readonly\nhttps://www.googleapis.com/auth/devstorage.read_write\nhttps://www.googleapis.com/auth/logging.writeIf no scopes are specified, the following defaults are also provided:\nhttps://www.googleapis.com/auth/bigquery\nhttps://www.googleapis.com/auth/bigtable.admin.table\nhttps://www.googleapis.com/auth/bigtable.data\nhttps://www.googleapis.com/auth/devstorage.full_control",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "tags": {
+ "description": "The Google Compute Engine tags to add to all instances (see Tagging instances).",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "serviceAccount": {
+ "description": "Optional. The service account of the instances. Defaults to the default Google Compute Engine service account. Custom service accounts need permissions equivalent to the folloing IAM roles:\nroles/logging.logWriter\nroles/storage.objectAdmin(see https://cloud.google.com/compute/docs/access/service-accounts#custom_service_accounts for more information). Example: [account_id]@[project_id].iam.gserviceaccount.com",
+ "type": "string"
+ },
+ "subnetworkUri": {
+ "description": "Optional. The Google Compute Engine subnetwork to be used for machine communications. Cannot be specified with network_uri.A full URL, partial URI, or short name are valid. Examples:\nhttps://www.googleapis.com/compute/v1/projects/[project_id]/regions/us-east1/sub0\nprojects/[project_id]/regions/us-east1/sub0\nsub0",
+ "type": "string"
+ },
+ "networkUri": {
+ "description": "Optional. The Google Compute Engine network to be used for machine communications. Cannot be specified with subnetwork_uri. If neither network_uri nor subnetwork_uri is specified, the \"default\" network of the project is used, if it exists. Cannot be a \"Custom Subnet Network\" (see Using Subnetworks for more information).A full URL, partial URI, or short name are valid. Examples:\nhttps://www.googleapis.com/compute/v1/projects/[project_id]/regions/global/default\nprojects/[project_id]/regions/global/default\ndefault",
+ "type": "string"
+ },
+ "zoneUri": {
+ "description": "Optional. The zone where the Google Compute Engine cluster will be located. On a create request, it is required in the \"global\" region. If omitted in a non-global Cloud Dataproc region, the service will pick a zone in the corresponding Compute Engine region. On a get request, zone will always be present.A full URL, partial URI, or short name are valid. Examples:\nhttps://www.googleapis.com/compute/v1/projects/[project_id]/zones/[zone]\nprojects/[project_id]/zones/[zone]\nus-central1-f",
+ "type": "string"
+ }
+ },
+ "id": "GceClusterConfig"
+ },
+ "AcceleratorConfig": {
+ "description": "Specifies the type and number of accelerator cards attached to the instances of an instance group (see GPUs on Compute Engine).",
+ "type": "object",
+ "properties": {
+ "acceleratorCount": {
+ "description": "The number of the accelerator cards of this type exposed to this instance.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "acceleratorTypeUri": {
+ "description": "Full URL, partial URI, or short name of the accelerator type resource to expose to this instance. See Google Compute Engine AcceleratorTypes( /compute/docs/reference/beta/acceleratorTypes)Examples * https://www.googleapis.com/compute/beta/projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80 * projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80 * nvidia-tesla-k80",
+ "type": "string"
+ }
+ },
+ "id": "AcceleratorConfig"
+ },
+ "ClusterMetrics": {
+ "description": "Contains cluster daemon metrics, such as HDFS and YARN stats.Beta Feature: This report is available for testing purposes only. It may be changed before final release.",
+ "type": "object",
+ "properties": {
+ "yarnMetrics": {
+ "additionalProperties": {
+ "format": "int64",
+ "type": "string"
+ },
+ "description": "The YARN metrics.",
+ "type": "object"
+ },
+ "hdfsMetrics": {
+ "description": "The HDFS metrics.",
+ "type": "object",
+ "additionalProperties": {
+ "format": "int64",
+ "type": "string"
+ }
+ }
+ },
+ "id": "ClusterMetrics"
+ },
+ "LoggingConfig": {
+ "description": "The runtime logging config of the job.",
+ "type": "object",
+ "properties": {
+ "driverLogLevels": {
+ "description": "The per-package log levels for the driver. This may include \"root\" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string",
+ "enum": [
+ "LEVEL_UNSPECIFIED",
+ "ALL",
+ "TRACE",
+ "DEBUG",
+ "INFO",
+ "WARN",
+ "ERROR",
+ "FATAL",
+ "OFF"
+ ]
+ }
+ }
+ },
+ "id": "LoggingConfig"
+ },
+ "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"
+ },
+ "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"
+ },
+ "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"
+ },
+ "SubmitJobRequest": {
+ "description": "A request to submit a job.",
+ "type": "object",
+ "properties": {
+ "job": {
+ "description": "Required. The job resource.",
+ "$ref": "Job"
+ }
+ },
+ "id": "SubmitJobRequest"
+ },
+ "Status": {
+ "description": "The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). The error model is designed to be:\nSimple to use and understand for most users\nFlexible enough to meet unexpected needsOverviewThe Status message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers understand and resolve the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package google.rpc that can be used for common error conditions.Language mappingThe Status message is the logical representation of the error model, but it is not necessarily the actual wire format. When the Status message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C.Other usesThe error model and the Status message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments.Example uses of this error model include:\nPartial errors. If a service needs to return partial errors to the client, it may embed the Status in the normal response to indicate the partial errors.\nWorkflow errors. A typical workflow has multiple steps. Each step may have a Status message for error reporting.\nBatch operations. If a client uses batch request and batch response, the Status message should be used directly inside batch response, one for each error sub-response.\nAsynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the Status message.\nLogging. If some API errors are stored in logs, the message Status could be used directly after any stripping needed for security/privacy reasons.",
+ "type": "object",
+ "properties": {
+ "code": {
+ "description": "The status code, which should be an enum value of google.rpc.Code.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "message": {
+ "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.",
+ "type": "string"
+ },
+ "details": {
+ "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ }
+ }
+ }
+ },
+ "id": "Status"
+ },
+ "JobScheduling": {
+ "description": "Job scheduling options.",
+ "type": "object",
+ "properties": {
+ "maxFailuresPerHour": {
+ "description": "Optional. Maximum number of times per hour a driver may be restarted as a result of driver terminating with non-zero code before job is reported failed.A job may be reported as thrashing if driver exits with non-zero code 4 times within 10 minute window.Maximum value is 10.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "JobScheduling"
+ },
+ "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": {
+ "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": {
+ "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"
+ }
+ }
+ },
+ "id": "InstanceGroupConfig"
+ },
"ListJobsResponse": {
"description": "A list of jobs in a project.",
"type": "object",
"properties": {
+ "nextPageToken": {
+ "description": "Optional. This token is included in the response if there are more results to fetch. To fetch additional results, provide this value as the page_token in a subsequent \u003ccode\u003eListJobsRequest\u003c/code\u003e.",
+ "type": "string"
+ },
"jobs": {
"description": "Output-only. Jobs list.",
"type": "array",
"items": {
"$ref": "Job"
}
- },
- "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"
@@ -785,14 +1121,6 @@
"description": "A Cloud Dataproc job for running Apache Spark SQL (http://spark.apache.org/sql/) queries.",
"type": "object",
"properties": {
- "queryFileUri": {
- "description": "The HCFS URI of the script that contains SQL queries.",
- "type": "string"
- },
- "queryList": {
- "description": "A list of queries.",
- "$ref": "QueryList"
- },
"scriptVariables": {
"additionalProperties": {
"type": "string"
@@ -812,11 +1140,19 @@
"description": "Optional. The runtime log config for job execution."
},
"properties": {
- "description": "Optional. A mapping of property names to values, used to configure Spark SQL's SparkConf. Properties that conflict with values set by the Cloud Dataproc API may be overwritten.",
- "type": "object",
"additionalProperties": {
"type": "string"
- }
+ },
+ "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."
}
},
"id": "SparkSqlJob"
@@ -870,21 +1206,41 @@
"description": "The response message for Operations.ListOperations.",
"type": "object",
"properties": {
- "nextPageToken": {
- "description": "The standard List next-page token.",
- "type": "string"
- },
"operations": {
"description": "A list of operations that matches the specified filter in the request.",
"type": "array",
"items": {
"$ref": "Operation"
}
+ },
+ "nextPageToken": {
+ "description": "The standard List next-page token.",
+ "type": "string"
}
},
"id": "ListOperationsResponse"
},
+ "SoftwareConfig": {
+ "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"
+ },
"JobPlacement": {
+ "description": "Cloud Dataproc job config.",
+ "type": "object",
"properties": {
"clusterName": {
"description": "Required. The name of the cluster where the job will be submitted.",
@@ -895,77 +1251,7 @@
"type": "string"
}
},
- "id": "JobPlacement",
- "description": "Cloud Dataproc job config.",
- "type": "object"
- },
- "SoftwareConfig": {
- "properties": {
- "properties": {
- "description": "Optional. The properties to set on daemon config files.Property keys are specified in prefix:property format, such as core:fs.defaultFS. The following are supported prefixes and their mappings:\ncapacity-scheduler: capacity-scheduler.xml\ncore: core-site.xml\ndistcp: distcp-default.xml\nhdfs: hdfs-site.xml\nhive: hive-site.xml\nmapred: mapred-site.xml\npig: pig.properties\nspark: spark-defaults.conf\nyarn: yarn-site.xmlFor more information, see Cluster properties.",
- "type": "object",
- "additionalProperties": {
- "type": "string"
- }
- },
- "imageVersion": {
- "description": "Optional. The version of software inside the cluster. It must match the regular expression [0-9]+\\.[0-9]+. If unspecified, it defaults to the latest version (see Cloud Dataproc Versioning).",
- "type": "string"
- }
- },
- "id": "SoftwareConfig",
- "description": "Specifies the selection and config of software inside the cluster.",
- "type": "object"
- },
- "ClusterStatus": {
- "description": "The status of a cluster and its instances.",
- "type": "object",
- "properties": {
- "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."
- ]
- },
- "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."
- ]
- }
- },
- "id": "ClusterStatus"
+ "id": "JobPlacement"
},
"PigJob": {
"description": "A Cloud Dataproc job for running Apache Pig (https://pig.apache.org/) queries on YARN.",
@@ -998,19 +1284,69 @@
"type": "object"
},
"loggingConfig": {
- "$ref": "LoggingConfig",
- "description": "Optional. The runtime log config for job execution."
+ "description": "Optional. The runtime log config for job execution.",
+ "$ref": "LoggingConfig"
},
"properties": {
- "description": "Optional. A mapping of property names to values, used to configure Pig. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/pig/conf/pig.properties, and classes in user code.",
- "type": "object",
"additionalProperties": {
"type": "string"
- }
+ },
+ "description": "Optional. A mapping of property names to values, used to configure Pig. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/pig/conf/pig.properties, and classes in user code.",
+ "type": "object"
}
},
"id": "PigJob"
},
+ "ClusterStatus": {
+ "description": "The status of a cluster and its instances.",
+ "type": "object",
+ "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"
+ },
"ListClustersResponse": {
"description": "The list of all clusters in a project.",
"type": "object",
@@ -1033,48 +1369,20 @@
"description": "A Cloud Dataproc job resource.",
"type": "object",
"properties": {
- "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": {
- "$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": {
- "$ref": "JobScheduling",
- "description": "Optional. Job scheduling configuration."
- },
- "pigJob": {
- "$ref": "PigJob",
- "description": "Job is a Pig job."
- },
- "hiveJob": {
- "$ref": "HiveJob",
- "description": "Job is a Hive job."
- },
"labels": {
- "description": "Optional. The labels to associate with this job. Label keys must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be associated with a job.",
- "type": "object",
"additionalProperties": {
"type": "string"
- }
+ },
+ "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."
+ "description": "Job is a Spark job.",
+ "$ref": "SparkJob"
},
"sparkSqlJob": {
"$ref": "SparkSqlJob",
@@ -1101,6 +1409,34 @@
"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": {
+ "$ref": "HadoopJob",
+ "description": "Job is a Hadoop job."
+ },
+ "status": {
+ "$ref": "JobStatus",
+ "description": "Output-only. The job status. Additional application-specific status information may be contained in the \u003ccode\u003etype_job\u003c/code\u003e and \u003ccode\u003eyarn_applications\u003c/code\u003e fields."
+ },
+ "placement": {
+ "$ref": "JobPlacement",
+ "description": "Required. Job information, including how, when, and where to run the job."
+ },
+ "driverControlFilesUri": {
+ "description": "Output-only. If present, the location of miscellaneous control files which may be used as part of job setup and handling. If not present, control files may be placed in the same location as driver_output_uri.",
+ "type": "string"
+ },
+ "scheduling": {
+ "description": "Optional. Job scheduling configuration.",
+ "$ref": "JobScheduling"
+ },
+ "pigJob": {
+ "description": "Job is a Pig job.",
+ "$ref": "PigJob"
+ },
+ "hiveJob": {
+ "$ref": "HiveJob",
+ "description": "Job is a Hive job."
}
},
"id": "Job"
@@ -1109,10 +1445,6 @@
"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",
@@ -1121,15 +1453,15 @@
}
},
"loggingConfig": {
- "description": "Optional. The runtime log config for job execution.",
- "$ref": "LoggingConfig"
+ "$ref": "LoggingConfig",
+ "description": "Optional. The runtime log config for job execution."
},
"properties": {
+ "description": "Optional. A mapping of property names to values, used to configure Spark. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.",
+ "type": "object",
"additionalProperties": {
"type": "string"
- },
- "description": "Optional. A mapping of property names to values, used to configure Spark. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.",
- "type": "object"
+ }
},
"args": {
"description": "Optional. The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.",
@@ -1155,6 +1487,10 @@
"items": {
"type": "string"
}
+ },
+ "mainJarFileUri": {
+ "description": "The HCFS URI of the jar file that contains the main class.",
+ "type": "string"
}
},
"id": "SparkJob"
@@ -1185,6 +1521,18 @@
]
},
"state": {
+ "enumDescriptions": [
+ "The job state is unknown.",
+ "The job is pending; it has been submitted, but is not yet running.",
+ "Job has been received by the service and completed initial setup; it will soon be submitted to the cluster.",
+ "The job is running on the cluster.",
+ "A CancelJob request has been received, but is pending.",
+ "Transient in-flight resources have been canceled, and the request to cancel the running job has been issued to the cluster.",
+ "The job cancellation was successful.",
+ "The job has completed successfully.",
+ "The job has completed, but encountered an error.",
+ "Job attempt has failed. The detail field contains failure details for this attempt.Applies to restartable jobs only."
+ ],
"enum": [
"STATE_UNSPECIFIED",
"PENDING",
@@ -1198,19 +1546,7 @@
"ATTEMPT_FAILURE"
],
"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.",
- "Job has been received by the service and completed initial setup; it will soon be submitted to the cluster.",
- "The job is running on the cluster.",
- "A CancelJob request has been received, but is pending.",
- "Transient in-flight resources have been canceled, and the request to cancel the running job has been issued to the cluster.",
- "The job cancellation was successful.",
- "The job has completed successfully.",
- "The job has completed, but encountered an error.",
- "Job attempt has failed. The detail field contains failure details for this attempt.Applies to restartable jobs only."
- ]
+ "type": "string"
},
"details": {
"description": "Output-only. Optional job state details, such as an error description if the state is \u003ccode\u003eERROR\u003c/code\u003e.",
@@ -1235,14 +1571,10 @@
"id": "ManagedGroupConfig"
},
"ClusterOperationStatus": {
+ "description": "The status of the operation.",
+ "type": "object",
"properties": {
"state": {
- "enum": [
- "UNKNOWN",
- "PENDING",
- "RUNNING",
- "DONE"
- ],
"description": "Output-only. A message containing the operation state.",
"type": "string",
"enumDescriptions": [
@@ -1250,6 +1582,12 @@
"The operation has been created.",
"The operation is running.",
"The operation is done; either cancelled or completed."
+ ],
+ "enum": [
+ "UNKNOWN",
+ "PENDING",
+ "RUNNING",
+ "DONE"
]
},
"details": {
@@ -1266,9 +1604,7 @@
"type": "string"
}
},
- "id": "ClusterOperationStatus",
- "description": "The status of the operation.",
- "type": "object"
+ "id": "ClusterOperationStatus"
},
"HadoopJob": {
"description": "A Cloud Dataproc job for running Apache Hadoop MapReduce (https://hadoop.apache.org/docs/current/hadoop-mapreduce-client/hadoop-mapreduce-client-core/MapReduceTutorial.html) jobs on Apache Hadoop YARN (https://hadoop.apache.org/docs/r2.7.1/hadoop-yarn/hadoop-yarn-site/YARN.html).",
@@ -1343,6 +1679,8 @@
"type": "object",
"properties": {
"state": {
+ "description": "Required. The application state.",
+ "type": "string",
"enumDescriptions": [
"Status is unspecified.",
"Status is NEW.",
@@ -1364,9 +1702,7 @@
"FINISHED",
"FAILED",
"KILLED"
- ],
- "description": "Required. The application state.",
- "type": "string"
+ ]
},
"name": {
"description": "Required. The application name.",
@@ -1394,13 +1730,13 @@
"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.",
+ "bootDiskSizeGb": {
+ "description": "Optional. Size in GB of the boot disk (default is 500GB).",
"format": "int32",
"type": "integer"
},
- "bootDiskSizeGb": {
- "description": "Optional. Size in GB of the boot disk (default is 500GB).",
+ "numLocalSsds": {
+ "description": "Optional. Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs and HDFS (https://hadoop.apache.org/docs/r1.2.1/hdfs_user_guide.html) data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic config and installed binaries.",
"format": "int32",
"type": "integer"
}
@@ -1427,15 +1763,15 @@
}
},
"labels": {
+ "description": "Output-only. Labels associated with the operation",
+ "type": "object",
"additionalProperties": {
"type": "string"
- },
- "description": "Output-only. Labels associated with the operation",
- "type": "object"
+ }
},
"status": {
- "$ref": "ClusterOperationStatus",
- "description": "Output-only. Current operation status."
+ "description": "Output-only. Current operation status.",
+ "$ref": "ClusterOperationStatus"
},
"statusHistory": {
"description": "Output-only. The previous operation status.",
@@ -1455,22 +1791,16 @@
},
"id": "ClusterOperationMetadata"
},
+ "Empty": {
+ "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance:\nservice Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n}\nThe JSON representation for Empty is empty JSON object {}.",
+ "type": "object",
+ "properties": {},
+ "id": "Empty"
+ },
"HiveJob": {
"description": "A Cloud Dataproc job for running Apache Hive (https://hive.apache.org/) queries on YARN.",
"type": "object",
"properties": {
- "continueOnFailure": {
- "description": "Optional. Whether to continue executing queries if a query fails. The default value is false. Setting to true can be useful when executing independent parallel queries.",
- "type": "boolean"
- },
- "queryFileUri": {
- "description": "The HCFS URI of the script that contains Hive queries.",
- "type": "string"
- },
- "queryList": {
- "$ref": "QueryList",
- "description": "A list of queries."
- },
"jarFileUris": {
"description": "Optional. HCFS URIs of jar files to add to the CLASSPATH of the Hive server and Hadoop MapReduce (MR) tasks. Can contain Hive SerDes and UDFs.",
"type": "array",
@@ -1491,26 +1821,32 @@
},
"description": "Optional. A mapping of property names and values, used to configure Hive. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/hive/conf/hive-site.xml, and classes in user code.",
"type": "object"
+ },
+ "continueOnFailure": {
+ "description": "Optional. Whether to continue executing queries if a query fails. The default value is false. Setting to true can be useful when executing independent parallel queries.",
+ "type": "boolean"
+ },
+ "queryList": {
+ "$ref": "QueryList",
+ "description": "A list of queries."
+ },
+ "queryFileUri": {
+ "description": "The HCFS URI of the script that contains Hive queries.",
+ "type": "string"
}
},
"id": "HiveJob"
},
- "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"
- },
"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.",
@@ -1528,12 +1864,12 @@
"type": "string"
},
"workerConfig": {
- "description": "Optional. The Google Compute Engine config settings for worker instances in a cluster.",
- "$ref": "InstanceGroupConfig"
+ "$ref": "InstanceGroupConfig",
+ "description": "Optional. The Google Compute Engine config settings for worker instances in a cluster."
},
"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": {
"$ref": "SoftwareConfig",
@@ -1544,353 +1880,17 @@
"$ref": "InstanceGroupConfig"
},
"secondaryWorkerConfig": {
- "$ref": "InstanceGroupConfig",
- "description": "Optional. The Google Compute Engine config settings for additional worker instances in a cluster."
+ "description": "Optional. The Google Compute Engine config settings for additional worker instances in a cluster.",
+ "$ref": "InstanceGroupConfig"
}
},
"id": "ClusterConfig"
- },
- "PySparkJob": {
- "description": "A Cloud Dataproc job for running Apache PySpark (https://spark.apache.org/docs/0.9.0/python-programming-guide.html) applications on YARN.",
- "type": "object",
- "properties": {
- "jarFileUris": {
- "description": "Optional. HCFS URIs of jar files to add to the CLASSPATHs of the Python driver and tasks.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "loggingConfig": {
- "description": "Optional. The runtime log config for job execution.",
- "$ref": "LoggingConfig"
- },
- "properties": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "Optional. A mapping of property names to values, used to configure PySpark. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.",
- "type": "object"
- },
- "args": {
- "description": "Optional. The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "fileUris": {
- "description": "Optional. HCFS URIs of files to be copied to the working directory of Python drivers and distributed tasks. Useful for naively parallel tasks.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "pythonFileUris": {
- "description": "Optional. HCFS file URIs of Python files to pass to the PySpark framework. Supported file types: .py, .egg, and .zip.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "mainPythonFileUri": {
- "description": "Required. The HCFS URI of the main Python file to use as the driver. Must be a .py file.",
- "type": "string"
- },
- "archiveUris": {
- "description": "Optional. HCFS URIs of archives to be extracted in the working directory of .jar, .tar, .tar.gz, .tgz, and .zip.",
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "id": "PySparkJob"
- },
- "GceClusterConfig": {
- "description": "Common config settings for resources of Google Compute Engine cluster instances, applicable to all instances in the cluster.",
- "type": "object",
- "properties": {
- "metadata": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "The Google Compute Engine metadata entries to add to all instances (see Project and instance metadata (https://cloud.google.com/compute/docs/storing-retrieving-metadata#project_and_instance_metadata)).",
- "type": "object"
- },
- "internalIpOnly": {
- "description": "Optional. If true, all instances in the cluster will only have internal IP addresses. By default, clusters are not restricted to internal IP addresses, and will have ephemeral external IP addresses assigned to each instance. This internal_ip_only restriction can only be enabled for subnetwork enabled networks, and all off-cluster dependencies must be configured to be accessible without external IP addresses.",
- "type": "boolean"
- },
- "serviceAccountScopes": {
- "description": "Optional. The URIs of service account scopes to be included in Google Compute Engine instances. The following base set of scopes is always included:\nhttps://www.googleapis.com/auth/cloud.useraccounts.readonly\nhttps://www.googleapis.com/auth/devstorage.read_write\nhttps://www.googleapis.com/auth/logging.writeIf no scopes are specified, the following defaults are also provided:\nhttps://www.googleapis.com/auth/bigquery\nhttps://www.googleapis.com/auth/bigtable.admin.table\nhttps://www.googleapis.com/auth/bigtable.data\nhttps://www.googleapis.com/auth/devstorage.full_control",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "tags": {
- "description": "The Google Compute Engine tags to add to all instances (see Tagging instances).",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "serviceAccount": {
- "description": "Optional. The service account of the instances. Defaults to the default Google Compute Engine service account. Custom service accounts need permissions equivalent to the folloing IAM roles:\nroles/logging.logWriter\nroles/storage.objectAdmin(see https://cloud.google.com/compute/docs/access/service-accounts#custom_service_accounts for more information). Example: [account_id]@[project_id].iam.gserviceaccount.com",
- "type": "string"
- },
- "subnetworkUri": {
- "description": "Optional. The Google Compute Engine subnetwork to be used for machine communications. Cannot be specified with network_uri.A full URL, partial URI, or short name are valid. Examples:\nhttps://www.googleapis.com/compute/v1/projects/[project_id]/regions/us-east1/sub0\nprojects/[project_id]/regions/us-east1/sub0\nsub0",
- "type": "string"
- },
- "networkUri": {
- "description": "Optional. The Google Compute Engine network to be used for machine communications. Cannot be specified with subnetwork_uri. If neither network_uri nor subnetwork_uri is specified, the \"default\" network of the project is used, if it exists. Cannot be a \"Custom Subnet Network\" (see Using Subnetworks for more information).A full URL, partial URI, or short name are valid. Examples:\nhttps://www.googleapis.com/compute/v1/projects/[project_id]/regions/global/default\nprojects/[project_id]/regions/global/default\ndefault",
- "type": "string"
- },
- "zoneUri": {
- "description": "Optional. The zone where the Google Compute Engine cluster will be located. On a create request, it is required in the \"global\" region. If omitted in a non-global Cloud Dataproc region, the service will pick a zone in the corresponding Compute Engine region. On a get request, zone will always be present.A full URL, partial URI, or short name are valid. Examples:\nhttps://www.googleapis.com/compute/v1/projects/[project_id]/zones/[zone]\nprojects/[project_id]/zones/[zone]\nus-central1-f",
- "type": "string"
- }
- },
- "id": "GceClusterConfig"
- },
- "ClusterMetrics": {
- "description": "Contains cluster daemon metrics, such as HDFS and YARN stats.Beta Feature: This report is available for testing purposes only. It may be changed before final release.",
- "type": "object",
- "properties": {
- "yarnMetrics": {
- "additionalProperties": {
- "format": "int64",
- "type": "string"
- },
- "description": "The YARN metrics.",
- "type": "object"
- },
- "hdfsMetrics": {
- "additionalProperties": {
- "format": "int64",
- "type": "string"
- },
- "description": "The HDFS metrics.",
- "type": "object"
- }
- },
- "id": "ClusterMetrics"
- },
- "AcceleratorConfig": {
- "description": "Specifies the type and number of accelerator cards attached to the instances of an instance group (see GPUs on Compute Engine).",
- "type": "object",
- "properties": {
- "acceleratorCount": {
- "description": "The number of the accelerator cards of this type exposed to this instance.",
- "format": "int32",
- "type": "integer"
- },
- "acceleratorTypeUri": {
- "description": "Full URL, partial URI, or short name of the accelerator type resource to expose to this instance. See Google Compute Engine AcceleratorTypes( /compute/docs/reference/beta/acceleratorTypes)Examples * https://www.googleapis.com/compute/beta/projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80 * projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80 * nvidia-tesla-k80",
- "type": "string"
- }
- },
- "id": "AcceleratorConfig"
- },
- "LoggingConfig": {
- "description": "The runtime logging config of the job.",
- "type": "object",
- "properties": {
- "driverLogLevels": {
- "additionalProperties": {
- "type": "string",
- "enum": [
- "LEVEL_UNSPECIFIED",
- "ALL",
- "TRACE",
- "DEBUG",
- "INFO",
- "WARN",
- "ERROR",
- "FATAL",
- "OFF"
- ]
- },
- "description": "The per-package log levels for the driver. This may include \"root\" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'",
- "type": "object"
- }
- },
- "id": "LoggingConfig"
- },
- "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"
- },
- "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"
- },
- "SubmitJobRequest": {
- "description": "A request to submit a job.",
- "type": "object",
- "properties": {
- "job": {
- "description": "Required. The job resource.",
- "$ref": "Job"
- }
- },
- "id": "SubmitJobRequest"
- },
- "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"
- },
- "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": {
- "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": {
- "description": "Optional. Disk option config settings.",
- "$ref": "DiskConfig"
- },
- "managedGroupConfig": {
- "description": "Output-only. The config for Google Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.",
- "$ref": "ManagedGroupConfig"
- },
- "isPreemptible": {
- "description": "Optional. Specifies that this instance group contains preemptible instances.",
- "type": "boolean"
- },
- "imageUri": {
- "description": "Output-only. The Google Compute Engine image resource used for cluster instances. Inferred from SoftwareConfig.image_version.",
- "type": "string"
- },
- "machineTypeUri": {
- "description": "Optional. The Google Compute Engine machine type used for cluster instances.A full URL, partial URI, or short name are valid. Examples:\nhttps://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2\nprojects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2\nn1-standard-2",
- "type": "string"
- },
- "instanceNames": {
- "description": "Optional. The list of instance names. Cloud Dataproc derives the names from cluster_name, num_instances, and the instance group if not set by user (recommended practice is to let Cloud Dataproc derive the name).",
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "id": "InstanceGroupConfig"
}
},
"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://dataproc.googleapis.com/",
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/cloud-platform": {
- "description": "View and manage your data across Google Cloud Platform services"
- }
- }
- }
- },
- "kind": "discovery#restDescription",
- "description": "Manages Hadoop-based clusters and jobs on Google Cloud Platform.",
- "servicePath": "",
- "rootUrl": "https://dataproc.googleapis.com/",
- "basePath": "",
- "ownerDomain": "google.com",
- "name": "dataproc",
- "batchPath": "batch",
- "revision": "20171212",
- "documentationLink": "https://cloud.google.com/dataproc/",
- "id": "dataproc:v1"
+ "version": "v1"
}
diff --git a/dataproc/v1beta2/dataproc-api.json b/dataproc/v1beta2/dataproc-api.json
index 772d59b..86770e8 100644
--- a/dataproc/v1beta2/dataproc-api.json
+++ b/dataproc/v1beta2/dataproc-api.json
@@ -1,302 +1,19 @@
{
+ "baseUrl": "https://dataproc.googleapis.com/",
+ "kind": "discovery#restDescription",
+ "description": "Manages Hadoop-based clusters and jobs on Google Cloud Platform.",
+ "servicePath": "",
+ "basePath": "",
"id": "dataproc:v1beta2",
- "documentationLink": "https://cloud.google.com/dataproc/",
"revision": "20171212",
+ "documentationLink": "https://cloud.google.com/dataproc/",
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
- "WorkflowTemplatePlacement": {
- "description": "Specifies workflow execution target.Either managed_cluster or cluster_selector is required.",
- "type": "object",
- "properties": {
- "managedCluster": {
- "description": "Optional. A cluster that is managed by the workflow.",
- "$ref": "ManagedCluster"
- },
- "clusterSelector": {
- "$ref": "ClusterSelector",
- "description": "Optional. A selector that chooses target cluster for jobs based on metadata.The selector is evaluated at the time each job is submitted."
- }
- },
- "id": "WorkflowTemplatePlacement"
- },
- "WorkflowMetadata": {
- "description": "A Cloud Dataproc workflow template resource.",
- "type": "object",
- "properties": {
- "deleteCluster": {
- "description": "Output only. The delete cluster operation metadata.",
- "$ref": "ClusterOperation"
- },
- "state": {
- "description": "Output only. The workflow 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"
- ]
- },
- "clusterName": {
- "description": "Output only. The name of the managed cluster.",
- "type": "string"
- },
- "createCluster": {
- "description": "Output only. The create cluster operation metadata.",
- "$ref": "ClusterOperation"
- },
- "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"
- }
- },
- "id": "WorkflowMetadata"
- },
- "ClusterOperation": {
- "type": "object",
- "properties": {
- "operationId": {
- "description": "Output only. The id of the cluster operation.",
- "type": "string"
- },
- "error": {
- "description": "Output only. Error, if operation failed.",
- "type": "string"
- },
- "done": {
- "description": "Output only. Indicates the operation is done.",
- "type": "boolean"
- }
- },
- "id": "ClusterOperation"
- },
- "SparkJob": {
- "description": "A Cloud Dataproc job for running Apache Spark (http://spark.apache.org/) applications on YARN.",
- "type": "object",
- "properties": {
- "mainClass": {
- "description": "The name of the driver's main class. The jar file that contains the class must be in the default CLASSPATH or specified in jar_file_uris.",
- "type": "string"
- },
- "archiveUris": {
- "description": "Optional. HCFS URIs of archives to be extracted in the working directory of Spark drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "mainJarFileUri": {
- "description": "The HCFS URI of the jar file that contains the main class.",
- "type": "string"
- },
- "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"
- },
- "properties": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "Optional. A mapping of property names to values, used to configure Spark. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.",
- "type": "object"
- },
- "args": {
- "description": "Optional. The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "fileUris": {
- "description": "Optional. HCFS URIs of files to be copied to the working directory of Spark drivers and distributed tasks. Useful for naively parallel tasks.",
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "id": "SparkJob"
- },
- "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": [
- "The job state is unknown.",
- "The job is pending; it has been submitted, but is not yet running.",
- "Job has been received by the service and completed initial setup; it will soon be submitted to the cluster.",
- "The job is running on the cluster.",
- "A CancelJob request has been received, but is pending.",
- "Transient in-flight resources have been canceled, and the request to cancel the running job has been issued to the cluster.",
- "The job cancellation was successful.",
- "The job has completed successfully.",
- "The job has completed, but encountered an error.",
- "Job attempt has failed. The detail field contains failure details for this attempt.Applies to restartable jobs only."
- ]
- },
- "details": {
- "description": "Output-only. Optional job state details, such as an error description if the state is \u003ccode\u003eERROR\u003c/code\u003e.",
- "type": "string"
- },
- "stateStartTime": {
- "description": "Output-only. The time when this state was entered.",
- "format": "google-datetime",
- "type": "string"
- },
- "substate": {
- "enumDescriptions": [
- "",
- "The Job is submitted to the agent.Applies to RUNNING state.",
- "The Job has been received and is awaiting execution (it may be waiting for a condition to be met). See the \"details\" field for the reason for the delay.Applies to RUNNING state.",
- "The agent-reported status is out of date, which may be caused by a loss of communication between the agent and Cloud Dataproc. If the agent does not send a timely update, the job will fail.Applies to RUNNING state."
- ],
- "enum": [
- "UNSPECIFIED",
- "SUBMITTED",
- "QUEUED",
- "STALE_STATUS"
- ],
- "description": "Output-only. Additional state information, which includes status reported by the agent.",
- "type": "string"
- }
- },
- "id": "JobStatus"
- },
- "DiagnoseClusterRequest": {
- "description": "A request to collect cluster diagnostic information.",
- "type": "object",
- "properties": {},
- "id": "DiagnoseClusterRequest"
- },
- "DiskConfig": {
- "properties": {
- "bootDiskType": {
- "description": "Optional. Type of the boot disk (default is 'pd-standard'). Valid values: 'pd-ssd', 'pd-standard'",
- "type": "string"
- },
- "numLocalSsds": {
- "description": "Optional. Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs and HDFS (https://hadoop.apache.org/docs/r1.2.1/hdfs_user_guide.html) data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic config and installed binaries.",
- "format": "int32",
- "type": "integer"
- },
- "bootDiskSizeGb": {
- "description": "Optional. Size in GB of the boot disk (default is 500GB).",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "DiskConfig",
- "description": "Specifies the config of disk options for a group of VM instances.",
- "type": "object"
- },
- "ClusterOperationMetadata": {
- "description": "Metadata describing the operation.",
- "type": "object",
- "properties": {
- "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": {
- "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"
- },
- "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"
- },
- "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": {
"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",
@@ -304,6 +21,10 @@
"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"
+ },
"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",
@@ -325,13 +46,19 @@
"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": {
- "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.",
@@ -351,7 +78,9 @@
}
}
},
- "id": "Policy"
+ "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.",
@@ -374,39 +103,41 @@
"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 contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.",
+ "type": "object",
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
- },
- "description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.",
- "type": "object"
+ }
}
},
"id": "Operation"
},
"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"
}
- },
- "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"
+ "id": "ListWorkflowTemplatesResponse",
+ "description": "A response to a request to list workflow templates in a project.",
+ "type": "object"
},
"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.",
@@ -417,18 +148,12 @@
"type": "string"
}
},
- "id": "JobReference",
- "description": "Encapsulates the full scoping used to reference a job.",
- "type": "object"
+ "id": "JobReference"
},
"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",
@@ -444,13 +169,15 @@
"description": "The status code, which should be an enum value of google.rpc.Code.",
"format": "int32",
"type": "integer"
+ },
+ "message": {
+ "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.",
+ "type": "string"
}
},
"id": "Status"
},
"Binding": {
- "description": "Associates members with a role.",
- "type": "object",
"properties": {
"members": {
"description": "Specifies the identities requesting access for a Cloud Platform resource. members can have the following values:\nallUsers: A special identifier that represents anyone who is on the internet; with or without a Google account.\nallAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account.\nuser:{emailid}: An email address that represents a specific Google account. For example, alice@gmail.com or joe@example.com.\nserviceAccount:{emailid}: An email address that represents a service account. For example, my-other-app@appspot.gserviceaccount.com.\ngroup:{emailid}: An email address that represents a Google group. For example, admins@example.com.\ndomain:{domain}: A Google Apps domain name that represents all the users of that domain. For example, google.com or example.com.",
@@ -464,12 +191,41 @@
"type": "string"
}
},
- "id": "Binding"
+ "id": "Binding",
+ "description": "Associates members with a role.",
+ "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": {
+ "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",
@@ -485,33 +241,6 @@
"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"
- },
- "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"
- },
- "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"
- }
}
},
"id": "InstanceGroupConfig"
@@ -520,54 +249,44 @@
"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"
- },
- "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"
}
- },
- "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"
+ "id": "ListJobsResponse",
+ "description": "A list of jobs in a project.",
+ "type": "object"
},
"CancelJobRequest": {
- "description": "A request to cancel a job.",
- "type": "object",
"properties": {},
- "id": "CancelJobRequest"
+ "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": {
- "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"
@@ -587,32 +306,42 @@
"$ref": "LoggingConfig"
},
"properties": {
+ "description": "Optional. A mapping of property names to values, used to configure Spark SQL's SparkConf. Properties that conflict with values set by the Cloud Dataproc API may be overwritten.",
+ "type": "object",
"additionalProperties": {
"type": "string"
- },
- "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"
- },
- "ListOperationsResponse": {
- "description": "The response message for Operations.ListOperations.",
- "type": "object",
- "properties": {
- "nextPageToken": {
- "description": "The standard List next-page token.",
+ }
+ },
+ "queryFileUri": {
+ "description": "The HCFS URI of the script that contains SQL queries.",
"type": "string"
},
+ "queryList": {
+ "description": "A list of queries.",
+ "$ref": "QueryList"
+ }
+ },
+ "id": "SparkSqlJob",
+ "description": "A Cloud Dataproc job for running Apache Spark SQL (http://spark.apache.org/sql/) queries.",
+ "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"
+ "id": "ListOperationsResponse",
+ "description": "The response message for Operations.ListOperations.",
+ "type": "object"
},
"JobPlacement": {
"description": "Cloud Dataproc job config.",
@@ -648,8 +377,8 @@
"type": "object"
},
"loggingConfig": {
- "description": "Optional. The runtime log config for job execution.",
- "$ref": "LoggingConfig"
+ "$ref": "LoggingConfig",
+ "description": "Optional. The runtime log config for job execution."
},
"properties": {
"additionalProperties": {
@@ -663,8 +392,8 @@
"type": "boolean"
},
"queryList": {
- "$ref": "QueryList",
- "description": "A list of queries."
+ "description": "A list of queries.",
+ "$ref": "QueryList"
},
"queryFileUri": {
"description": "The HCFS URI of the script that contains the Pig queries.",
@@ -677,10 +406,6 @@
"description": "The status of a cluster and its instances.",
"type": "object",
"properties": {
- "detail": {
- "description": "Output-only. Optional details of cluster's state.",
- "type": "string"
- },
"state": {
"enum": [
"UNKNOWN",
@@ -719,6 +444,10 @@
],
"description": "Output-only. Additional state information that includes status reported by the agent.",
"type": "string"
+ },
+ "detail": {
+ "description": "Output-only. Optional details of cluster's state.",
+ "type": "string"
}
},
"id": "ClusterStatus"
@@ -735,11 +464,11 @@
}
},
"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"
- }
+ },
+ "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.",
@@ -747,8 +476,8 @@
"type": "string"
},
"placement": {
- "$ref": "WorkflowTemplatePlacement",
- "description": "Required. WorkflowTemplate scheduling information."
+ "description": "Required. WorkflowTemplate scheduling information.",
+ "$ref": "WorkflowTemplatePlacement"
},
"updateTime": {
"description": "Output only. The time template was last updated.",
@@ -759,14 +488,14 @@
"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"
},
+ "id": {
+ "description": "Required. The template id.",
+ "type": "string"
+ },
"version": {
"description": "Optional. Used to perform a consistent read-modify-write.This field should be left blank for a CreateWorkflowTemplate request. It is required for an UpdateWorkflowTemplate request, and must match the current server version. A typical update template flow would fetch the current template with a GetWorkflowTemplate request, which will return the current template with the version field filled in with the current server version. The user updates other fields in the template, then returns it as part of the UpdateWorkflowTemplate request.",
"format": "int32",
"type": "integer"
- },
- "id": {
- "description": "Required. The template id.",
- "type": "string"
}
},
"id": "WorkflowTemplate"
@@ -814,8 +543,8 @@
"$ref": "JobScheduling"
},
"pigJob": {
- "description": "Job is a Pig job.",
- "$ref": "PigJob"
+ "$ref": "PigJob",
+ "description": "Job is a Pig job."
},
"hiveJob": {
"description": "Job is a Hive job.",
@@ -837,8 +566,8 @@
"description": "Job is a Spark job."
},
"sparkSqlJob": {
- "description": "Job is a SparkSql job.",
- "$ref": "SparkSqlJob"
+ "$ref": "SparkSqlJob",
+ "description": "Job is a SparkSql job."
},
"statusHistory": {
"description": "Output-only. The previous job status.",
@@ -884,6 +613,11 @@
"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",
@@ -893,18 +627,11 @@
"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"
- },
- "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"
}
},
"id": "LifecycleConfig"
},
"ManagedCluster": {
- "description": "Cluster that is managed by the workflow.",
- "type": "object",
"properties": {
"labels": {
"additionalProperties": {
@@ -914,40 +641,22 @@
"type": "object"
},
"config": {
- "description": "Required. The cluster configuration.",
- "$ref": "ClusterConfig"
+ "$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"
}
},
- "id": "ManagedCluster"
+ "id": "ManagedCluster",
+ "description": "Cluster that is managed by the workflow.",
+ "type": "object"
},
"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"
@@ -956,14 +665,47 @@
"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": [
+ "Unused.",
+ "The operation has been created.",
+ "The operation is running.",
+ "The operation is done; either cancelled or completed."
+ ]
+ },
+ "details": {
+ "description": "Output-only.A message containing any operation metadata details.",
+ "type": "string"
}
},
"id": "ClusterOperationStatus"
},
"HadoopJob": {
- "description": "A Cloud Dataproc job for running Apache Hadoop MapReduce (https://hadoop.apache.org/docs/current/hadoop-mapreduce-client/hadoop-mapreduce-client-core/MapReduceTutorial.html) jobs on Apache Hadoop YARN (https://hadoop.apache.org/docs/r2.7.1/hadoop-yarn/hadoop-yarn-site/YARN.html).",
- "type": "object",
"properties": {
+ "mainClass": {
+ "description": "The name of the driver's main class. The jar file containing the class must be in the default CLASSPATH or specified in jar_file_uris.",
+ "type": "string"
+ },
+ "archiveUris": {
+ "description": "Optional. HCFS URIs of archives to be extracted in the working directory of Hadoop drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, or .zip.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "mainJarFileUri": {
+ "description": "The HCFS URI of the jar file containing the main class. Examples: 'gs://foo-bucket/analytics-binaries/extract-useful-metrics-mr.jar' 'hdfs:/tmp/test-samples/custom-wordcount.jar' 'file:///home/usr/lib/hadoop-mapreduce/hadoop-mapreduce-examples.jar'",
+ "type": "string"
+ },
"jarFileUris": {
"description": "Optional. Jar file URIs to add to the CLASSPATHs of the Hadoop driver and tasks.",
"type": "array",
@@ -972,8 +714,8 @@
}
},
"loggingConfig": {
- "$ref": "LoggingConfig",
- "description": "Optional. The runtime log config for job execution."
+ "description": "Optional. The runtime log config for job execution.",
+ "$ref": "LoggingConfig"
},
"properties": {
"additionalProperties": {
@@ -995,24 +737,11 @@
"items": {
"type": "string"
}
- },
- "mainClass": {
- "description": "The name of the driver's main class. The jar file containing the class must be in the default CLASSPATH or specified in jar_file_uris.",
- "type": "string"
- },
- "archiveUris": {
- "description": "Optional. HCFS URIs of archives to be extracted in the working directory of Hadoop drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, or .zip.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "mainJarFileUri": {
- "description": "The HCFS URI of the jar file containing the main class. Examples: 'gs://foo-bucket/analytics-binaries/extract-useful-metrics-mr.jar' 'hdfs:/tmp/test-samples/custom-wordcount.jar' 'file:///home/usr/lib/hadoop-mapreduce/hadoop-mapreduce-examples.jar'",
- "type": "string"
}
},
- "id": "HadoopJob"
+ "id": "HadoopJob",
+ "description": "A Cloud Dataproc job for running Apache Hadoop MapReduce (https://hadoop.apache.org/docs/current/hadoop-mapreduce-client/hadoop-mapreduce-client-core/MapReduceTutorial.html) jobs on Apache Hadoop YARN (https://hadoop.apache.org/docs/r2.7.1/hadoop-yarn/hadoop-yarn-site/YARN.html).",
+ "type": "object"
},
"QueryList": {
"description": "A list of queries to run on a cluster.",
@@ -1029,28 +758,10 @@
"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": {
- "trackingUrl": {
- "description": "Optional. The HTTP URL of the ApplicationMaster, HistoryServer, or TimelineServer that provides application-specific information. The URL uses the internal hostname, and requires a proxy server for resolution and, possibly, access.",
- "type": "string"
- },
- "progress": {
- "description": "Required. The numerical progress of the application, from 1 to 100.",
- "format": "float",
- "type": "number"
- },
"state": {
- "enumDescriptions": [
- "Status is unspecified.",
- "Status is NEW.",
- "Status is NEW_SAVING.",
- "Status is SUBMITTED.",
- "Status is ACCEPTED.",
- "Status is RUNNING.",
- "Status is FINISHED.",
- "Status is FAILED.",
- "Status is KILLED."
- ],
"enum": [
"STATE_UNSPECIFIED",
"NEW",
@@ -1063,16 +774,34 @@
"KILLED"
],
"description": "Required. The application state.",
- "type": "string"
+ "type": "string",
+ "enumDescriptions": [
+ "Status is unspecified.",
+ "Status is NEW.",
+ "Status is NEW_SAVING.",
+ "Status is SUBMITTED.",
+ "Status is ACCEPTED.",
+ "Status is RUNNING.",
+ "Status is FINISHED.",
+ "Status is FAILED.",
+ "Status is KILLED."
+ ]
},
"name": {
"description": "Required. The application name.",
"type": "string"
+ },
+ "trackingUrl": {
+ "description": "Optional. The HTTP URL of the ApplicationMaster, HistoryServer, or TimelineServer that provides application-specific information. The URL uses the internal hostname, and requires a proxy server for resolution and, possibly, access.",
+ "type": "string"
+ },
+ "progress": {
+ "description": "Required. The numerical progress of the application, from 1 to 100.",
+ "format": "float",
+ "type": "number"
}
},
- "id": "YarnApplication",
- "description": "A YARN application created by a job. Application information is a subset of \u003ccode\u003eorg.apache.hadoop.yarn.proto.YarnProtos.ApplicationReportProto\u003c/code\u003e.Beta Feature: This report is available for testing purposes only. It may be changed before final release.",
- "type": "object"
+ "id": "YarnApplication"
},
"SetIamPolicyRequest": {
"description": "Request message for SetIamPolicy method.",
@@ -1086,19 +815,21 @@
"id": "SetIamPolicyRequest"
},
"HiveJob": {
+ "description": "A Cloud Dataproc job for running Apache Hive (https://hive.apache.org/) queries on YARN.",
+ "type": "object",
"properties": {
"continueOnFailure": {
"description": "Optional. Whether to continue executing queries if a query fails. The default value is false. Setting to true can be useful when executing independent parallel queries.",
"type": "boolean"
},
- "queryList": {
- "$ref": "QueryList",
- "description": "A list of queries."
- },
"queryFileUri": {
"description": "The HCFS URI of the script that contains Hive queries.",
"type": "string"
},
+ "queryList": {
+ "$ref": "QueryList",
+ "description": "A list of queries."
+ },
"jarFileUris": {
"description": "Optional. HCFS URIs of jar files to add to the CLASSPATH of the Hive server and Hadoop MapReduce (MR) tasks. Can contain Hive SerDes and UDFs.",
"type": "array",
@@ -1114,16 +845,14 @@
"type": "object"
},
"properties": {
- "description": "Optional. A mapping of property names and values, used to configure Hive. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/hive/conf/hive-site.xml, and classes in user code.",
- "type": "object",
"additionalProperties": {
"type": "string"
- }
+ },
+ "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",
- "description": "A Cloud Dataproc job for running Apache Hive (https://hive.apache.org/) queries on YARN.",
- "type": "object"
+ "id": "HiveJob"
},
"WorkflowGraph": {
"description": "The workflow graph.",
@@ -1154,25 +883,13 @@
"description": "The cluster config.",
"type": "object",
"properties": {
- "gceClusterConfig": {
- "description": "Required. The shared Google Compute Engine config settings for all instances in a cluster.",
- "$ref": "GceClusterConfig"
- },
- "softwareConfig": {
- "$ref": "SoftwareConfig",
- "description": "Optional. The config settings for software inside the cluster."
- },
"masterConfig": {
"$ref": "InstanceGroupConfig",
"description": "Optional. The Google Compute Engine config settings for the master instance in a cluster."
},
"secondaryWorkerConfig": {
- "description": "Optional. The Google Compute Engine config settings for additional worker instances in a cluster.",
- "$ref": "InstanceGroupConfig"
- },
- "lifecycleConfig": {
- "$ref": "LifecycleConfig",
- "description": "Optional. The config setting for auto delete cluster schedule."
+ "$ref": "InstanceGroupConfig",
+ "description": "Optional. The Google Compute Engine config settings for additional worker instances in a cluster."
},
"initializationActions": {
"description": "Optional. Commands to execute on each node after config is completed. By default, executables are run on master and all worker nodes. You can test a node's \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",
@@ -1181,6 +898,10 @@
"$ref": "NodeInitializationAction"
}
},
+ "lifecycleConfig": {
+ "description": "Optional. The config setting for auto delete cluster schedule.",
+ "$ref": "LifecycleConfig"
+ },
"configBucket": {
"description": "Optional. A Google Cloud Storage staging bucket used for sharing generated SSH keys and config. If you do not specify a staging bucket, Cloud Dataproc will determine an appropriate Cloud Storage location (US, ASIA, or EU) for your cluster's staging bucket according to the Google Compute Engine zone where your cluster is deployed, and then it will create and manage this project-level, per-location bucket for you.",
"type": "string"
@@ -1188,6 +909,14 @@
"workerConfig": {
"description": "Optional. The Google Compute Engine config settings for worker instances in a cluster.",
"$ref": "InstanceGroupConfig"
+ },
+ "gceClusterConfig": {
+ "$ref": "GceClusterConfig",
+ "description": "Required. The shared Google Compute Engine config settings for all instances in a cluster."
+ },
+ "softwareConfig": {
+ "$ref": "SoftwareConfig",
+ "description": "Optional. The config settings for software inside the cluster."
}
},
"id": "ClusterConfig"
@@ -1204,8 +933,8 @@
}
},
"loggingConfig": {
- "$ref": "LoggingConfig",
- "description": "Optional. The runtime log config for job execution."
+ "description": "Optional. The runtime log config for job execution.",
+ "$ref": "LoggingConfig"
},
"properties": {
"additionalProperties": {
@@ -1254,12 +983,12 @@
"type": "object",
"properties": {
"yarnMetrics": {
- "description": "The YARN metrics.",
- "type": "object",
"additionalProperties": {
"format": "int64",
"type": "string"
- }
+ },
+ "description": "The YARN metrics.",
+ "type": "object"
},
"hdfsMetrics": {
"additionalProperties": {
@@ -1273,8 +1002,6 @@
"id": "ClusterMetrics"
},
"AcceleratorConfig": {
- "description": "Specifies the type and number of accelerator cards attached to the instances of an instance group (see GPUs on Compute Engine).",
- "type": "object",
"properties": {
"acceleratorCount": {
"description": "The number of the accelerator cards of this type exposed to this instance.",
@@ -1286,7 +1013,9 @@
"type": "string"
}
},
- "id": "AcceleratorConfig"
+ "id": "AcceleratorConfig",
+ "description": "Specifies the type and number of accelerator cards attached to the instances of an instance group (see GPUs on Compute Engine).",
+ "type": "object"
},
"TestIamPermissionsRequest": {
"description": "Request message for TestIamPermissions method.",
@@ -1328,26 +1057,31 @@
"id": "LoggingConfig"
},
"OrderedJob": {
+ "type": "object",
"properties": {
+ "pysparkJob": {
+ "description": "Job is a Pyspark job.",
+ "$ref": "PySparkJob"
+ },
"scheduling": {
"$ref": "JobScheduling",
"description": "Optional. Job scheduling configuration."
},
- "pigJob": {
- "$ref": "PigJob",
- "description": "Job is a Pig job."
- },
"stepId": {
"description": "Required. The step id. The id must be unique among all jobs within the template.The step id is used as prefix for job id, as job workflow-step-id label, and in prerequisite_step_ids field from other steps.",
"type": "string"
},
+ "pigJob": {
+ "description": "Job is a Pig job.",
+ "$ref": "PigJob"
+ },
"hadoopJob": {
"description": "Job is a Hadoop job.",
"$ref": "HadoopJob"
},
"hiveJob": {
- "description": "Job is a Hive job.",
- "$ref": "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.",
@@ -1357,31 +1091,24 @@
}
},
"labels": {
- "description": "Optional. The labels to associate with this job.Label keys must be between 1 and 63 characters long, and must conform to the following regular expression: \\p{Ll}\\p{Lo}{0,62}Label values must be between 1 and 63 characters long, and must conform to the following regular expression: \\p{Ll}\\p{Lo}\\p{N}_-{0,63}No more than 64 labels can be associated with a given job.",
- "type": "object",
"additionalProperties": {
"type": "string"
- }
- },
- "sparkJob": {
- "description": "Job is a Spark job.",
- "$ref": "SparkJob"
+ },
+ "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": {
"description": "Job is a SparkSql job.",
"$ref": "SparkSqlJob"
},
- "pysparkJob": {
- "description": "Job is a Pyspark job.",
- "$ref": "PySparkJob"
+ "sparkJob": {
+ "$ref": "SparkJob",
+ "description": "Job is a Spark job."
}
},
- "id": "OrderedJob",
- "type": "object"
+ "id": "OrderedJob"
},
"WorkflowNode": {
- "description": "The workflow node.",
- "type": "object",
"properties": {
"state": {
"enumDescriptions": [
@@ -1423,20 +1150,22 @@
}
}
},
- "id": "WorkflowNode"
+ "id": "WorkflowNode",
+ "description": "The workflow node.",
+ "type": "object"
},
"InstantiateWorkflowTemplateRequest": {
"description": "A request to instantiate a workflow template.",
"type": "object",
"properties": {
+ "instanceId": {
+ "description": "Optional. A tag that prevents multiple concurrent workflow instances with the same tag from running. This mitigates risk of concurrent instances started due to retries.It is recommended to always set this value to a UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier).The tag must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.",
+ "type": "string"
+ },
"version": {
"description": "Optional. The version of workflow template to instantiate. If specified, the workflow will be instantiated only if the current version of the workflow template has the supplied version.This option cannot be used to instantiate a previous version of workflow template.",
"format": "int32",
"type": "integer"
- },
- "instanceId": {
- "description": "Optional. A tag that prevents multiple concurrent workflow instances with the same tag from running. This mitigates risk of concurrent instances started due to retries.It is recommended to always set this value to a UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier).The tag must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.",
- "type": "string"
}
},
"id": "InstantiateWorkflowTemplateRequest"
@@ -1444,8 +1173,8 @@
"SubmitJobRequest": {
"properties": {
"job": {
- "description": "Required. The job resource.",
- "$ref": "Job"
+ "$ref": "Job",
+ "description": "Required. The job resource."
}
},
"id": "SubmitJobRequest",
@@ -1468,20 +1197,24 @@
"description": "Describes the identifying information, config, and status of a cluster of Google Compute Engine instances.",
"type": "object",
"properties": {
+ "projectId": {
+ "description": "Required. The Google Cloud Platform project ID that the cluster belongs to.",
+ "type": "string"
+ },
"labels": {
- "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",
"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."
+ "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.",
@@ -1491,8 +1224,8 @@
}
},
"config": {
- "description": "Required. The cluster config. Note that Cloud Dataproc may set default values, and values may change when clusters are updated.",
- "$ref": "ClusterConfig"
+ "$ref": "ClusterConfig",
+ "description": "Required. The cluster config. Note that Cloud Dataproc may set default values, and values may change when clusters are updated."
},
"clusterName": {
"description": "Required. The cluster name. Cluster names within a project must be unique. Names of deleted clusters can be reused.",
@@ -1501,10 +1234,6 @@
"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"
@@ -1545,19 +1274,295 @@
"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"
+ }
+ },
+ "id": "ClusterSelector"
+ },
+ "WorkflowTemplatePlacement": {
+ "description": "Specifies workflow execution target.Either managed_cluster or cluster_selector is required.",
+ "type": "object",
+ "properties": {
+ "managedCluster": {
+ "$ref": "ManagedCluster",
+ "description": "Optional. A cluster that is managed by the workflow."
+ },
+ "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."
+ }
+ },
+ "id": "WorkflowTemplatePlacement"
+ },
+ "WorkflowMetadata": {
+ "description": "A Cloud Dataproc workflow template resource.",
+ "type": "object",
+ "properties": {
+ "state": {
+ "enum": [
+ "UNKNOWN",
+ "PENDING",
+ "RUNNING",
+ "DONE"
+ ],
+ "description": "Output only. The workflow state.",
+ "type": "string",
+ "enumDescriptions": [
+ "Unused.",
+ "The operation has been created.",
+ "The operation is running.",
+ "The operation is done; either cancelled or completed."
+ ]
+ },
+ "clusterName": {
+ "description": "Output only. The name of the managed cluster.",
+ "type": "string"
+ },
+ "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": {
+ "$ref": "WorkflowGraph",
+ "description": "Output only. The workflow graph."
+ },
+ "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": {
+ "done": {
+ "description": "Output only. Indicates the operation is done.",
+ "type": "boolean"
+ },
+ "operationId": {
+ "description": "Output only. The id of the cluster operation.",
+ "type": "string"
+ },
+ "error": {
+ "description": "Output only. Error, if operation failed.",
+ "type": "string"
+ }
+ },
+ "id": "ClusterOperation"
+ },
+ "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": {
+ "description": "Optional. The runtime log config for job execution.",
+ "$ref": "LoggingConfig"
+ },
+ "properties": {
+ "description": "Optional. A mapping of property names to values, used to configure Spark. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.",
"type": "object",
"additionalProperties": {
"type": "string"
}
},
- "zone": {
- "description": "Optional. The zone where workflow process executes. This parameter does not affect the selection of the cluster.If unspecified, the zone of the first cluster matching the selector is used.",
+ "args": {
+ "description": "Optional. The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "fileUris": {
+ "description": "Optional. HCFS URIs of files to be copied to the working directory of Spark drivers and distributed tasks. Useful for naively parallel tasks.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "mainClass": {
+ "description": "The name of the driver's main class. The jar file that contains the class must be in the default CLASSPATH or specified in jar_file_uris.",
+ "type": "string"
+ },
+ "archiveUris": {
+ "description": "Optional. HCFS URIs of archives to be extracted in the working directory of Spark drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "id": "SparkJob"
+ },
+ "JobStatus": {
+ "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": [
+ "The job state is unknown.",
+ "The job is pending; it has been submitted, but is not yet running.",
+ "Job has been received by the service and completed initial setup; it will soon be submitted to the cluster.",
+ "The job is running on the cluster.",
+ "A CancelJob request has been received, but is pending.",
+ "Transient in-flight resources have been canceled, and the request to cancel the running job has been issued to the cluster.",
+ "The job cancellation was successful.",
+ "The job has completed successfully.",
+ "The job has completed, but encountered an error.",
+ "Job attempt has failed. The detail field contains failure details for this attempt.Applies to restartable jobs only."
+ ]
+ },
+ "details": {
+ "description": "Output-only. Optional job state details, such as an error description if the state is \u003ccode\u003eERROR\u003c/code\u003e.",
+ "type": "string"
+ },
+ "stateStartTime": {
+ "description": "Output-only. The time when this state was entered.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "substate": {
+ "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."
+ ],
+ "enum": [
+ "UNSPECIFIED",
+ "SUBMITTED",
+ "QUEUED",
+ "STALE_STATUS"
+ ]
+ }
+ },
+ "id": "JobStatus",
+ "description": "Cloud Dataproc job status.",
+ "type": "object"
+ },
+ "DiagnoseClusterRequest": {
+ "description": "A request to collect cluster diagnostic information.",
+ "type": "object",
+ "properties": {},
+ "id": "DiagnoseClusterRequest"
+ },
+ "DiskConfig": {
+ "description": "Specifies the config of disk options for a group of VM instances.",
+ "type": "object",
+ "properties": {
+ "bootDiskType": {
+ "description": "Optional. Type of the boot disk (default is 'pd-standard'). Valid values: 'pd-ssd', 'pd-standard'",
+ "type": "string"
+ },
+ "numLocalSsds": {
+ "description": "Optional. Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs and HDFS (https://hadoop.apache.org/docs/r1.2.1/hdfs_user_guide.html) data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic config and installed binaries.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "bootDiskSizeGb": {
+ "description": "Optional. Size in GB of the boot disk (default is 500GB).",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "DiskConfig"
+ },
+ "ClusterOperationMetadata": {
+ "description": "Metadata describing the operation.",
+ "type": "object",
+ "properties": {
+ "operationType": {
+ "description": "Output-only. The operation type.",
+ "type": "string"
+ },
+ "description": {
+ "description": "Output-only. Short description of operation.",
+ "type": "string"
+ },
+ "warnings": {
+ "description": "Output-only. Errors encountered during operation execution.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "labels": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Output-only. Labels associated with the operation",
+ "type": "object"
+ },
+ "status": {
+ "$ref": "ClusterOperationStatus",
+ "description": "Output-only. Current operation status."
+ },
+ "statusHistory": {
+ "description": "Output-only. The previous operation status.",
+ "type": "array",
+ "items": {
+ "$ref": "ClusterOperationStatus"
+ }
+ },
+ "clusterUuid": {
+ "description": "Output-only. Cluster UUID for the operation.",
+ "type": "string"
+ },
+ "clusterName": {
+ "description": "Output-only. Name of the cluster for the operation.",
"type": "string"
}
},
- "id": "ClusterSelector"
+ "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"
}
},
"icons": {
@@ -1588,79 +1593,21 @@
"resources": {
"workflowTemplates": {
"methods": {
- "list": {
- "description": "Lists workflows that match the specified filter in the request.",
+ "get": {
"httpMethod": "GET",
"parameterOrder": [
- "parent"
- ],
- "response": {
- "$ref": "ListWorkflowTemplatesResponse"
- },
- "parameters": {
- "parent": {
- "description": "Required. The \"resource name\" of the region, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+$",
- "location": "path"
- },
- "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"
- }
- },
- "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"
- },
- "create": {
- "path": "v1beta2/{+parent}/workflowTemplates",
- "id": "dataproc.projects.locations.workflowTemplates.create",
- "request": {
- "$ref": "WorkflowTemplate"
- },
- "description": "Creates new workflow template.",
- "response": {
- "$ref": "WorkflowTemplate"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "POST",
- "parameters": {
- "parent": {
- "description": "Required. The \"resource name\" of the region, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/workflowTemplates"
- },
- "instantiate": {
- "httpMethod": "POST",
- "parameterOrder": [
"name"
],
"response": {
- "$ref": "Operation"
+ "$ref": "WorkflowTemplate"
},
"parameters": {
+ "version": {
+ "location": "query",
+ "description": "Optional. The version of workflow template to retrieve. Only previously instatiated versions can be retrieved.If unspecified, retrieves the current version.",
+ "format": "int32",
+ "type": "integer"
+ },
"name": {
"description": "Required. The \"resource name\" of the workflow template, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}/workflowTemplates/{template_id}",
"required": true,
@@ -1672,44 +1619,10 @@
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
- "flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/workflowTemplates/{workflowTemplatesId}:instantiate",
- "id": "dataproc.projects.locations.workflowTemplates.instantiate",
- "path": "v1beta2/{+name}:instantiate",
- "request": {
- "$ref": "InstantiateWorkflowTemplateRequest"
- },
- "description": "Instantiates a template and begins execution.The returned Operation can be used to track execution of workflow by polling google.cloud.dataproc.v1beta2.OperationService.GetOperation. The Operation will complete when entire workflow is finished.The running workflow can be aborted via google.cloud.dataproc.v1beta2.OperationService.CancelOperation.The google.cloud.dataproc.v1beta2.Operation.metadata will always be google.cloud.dataproc.v1beta2.WorkflowMetadata.The google.cloud.dataproc.v1beta2.Operation.result will always be google.protobuf.Empty."
- },
- "get": {
"flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/workflowTemplates/{workflowTemplatesId}",
- "path": "v1beta2/{+name}",
"id": "dataproc.projects.locations.workflowTemplates.get",
- "description": "Retrieves the latest workflow template.Can retrieve previously instantiated template by specifying optional version parameter.",
- "response": {
- "$ref": "WorkflowTemplate"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "parameters": {
- "name": {
- "location": "path",
- "description": "Required. The \"resource name\" of the workflow template, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}/workflowTemplates/{template_id}",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+/workflowTemplates/[^/]+$"
- },
- "version": {
- "location": "query",
- "description": "Optional. The version of workflow template to 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"
- ]
+ "path": "v1beta2/{+name}",
+ "description": "Retrieves the latest workflow template.Can retrieve previously instantiated template by specifying optional version parameter."
},
"update": {
"path": "v1beta2/{+name}",
@@ -1740,16 +1653,108 @@
"flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/workflowTemplates/{workflowTemplatesId}"
},
"delete": {
+ "description": "Deletes a workflow template. It does not cancel in-progress workflows.",
+ "httpMethod": "DELETE",
"response": {
"$ref": "Empty"
},
"parameterOrder": [
"name"
],
- "httpMethod": "DELETE",
+ "parameters": {
+ "name": {
+ "description": "Required. The \"resource name\" of the workflow template, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}/workflowTemplates/{template_id}",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+/workflowTemplates/[^/]+$",
+ "location": "path"
+ },
+ "version": {
+ "location": "query",
+ "description": "Optional. The version of workflow template to delete. If specified, will only delete the template if the current server version matches specified version.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
+ "flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/workflowTemplates/{workflowTemplatesId}",
+ "id": "dataproc.projects.locations.workflowTemplates.delete",
+ "path": "v1beta2/{+name}"
+ },
+ "list": {
+ "flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/workflowTemplates",
+ "path": "v1beta2/{+parent}/workflowTemplates",
+ "id": "dataproc.projects.locations.workflowTemplates.list",
+ "description": "Lists workflows that match the specified filter in the request.",
+ "response": {
+ "$ref": "ListWorkflowTemplatesResponse"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "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": {
+ "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"
+ ]
+ },
+ "create": {
+ "response": {
+ "$ref": "WorkflowTemplate"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "parent": {
+ "pattern": "^projects/[^/]+/locations/[^/]+$",
+ "location": "path",
+ "description": "Required. The \"resource name\" of the region, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/workflowTemplates",
+ "path": "v1beta2/{+parent}/workflowTemplates",
+ "id": "dataproc.projects.locations.workflowTemplates.create",
+ "request": {
+ "$ref": "WorkflowTemplate"
+ },
+ "description": "Creates new workflow template."
+ },
+ "instantiate": {
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "POST",
"parameters": {
"name": {
"location": "path",
@@ -1757,18 +1762,18 @@
"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",
- "description": "Deletes a workflow template. It does not cancel in-progress workflows."
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/workflowTemplates/{workflowTemplatesId}:instantiate",
+ "path": "v1beta2/{+name}:instantiate",
+ "id": "dataproc.projects.locations.workflowTemplates.instantiate",
+ "request": {
+ "$ref": "InstantiateWorkflowTemplateRequest"
+ },
+ "description": "Instantiates a template and begins execution.The returned Operation can be used to track execution of workflow by polling google.cloud.dataproc.v1beta2.OperationService.GetOperation. The Operation will complete when entire workflow is finished.The running workflow can be aborted via google.cloud.dataproc.v1beta2.OperationService.CancelOperation.The google.cloud.dataproc.v1beta2.Operation.metadata will always be google.cloud.dataproc.v1beta2.WorkflowMetadata.The google.cloud.dataproc.v1beta2.Operation.result will always be google.protobuf.Empty."
}
}
}
@@ -1776,8 +1781,461 @@
},
"regions": {
"resources": {
+ "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": [
+ "name"
+ ],
+ "response": {
+ "$ref": "ListOperationsResponse"
+ },
+ "parameters": {
+ "name": {
+ "location": "path",
+ "description": "The name of the operation's parent resource.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/regions/[^/]+/operations$"
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "The standard list page token.",
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "The standard list page size.",
+ "format": "int32",
+ "type": "integer",
+ "location": "query"
+ },
+ "filter": {
+ "description": "The standard list filter.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta2/projects/{projectsId}/regions/{regionsId}/operations",
+ "id": "dataproc.projects.regions.operations.list",
+ "path": "v1beta2/{+name}"
+ },
+ "get": {
+ "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "name": {
+ "location": "path",
+ "description": "The name of the operation resource.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/regions/[^/]+/operations/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta2/projects/{projectsId}/regions/{regionsId}/operations/{operationsId}",
+ "path": "v1beta2/{+name}",
+ "id": "dataproc.projects.regions.operations.get"
+ },
+ "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",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameters": {
+ "name": {
+ "description": "The name of the operation resource to be cancelled.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/regions/[^/]+/operations/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta2/projects/{projectsId}/regions/{regionsId}/operations/{operationsId}:cancel",
+ "id": "dataproc.projects.regions.operations.cancel",
+ "path": "v1beta2/{+name}:cancel"
+ },
+ "delete": {
+ "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/[^/]+/regions/[^/]+/operations/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta2/projects/{projectsId}/regions/{regionsId}/operations/{operationsId}",
+ "id": "dataproc.projects.regions.operations.delete",
+ "path": "v1beta2/{+name}",
+ "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED."
+ }
+ }
+ },
+ "jobs": {
+ "methods": {
+ "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.",
+ "httpMethod": "POST",
+ "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"
+ },
+ "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}:cancel",
+ "id": "dataproc.projects.regions.jobs.cancel",
+ "path": "v1beta2/projects/{projectId}/regions/{region}/jobs/{jobId}:cancel"
+ },
+ "get": {
+ "description": "Gets the resource representation for a job in a project.",
+ "response": {
+ "$ref": "Job"
+ },
+ "parameterOrder": [
+ "projectId",
+ "region",
+ "jobId"
+ ],
+ "httpMethod": "GET",
+ "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"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta2/projects/{projectId}/regions/{region}/jobs/{jobId}",
+ "path": "v1beta2/projects/{projectId}/regions/{region}/jobs/{jobId}",
+ "id": "dataproc.projects.regions.jobs.get"
+ },
+ "patch": {
+ "path": "v1beta2/projects/{projectId}/regions/{region}/jobs/{jobId}",
+ "id": "dataproc.projects.regions.jobs.patch",
+ "description": "Updates a job in a project.",
+ "request": {
+ "$ref": "Job"
+ },
+ "response": {
+ "$ref": "Job"
+ },
+ "parameterOrder": [
+ "projectId",
+ "region",
+ "jobId"
+ ],
+ "httpMethod": "PATCH",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "projectId": {
+ "description": "Required. The ID of the Google Cloud Platform project that the job belongs to.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "jobId": {
+ "location": "path",
+ "description": "Required. The job ID.",
+ "required": true,
+ "type": "string"
+ },
+ "region": {
+ "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\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": "v1beta2/projects/{projectId}/regions/{region}/jobs/{jobId}"
+ },
+ "submit": {
+ "path": "v1beta2/projects/{projectId}/regions/{region}/jobs:submit",
+ "id": "dataproc.projects.regions.jobs.submit",
+ "request": {
+ "$ref": "SubmitJobRequest"
+ },
+ "description": "Submits a job to a cluster.",
+ "response": {
+ "$ref": "Job"
+ },
+ "parameterOrder": [
+ "projectId",
+ "region"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "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"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta2/projects/{projectId}/regions/{region}/jobs:submit"
+ },
+ "delete": {
+ "description": "Deletes the job from the project. If the job is active, the delete fails, and the response returns FAILED_PRECONDITION.",
+ "httpMethod": "DELETE",
+ "parameterOrder": [
+ "projectId",
+ "region",
+ "jobId"
+ ],
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameters": {
+ "projectId": {
+ "location": "path",
+ "description": "Required. The ID of the Google Cloud Platform project that the job belongs to.",
+ "required": true,
+ "type": "string"
+ },
+ "jobId": {
+ "description": "Required. The job ID.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "region": {
+ "description": "Required. The Cloud Dataproc region in which to handle the request.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "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}"
+ },
+ "list": {
+ "description": "Lists regions/{region}/jobs in a project.",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "ListJobsResponse"
+ },
+ "parameterOrder": [
+ "projectId",
+ "region"
+ ],
+ "parameters": {
+ "pageSize": {
+ "location": "query",
+ "description": "Optional. The number of results to return in each response.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "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": {
+ "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": {
+ "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"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta2/projects/{projectId}/regions/{region}/jobs",
+ "id": "dataproc.projects.regions.jobs.list",
+ "path": "v1beta2/projects/{projectId}/regions/{region}/jobs"
+ }
+ }
+ },
"clusters": {
"methods": {
+ "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": {
+ "pattern": "^projects/[^/]+/regions/[^/]+/clusters/[^/]+$",
+ "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"
+ }
+ },
+ "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": {
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "projectId",
+ "region",
+ "clusterName"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "region": {
+ "location": "path",
+ "description": "Required. The Cloud Dataproc region in which to handle the request.",
+ "required": true,
+ "type": "string"
+ },
+ "clusterName": {
+ "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",
+ "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."
+ },
"delete": {
"description": "Deletes a cluster in a project.",
"response": {
@@ -1793,12 +2251,6 @@
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
- "region": {
- "location": "path",
- "description": "Required. The Cloud Dataproc region in which to handle the request.",
- "required": true,
- "type": "string"
- },
"clusterName": {
"description": "Required. The cluster name.",
"required": true,
@@ -1811,8 +2263,14 @@
"type": "string"
},
"projectId": {
+ "location": "path",
"description": "Required. The ID of the Google Cloud Platform project that the cluster belongs to.",
"required": true,
+ "type": "string"
+ },
+ "region": {
+ "description": "Required. The Cloud Dataproc region in which to handle the request.",
+ "required": true,
"type": "string",
"location": "path"
}
@@ -1821,49 +2279,7 @@
"path": "v1beta2/projects/{projectId}/regions/{region}/clusters/{clusterName}",
"id": "dataproc.projects.regions.clusters.delete"
},
- "diagnose": {
- "httpMethod": "POST",
- "parameterOrder": [
- "projectId",
- "region",
- "clusterName"
- ],
- "response": {
- "$ref": "Operation"
- },
- "parameters": {
- "region": {
- "location": "path",
- "description": "Required. The Cloud Dataproc region in which to handle the request.",
- "required": true,
- "type": "string"
- },
- "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"
- ],
- "flatPath": "v1beta2/projects/{projectId}/regions/{region}/clusters/{clusterName}:diagnose",
- "id": "dataproc.projects.regions.clusters.diagnose",
- "path": "v1beta2/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."
- },
"list": {
- "description": "Lists all regions/{region}/clusters in a project.",
"response": {
"$ref": "ListClustersResponse"
},
@@ -1877,9 +2293,9 @@
],
"parameters": {
"pageToken": {
+ "location": "query",
"description": "Optional. The standard List page token.",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"pageSize": {
"description": "Optional. The standard List page size.",
@@ -1907,41 +2323,10 @@
},
"flatPath": "v1beta2/projects/{projectId}/regions/{region}/clusters",
"path": "v1beta2/projects/{projectId}/regions/{region}/clusters",
- "id": "dataproc.projects.regions.clusters.list"
- },
- "setIamPolicy": {
- "description": "Sets the access control policy on the specified resource. Replaces any existing policy.",
- "request": {
- "$ref": "SetIamPolicyRequest"
- },
- "response": {
- "$ref": "Policy"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "resource": {
- "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"
- }
- },
- "flatPath": "v1beta2/projects/{projectsId}/regions/{regionsId}/clusters/{clustersId}:setIamPolicy",
- "path": "v1beta2/{+resource}:setIamPolicy",
- "id": "dataproc.projects.regions.clusters.setIamPolicy"
+ "id": "dataproc.projects.regions.clusters.list",
+ "description": "Lists all regions/{region}/clusters in a project."
},
"create": {
- "request": {
- "$ref": "Cluster"
- },
- "description": "Creates a cluster in a project.",
"response": {
"$ref": "Operation"
},
@@ -1950,6 +2335,9 @@
"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 cluster belongs to.",
@@ -1964,27 +2352,50 @@
"location": "path"
}
},
- "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"
+ "id": "dataproc.projects.regions.clusters.create",
+ "description": "Creates a cluster in a project.",
+ "request": {
+ "$ref": "Cluster"
+ }
},
- "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.",
- "response": {
- "$ref": "Policy"
+ "setIamPolicy": {
+ "flatPath": "v1beta2/projects/{projectsId}/regions/{regionsId}/clusters/{clustersId}:setIamPolicy",
+ "id": "dataproc.projects.regions.clusters.setIamPolicy",
+ "path": "v1beta2/{+resource}:setIamPolicy",
+ "request": {
+ "$ref": "SetIamPolicyRequest"
},
+ "description": "Sets the access control policy on the specified resource. Replaces any existing policy.",
+ "httpMethod": "POST",
"parameterOrder": [
"resource"
],
- "httpMethod": "GET",
+ "response": {
+ "$ref": "Policy"
+ },
+ "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"
+ ]
+ },
+ "getIamPolicy": {
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "resource"
],
+ "response": {
+ "$ref": "Policy"
+ },
"parameters": {
"resource": {
"location": "path",
@@ -1994,7 +2405,51 @@
"pattern": "^projects/[^/]+/regions/[^/]+/clusters/[^/]+$"
}
},
- "flatPath": "v1beta2/projects/{projectsId}/regions/{regionsId}/clusters/{clustersId}:getIamPolicy"
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta2/projects/{projectsId}/regions/{regionsId}/clusters/{clustersId}:getIamPolicy",
+ "id": "dataproc.projects.regions.clusters.getIamPolicy",
+ "path": "v1beta2/{+resource}:getIamPolicy",
+ "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": {
+ "response": {
+ "$ref": "Cluster"
+ },
+ "parameterOrder": [
+ "projectId",
+ "region",
+ "clusterName"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "projectId": {
+ "location": "path",
+ "description": "Required. The ID of the Google Cloud Platform project that the cluster belongs to.",
+ "required": true,
+ "type": "string"
+ },
+ "region": {
+ "description": "Required. The Cloud Dataproc region in which to handle the request.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "clusterName": {
+ "location": "path",
+ "description": "Required. The cluster name.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta2/projects/{projectId}/regions/{region}/clusters/{clusterName}",
+ "path": "v1beta2/projects/{projectId}/regions/{region}/clusters/{clusterName}",
+ "id": "dataproc.projects.regions.clusters.get",
+ "description": "Gets the resource representation for a cluster in a project."
},
"patch": {
"response": {
@@ -2010,6 +2465,18 @@
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
+ "region": {
+ "description": "Required. The Cloud Dataproc region in which to handle the request.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "updateMask": {
+ "description": "Required. Specifies the path, relative to \u003ccode\u003eCluster\u003c/code\u003e, of the field to update. For example, to change the number of workers in a cluster to 5, the \u003ccode\u003eupdate_mask\u003c/code\u003e parameter would be specified as \u003ccode\u003econfig.worker_config.num_instances\u003c/code\u003e, and the PATCH request body would specify the new value, as follows:\n{\n \"config\":{\n \"workerConfig\":{\n \"numInstances\":\"5\"\n }\n }\n}\nSimilarly, to change the number of preemptible workers in a cluster to 5, the \u003ccode\u003eupdate_mask\u003c/code\u003e parameter would be \u003ccode\u003econfig.secondary_worker_config.num_instances\u003c/code\u003e, and the PATCH request body would be set as follows:\n{\n \"config\":{\n \"secondaryWorkerConfig\":{\n \"numInstances\":\"5\"\n }\n }\n}\n\u003cstrong\u003eNote:\u003c/strong\u003e currently only some fields can be updated: |Mask|Purpose| |labels|Updates labels| |config.worker_config.num_instances|Resize primary worker group| |config.secondary_worker_config.num_instances|Resize secondary worker group|",
+ "format": "google-fieldmask",
+ "type": "string",
+ "location": "query"
+ },
"clusterName": {
"location": "path",
"description": "Required. The cluster name.",
@@ -2017,28 +2484,16 @@
"type": "string"
},
"gracefulDecommissionTimeout": {
- "location": "query",
"description": "Optional. Timeout for graceful YARN decomissioning. Graceful decommissioning allows removing nodes from the cluster without interrupting jobs in progress. Timeout specifies how long to wait for jobs in progress to finish before forcefully removing nodes (and potentially interrupting jobs). Default timeout is 0 (for forceful decommission), and the maximum allowed timeout is 1 day.Only supported on Dataproc image versions 1.2 and higher.",
"format": "google-duration",
- "type": "string"
- },
- "projectId": {
- "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": {
- "description": "Required. Specifies the path, relative to \u003ccode\u003eCluster\u003c/code\u003e, of the field to update. For example, to change the number of workers in a cluster to 5, the \u003ccode\u003eupdate_mask\u003c/code\u003e parameter would be specified as \u003ccode\u003econfig.worker_config.num_instances\u003c/code\u003e, and the PATCH request body would specify the new value, as follows:\n{\n \"config\":{\n \"workerConfig\":{\n \"numInstances\":\"5\"\n }\n }\n}\nSimilarly, to change the number of preemptible workers in a cluster to 5, the \u003ccode\u003eupdate_mask\u003c/code\u003e parameter would be \u003ccode\u003econfig.secondary_worker_config.num_instances\u003c/code\u003e, and the PATCH request body would be set as follows:\n{\n \"config\":{\n \"secondaryWorkerConfig\":{\n \"numInstances\":\"5\"\n }\n }\n}\n\u003cstrong\u003eNote:\u003c/strong\u003e currently only some fields can be updated: |Mask|Purpose| |labels|Updates labels| |config.worker_config.num_instances|Resize primary worker group| |config.secondary_worker_config.num_instances|Resize secondary worker group|",
- "format": "google-fieldmask",
"type": "string",
"location": "query"
+ },
+ "projectId": {
+ "description": "Required. The ID of the Google Cloud Platform project the cluster belongs to.",
+ "required": true,
+ "type": "string",
+ "location": "path"
}
},
"flatPath": "v1beta2/projects/{projectId}/regions/{region}/clusters/{clusterName}",
@@ -2048,90 +2503,32 @@
"request": {
"$ref": "Cluster"
}
- },
- "get": {
- "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",
- "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"
- },
- "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}"
- },
- "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.",
- "response": {
- "$ref": "TestIamPermissionsResponse"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
- "parameters": {
- "resource": {
- "description": "REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/regions/[^/]+/clusters/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta2/projects/{projectsId}/regions/{regionsId}/clusters/{clustersId}:testIamPermissions",
- "path": "v1beta2/{+resource}:testIamPermissions",
- "id": "dataproc.projects.regions.clusters.testIamPermissions"
}
}
},
"workflowTemplates": {
"methods": {
- "create": {
- "request": {
- "$ref": "WorkflowTemplate"
- },
- "description": "Creates new workflow template.",
+ "list": {
+ "description": "Lists workflows that match the specified filter in the request.",
"response": {
- "$ref": "WorkflowTemplate"
+ "$ref": "ListWorkflowTemplatesResponse"
},
"parameterOrder": [
"parent"
],
- "httpMethod": "POST",
+ "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.",
+ "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}",
@@ -2145,13 +2542,37 @@
],
"flatPath": "v1beta2/projects/{projectsId}/regions/{regionsId}/workflowTemplates",
"path": "v1beta2/{+parent}/workflowTemplates",
- "id": "dataproc.projects.regions.workflowTemplates.create"
+ "id": "dataproc.projects.regions.workflowTemplates.list"
+ },
+ "create": {
+ "path": "v1beta2/{+parent}/workflowTemplates",
+ "id": "dataproc.projects.regions.workflowTemplates.create",
+ "request": {
+ "$ref": "WorkflowTemplate"
+ },
+ "description": "Creates new workflow template.",
+ "response": {
+ "$ref": "WorkflowTemplate"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "parent": {
+ "description": "Required. The \"resource name\" of the region, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/regions/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta2/projects/{projectsId}/regions/{regionsId}/workflowTemplates"
},
"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"
},
@@ -2159,9 +2580,6 @@
"name"
],
"httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
"parameters": {
"name": {
"location": "path",
@@ -2171,9 +2589,16 @@
"pattern": "^projects/[^/]+/regions/[^/]+/workflowTemplates/[^/]+$"
}
},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
"flatPath": "v1beta2/projects/{projectsId}/regions/{regionsId}/workflowTemplates/{workflowTemplatesId}:instantiate",
"path": "v1beta2/{+name}:instantiate",
- "id": "dataproc.projects.regions.workflowTemplates.instantiate"
+ "id": "dataproc.projects.regions.workflowTemplates.instantiate",
+ "request": {
+ "$ref": "InstantiateWorkflowTemplateRequest"
+ },
+ "description": "Instantiates a template and begins execution.The returned Operation can be used to track execution of workflow by polling google.cloud.dataproc.v1beta2.OperationService.GetOperation. The Operation will complete when entire workflow is finished.The running workflow can be aborted via google.cloud.dataproc.v1beta2.OperationService.CancelOperation.The google.cloud.dataproc.v1beta2.Operation.metadata will always be google.cloud.dataproc.v1beta2.WorkflowMetadata.The google.cloud.dataproc.v1beta2.Operation.result will always be google.protobuf.Empty."
},
"get": {
"path": "v1beta2/{+name}",
@@ -2186,6 +2611,9 @@
"name"
],
"httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
"parameters": {
"version": {
"location": "query",
@@ -2201,9 +2629,6 @@
"location": "path"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
"flatPath": "v1beta2/projects/{projectsId}/regions/{regionsId}/workflowTemplates/{workflowTemplatesId}"
},
"update": {
@@ -2245,445 +2670,25 @@
"name"
],
"httpMethod": "DELETE",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
"parameters": {
- "version": {
- "location": "query",
- "description": "Optional. The version of workflow template to delete. If specified, will only delete the template if the current server version matches specified version.",
- "format": "int32",
- "type": "integer"
- },
"name": {
- "location": "path",
"description": "Required. The \"resource name\" of the workflow template, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}/workflowTemplates/{template_id}",
"required": true,
"type": "string",
- "pattern": "^projects/[^/]+/regions/[^/]+/workflowTemplates/[^/]+$"
+ "pattern": "^projects/[^/]+/regions/[^/]+/workflowTemplates/[^/]+$",
+ "location": "path"
+ },
+ "version": {
+ "description": "Optional. The version of workflow template to delete. If specified, will only delete the template if the current server version matches specified version.",
+ "format": "int32",
+ "type": "integer",
+ "location": "query"
}
},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
"flatPath": "v1beta2/projects/{projectsId}/regions/{regionsId}/workflowTemplates/{workflowTemplatesId}"
- },
- "list": {
- "response": {
- "$ref": "ListWorkflowTemplatesResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "GET",
- "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}",
- "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"
- },
- "pageSize": {
- "description": "Optional. The maximum number of results to return in each response.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- }
- },
- "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."
- }
- }
- },
- "operations": {
- "methods": {
- "cancel": {
- "path": "v1beta2/{+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",
- "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/[^/]+/regions/[^/]+/operations/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1beta2/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": "v1beta2/projects/{projectsId}/regions/{regionsId}/operations/{operationsId}",
- "path": "v1beta2/{+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",
- "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": "path",
- "description": "The name of the operation's parent resource.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/regions/[^/]+/operations$"
- },
- "pageToken": {
- "description": "The standard list page token.",
- "type": "string",
- "location": "query"
- }
- },
- "flatPath": "v1beta2/projects/{projectsId}/regions/{regionsId}/operations",
- "path": "v1beta2/{+name}",
- "id": "dataproc.projects.regions.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.",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "description": "The name of the operation resource.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/regions/[^/]+/operations/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1beta2/projects/{projectsId}/regions/{regionsId}/operations/{operationsId}",
- "path": "v1beta2/{+name}",
- "id": "dataproc.projects.regions.operations.get"
- }
- }
- },
- "jobs": {
- "methods": {
- "submit": {
- "request": {
- "$ref": "SubmitJobRequest"
- },
- "description": "Submits a job to a cluster.",
- "httpMethod": "POST",
- "parameterOrder": [
- "projectId",
- "region"
- ],
- "response": {
- "$ref": "Job"
- },
- "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"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta2/projects/{projectId}/regions/{region}/jobs:submit",
- "id": "dataproc.projects.regions.jobs.submit",
- "path": "v1beta2/projects/{projectId}/regions/{region}/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": {
- "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": {
- "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/{jobId}"
- },
- "list": {
- "flatPath": "v1beta2/projects/{projectId}/regions/{region}/jobs",
- "path": "v1beta2/projects/{projectId}/regions/{region}/jobs",
- "id": "dataproc.projects.regions.jobs.list",
- "description": "Lists regions/{region}/jobs in a project.",
- "response": {
- "$ref": "ListJobsResponse"
- },
- "parameterOrder": [
- "projectId",
- "region"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "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": {
- "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": {
- "enum": [
- "ALL",
- "ACTIVE",
- "NON_ACTIVE"
- ],
- "description": "Optional. Specifies enumerated categories of jobs to list. (default = match ALL jobs).If filter is provided, jobStateMatcher will be ignored.",
- "type": "string",
- "location": "query"
- },
- "pageToken": {
- "location": "query",
- "description": "Optional. The page token, returned by a previous call, to request the next page of results.",
- "type": "string"
- },
- "pageSize": {
- "description": "Optional. The number of results to return in each response.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- },
- "region": {
- "location": "path",
- "description": "Required. The Cloud Dataproc region in which to handle the request.",
- "required": true,
- "type": "string"
- }
- }
- },
- "cancel": {
- "path": "v1beta2/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.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta2/projects/{projectId}/regions/{region}/jobs/{jobId}:cancel"
- },
- "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": {
- "description": "Required. The job ID.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "region": {
- "description": "Required. The Cloud Dataproc region in which to handle the request.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "updateMask": {
- "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": "v1beta2/projects/{projectId}/regions/{region}/jobs/{jobId}",
- "path": "v1beta2/projects/{projectId}/regions/{region}/jobs/{jobId}",
- "id": "dataproc.projects.regions.jobs.patch"
- },
- "get": {
- "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.",
- "response": {
- "$ref": "Job"
- },
- "parameterOrder": [
- "projectId",
- "region",
- "jobId"
- ],
- "httpMethod": "GET",
- "parameters": {
- "projectId": {
- "description": "Required. The ID of the Google Cloud Platform project that the job belongs to.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "jobId": {
- "description": "Required. The job ID.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "region": {
- "description": "Required. The Cloud Dataproc region in which to handle the request.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta2/projects/{projectId}/regions/{region}/jobs/{jobId}"
}
}
}
@@ -2699,15 +2704,15 @@
"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"
+ "type": "string",
+ "location": "query"
},
"uploadType": {
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
@@ -2728,9 +2733,9 @@
]
},
"callback": {
+ "location": "query",
"description": "JSONP",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"alt": {
"description": "Data format for response.",
@@ -2754,15 +2759,15 @@
"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"
},
+ "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.",
@@ -2775,15 +2780,10 @@
"location": "query"
},
"bearer_token": {
+ "location": "query",
"description": "OAuth bearer token.",
- "type": "string",
- "location": "query"
+ "type": "string"
}
},
- "version": "v1beta2",
- "baseUrl": "https://dataproc.googleapis.com/",
- "servicePath": "",
- "description": "Manages Hadoop-based clusters and jobs on Google Cloud Platform.",
- "kind": "discovery#restDescription",
- "basePath": ""
+ "version": "v1beta2"
}
diff --git a/datastore/v1/datastore-api.json b/datastore/v1/datastore-api.json
index ca1f3a9..f475366 100644
--- a/datastore/v1/datastore-api.json
+++ b/datastore/v1/datastore-api.json
@@ -1,305 +1,22 @@
{
+ "basePath": "",
+ "ownerDomain": "google.com",
+ "name": "datastore",
+ "batchPath": "batch",
+ "revision": "20171212",
+ "documentationLink": "https://cloud.google.com/datastore/",
+ "id": "datastore:v1",
+ "title": "Google Cloud Datastore API",
"ownerName": "Google",
"discoveryVersion": "v1",
"version_module": true,
"resources": {
"projects": {
- "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/[^/]+/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/datastore"
- ],
- "flatPath": "v1/projects/{projectsId}/operations/{operationsId}:cancel",
- "path": "v1/{+name}:cancel",
- "id": "datastore.projects.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": {
- "location": "path",
- "description": "The name of the operation resource to be deleted.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/operations/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/datastore"
- ],
- "flatPath": "v1/projects/{projectsId}/operations/{operationsId}",
- "path": "v1/{+name}",
- "id": "datastore.projects.operations.delete"
- },
- "list": {
- "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": {
- "pageSize": {
- "description": "The standard list page size.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- },
- "filter": {
- "location": "query",
- "description": "The standard list filter.",
- "type": "string"
- },
- "name": {
- "location": "path",
- "description": "The name of the operation's parent resource.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+$"
- },
- "pageToken": {
- "location": "query",
- "description": "The standard list page token.",
- "type": "string"
- }
- },
- "flatPath": "v1/projects/{projectsId}/operations",
- "path": "v1/{+name}/operations",
- "id": "datastore.projects.operations.list"
- },
- "get": {
- "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}",
- "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."
- }
- }
- }
- },
"methods": {
- "rollback": {
- "id": "datastore.projects.rollback",
- "path": "v1/projects/{projectId}:rollback",
- "request": {
- "$ref": "RollbackRequest"
- },
- "description": "Rolls back a transaction.",
- "httpMethod": "POST",
- "parameterOrder": [
- "projectId"
- ],
- "response": {
- "$ref": "RollbackResponse"
- },
- "parameters": {
- "projectId": {
- "location": "path",
- "description": "The ID of the project against which to make the request.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/datastore"
- ],
- "flatPath": "v1/projects/{projectId}:rollback"
- },
- "runQuery": {
- "response": {
- "$ref": "RunQueryResponse"
- },
- "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}:runQuery",
- "path": "v1/projects/{projectId}:runQuery",
- "id": "datastore.projects.runQuery",
- "request": {
- "$ref": "RunQueryRequest"
- },
- "description": "Queries for entities."
- },
- "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"
- },
- "allocateIds": {
- "response": {
- "$ref": "AllocateIdsResponse"
- },
- "parameterOrder": [
- "projectId"
- ],
- "httpMethod": "POST",
- "parameters": {
- "projectId": {
- "description": "The ID of the project against which to make the request.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/datastore"
- ],
- "flatPath": "v1/projects/{projectId}:allocateIds",
- "path": "v1/projects/{projectId}:allocateIds",
- "id": "datastore.projects.allocateIds",
- "request": {
- "$ref": "AllocateIdsRequest"
- },
- "description": "Allocates IDs for the given keys, which is useful for referencing an entity\nbefore it is inserted."
- },
- "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",
- "path": "v1/projects/{projectId}:beginTransaction",
- "id": "datastore.projects.beginTransaction"
- },
- "commit": {
- "request": {
- "$ref": "CommitRequest"
- },
- "description": "Commits a transaction, optionally creating, deleting or modifying some\nentities.",
- "response": {
- "$ref": "CommitResponse"
- },
- "parameterOrder": [
- "projectId"
- ],
- "httpMethod": "POST",
- "parameters": {
- "projectId": {
- "description": "The ID of the project against which to make the request.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/datastore"
- ],
- "flatPath": "v1/projects/{projectId}:commit",
- "path": "v1/projects/{projectId}:commit",
- "id": "datastore.projects.commit"
- },
"reserveIds": {
+ "flatPath": "v1/projects/{projectId}:reserveIds",
+ "path": "v1/projects/{projectId}:reserveIds",
+ "id": "datastore.projects.reserveIds",
"description": "Prevents the supplied keys' IDs from being auto-allocated by Cloud\nDatastore.",
"request": {
"$ref": "ReserveIdsRequest"
@@ -317,20 +34,321 @@
],
"parameters": {
"projectId": {
+ "description": "The ID of the project against which to make the request.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ }
+ },
+ "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": "v1/projects/{projectId}:reserveIds",
- "path": "v1/projects/{projectId}:reserveIds",
- "id": "datastore.projects.reserveIds"
+ "flatPath": "v1/projects/{projectId}:runQuery",
+ "path": "v1/projects/{projectId}:runQuery",
+ "id": "datastore.projects.runQuery",
+ "description": "Queries for entities.",
+ "request": {
+ "$ref": "RunQueryRequest"
+ }
+ },
+ "rollback": {
+ "request": {
+ "$ref": "RollbackRequest"
+ },
+ "description": "Rolls back a transaction.",
+ "response": {
+ "$ref": "RollbackResponse"
+ },
+ "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}:rollback",
+ "path": "v1/projects/{projectId}:rollback",
+ "id": "datastore.projects.rollback"
+ },
+ "lookup": {
+ "request": {
+ "$ref": "LookupRequest"
+ },
+ "description": "Looks up entities by key.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "projectId"
+ ],
+ "response": {
+ "$ref": "LookupResponse"
+ },
+ "parameters": {
+ "projectId": {
+ "location": "path",
+ "description": "The ID of the project against which to make the request.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/datastore"
+ ],
+ "flatPath": "v1/projects/{projectId}:lookup",
+ "id": "datastore.projects.lookup",
+ "path": "v1/projects/{projectId}:lookup"
+ },
+ "allocateIds": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "projectId"
+ ],
+ "response": {
+ "$ref": "AllocateIdsResponse"
+ },
+ "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."
+ },
+ "commit": {
+ "flatPath": "v1/projects/{projectId}:commit",
+ "path": "v1/projects/{projectId}:commit",
+ "id": "datastore.projects.commit",
+ "request": {
+ "$ref": "CommitRequest"
+ },
+ "description": "Commits a transaction, optionally creating, deleting or modifying some\nentities.",
+ "response": {
+ "$ref": "CommitResponse"
+ },
+ "parameterOrder": [
+ "projectId"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "projectId": {
+ "location": "path",
+ "description": "The ID of the project against which to make the request.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/datastore"
+ ]
+ },
+ "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"
+ }
+ },
+ "resources": {
+ "operations": {
+ "methods": {
+ "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",
+ "response": {
+ "$ref": "GoogleLongrunningListOperationsResponse"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "filter": {
+ "description": "The standard list filter.",
+ "type": "string",
+ "location": "query"
+ },
+ "name": {
+ "description": "The name of the operation's parent resource.",
+ "required": true,
+ "type": "string",
+ "pattern": "^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",
+ "https://www.googleapis.com/auth/datastore"
+ ],
+ "flatPath": "v1/projects/{projectsId}/operations"
+ },
+ "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": {
+ "description": "The name of the operation resource.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/operations/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/operations/{operationsId}"
+ },
+ "cancel": {
+ "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",
+ "description": "Starts asynchronous cancellation on a long-running operation. The server\nmakes a best effort to cancel the operation, but success is not\nguaranteed. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`. Clients can use\nOperations.GetOperation or\nother methods to check whether the cancellation succeeded or whether the\noperation completed despite cancellation. On successful cancellation,\nthe operation is not deleted; instead, it becomes an operation with\nan Operation.error value with a google.rpc.Status.code of 1,\ncorresponding to `Code.CANCELLED`."
+ },
+ "delete": {
+ "description": "Deletes a long-running operation. This method indicates that the client is\nno longer interested in the operation result. It does not cancel the\noperation. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`.",
+ "httpMethod": "DELETE",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The name of the operation resource to be deleted.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/operations/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/datastore"
+ ],
+ "flatPath": "v1/projects/{projectsId}/operations/{operationsId}",
+ "id": "datastore.projects.operations.delete",
+ "path": "v1/{+name}"
+ }
+ }
}
}
}
},
"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\").",
@@ -342,22 +360,19 @@
"default": "true",
"location": "query"
},
- "fields": {
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string",
- "location": "query"
- },
"uploadType": {
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"type": "string",
"location": "query"
},
- "callback": {
- "description": "JSONP",
+ "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"
@@ -366,13 +381,14 @@
"enum": [
"1",
"2"
- ],
- "description": "V1 error format.",
+ ]
+ },
+ "callback": {
+ "location": "query",
+ "description": "JSONP",
"type": "string"
},
"alt": {
- "description": "Data format for response.",
- "default": "json",
"enum": [
"json",
"media",
@@ -384,6 +400,13 @@
"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": {
@@ -391,82 +414,303 @@
"description": "OAuth access token.",
"type": "string"
},
- "key": {
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "quotaUser": {
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
"type": "string",
"location": "query"
},
- "quotaUser": {
- "location": "query",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string"
- },
"pp": {
"location": "query",
"description": "Pretty-print response.",
"type": "boolean",
"default": "true"
- },
- "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": {
+ "PropertyOrder": {
+ "properties": {
+ "property": {
+ "description": "The property to order by.",
+ "$ref": "PropertyReference"
+ },
+ "direction": {
+ "enumDescriptions": [
+ "Unspecified. This value must not be used.",
+ "Ascending.",
+ "Descending."
+ ],
+ "enum": [
+ "DIRECTION_UNSPECIFIED",
+ "ASCENDING",
+ "DESCENDING"
+ ],
+ "description": "The direction to order by. Defaults to `ASCENDING`.",
+ "type": "string"
+ }
+ },
+ "id": "PropertyOrder",
+ "description": "The desired order for a specific property.",
+ "type": "object"
+ },
+ "ReserveIdsResponse": {
+ "description": "The response for Datastore.ReserveIds.",
+ "type": "object",
+ "properties": {},
+ "id": "ReserveIdsResponse"
+ },
+ "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"
+ },
+ "PropertyReference": {
+ "description": "A reference to a property relative to the kind expressions.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "The name of the property.\nIf name includes \".\"s, it may be interpreted as a property name path.",
+ "type": "string"
+ }
+ },
+ "id": "PropertyReference"
+ },
+ "Projection": {
+ "properties": {
+ "property": {
+ "description": "The property to project.",
+ "$ref": "PropertyReference"
+ }
+ },
+ "id": "Projection",
+ "description": "A representation of a property in a projection.",
+ "type": "object"
+ },
+ "Mutation": {
+ "description": "A mutation to apply to an entity.",
+ "type": "object",
+ "properties": {
+ "update": {
+ "$ref": "Entity",
+ "description": "The entity to update. The entity must already exist.\nMust have a complete key path."
+ },
+ "upsert": {
+ "$ref": "Entity",
+ "description": "The entity to upsert. The entity may or may not already exist.\nThe entity key's final path element may be incomplete."
+ },
+ "delete": {
+ "description": "The key of the entity to delete. The entity may or may not already exist.\nMust have a complete key path and must not be reserved/read-only.",
+ "$ref": "Key"
+ },
+ "insert": {
+ "description": "The entity to insert. The entity must not already exist.\nThe entity key's final path element may be incomplete.",
+ "$ref": "Entity"
+ },
+ "baseVersion": {
+ "description": "The version of the entity that this mutation is being applied to. If this\ndoes not match the current version on the server, the mutation conflicts.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "id": "Mutation"
+ },
+ "ReadOptions": {
+ "description": "The options shared by read requests.",
+ "type": "object",
+ "properties": {
+ "readConsistency": {
+ "enumDescriptions": [
+ "Unspecified. This value must not be used.",
+ "Strong consistency.",
+ "Eventual consistency."
+ ],
+ "enum": [
+ "READ_CONSISTENCY_UNSPECIFIED",
+ "STRONG",
+ "EVENTUAL"
+ ],
+ "description": "The non-transactional read consistency to use.\nCannot be set to `STRONG` for global queries.",
+ "type": "string"
+ },
+ "transaction": {
+ "description": "The identifier of the transaction in which to read. A\ntransaction identifier is returned by a call to\nDatastore.BeginTransaction.",
+ "format": "byte",
+ "type": "string"
+ }
+ },
+ "id": "ReadOptions"
+ },
+ "RollbackResponse": {
+ "description": "The response for Datastore.Rollback.\n(an empty message).",
+ "type": "object",
+ "properties": {},
+ "id": "RollbackResponse"
+ },
+ "MutationResult": {
+ "description": "The result of applying a mutation.",
+ "type": "object",
+ "properties": {
+ "version": {
+ "description": "The version of the entity on the server after processing the mutation. If\nthe mutation doesn't change anything on the server, then the version will\nbe the version of the current entity or, if no entity is present, a version\nthat is strictly greater than the version of any previous entity and less\nthan the version of any possible future entity.",
+ "format": "int64",
+ "type": "string"
+ },
+ "conflictDetected": {
+ "description": "Whether a conflict was detected for this mutation. Always false when a\nconflict detection strategy field is not set in the mutation.",
+ "type": "boolean"
+ },
+ "key": {
+ "description": "The automatically allocated key.\nSet only when the mutation allocated a key.",
+ "$ref": "Key"
+ }
+ },
+ "id": "MutationResult"
+ },
+ "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"
+ },
+ "GoogleDatastoreAdminV1beta1ExportEntitiesMetadata": {
+ "properties": {
+ "progressBytes": {
+ "description": "An estimate of the number of bytes processed.",
+ "$ref": "GoogleDatastoreAdminV1beta1Progress"
+ },
+ "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": {
+ "description": "An estimate of the number of entities processed.",
+ "$ref": "GoogleDatastoreAdminV1beta1Progress"
+ },
+ "common": {
+ "description": "Metadata common to all Datastore Admin operations.",
+ "$ref": "GoogleDatastoreAdminV1beta1CommonMetadata"
+ }
+ },
+ "id": "GoogleDatastoreAdminV1beta1ExportEntitiesMetadata",
+ "description": "Metadata for ExportEntities operations.",
+ "type": "object"
+ },
+ "CompositeFilter": {
+ "properties": {
+ "filters": {
+ "description": "The list of filters to combine.\nMust contain at least one filter.",
+ "type": "array",
+ "items": {
+ "$ref": "Filter"
+ }
+ },
+ "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."
+ ],
+ "enum": [
+ "OPERATOR_UNSPECIFIED",
+ "AND"
+ ]
+ }
+ },
+ "id": "CompositeFilter",
+ "description": "A filter that merges multiple other filters using the given operator.",
+ "type": "object"
+ },
+ "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"
+ },
"GoogleLongrunningOperation": {
"description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
"type": "object",
"properties": {
+ "error": {
+ "description": "The error result of the operation in case of failure or cancellation.",
+ "$ref": "Status"
+ },
+ "metadata": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "description": "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"
- }
+ },
+ "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": "GoogleLongrunningOperation"
},
"PropertyFilter": {
- "description": "A filter on a specific property.",
- "type": "object",
"properties": {
- "value": {
- "description": "The value to compare the property to.",
- "$ref": "Value"
- },
"property": {
- "$ref": "PropertyReference",
- "description": "The property to filter by."
+ "description": "The property to filter by.",
+ "$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": [
@@ -477,19 +721,16 @@
"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"
]
+ },
+ "value": {
+ "$ref": "Value",
+ "description": "The value to compare the property to."
}
},
- "id": "PropertyFilter"
+ "id": "PropertyFilter",
+ "description": "A filter on a specific property.",
+ "type": "object"
},
"CommitResponse": {
"description": "The response for Datastore.Commit.",
@@ -511,8 +752,6 @@
"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.",
@@ -523,22 +762,24 @@
"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": {
- "$ref": "Key",
- "description": "The entity's key.\n\nAn entity must have a key, unless otherwise documented (for example,\nan entity in `Value.entity_value` may have no key).\nAn entity's kind is its key path's last element's kind,\nor null if it has no key."
}
},
"id": "Entity"
@@ -547,29 +788,6 @@
"description": "A batch of results produced by a query.",
"type": "object",
"properties": {
- "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.",
- "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",
- "MORE_RESULTS_AFTER_LIMIT",
- "MORE_RESULTS_AFTER_CURSOR",
- "NO_MORE_RESULTS"
- ]
- },
- "endCursor": {
- "description": "A cursor that points to the position after the last result in the batch.",
- "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.",
"format": "int64",
@@ -607,13 +825,34 @@
"items": {
"$ref": "EntityResult"
}
+ },
+ "moreResults": {
+ "description": "The state of the query after the current batch.",
+ "type": "string",
+ "enumDescriptions": [
+ "Unspecified. This value is never used.",
+ "There may be additional batches to fetch from this query.",
+ "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",
+ "MORE_RESULTS_AFTER_LIMIT",
+ "MORE_RESULTS_AFTER_CURSOR",
+ "NO_MORE_RESULTS"
+ ]
+ },
+ "endCursor": {
+ "description": "A cursor that points to the position after the last result in the batch.",
+ "format": "byte",
+ "type": "string"
}
},
"id": "QueryResultBatch"
},
"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.",
@@ -626,17 +865,14 @@
"type": "string"
}
},
- "id": "GoogleDatastoreAdminV1beta1Progress"
+ "id": "GoogleDatastoreAdminV1beta1Progress",
+ "description": "Measures the progress of a particular metric.",
+ "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.",
"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"
@@ -644,6 +880,11 @@
"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"
@@ -694,46 +935,10 @@
},
"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": {
- "properties": {
- "batch": {
- "description": "A batch of query results (always present).",
- "$ref": "QueryResultBatch"
- },
- "query": {
- "description": "The parsed form of the `GqlQuery` from the request, if it was set.",
- "$ref": "Query"
- }
- },
- "id": "RunQueryResponse",
- "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",
@@ -747,26 +952,76 @@
"items": {
"$ref": "EntityResult"
}
+ },
+ "deferred": {
+ "description": "A list of keys that were not looked up due to resource constraints. The\norder of results in this field is undefined and has no relation to the\norder of the keys in the input.",
+ "type": "array",
+ "items": {
+ "$ref": "Key"
+ }
}
},
"id": "LookupResponse"
},
- "CommitRequest": {
- "description": "The request for Datastore.Commit.",
+ "RunQueryResponse": {
+ "properties": {
+ "query": {
+ "description": "The parsed form of the `GqlQuery` from the request, if it was set.",
+ "$ref": "Query"
+ },
+ "batch": {
+ "description": "A batch of query results (always present).",
+ "$ref": "QueryResultBatch"
+ }
+ },
+ "id": "RunQueryResponse",
+ "description": "The response for Datastore.RunQuery.",
+ "type": "object"
+ },
+ "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": {
+ "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": {
+ "enum": [
+ "MODE_UNSPECIFIED",
+ "TRANSACTIONAL",
+ "NON_TRANSACTIONAL"
+ ],
"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": {
@@ -775,48 +1030,34 @@
"items": {
"$ref": "Mutation"
}
- },
- "transaction": {
- "description": "The identifier of the transaction associated with the commit. A\ntransaction identifier is returned by a call to\nDatastore.BeginTransaction.",
- "format": "byte",
- "type": "string"
}
},
- "id": "CommitRequest"
- },
- "BeginTransactionRequest": {
- "properties": {
- "transactionOptions": {
- "$ref": "TransactionOptions",
- "description": "Options for a new transaction."
- }
- },
- "id": "BeginTransactionRequest",
- "description": "The request for Datastore.BeginTransaction.",
+ "id": "CommitRequest",
+ "description": "The request for Datastore.Commit.",
"type": "object"
},
"KindExpression": {
+ "description": "A representation of a kind.",
+ "type": "object",
"properties": {
"name": {
"description": "The name of the kind.",
"type": "string"
}
},
- "id": "KindExpression",
- "description": "A representation of a kind.",
- "type": "object"
+ "id": "KindExpression"
},
"LatLng": {
"description": "An object representing a latitude/longitude pair. This is expressed as a pair\nof doubles representing degrees latitude and degrees longitude. Unless\nspecified otherwise, this must conform to the\n\u003ca href=\"http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf\"\u003eWGS84\nstandard\u003c/a\u003e. Values must be within normalized ranges.",
"type": "object",
"properties": {
- "latitude": {
- "description": "The latitude in degrees. It must be in the range [-90.0, +90.0].",
+ "longitude": {
+ "description": "The longitude in degrees. It must be in the range [-180.0, +180.0].",
"format": "double",
"type": "number"
},
- "longitude": {
- "description": "The longitude in degrees. It must be in the range [-180.0, +180.0].",
+ "latitude": {
+ "description": "The latitude in degrees. It must be in the range [-90.0, +90.0].",
"format": "double",
"type": "number"
}
@@ -827,30 +1068,28 @@
"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": {
+ "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"
+ },
"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"
},
"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.",
- "type": "object"
+ }
},
"endTime": {
"description": "The time the operation ended, either successfully or otherwise.",
@@ -901,7 +1140,9 @@
"type": "string"
}
},
- "id": "GoogleDatastoreAdminV1beta1CommonMetadata"
+ "id": "GoogleDatastoreAdminV1beta1CommonMetadata",
+ "description": "Metadata common to all Datastore Admin operations.",
+ "type": "object"
},
"ArrayValue": {
"description": "An array value.",
@@ -918,19 +1159,17 @@
"id": "ArrayValue"
},
"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",
- "description": "The response for\ngoogle.datastore.admin.v1beta1.DatastoreAdmin.ExportEntities.",
- "type": "object"
+ "id": "GoogleDatastoreAdminV1beta1ExportEntitiesResponse"
},
"GqlQuery": {
- "description": "A [GQL query](https://cloud.google.com/datastore/docs/apis/gql/gql_reference).",
- "type": "object",
"properties": {
"queryString": {
"description": "A string of the format described\n[here](https://cloud.google.com/datastore/docs/apis/gql/gql_reference).",
@@ -941,11 +1180,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.",
@@ -955,41 +1194,35 @@
}
}
},
- "id": "GqlQuery"
+ "id": "GqlQuery",
+ "description": "A [GQL query](https://cloud.google.com/datastore/docs/apis/gql/gql_reference).",
+ "type": "object"
},
"Filter": {
"description": "A holder for any type of filter.",
"type": "object",
"properties": {
- "propertyFilter": {
- "description": "A filter on a property.",
- "$ref": "PropertyFilter"
- },
"compositeFilter": {
- "description": "A composite filter.",
- "$ref": "CompositeFilter"
+ "$ref": "CompositeFilter",
+ "description": "A composite filter."
+ },
+ "propertyFilter": {
+ "$ref": "PropertyFilter",
+ "description": "A filter on a property."
}
},
"id": "Filter"
},
"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"
},
"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."
@@ -997,6 +1230,14 @@
"gqlQuery": {
"$ref": "GqlQuery",
"description": "The GQL query to run."
+ },
+ "readOptions": {
+ "description": "The options for this query.",
+ "$ref": "ReadOptions"
+ },
+ "query": {
+ "$ref": "Query",
+ "description": "The query to run."
}
},
"id": "RunQueryRequest"
@@ -1010,8 +1251,8 @@
"$ref": "ReadWrite"
},
"readOnly": {
- "description": "The transaction should only allow reads.",
- "$ref": "ReadOnly"
+ "$ref": "ReadOnly",
+ "description": "The transaction should only allow reads."
}
},
"id": "TransactionOptions"
@@ -1025,8 +1266,8 @@
"$ref": "GoogleDatastoreAdminV1beta1Progress"
},
"common": {
- "description": "Metadata common to all Datastore Admin operations.",
- "$ref": "GoogleDatastoreAdminV1beta1CommonMetadata"
+ "$ref": "GoogleDatastoreAdminV1beta1CommonMetadata",
+ "description": "Metadata common to all Datastore Admin operations."
},
"progressBytes": {
"description": "An estimate of the number of bytes processed.",
@@ -1045,27 +1286,6 @@
},
"Query": {
"properties": {
- "kind": {
- "description": "The kinds to query (if empty, returns entities of all kinds).\nCurrently at most 1 kind may be specified.",
- "type": "array",
- "items": {
- "$ref": "KindExpression"
- }
- },
- "distinctOn": {
- "description": "The properties to make distinct. The query results will contain the first\nresult for each distinct combination of values for the given properties\n(if empty, all results are returned).",
- "type": "array",
- "items": {
- "$ref": "PropertyReference"
- }
- },
- "order": {
- "description": "The order to apply to the query results (if empty, order is unspecified).",
- "type": "array",
- "items": {
- "$ref": "PropertyOrder"
- }
- },
"projection": {
"description": "The projection to return. Defaults to returning all properties.",
"type": "array",
@@ -1096,6 +1316,27 @@
"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",
+ "items": {
+ "$ref": "KindExpression"
+ }
+ },
+ "distinctOn": {
+ "description": "The properties to make distinct. The query results will contain the first\nresult for each distinct combination of values for the given properties\n(if empty, all results are returned).",
+ "type": "array",
+ "items": {
+ "$ref": "PropertyReference"
+ }
+ },
+ "order": {
+ "description": "The order to apply to the query results (if empty, order is unspecified).",
+ "type": "array",
+ "items": {
+ "$ref": "PropertyOrder"
+ }
}
},
"id": "Query",
@@ -1112,6 +1353,10 @@
"description": "The result of fetching an entity from Datastore.",
"type": "object",
"properties": {
+ "entity": {
+ "$ref": "Entity",
+ "description": "The resulting entity."
+ },
"cursor": {
"description": "A cursor that points to the position after the result entity.\nSet only when the `EntityResult` is part of a `QueryResultBatch` message.",
"format": "byte",
@@ -1121,18 +1366,40 @@
"description": "The version of the entity, a strictly positive number that monotonically\nincreases with changes to the entity.\n\nThis field is set for `FULL` entity\nresults.\n\nFor missing entities in `LookupResponse`, this\nis the version of the snapshot that was used to look up the entity, and it\nis always set except for eventually consistent reads.",
"format": "int64",
"type": "string"
- },
- "entity": {
- "description": "The resulting entity.",
- "$ref": "Entity"
}
},
"id": "EntityResult"
},
"Value": {
- "description": "A message that can hold any of the supported value types and associated\nmetadata.",
- "type": "object",
"properties": {
+ "excludeFromIndexes": {
+ "description": "If the value should be excluded from all indexes including those defined\nexplicitly.",
+ "type": "boolean"
+ },
+ "doubleValue": {
+ "description": "A double value.",
+ "format": "double",
+ "type": "number"
+ },
+ "timestampValue": {
+ "description": "A timestamp value.\nWhen stored in the Datastore, precise only to microseconds;\nany additional precision is rounded down.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "booleanValue": {
+ "description": "A boolean value.",
+ "type": "boolean"
+ },
+ "nullValue": {
+ "description": "A null value.",
+ "type": "string",
+ "enumDescriptions": [
+ "Null value."
+ ],
+ "enum": [
+ "NULL_VALUE"
+ ]
+ },
"blobValue": {
"description": "A blob value.\nMay have at most 1,000,000 bytes.\nWhen `exclude_from_indexes` is false, may have at most 1500 bytes.\nIn JSON requests, must be base64-encoded.",
"format": "byte",
@@ -1148,56 +1415,30 @@
"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": {
- "$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."
+ "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": {
- "description": "A geo point value representing a point on the surface of Earth.",
- "$ref": "LatLng"
+ "$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"
},
- "keyValue": {
- "$ref": "Key",
- "description": "A key value."
- },
"stringValue": {
"description": "A UTF-8 encoded string value.\nWhen `exclude_from_indexes` is false (it is indexed) , may have at most 1500 bytes.\nOtherwise, may be set to at least 1,000,000 bytes.",
"type": "string"
- },
- "excludeFromIndexes": {
- "description": "If the value should be excluded from all indexes including those defined\nexplicitly.",
- "type": "boolean"
- },
- "doubleValue": {
- "description": "A double value.",
- "format": "double",
- "type": "number"
- },
- "timestampValue": {
- "description": "A timestamp value.\nWhen stored in the Datastore, precise only to microseconds;\nany additional precision is rounded down.",
- "format": "google-datetime",
- "type": "string"
- },
- "nullValue": {
- "description": "A null value.",
- "type": "string",
- "enumDescriptions": [
- "Null value."
- ],
- "enum": [
- "NULL_VALUE"
- ]
- },
- "booleanValue": {
- "description": "A boolean value.",
- "type": "boolean"
}
},
- "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.",
@@ -1212,6 +1453,8 @@
"id": "ReadWrite"
},
"LookupRequest": {
+ "description": "The request for Datastore.Lookup.",
+ "type": "object",
"properties": {
"keys": {
"description": "Keys of entities to look up.",
@@ -1221,34 +1464,43 @@
}
},
"readOptions": {
- "description": "The options for this lookup request.",
- "$ref": "ReadOptions"
+ "$ref": "ReadOptions",
+ "description": "The options for this lookup request."
}
},
- "id": "LookupRequest",
- "description": "The request for Datastore.Lookup.",
- "type": "object"
+ "id": "LookupRequest"
},
"ReserveIdsRequest": {
"description": "The request for Datastore.ReserveIds.",
"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"
},
"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",
@@ -1259,253 +1511,9 @@
},
"type": "object"
}
- },
- "code": {
- "description": "The status code, which should be an enum value of google.rpc.Code.",
- "format": "int32",
- "type": "integer"
- },
- "message": {
- "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
- "type": "string"
}
},
- "id": "Status",
- "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
- "type": "object"
- },
- "PropertyOrder": {
- "description": "The desired order for a specific property.",
- "type": "object",
- "properties": {
- "property": {
- "$ref": "PropertyReference",
- "description": "The property to order by."
- },
- "direction": {
- "description": "The direction to order by. Defaults to `ASCENDING`.",
- "type": "string",
- "enumDescriptions": [
- "Unspecified. This value must not be used.",
- "Ascending.",
- "Descending."
- ],
- "enum": [
- "DIRECTION_UNSPECIFIED",
- "ASCENDING",
- "DESCENDING"
- ]
- }
- },
- "id": "PropertyOrder"
- },
- "ReserveIdsResponse": {
- "properties": {},
- "id": "ReserveIdsResponse",
- "description": "The response for Datastore.ReserveIds.",
- "type": "object"
- },
- "PropertyReference": {
- "description": "A reference to a property relative to the kind expressions.",
- "type": "object",
- "properties": {
- "name": {
- "description": "The name of the property.\nIf name includes \".\"s, it may be interpreted as a property name path.",
- "type": "string"
- }
- },
- "id": "PropertyReference"
- },
- "GoogleDatastoreAdminV1beta1EntityFilter": {
- "description": "Identifies a subset of entities in a project. This is specified as\ncombinations of kinds and namespaces (either or both of which may be all, as\ndescribed in the following examples).\nExample usage:\n\nEntire project:\n kinds=[], namespace_ids=[]\n\nKinds Foo and Bar in all namespaces:\n kinds=['Foo', 'Bar'], namespace_ids=[]\n\nKinds Foo and Bar only in the default namespace:\n kinds=['Foo', 'Bar'], namespace_ids=['']\n\nKinds Foo and Bar in both the default and Baz namespaces:\n kinds=['Foo', 'Bar'], namespace_ids=['', 'Baz']\n\nThe entire Baz namespace:\n kinds=[], namespace_ids=['Baz']",
- "type": "object",
- "properties": {
- "kinds": {
- "description": "If empty, then this represents all kinds.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "namespaceIds": {
- "description": "An empty list represents all namespaces. This is the preferred\nusage for projects that don't use namespaces.\n\nAn empty string element represents the default namespace. This should be\nused if the project has data in non-default namespaces, but doesn't want to\ninclude them.\nEach namespace in this list must be unique.",
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "id": "GoogleDatastoreAdminV1beta1EntityFilter"
- },
- "Projection": {
- "description": "A representation of a property in a projection.",
- "type": "object",
- "properties": {
- "property": {
- "$ref": "PropertyReference",
- "description": "The property to project."
- }
- },
- "id": "Projection"
- },
- "Mutation": {
- "description": "A mutation to apply to an entity.",
- "type": "object",
- "properties": {
- "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": {
- "$ref": "Entity",
- "description": "The entity to insert. The entity must not already exist.\nThe entity key's final path element may be incomplete."
- },
- "baseVersion": {
- "description": "The version of the entity that this mutation is being applied to. If this\ndoes not match the current version on the server, the mutation conflicts.",
- "format": "int64",
- "type": "string"
- },
- "update": {
- "$ref": "Entity",
- "description": "The entity to update. The entity must already exist.\nMust have a complete key path."
- },
- "upsert": {
- "$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": {
- "enum": [
- "READ_CONSISTENCY_UNSPECIFIED",
- "STRONG",
- "EVENTUAL"
- ],
- "description": "The non-transactional read consistency to use.\nCannot be set to `STRONG` for global queries.",
- "type": "string",
- "enumDescriptions": [
- "Unspecified. This value must not be used.",
- "Strong consistency.",
- "Eventual consistency."
- ]
- },
- "transaction": {
- "description": "The identifier of the transaction in which to read. A\ntransaction identifier is returned by a call to\nDatastore.BeginTransaction.",
- "format": "byte",
- "type": "string"
- }
- },
- "id": "ReadOptions"
- },
- "RollbackResponse": {
- "properties": {},
- "id": "RollbackResponse",
- "description": "The response for Datastore.Rollback.\n(an empty message).",
- "type": "object"
- },
- "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"
- }
- },
- "id": "MutationResult"
- },
- "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"
- },
- "GoogleDatastoreAdminV1beta1ExportEntitiesMetadata": {
- "description": "Metadata for ExportEntities operations.",
- "type": "object",
- "properties": {
- "common": {
- "description": "Metadata common to all Datastore Admin operations.",
- "$ref": "GoogleDatastoreAdminV1beta1CommonMetadata"
- },
- "progressBytes": {
- "description": "An estimate of the number of bytes processed.",
- "$ref": "GoogleDatastoreAdminV1beta1Progress"
- },
- "entityFilter": {
- "$ref": "GoogleDatastoreAdminV1beta1EntityFilter",
- "description": "Description of which entities are being exported."
- },
- "outputUrlPrefix": {
- "description": "Location for the export metadata and data files. This will be the same\nvalue as the\ngoogle.datastore.admin.v1beta1.ExportEntitiesRequest.output_url_prefix\nfield. The final output location is provided in\ngoogle.datastore.admin.v1beta1.ExportEntitiesResponse.output_url.",
- "type": "string"
- },
- "progressEntities": {
- "description": "An estimate of the number of entities processed.",
- "$ref": "GoogleDatastoreAdminV1beta1Progress"
- }
- },
- "id": "GoogleDatastoreAdminV1beta1ExportEntitiesMetadata"
- },
- "CompositeFilter": {
- "properties": {
- "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"
- },
- "filters": {
- "description": "The list of filters to combine.\nMust contain at least one filter.",
- "type": "array",
- "items": {
- "$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.",
- "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"
+ "id": "Status"
}
},
"icons": {
@@ -1518,11 +1526,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/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"
}
}
}
@@ -1530,13 +1538,5 @@
"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",
- "documentationLink": "https://cloud.google.com/datastore/",
- "id": "datastore:v1",
- "revision": "20171212",
- "title": "Google Cloud Datastore API"
+ "rootUrl": "https://datastore.googleapis.com/"
}
diff --git a/datastore/v1beta1/datastore-api.json b/datastore/v1beta1/datastore-api.json
index e533f85..88a212a 100644
--- a/datastore/v1beta1/datastore-api.json
+++ b/datastore/v1beta1/datastore-api.json
@@ -1,25 +1,30 @@
{
- "discoveryVersion": "v1",
+ "title": "Google Cloud Datastore API",
"ownerName": "Google",
+ "discoveryVersion": "v1",
"version_module": true,
"resources": {
"projects": {
"methods": {
"export": {
"flatPath": "v1beta1/projects/{projectId}:export",
- "id": "datastore.projects.export",
"path": "v1beta1/projects/{projectId}:export",
+ "id": "datastore.projects.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"
},
- "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.",
- "httpMethod": "POST",
- "parameterOrder": [
- "projectId"
- ],
"response": {
"$ref": "GoogleLongrunningOperation"
},
+ "parameterOrder": [
+ "projectId"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/datastore"
+ ],
"parameters": {
"projectId": {
"description": "Project ID against which to make the request.",
@@ -27,30 +32,26 @@
"type": "string",
"location": "path"
}
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/datastore"
- ]
+ }
},
"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"
- },
+ "httpMethod": "POST",
"parameterOrder": [
"projectId"
],
- "httpMethod": "POST",
+ "response": {
+ "$ref": "GoogleLongrunningOperation"
+ },
"parameters": {
"projectId": {
+ "location": "path",
"description": "Project ID against which to make the request.",
"required": true,
- "type": "string",
- "location": "path"
+ "type": "string"
}
},
"scopes": [
@@ -58,52 +59,14 @@
"https://www.googleapis.com/auth/datastore"
],
"flatPath": "v1beta1/projects/{projectId}:import",
- "path": "v1beta1/projects/{projectId}:import",
- "id": "datastore.projects.import"
+ "id": "datastore.projects.import",
+ "path": "v1beta1/projects/{projectId}:import"
}
}
}
},
"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"
- },
- "fields": {
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string",
- "location": "query"
- },
- "uploadType": {
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string",
- "location": "query"
- },
- "callback": {
- "location": "query",
- "description": "JSONP",
- "type": "string"
- },
"$.xgafv": {
- "description": "V1 error format.",
- "type": "string",
"enumDescriptions": [
"v1 error format",
"v2 error format"
@@ -112,7 +75,14 @@
"enum": [
"1",
"2"
- ]
+ ],
+ "description": "V1 error format.",
+ "type": "string"
+ },
+ "callback": {
+ "description": "JSONP",
+ "type": "string",
+ "location": "query"
},
"alt": {
"type": "string",
@@ -131,14 +101,14 @@
]
},
"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": {
- "location": "query",
"description": "OAuth access token.",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"quotaUser": {
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
@@ -146,107 +116,51 @@
"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"
+ },
+ "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": {
- "GoogleDatastoreAdminV1beta1ImportEntitiesRequest": {
- "description": "The request for\ngoogle.datastore.admin.v1beta1.DatastoreAdmin.ImportEntities.",
- "type": "object",
- "properties": {
- "labels": {
- "description": "Client-assigned labels.",
- "type": "object",
- "additionalProperties": {
- "type": "string"
- }
- },
- "inputUrl": {
- "description": "The full resource URL of the external storage location. Currently, only\nGoogle Cloud Storage is supported. So input_url should be of the form:\n`gs://BUCKET_NAME[/NAMESPACE_PATH]/OVERALL_EXPORT_METADATA_FILE`, where\n`BUCKET_NAME` is the name of the Cloud Storage bucket, `NAMESPACE_PATH` is\nan optional Cloud Storage namespace path (this is not a Cloud Datastore\nnamespace), and `OVERALL_EXPORT_METADATA_FILE` is the metadata file written\nby the ExportEntities operation. For more information about Cloud Storage\nnamespace paths, see\n[Object name\nconsiderations](https://cloud.google.com/storage/docs/naming#object-considerations).\n\nFor more information, see\ngoogle.datastore.admin.v1beta1.ExportEntitiesResponse.output_url.",
- "type": "string"
- },
- "entityFilter": {
- "description": "Optionally specify which kinds/namespaces are to be imported. If provided,\nthe list must be a subset of the EntityFilter used in creating the export,\notherwise a FAILED_PRECONDITION error will be returned. If no filter is\nspecified then all entities from the export are imported.",
- "$ref": "GoogleDatastoreAdminV1beta1EntityFilter"
- }
- },
- "id": "GoogleDatastoreAdminV1beta1ImportEntitiesRequest"
- },
- "GoogleDatastoreAdminV1beta1ImportEntitiesMetadata": {
- "description": "Metadata for ImportEntities operations.",
- "type": "object",
- "properties": {
- "progressBytes": {
- "$ref": "GoogleDatastoreAdminV1beta1Progress",
- "description": "An estimate of the number of bytes processed."
- },
- "inputUrl": {
- "description": "The location of the import metadata file. This will be the same value as\nthe google.datastore.admin.v1beta1.ExportEntitiesResponse.output_url\nfield.",
- "type": "string"
- },
- "entityFilter": {
- "description": "Description of which entities are being imported.",
- "$ref": "GoogleDatastoreAdminV1beta1EntityFilter"
- },
- "progressEntities": {
- "$ref": "GoogleDatastoreAdminV1beta1Progress",
- "description": "An estimate of the number of entities processed."
- },
- "common": {
- "$ref": "GoogleDatastoreAdminV1beta1CommonMetadata",
- "description": "Metadata common to all Datastore Admin operations."
- }
- },
- "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": {
- "description": "The amount of work that has been completed. Note that this may be greater\nthan work_estimated.",
- "format": "int64",
- "type": "string"
- }
- },
- "id": "GoogleDatastoreAdminV1beta1Progress"
- },
- "GoogleDatastoreAdminV1beta1EntityFilter": {
- "description": "Identifies a subset of entities in a project. This is specified as\ncombinations of kinds and namespaces (either or both of which may be all, as\ndescribed in the following examples).\nExample usage:\n\nEntire project:\n kinds=[], namespace_ids=[]\n\nKinds Foo and Bar in all namespaces:\n kinds=['Foo', 'Bar'], namespace_ids=[]\n\nKinds Foo and Bar only in the default namespace:\n kinds=['Foo', 'Bar'], namespace_ids=['']\n\nKinds Foo and Bar in both the default and Baz namespaces:\n kinds=['Foo', 'Bar'], namespace_ids=['', 'Baz']\n\nThe entire Baz namespace:\n kinds=[], namespace_ids=['Baz']",
- "type": "object",
- "properties": {
- "kinds": {
- "description": "If empty, then this represents all kinds.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "namespaceIds": {
- "description": "An empty list represents all namespaces. This is the preferred\nusage for projects that don't use namespaces.\n\nAn empty string element represents the default namespace. This should be\nused if the project has data in non-default namespaces, but doesn't want to\ninclude them.\nEach namespace in this list must be unique.",
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "id": "GoogleDatastoreAdminV1beta1EntityFilter"
- },
"GoogleLongrunningOperation": {
"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"
+ "$ref": "Status",
+ "description": "The error result of the operation in case of failure or cancellation."
},
"metadata": {
"additionalProperties": {
@@ -275,16 +189,37 @@
},
"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": {
+ "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"
+ },
"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.",
+ "type": "object"
},
"endTime": {
"description": "The time the operation ended, either successfully or otherwise.",
@@ -292,8 +227,6 @@
"type": "string"
},
"operationType": {
- "description": "The type of the operation. Can be used as a filter in\nListOperationsRequest.",
- "type": "string",
"enumDescriptions": [
"Unspecified.",
"ExportEntities.",
@@ -303,9 +236,13 @@
"OPERATION_TYPE_UNSPECIFIED",
"EXPORT_ENTITIES",
"IMPORT_ENTITIES"
- ]
+ ],
+ "description": "The type of the operation. Can be used as a filter in\nListOperationsRequest.",
+ "type": "string"
},
"state": {
+ "description": "The current state of the Operation.",
+ "type": "string",
"enumDescriptions": [
"Unspecified.",
"Request is being prepared for processing.",
@@ -325,9 +262,7 @@
"SUCCESSFUL",
"FAILED",
"CANCELLED"
- ],
- "description": "The current state of the Operation.",
- "type": "string"
+ ]
},
"startTime": {
"description": "The time that work began on the operation.",
@@ -341,6 +276,17 @@
"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",
@@ -349,58 +295,21 @@
"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"
},
- "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"
- },
"GoogleDatastoreAdminV1beta1ExportEntitiesMetadata": {
"description": "Metadata for ExportEntities operations.",
"type": "object",
"properties": {
- "common": {
- "description": "Metadata common to all Datastore Admin operations.",
- "$ref": "GoogleDatastoreAdminV1beta1CommonMetadata"
- },
"progressBytes": {
- "$ref": "GoogleDatastoreAdminV1beta1Progress",
- "description": "An estimate of the number of bytes processed."
+ "description": "An estimate of the number of bytes processed.",
+ "$ref": "GoogleDatastoreAdminV1beta1Progress"
},
"entityFilter": {
- "description": "Description of which entities are being exported.",
- "$ref": "GoogleDatastoreAdminV1beta1EntityFilter"
+ "$ref": "GoogleDatastoreAdminV1beta1EntityFilter",
+ "description": "Description of which entities are being exported."
},
"outputUrlPrefix": {
"description": "Location for the export metadata and data files. This will be the same\nvalue as the\ngoogle.datastore.admin.v1beta1.ExportEntitiesRequest.output_url_prefix\nfield. The final output location is provided in\ngoogle.datastore.admin.v1beta1.ExportEntitiesResponse.output_url.",
@@ -409,10 +318,36 @@
"progressEntities": {
"description": "An estimate of the number of entities processed.",
"$ref": "GoogleDatastoreAdminV1beta1Progress"
+ },
+ "common": {
+ "$ref": "GoogleDatastoreAdminV1beta1CommonMetadata",
+ "description": "Metadata common to all Datastore Admin operations."
}
},
"id": "GoogleDatastoreAdminV1beta1ExportEntitiesMetadata"
},
+ "GoogleDatastoreAdminV1beta1ExportEntitiesRequest": {
+ "description": "The request for\ngoogle.datastore.admin.v1beta1.DatastoreAdmin.ExportEntities.",
+ "type": "object",
+ "properties": {
+ "labels": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Client-assigned labels.",
+ "type": "object"
+ },
+ "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"
+ }
+ },
+ "id": "GoogleDatastoreAdminV1beta1ExportEntitiesRequest"
+ },
"GoogleDatastoreAdminV1beta1ExportEntitiesResponse": {
"description": "The response for\ngoogle.datastore.admin.v1beta1.DatastoreAdmin.ExportEntities.",
"type": "object",
@@ -423,6 +358,72 @@
}
},
"id": "GoogleDatastoreAdminV1beta1ExportEntitiesResponse"
+ },
+ "GoogleDatastoreAdminV1beta1ImportEntitiesMetadata": {
+ "description": "Metadata for ImportEntities operations.",
+ "type": "object",
+ "properties": {
+ "common": {
+ "description": "Metadata common to all Datastore Admin operations.",
+ "$ref": "GoogleDatastoreAdminV1beta1CommonMetadata"
+ },
+ "progressBytes": {
+ "description": "An estimate of the number of bytes processed.",
+ "$ref": "GoogleDatastoreAdminV1beta1Progress"
+ },
+ "inputUrl": {
+ "description": "The location of the import metadata file. This will be the same value as\nthe google.datastore.admin.v1beta1.ExportEntitiesResponse.output_url\nfield.",
+ "type": "string"
+ },
+ "entityFilter": {
+ "description": "Description of which entities are being imported.",
+ "$ref": "GoogleDatastoreAdminV1beta1EntityFilter"
+ },
+ "progressEntities": {
+ "description": "An estimate of the number of entities processed.",
+ "$ref": "GoogleDatastoreAdminV1beta1Progress"
+ }
+ },
+ "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": {
+ "$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": {
+ "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"
}
},
"icons": {
@@ -444,16 +445,15 @@
}
}
},
- "servicePath": "",
- "description": "Accesses the schemaless NoSQL database to provide fully managed, robust, scalable storage for your application.\n",
"kind": "discovery#restDescription",
+ "description": "Accesses the schemaless NoSQL database to provide fully managed, robust, scalable storage for your application.\n",
+ "servicePath": "",
"rootUrl": "https://datastore.googleapis.com/",
"basePath": "",
"ownerDomain": "google.com",
"name": "datastore",
"batchPath": "batch",
- "revision": "20171212",
- "documentationLink": "https://cloud.google.com/datastore/",
"id": "datastore:v1beta1",
- "title": "Google Cloud Datastore API"
+ "documentationLink": "https://cloud.google.com/datastore/",
+ "revision": "20171212"
}
diff --git a/datastore/v1beta3/datastore-api.json b/datastore/v1beta3/datastore-api.json
index 858837e..b01dbf1 100644
--- a/datastore/v1beta3/datastore-api.json
+++ b/datastore/v1beta3/datastore-api.json
@@ -1,48 +1,33 @@
{
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/datastore": {
- "description": "View and manage your Google Cloud Datastore data"
- },
- "https://www.googleapis.com/auth/cloud-platform": {
- "description": "View and manage your data across Google Cloud Platform services"
- }
- }
- }
- },
- "kind": "discovery#restDescription",
- "description": "Accesses the schemaless NoSQL database to provide fully managed, robust, scalable storage for your application.\n",
- "servicePath": "",
"rootUrl": "https://datastore.googleapis.com/",
"basePath": "",
"ownerDomain": "google.com",
"name": "datastore",
"batchPath": "batch",
- "revision": "20171212",
- "documentationLink": "https://cloud.google.com/datastore/",
"id": "datastore:v1beta3",
+ "documentationLink": "https://cloud.google.com/datastore/",
+ "revision": "20171212",
"title": "Google Cloud Datastore API",
- "discoveryVersion": "v1",
"ownerName": "Google",
+ "discoveryVersion": "v1",
"version_module": true,
"resources": {
"projects": {
"methods": {
"allocateIds": {
- "httpMethod": "POST",
- "parameterOrder": [
- "projectId"
- ],
"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",
- "location": "path"
+ "type": "string"
}
},
"scopes": [
@@ -50,27 +35,27 @@
"https://www.googleapis.com/auth/datastore"
],
"flatPath": "v1beta3/projects/{projectId}:allocateIds",
- "id": "datastore.projects.allocateIds",
"path": "v1beta3/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": {
- "httpMethod": "POST",
- "parameterOrder": [
- "projectId"
- ],
"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",
- "location": "path"
+ "type": "string"
}
},
"scopes": [
@@ -78,14 +63,20 @@
"https://www.googleapis.com/auth/datastore"
],
"flatPath": "v1beta3/projects/{projectId}:beginTransaction",
- "id": "datastore.projects.beginTransaction",
"path": "v1beta3/projects/{projectId}:beginTransaction",
+ "id": "datastore.projects.beginTransaction",
"request": {
"$ref": "BeginTransactionRequest"
},
"description": "Begins a new transaction."
},
"commit": {
+ "path": "v1beta3/projects/{projectId}:commit",
+ "id": "datastore.projects.commit",
+ "description": "Commits a transaction, optionally creating, deleting or modifying some\nentities.",
+ "request": {
+ "$ref": "CommitRequest"
+ },
"response": {
"$ref": "CommitResponse"
},
@@ -93,6 +84,10 @@
"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.",
@@ -101,17 +96,7 @@
"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."
+ "flatPath": "v1beta3/projects/{projectId}:commit"
},
"reserveIds": {
"response": {
@@ -141,7 +126,41 @@
},
"description": "Prevents the supplied keys' IDs from being auto-allocated by Cloud\nDatastore."
},
+ "rollback": {
+ "path": "v1beta3/projects/{projectId}:rollback",
+ "id": "datastore.projects.rollback",
+ "description": "Rolls back a transaction.",
+ "request": {
+ "$ref": "RollbackRequest"
+ },
+ "response": {
+ "$ref": "RollbackResponse"
+ },
+ "parameterOrder": [
+ "projectId"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/datastore"
+ ],
+ "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": {
+ "path": "v1beta3/projects/{projectId}:runQuery",
+ "id": "datastore.projects.runQuery",
+ "description": "Queries for entities.",
+ "request": {
+ "$ref": "RunQueryRequest"
+ },
"response": {
"$ref": "RunQueryResponse"
},
@@ -155,100 +174,55 @@
],
"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": {
- "request": {
- "$ref": "RollbackRequest"
- },
- "description": "Rolls back a transaction.",
- "response": {
- "$ref": "RollbackResponse"
- },
- "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": "v1beta3/projects/{projectId}:rollback",
- "path": "v1beta3/projects/{projectId}:rollback",
- "id": "datastore.projects.rollback"
- },
- "lookup": {
- "httpMethod": "POST",
- "parameterOrder": [
- "projectId"
- ],
- "response": {
- "$ref": "LookupResponse"
- },
- "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"
+ },
+ "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"
],
- "flatPath": "v1beta3/projects/{projectId}:lookup",
- "id": "datastore.projects.lookup",
- "path": "v1beta3/projects/{projectId}:lookup",
- "request": {
- "$ref": "LookupRequest"
+ "parameters": {
+ "projectId": {
+ "location": "path",
+ "description": "The ID of the project against which to make the request.",
+ "required": true,
+ "type": "string"
+ }
},
- "description": "Looks up entities by key."
+ "flatPath": "v1beta3/projects/{projectId}:lookup",
+ "path": "v1beta3/projects/{projectId}:lookup",
+ "id": "datastore.projects.lookup"
}
}
}
},
"parameters": {
- "upload_protocol": {
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string",
- "location": "query"
- },
- "prettyPrint": {
- "description": "Returns response with indentations and line breaks.",
- "type": "boolean",
- "default": "true",
- "location": "query"
- },
"fields": {
"location": "query",
"description": "Selector specifying which fields to include in a partial response.",
"type": "string"
},
"uploadType": {
+ "location": "query",
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"$.xgafv": {
"enumDescriptions": [
@@ -285,14 +259,14 @@
"default": "json"
},
"access_token": {
- "location": "query",
"description": "OAuth access token.",
- "type": "string"
+ "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"
+ "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.",
@@ -300,10 +274,10 @@
"location": "query"
},
"pp": {
- "location": "query",
"description": "Pretty-print response.",
"type": "boolean",
- "default": "true"
+ "default": "true",
+ "location": "query"
},
"oauth_token": {
"description": "OAuth 2.0 token for the current user.",
@@ -311,193 +285,44 @@
"location": "query"
},
"bearer_token": {
- "location": "query",
"description": "OAuth bearer token.",
+ "type": "string",
+ "location": "query"
+ },
+ "upload_protocol": {
+ "location": "query",
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"type": "string"
+ },
+ "prettyPrint": {
+ "location": "query",
+ "description": "Returns response with indentations and line breaks.",
+ "type": "boolean",
+ "default": "true"
}
},
"schemas": {
- "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": {
- "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": {
- "enum": [
- "STATE_UNSPECIFIED",
- "INITIALIZING",
- "PROCESSING",
- "CANCELLING",
- "FINALIZING",
- "SUCCESSFUL",
- "FAILED",
- "CANCELLED"
- ],
- "description": "The current state of the Operation.",
- "type": "string",
- "enumDescriptions": [
- "Unspecified.",
- "Request is being prepared for processing.",
- "Request is actively being processed.",
- "Request is in the process of being cancelled after user called\ngoogle.longrunning.Operations.CancelOperation on the operation.",
- "Request has been processed and is in its finalization stage.",
- "Request has completed successfully.",
- "Request has finished being processed, but encountered an error.",
- "Request has finished being cancelled after user called\ngoogle.longrunning.Operations.CancelOperation."
- ]
- },
- "startTime": {
- "description": "The time that work began on the operation.",
- "format": "google-datetime",
- "type": "string"
- }
- },
- "id": "GoogleDatastoreAdminV1beta1CommonMetadata",
- "description": "Metadata common to all Datastore Admin operations.",
- "type": "object"
- },
- "ArrayValue": {
- "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",
- "description": "An array value.",
- "type": "object"
- },
- "Projection": {
- "description": "A representation of a property in a projection.",
- "type": "object",
- "properties": {
- "property": {
- "description": "The property to project.",
- "$ref": "PropertyReference"
- }
- },
- "id": "Projection"
- },
- "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": {
- "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": {
- "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": {
+ "description": "The result of applying a mutation.",
+ "type": "object",
"properties": {
- "version": {
- "description": "The version of the entity on the server after processing the mutation. If\nthe mutation doesn't change anything on the server, then the version will\nbe the version of the current entity or, if no entity is present, a version\nthat is strictly greater than the version of any previous entity and less\nthan the version of any possible future entity.",
- "format": "int64",
- "type": "string"
- },
"conflictDetected": {
"description": "Whether a conflict was detected for this mutation. Always false when a\nconflict detection strategy field is not set in the mutation.",
"type": "boolean"
},
"key": {
- "$ref": "Key",
- "description": "The automatically allocated key.\nSet only when the mutation allocated a key."
+ "description": "The automatically allocated key.\nSet only when the mutation allocated a key.",
+ "$ref": "Key"
+ },
+ "version": {
+ "description": "The version of the entity on the server after processing the mutation. If\nthe mutation doesn't change anything on the server, then the version will\nbe the version of the current entity or, if no entity is present, a version\nthat is strictly greater than the version of any previous entity and less\nthan the version of any possible future entity.",
+ "format": "int64",
+ "type": "string"
}
},
- "id": "MutationResult",
- "description": "The result of applying a mutation.",
- "type": "object"
+ "id": "MutationResult"
},
"GqlQuery": {
- "description": "A [GQL query](https://cloud.google.com/datastore/docs/apis/gql/gql_reference).",
- "type": "object",
"properties": {
"queryString": {
"description": "A string of the format described\n[here](https://cloud.google.com/datastore/docs/apis/gql/gql_reference).",
@@ -522,34 +347,24 @@
}
}
},
- "id": "GqlQuery"
+ "id": "GqlQuery",
+ "description": "A [GQL query](https://cloud.google.com/datastore/docs/apis/gql/gql_reference).",
+ "type": "object"
},
"Filter": {
+ "description": "A holder for any type of filter.",
+ "type": "object",
"properties": {
"compositeFilter": {
- "description": "A composite filter.",
- "$ref": "CompositeFilter"
+ "$ref": "CompositeFilter",
+ "description": "A composite filter."
},
"propertyFilter": {
- "$ref": "PropertyFilter",
- "description": "A filter on a property."
+ "description": "A filter on a property.",
+ "$ref": "PropertyFilter"
}
},
- "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"
+ "id": "Filter"
},
"RunQueryRequest": {
"description": "The request for Datastore.RunQuery.",
@@ -574,6 +389,18 @@
},
"id": "RunQueryRequest"
},
+ "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"
+ },
"GoogleDatastoreAdminV1beta1ExportEntitiesMetadata": {
"properties": {
"progressEntities": {
@@ -585,12 +412,12 @@
"$ref": "GoogleDatastoreAdminV1beta1CommonMetadata"
},
"progressBytes": {
- "description": "An estimate of the number of bytes processed.",
- "$ref": "GoogleDatastoreAdminV1beta1Progress"
+ "$ref": "GoogleDatastoreAdminV1beta1Progress",
+ "description": "An estimate of the number of bytes processed."
},
"entityFilter": {
- "$ref": "GoogleDatastoreAdminV1beta1EntityFilter",
- "description": "Description of which entities are being exported."
+ "description": "Description of which entities are being exported.",
+ "$ref": "GoogleDatastoreAdminV1beta1EntityFilter"
},
"outputUrlPrefix": {
"description": "Location for the export metadata and data files. This will be the same\nvalue as the\ngoogle.datastore.admin.v1beta1.ExportEntitiesRequest.output_url_prefix\nfield. The final output location is provided in\ngoogle.datastore.admin.v1beta1.ExportEntitiesResponse.output_url.",
@@ -617,8 +444,6 @@
"id": "TransactionOptions"
},
"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.",
@@ -640,15 +465,19 @@
]
}
},
- "id": "CompositeFilter"
+ "id": "CompositeFilter",
+ "description": "A filter that merges multiple other filters using the given operator.",
+ "type": "object"
},
"GoogleDatastoreAdminV1beta1ImportEntitiesMetadata": {
- "description": "Metadata for ImportEntities operations.",
- "type": "object",
"properties": {
+ "progressEntities": {
+ "description": "An estimate of the number of entities processed.",
+ "$ref": "GoogleDatastoreAdminV1beta1Progress"
+ },
"common": {
- "$ref": "GoogleDatastoreAdminV1beta1CommonMetadata",
- "description": "Metadata common to all Datastore Admin operations."
+ "description": "Metadata common to all Datastore Admin operations.",
+ "$ref": "GoogleDatastoreAdminV1beta1CommonMetadata"
},
"progressBytes": {
"$ref": "GoogleDatastoreAdminV1beta1Progress",
@@ -661,13 +490,11 @@
"entityFilter": {
"description": "Description of which entities are being imported.",
"$ref": "GoogleDatastoreAdminV1beta1EntityFilter"
- },
- "progressEntities": {
- "description": "An estimate of the number of entities processed.",
- "$ref": "GoogleDatastoreAdminV1beta1Progress"
}
},
- "id": "GoogleDatastoreAdminV1beta1ImportEntitiesMetadata"
+ "id": "GoogleDatastoreAdminV1beta1ImportEntitiesMetadata",
+ "description": "Metadata for ImportEntities operations.",
+ "type": "object"
},
"AllocateIdsResponse": {
"properties": {
@@ -684,7 +511,23 @@
"type": "object"
},
"Query": {
+ "description": "A query for entities.",
+ "type": "object",
"properties": {
+ "order": {
+ "description": "The order to apply to the query results (if empty, order is unspecified).",
+ "type": "array",
+ "items": {
+ "$ref": "PropertyOrder"
+ }
+ },
+ "projection": {
+ "description": "The projection to return. Defaults to returning all properties.",
+ "type": "array",
+ "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",
@@ -722,35 +565,17 @@
"items": {
"$ref": "PropertyReference"
}
- },
- "order": {
- "description": "The order to apply to the query results (if empty, order is unspecified).",
- "type": "array",
- "items": {
- "$ref": "PropertyOrder"
- }
- },
- "projection": {
- "description": "The projection to return. Defaults to returning all properties.",
- "type": "array",
- "items": {
- "$ref": "Projection"
- }
}
},
- "id": "Query",
- "description": "A query for entities.",
- "type": "object"
+ "id": "Query"
},
"ReadOnly": {
- "description": "Options specific to read-only transactions.",
- "type": "object",
"properties": {},
- "id": "ReadOnly"
+ "id": "ReadOnly",
+ "description": "Options specific to read-only transactions.",
+ "type": "object"
},
"PropertyFilter": {
- "description": "A filter on a specific property.",
- "type": "object",
"properties": {
"value": {
"$ref": "Value",
@@ -761,6 +586,15 @@
"$ref": "PropertyReference"
},
"op": {
+ "enumDescriptions": [
+ "Unspecified. This value must not be used.",
+ "Less than.",
+ "Less than or equal.",
+ "Greater than.",
+ "Greater than or equal.",
+ "Equal.",
+ "Has ancestor."
+ ],
"enum": [
"OPERATOR_UNSPECIFIED",
"LESS_THAN",
@@ -771,21 +605,16 @@
"HAS_ANCESTOR"
],
"description": "The operator to filter by.",
- "type": "string",
- "enumDescriptions": [
- "Unspecified. This value must not be used.",
- "Less than.",
- "Less than or equal.",
- "Greater than.",
- "Greater than or equal.",
- "Equal.",
- "Has ancestor."
- ]
+ "type": "string"
}
},
- "id": "PropertyFilter"
+ "id": "PropertyFilter",
+ "description": "A filter on a specific property.",
+ "type": "object"
},
"EntityResult": {
+ "description": "The result of fetching an entity from Datastore.",
+ "type": "object",
"properties": {
"cursor": {
"description": "A cursor that points to the position after the result entity.\nSet only when the `EntityResult` is part of a `QueryResultBatch` message.",
@@ -802,13 +631,9 @@
"description": "The resulting entity."
}
},
- "id": "EntityResult",
- "description": "The result of fetching an entity from Datastore.",
- "type": "object"
+ "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.",
@@ -823,40 +648,12 @@
}
}
},
- "id": "CommitResponse"
+ "id": "CommitResponse",
+ "description": "The response for Datastore.Commit.",
+ "type": "object"
},
"Value": {
"properties": {
- "meaning": {
- "description": "The `meaning` field should only be populated for backwards compatibility.",
- "format": "int32",
- "type": "integer"
- },
- "arrayValue": {
- "$ref": "ArrayValue",
- "description": "An array value.\nCannot contain another array value.\nA `Value` instance that sets field `array_value` must not set fields\n`meaning` or `exclude_from_indexes`."
- },
- "entityValue": {
- "description": "An entity value.\n\n- May have no key.\n- May have a key with an incomplete key path.\n- May have a reserved/read-only key.",
- "$ref": "Entity"
- },
- "geoPointValue": {
- "$ref": "LatLng",
- "description": "A geo point value representing a point on the surface of Earth."
- },
- "keyValue": {
- "description": "A key value.",
- "$ref": "Key"
- },
- "integerValue": {
- "description": "An integer value.",
- "format": "int64",
- "type": "string"
- },
- "stringValue": {
- "description": "A UTF-8 encoded string value.\nWhen `exclude_from_indexes` is false (it is indexed) , may have at most 1500 bytes.\nOtherwise, may be set to at least 1,000,000 bytes.",
- "type": "string"
- },
"excludeFromIndexes": {
"description": "If the value should be excluded from all indexes including those defined\nexplicitly.",
"type": "boolean"
@@ -871,10 +668,6 @@
"format": "google-datetime",
"type": "string"
},
- "booleanValue": {
- "description": "A boolean value.",
- "type": "boolean"
- },
"nullValue": {
"enumDescriptions": [
"Null value."
@@ -885,10 +678,44 @@
"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",
"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": {
+ "description": "An entity value.\n\n- May have no key.\n- May have a key with an incomplete key path.\n- May have a reserved/read-only key.",
+ "$ref": "Entity"
+ },
+ "geoPointValue": {
+ "$ref": "LatLng",
+ "description": "A geo point value representing a point on the surface of Earth."
+ },
+ "integerValue": {
+ "description": "An integer value.",
+ "format": "int64",
+ "type": "string"
+ },
+ "keyValue": {
+ "$ref": "Key",
+ "description": "A key value."
+ },
+ "stringValue": {
+ "description": "A UTF-8 encoded string value.\nWhen `exclude_from_indexes` is false (it is indexed) , may have at most 1500 bytes.\nOtherwise, may be set to at least 1,000,000 bytes.",
+ "type": "string"
}
},
"id": "Value",
@@ -899,36 +726,20 @@
"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": {
+ "description": "The ID of the project to which the entities belong.",
+ "type": "string"
}
},
"id": "PartitionId"
},
- "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",
- "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."
- },
- "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"
- }
- },
- "id": "Entity"
- },
"ReadWrite": {
+ "description": "Options specific to read / write transactions.",
+ "type": "object",
"properties": {
"previousTransaction": {
"description": "The transaction identifier of the transaction being retried.",
@@ -936,65 +747,65 @@
"type": "string"
}
},
- "id": "ReadWrite",
- "description": "Options specific to read / write transactions.",
- "type": "object"
+ "id": "ReadWrite"
+ },
+ "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": {
+ "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"
},
"LookupRequest": {
"properties": {
- "readOptions": {
- "description": "The options for this lookup request.",
- "$ref": "ReadOptions"
- },
"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",
"description": "The request for Datastore.Lookup.",
"type": "object"
},
+ "GoogleDatastoreAdminV1beta1Progress": {
+ "properties": {
+ "workCompleted": {
+ "description": "The amount of work that has been completed. Note that this may be greater\nthan work_estimated.",
+ "format": "int64",
+ "type": "string"
+ },
+ "workEstimated": {
+ "description": "An estimate of how much work needs to be performed. May be zero if the\nwork estimate is unavailable.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "id": "GoogleDatastoreAdminV1beta1Progress",
+ "description": "Measures the progress of a particular metric.",
+ "type": "object"
+ },
"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": {
- "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"
- },
- "entityResults": {
- "description": "The results for this batch.",
- "type": "array",
- "items": {
- "$ref": "EntityResult"
- }
- },
"endCursor": {
"description": "A cursor that points to the position after the last result in the batch.",
"format": "byte",
@@ -1022,27 +833,43 @@
"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": {
+ "enum": [
+ "RESULT_TYPE_UNSPECIFIED",
+ "FULL",
+ "PROJECTION",
+ "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."
+ ]
+ },
+ "entityResults": {
+ "description": "The results for this batch.",
+ "type": "array",
+ "items": {
+ "$ref": "EntityResult"
+ }
}
},
"id": "QueryResultBatch"
},
- "GoogleDatastoreAdminV1beta1Progress": {
- "description": "Measures the progress of a particular metric.",
- "type": "object",
- "properties": {
- "workEstimated": {
- "description": "An estimate of how much work needs to be performed. May be zero if the\nwork estimate is unavailable.",
- "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"
- },
"ReserveIdsRequest": {
"properties": {
"keys": {
@@ -1065,6 +892,11 @@
"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"
@@ -1072,11 +904,6 @@
"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"
@@ -1089,8 +916,8 @@
"type": "string"
},
"value": {
- "description": "A value parameter.",
- "$ref": "Value"
+ "$ref": "Value",
+ "description": "A value parameter."
}
},
"id": "GqlQueryParameter",
@@ -1110,23 +937,21 @@
"type": "object"
},
"RunQueryResponse": {
- "description": "The response for Datastore.RunQuery.",
- "type": "object",
"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"
- },
- "batch": {
- "description": "A batch of query results (always present).",
- "$ref": "QueryResultBatch"
}
},
- "id": "RunQueryResponse"
+ "id": "RunQueryResponse",
+ "description": "The response for Datastore.RunQuery.",
+ "type": "object"
},
"LookupResponse": {
- "description": "The response for Datastore.Lookup.",
- "type": "object",
"properties": {
"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.",
@@ -1150,11 +975,11 @@
}
}
},
- "id": "LookupResponse"
+ "id": "LookupResponse",
+ "description": "The response for Datastore.Lookup.",
+ "type": "object"
},
"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.",
@@ -1164,43 +989,45 @@
}
}
},
- "id": "AllocateIdsRequest"
+ "id": "AllocateIdsRequest",
+ "description": "The request for Datastore.AllocateIds.",
+ "type": "object"
},
"PropertyOrder": {
"description": "The desired order for a specific property.",
"type": "object",
"properties": {
"property": {
- "description": "The property to order by.",
- "$ref": "PropertyReference"
+ "$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",
- "enumDescriptions": [
- "Unspecified. This value must not be used.",
- "Ascending.",
- "Descending."
- ]
+ "type": "string"
}
},
"id": "PropertyOrder"
},
"BeginTransactionRequest": {
- "description": "The request for Datastore.BeginTransaction.",
- "type": "object",
"properties": {
"transactionOptions": {
- "$ref": "TransactionOptions",
- "description": "Options for a new transaction."
+ "description": "Options for a new transaction.",
+ "$ref": "TransactionOptions"
}
},
- "id": "BeginTransactionRequest"
+ "id": "BeginTransactionRequest",
+ "description": "The request for Datastore.BeginTransaction.",
+ "type": "object"
},
"CommitRequest": {
"properties": {
@@ -1247,8 +1074,6 @@
"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.",
@@ -1262,11 +1087,11 @@
"description": "Entities are partitioned into subsets, currently identified by a project\nID and namespace ID.\nQueries are scoped to a single partition."
}
},
- "id": "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"
},
"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].",
@@ -1279,24 +1104,26 @@
"type": "number"
}
},
- "id": "LatLng"
+ "id": "LatLng",
+ "description": "An object representing a latitude/longitude pair. This is expressed as a pair\nof doubles representing degrees latitude and degrees longitude. Unless\nspecified otherwise, this must conform to the\n\u003ca href=\"http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf\"\u003eWGS84\nstandard\u003c/a\u003e. Values must be within normalized ranges.",
+ "type": "object"
},
"ReserveIdsResponse": {
- "description": "The response for Datastore.ReserveIds.",
- "type": "object",
"properties": {},
- "id": "ReserveIdsResponse"
+ "id": "ReserveIdsResponse",
+ "description": "The response for Datastore.ReserveIds.",
+ "type": "object"
},
"PropertyReference": {
- "description": "A reference to a property relative to the kind expressions.",
- "type": "object",
"properties": {
"name": {
"description": "The name of the property.\nIf name includes \".\"s, it may be interpreted as a property name path.",
"type": "string"
}
},
- "id": "PropertyReference"
+ "id": "PropertyReference",
+ "description": "A reference to a property relative to the kind expressions.",
+ "type": "object"
},
"GoogleDatastoreAdminV1beta1EntityFilter": {
"properties": {
@@ -1318,13 +1145,186 @@
"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": {
+ "description": "Metadata common to all Datastore Admin operations.",
+ "type": "object",
+ "properties": {
+ "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": {
+ "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"
+ },
+ "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"
+ }
+ },
+ "id": "GoogleDatastoreAdminV1beta1CommonMetadata"
+ },
+ "Projection": {
+ "description": "A representation of a property in a projection.",
+ "type": "object",
+ "properties": {
+ "property": {
+ "$ref": "PropertyReference",
+ "description": "The property to project."
+ }
+ },
+ "id": "Projection"
+ },
+ "ArrayValue": {
+ "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",
+ "description": "An array value.",
+ "type": "object"
+ },
+ "Mutation": {
+ "description": "A mutation to apply to an entity.",
+ "type": "object",
+ "properties": {
+ "update": {
+ "$ref": "Entity",
+ "description": "The entity to update. The entity must already exist.\nMust have a complete key path."
+ },
+ "upsert": {
+ "$ref": "Entity",
+ "description": "The entity to upsert. The entity may or may not already exist.\nThe entity key's final path element may be incomplete."
+ },
+ "delete": {
+ "description": "The key of the entity to delete. The entity may or may not already exist.\nMust have a complete key path and must not be reserved/read-only.",
+ "$ref": "Key"
+ },
+ "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"
+ }
+ },
+ "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"
+ },
+ "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"
+ },
+ "RollbackResponse": {
+ "description": "The response for Datastore.Rollback.\n(an empty message).",
+ "type": "object",
+ "properties": {},
+ "id": "RollbackResponse"
}
},
- "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": "v1beta3",
- "baseUrl": "https://datastore.googleapis.com/"
+ "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": ""
}
diff --git a/dialogflow/v2beta1/dialogflow-api.json b/dialogflow/v2beta1/dialogflow-api.json
index 81ba1af..aed04d8 100644
--- a/dialogflow/v2beta1/dialogflow-api.json
+++ b/dialogflow/v2beta1/dialogflow-api.json
@@ -1,972 +1,1327 @@
{
+ "resources": {
+ "projects": {
+ "methods": {
+ "getAgent": {
+ "response": {
+ "$ref": "Agent"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "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"
+ }
+ },
+ "flatPath": "v2beta1/projects/{projectsId}/agent",
+ "path": "v2beta1/{+parent}/agent",
+ "id": "dialogflow.projects.getAgent",
+ "description": "Retrieves the specified agent."
+ }
+ },
+ "resources": {
+ "operations": {
+ "methods": {
+ "get": {
+ "flatPath": "v2beta1/projects/{projectsId}/operations/{operationsId}",
+ "id": "dialogflow.projects.operations.get",
+ "path": "v2beta1/{+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": {
+ "pattern": "^projects/[^/]+/operations/[^/]+$",
+ "location": "path",
+ "description": "The name of the operation resource.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ }
+ }
+ },
+ "agent": {
+ "methods": {
+ "train": {
+ "request": {
+ "$ref": "TrainAgentRequest"
+ },
+ "description": "Trains the specified agent.\n\n\nOperation \u003cresponse: google.protobuf.Empty,\n metadata: google.protobuf.Struct\u003e",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "parent": {
+ "description": "Required. The project that the agent to train 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:train",
+ "path": "v2beta1/{+parent}/agent:train",
+ "id": "dialogflow.projects.agent.train"
+ },
+ "export": {
+ "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 export is associated with.\nFormat: `projects/\u003cProject ID\u003e`.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v2beta1/projects/{projectsId}/agent:export",
+ "path": "v2beta1/{+parent}/agent:export",
+ "id": "dialogflow.projects.agent.export",
+ "description": "Exports the specified agent to a ZIP file.\n\n\nOperation \u003cresponse: ExportAgentResponse,\n metadata: google.protobuf.Struct\u003e",
+ "request": {
+ "$ref": "ExportAgentRequest"
+ }
+ },
+ "restore": {
+ "path": "v2beta1/{+parent}/agent:restore",
+ "id": "dialogflow.projects.agent.restore",
+ "request": {
+ "$ref": "RestoreAgentRequest"
+ },
+ "description": "Restores the specified agent from a ZIP file.\n\nReplaces the current agent version with a new one. All the intents and\nentity types in the older version are deleted.\n\n\nOperation \u003cresponse: google.protobuf.Empty,\n metadata: google.protobuf.Struct\u003e",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "parent": {
+ "location": "path",
+ "description": "Required. The project that the agent to restore is associated with.\nFormat: `projects/\u003cProject ID\u003e`.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v2beta1/projects/{projectsId}/agent:restore"
+ },
+ "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": {
+ "pattern": "^projects/[^/]+$",
+ "location": "path",
+ "description": "Required. The project that the agent to import is associated with.\nFormat: `projects/\u003cProject ID\u003e`.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v2beta1/projects/{projectsId}/agent:import",
+ "path": "v2beta1/{+parent}/agent:import",
+ "id": "dialogflow.projects.agent.import"
+ },
+ "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",
+ "parameterOrder": [
+ "parent"
+ ],
+ "response": {
+ "$ref": "SearchAgentsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "pageSize": {
+ "location": "query",
+ "description": "Optional. The maximum number of items to return in a single page. By\ndefault 100 and at most 1000.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "parent": {
+ "description": "Required. The project to list agents from.\nFormat: `projects/\u003cProject ID or '-'\u003e`.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+$",
+ "location": "path"
+ },
+ "pageToken": {
+ "description": "Optional. The next_page_token value returned from a previous list request.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "flatPath": "v2beta1/projects/{projectsId}/agent:search",
+ "id": "dialogflow.projects.agent.search",
+ "path": "v2beta1/{+parent}/agent:search"
+ }
+ },
+ "resources": {
+ "sessions": {
+ "methods": {
+ "deleteContexts": {
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "DELETE",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "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/[^/]+$"
+ }
+ },
+ "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": {
+ "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/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v2beta1/projects/{projectsId}/agent/sessions/{sessionsId}:detectIntent",
+ "path": "v2beta1/{+session}:detectIntent",
+ "id": "dialogflow.projects.agent.sessions.detectIntent"
+ }
+ },
+ "resources": {
+ "entityTypes": {
+ "methods": {
+ "delete": {
+ "description": "Deletes the specified session entity type.",
+ "httpMethod": "DELETE",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "location": "path",
+ "description": "Required. The name of the entity type to delete. Format:\n`projects/\u003cProject ID\u003e/agent/sessions/\u003cSession ID\u003e/entityTypes/\u003cEntity Type\nDisplay Name\u003e`.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/agent/sessions/[^/]+/entityTypes/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v2beta1/projects/{projectsId}/agent/sessions/{sessionsId}/entityTypes/{entityTypesId}",
+ "id": "dialogflow.projects.agent.sessions.entityTypes.delete",
+ "path": "v2beta1/{+name}"
+ },
+ "list": {
+ "description": "Returns the list of all session entity types in the specified session.",
+ "response": {
+ "$ref": "ListSessionEntityTypesResponse"
+ },
+ "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"
+ },
+ "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/[^/]+$"
+ }
+ },
+ "flatPath": "v2beta1/projects/{projectsId}/agent/sessions/{sessionsId}/entityTypes",
+ "path": "v2beta1/{+parent}/entityTypes",
+ "id": "dialogflow.projects.agent.sessions.entityTypes.list"
+ },
+ "get": {
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "SessionEntityType"
+ },
+ "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"
+ ],
+ "flatPath": "v2beta1/projects/{projectsId}/agent/sessions/{sessionsId}/entityTypes/{entityTypesId}",
+ "id": "dialogflow.projects.agent.sessions.entityTypes.get",
+ "path": "v2beta1/{+name}",
+ "description": "Retrieves the specified session entity type."
+ },
+ "patch": {
+ "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.",
+ "response": {
+ "$ref": "SessionEntityType"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "PATCH",
+ "parameters": {
+ "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"
+ },
+ "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"
+ ]
+ },
+ "create": {
+ "request": {
+ "$ref": "SessionEntityType"
+ },
+ "description": "Creates a session entity type.",
+ "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"
+ }
+ }
+ },
+ "contexts": {
+ "methods": {
+ "create": {
+ "response": {
+ "$ref": "Context"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "parent": {
+ "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",
+ "pattern": "^projects/[^/]+/agent/sessions/[^/]+$"
+ }
+ },
+ "flatPath": "v2beta1/projects/{projectsId}/agent/sessions/{sessionsId}/contexts",
+ "path": "v2beta1/{+parent}/contexts",
+ "id": "dialogflow.projects.agent.sessions.contexts.create",
+ "description": "Creates a context.",
+ "request": {
+ "$ref": "Context"
+ }
+ },
+ "delete": {
+ "description": "Deletes the specified context.",
+ "httpMethod": "DELETE",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Empty"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "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`.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/agent/sessions/[^/]+/contexts/[^/]+$"
+ }
+ },
+ "flatPath": "v2beta1/projects/{projectsId}/agent/sessions/{sessionsId}/contexts/{contextsId}",
+ "id": "dialogflow.projects.agent.sessions.contexts.delete",
+ "path": "v2beta1/{+name}"
+ },
+ "list": {
+ "description": "Returns the list of all contexts in the specified session.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "parent"
+ ],
+ "response": {
+ "$ref": "ListContextsResponse"
+ },
+ "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 contexts from.\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",
+ "id": "dialogflow.projects.agent.sessions.contexts.list",
+ "path": "v2beta1/{+parent}/contexts"
+ },
+ "get": {
+ "path": "v2beta1/{+name}",
+ "id": "dialogflow.projects.agent.sessions.contexts.get",
+ "description": "Retrieves the specified context.",
+ "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}"
+ },
+ "patch": {
+ "response": {
+ "$ref": "Context"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "PATCH",
+ "parameters": {
+ "updateMask": {
+ "description": "Optional. The mask to control which fields get updated.",
+ "format": "google-fieldmask",
+ "type": "string",
+ "location": "query"
+ },
+ "name": {
+ "required": true,
+ "type": "string",
+ "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."
+ }
+ },
+ "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."
+ }
+ }
+ }
+ }
+ },
+ "entityTypes": {
+ "methods": {
+ "list": {
+ "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": {
+ "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$",
+ "location": "path",
+ "description": "Required. The agent to list all entity types from.\nFormat: `projects/\u003cProject ID\u003e/agent`.",
+ "required": true,
+ "type": "string"
+ },
+ "languageCode": {
+ "type": "string",
+ "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."
+ }
+ },
+ "flatPath": "v2beta1/projects/{projectsId}/agent/entityTypes",
+ "path": "v2beta1/{+parent}/entityTypes",
+ "id": "dialogflow.projects.agent.entityTypes.list",
+ "description": "Returns the list of all entity types in the specified agent."
+ },
+ "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": {
+ "location": "path",
+ "description": "Required. The agent to create a entity type for.\nFormat: `projects/\u003cProject ID\u003e/agent`.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/agent$"
+ },
+ "languageCode": {
+ "location": "query",
+ "description": "Optional. The language of entity synonyms defined in `entity_type`. If not\nspecified, the agent's default language is used.\n[More than a dozen\nlanguages](https://dialogflow.com/docs/reference/language) are supported.\nNote: languages must be enabled in the agent, before they can be used.",
+ "type": "string"
+ }
+ },
+ "flatPath": "v2beta1/projects/{projectsId}/agent/entityTypes",
+ "path": "v2beta1/{+parent}/entityTypes",
+ "id": "dialogflow.projects.agent.entityTypes.create"
+ },
+ "batchDelete": {
+ "description": "Deletes entity types in the specified agent.\n\nOperation \u003cresponse: google.protobuf.Empty,\n metadata: google.protobuf.Struct\u003e",
+ "request": {
+ "$ref": "BatchDeleteEntityTypesRequest"
+ },
+ "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 delete all entities types for. Format:\n`projects/\u003cProject ID\u003e/agent`.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/agent$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v2beta1/projects/{projectsId}/agent/entityTypes:batchDelete",
+ "path": "v2beta1/{+parent}/entityTypes:batchDelete",
+ "id": "dialogflow.projects.agent.entityTypes.batchDelete"
+ },
+ "get": {
+ "response": {
+ "$ref": "EntityType"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "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": {
+ "location": "path",
+ "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/[^/]+$"
+ }
+ },
+ "flatPath": "v2beta1/projects/{projectsId}/agent/entityTypes/{entityTypesId}",
+ "path": "v2beta1/{+name}",
+ "id": "dialogflow.projects.agent.entityTypes.get",
+ "description": "Retrieves the specified entity type."
+ },
+ "patch": {
+ "response": {
+ "$ref": "EntityType"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "PATCH",
+ "parameters": {
+ "languageCode": {
+ "description": "Optional. The language of entity synonyms defined in `entity_type`. If not\nspecified, the agent's default language is used.\n[More than a dozen\nlanguages](https://dialogflow.com/docs/reference/language) are supported.\nNote: languages must be enabled in the agent, before they can be used.",
+ "type": "string",
+ "location": "query"
+ },
+ "updateMask": {
+ "location": "query",
+ "description": "Optional. The mask to control which fields get updated.",
+ "format": "google-fieldmask",
+ "type": "string"
+ },
+ "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/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v2beta1/projects/{projectsId}/agent/entityTypes/{entityTypesId}",
+ "path": "v2beta1/{+name}",
+ "id": "dialogflow.projects.agent.entityTypes.patch",
+ "request": {
+ "$ref": "EntityType"
+ },
+ "description": "Updates the specified entity type."
+ },
+ "batchUpdate": {
+ "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"
+ ],
+ "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"
+ },
+ "delete": {
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "DELETE",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "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/[^/]+$"
+ }
+ },
+ "flatPath": "v2beta1/projects/{projectsId}/agent/entityTypes/{entityTypesId}",
+ "path": "v2beta1/{+name}",
+ "id": "dialogflow.projects.agent.entityTypes.delete",
+ "description": "Deletes the specified entity type."
+ }
+ },
+ "resources": {
+ "entities": {
+ "methods": {
+ "batchUpdate": {
+ "id": "dialogflow.projects.agent.entityTypes.entities.batchUpdate",
+ "path": "v2beta1/{+parent}/entities: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",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "parent"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameters": {
+ "parent": {
+ "required": true,
+ "type": "string",
+ "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`."
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v2beta1/projects/{projectsId}/agent/entityTypes/{entityTypesId}/entities:batchUpdate"
+ },
+ "batchDelete": {
+ "request": {
+ "$ref": "BatchDeleteEntitiesRequest"
+ },
+ "description": "Deletes entities in the specified entity type.\n\nOperation \u003cresponse: google.protobuf.Empty,\n metadata: google.protobuf.Struct\u003e",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "parent": {
+ "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",
+ "path": "v2beta1/{+parent}/entities:batchDelete",
+ "id": "dialogflow.projects.agent.entityTypes.entities.batchDelete"
+ },
+ "batchCreate": {
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "POST",
+ "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"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v2beta1/projects/{projectsId}/agent/entityTypes/{entityTypesId}/entities:batchCreate",
+ "path": "v2beta1/{+parent}/entities:batchCreate",
+ "id": "dialogflow.projects.agent.entityTypes.entities.batchCreate",
+ "request": {
+ "$ref": "BatchCreateEntitiesRequest"
+ },
+ "description": "Creates multiple new entities in the specified entity type (extends the\nexisting collection of entries).\n\nOperation \u003cresponse: google.protobuf.Empty\u003e"
+ }
+ }
+ }
+ }
+ },
+ "intents": {
+ "methods": {
+ "create": {
+ "request": {
+ "$ref": "Intent"
+ },
+ "description": "Creates an intent in the specified agent.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "parent"
+ ],
+ "response": {
+ "$ref": "Intent"
+ },
+ "parameters": {
+ "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"
+ },
+ "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 create a intent for.\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",
+ "id": "dialogflow.projects.agent.intents.create",
+ "path": "v2beta1/{+parent}/intents"
+ },
+ "batchDelete": {
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "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`."
+ }
+ },
+ "flatPath": "v2beta1/projects/{projectsId}/agent/intents:batchDelete",
+ "path": "v2beta1/{+parent}/intents:batchDelete",
+ "id": "dialogflow.projects.agent.intents.batchDelete",
+ "description": "Deletes intents in the specified agent.\n\nOperation \u003cresponse: google.protobuf.Empty\u003e",
+ "request": {
+ "$ref": "BatchDeleteIntentsRequest"
+ }
+ },
+ "get": {
+ "description": "Retrieves the specified intent.",
+ "response": {
+ "$ref": "Intent"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "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"
+ },
+ "languageCode": {
+ "description": "Optional. The language to retrieve training phrases, parameters and rich\nmessages for. If not specified, the agent's default language is used.\n[More than a dozen\nlanguages](https://dialogflow.com/docs/reference/language) are supported.\nNote: languages must be enabled in the agent, before they can be used.",
+ "type": "string",
+ "location": "query"
+ },
+ "name": {
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/agent/intents/[^/]+$",
+ "location": "path",
+ "description": "Required. The name of the intent.\nFormat: `projects/\u003cProject ID\u003e/agent/intents/\u003cIntent ID\u003e`."
+ }
+ },
+ "flatPath": "v2beta1/projects/{projectsId}/agent/intents/{intentsId}",
+ "path": "v2beta1/{+name}",
+ "id": "dialogflow.projects.agent.intents.get"
+ },
+ "patch": {
+ "description": "Updates the specified intent.",
+ "request": {
+ "$ref": "Intent"
+ },
+ "response": {
+ "$ref": "Intent"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "PATCH",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "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"
+ },
+ "intentView": {
+ "type": "string",
+ "location": "query",
+ "enum": [
+ "INTENT_VIEW_UNSPECIFIED",
+ "INTENT_VIEW_FULL"
+ ],
+ "description": "Optional. The resource view to apply to the returned intent."
+ },
+ "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"
+ }
+ },
+ "flatPath": "v2beta1/projects/{projectsId}/agent/intents/{intentsId}",
+ "path": "v2beta1/{+name}",
+ "id": "dialogflow.projects.agent.intents.patch"
+ },
+ "batchUpdate": {
+ "request": {
+ "$ref": "BatchUpdateIntentsRequest"
+ },
+ "description": "Updates/Creates multiple intents in the specified agent.\n\nOperation \u003cresponse: BatchUpdateIntentsResponse\u003e",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "parent": {
+ "description": "Required. The name of the agent to update or create intents in.\nFormat: `projects/\u003cProject ID\u003e/agent`.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/agent$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v2beta1/projects/{projectsId}/agent/intents:batchUpdate",
+ "path": "v2beta1/{+parent}/intents:batchUpdate",
+ "id": "dialogflow.projects.agent.intents.batchUpdate"
+ },
+ "delete": {
+ "flatPath": "v2beta1/projects/{projectsId}/agent/intents/{intentsId}",
+ "path": "v2beta1/{+name}",
+ "id": "dialogflow.projects.agent.intents.delete",
+ "description": "Deletes the specified intent.",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "DELETE",
+ "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"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "list": {
+ "response": {
+ "$ref": "ListIntentsResponse"
+ },
+ "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"
+ },
+ "intentView": {
+ "description": "Optional. The resource view to apply to the returned intent.",
+ "type": "string",
+ "location": "query",
+ "enum": [
+ "INTENT_VIEW_UNSPECIFIED",
+ "INTENT_VIEW_FULL"
+ ]
+ },
+ "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"
+ }
+ },
+ "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."
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": {
+ "oauth_token": {
+ "location": "query",
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string"
+ },
+ "bearer_token": {
+ "location": "query",
+ "description": "OAuth bearer token.",
+ "type": "string"
+ },
+ "upload_protocol": {
+ "location": "query",
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "type": "string"
+ },
+ "prettyPrint": {
+ "description": "Returns response with indentations and line breaks.",
+ "type": "boolean",
+ "default": "true",
+ "location": "query"
+ },
+ "fields": {
+ "location": "query",
+ "description": "Selector specifying which fields to include in a partial response.",
+ "type": "string"
+ },
+ "uploadType": {
+ "type": "string",
+ "location": "query",
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")."
+ },
+ "$.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"
+ },
+ "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": {
+ "location": "query",
+ "description": "Pretty-print response.",
+ "type": "boolean",
+ "default": "true"
+ }
+ },
+ "version": "v2beta1",
+ "baseUrl": "https://dialogflow.googleapis.com/",
+ "kind": "discovery#restDescription",
+ "description": "An end-to-end development suite for conversational interfaces (e.g., chatbots, voice-powered apps and devices).",
+ "servicePath": "",
+ "basePath": "",
+ "id": "dialogflow:v2beta1",
+ "documentationLink": "https://cloud.google.com/dialogflow-enterprise/",
+ "revision": "20171218",
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
- "Intent": {
- "id": "Intent",
- "description": "Represents an intent.\nIntents convert a number of user expressions or patterns into an action. An\naction is an extraction of a user command or sentence semantics.",
- "type": "object",
- "properties": {
- "displayName": {
- "description": "Required. The name of this intent.",
- "type": "string"
- },
- "rootFollowupIntentName": {
- "description": "The unique identifier of the root intent in the chain of followup intents.\nIt identifies the correct followup intents chain for this intent.\nFormat: `projects/\u003cProject ID\u003e/agent/intents/\u003cIntent ID\u003e`.",
- "type": "string"
- },
- "isFallback": {
- "description": "Optional. Indicates whether this is a fallback intent.",
- "type": "boolean"
- },
- "mlEnabled": {
- "description": "Optional. Indicates whether Machine Learning is enabled for the intent.\nNote: If `ml_enabled` setting is set to false, then this intent is not\ntaken into account during inference in `ML ONLY` match mode. Also,\nauto-markup in the UI is turned off.",
- "type": "boolean"
- },
- "trainingPhrases": {
- "description": "Optional. The collection of examples/templates that the agent is\ntrained on.",
- "type": "array",
- "items": {
- "$ref": "IntentTrainingPhrase"
- }
- },
- "resetContexts": {
- "description": "Optional. Indicates whether to delete all contexts in the current\nsession when this intent is matched.",
- "type": "boolean"
- },
- "parameters": {
- "description": "Optional. The collection of parameters associated with the intent.",
- "type": "array",
- "items": {
- "$ref": "IntentParameter"
- }
- },
- "events": {
- "description": "Optional. The collection of event names that trigger the intent.\nIf the collection of input contexts is not empty, all of the contexts must\nbe present in the active user session for an event to trigger this intent.",
- "type": "array",
- "items": {
- "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": {
- "type": "string",
- "enum": [
- "PLATFORM_UNSPECIFIED",
- "FACEBOOK",
- "SLACK",
- "TELEGRAM",
- "KIK",
- "SKYPE",
- "LINE",
- "VIBER",
- "ACTIONS_ON_GOOGLE"
- ]
- }
- },
- "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"
- },
- "action": {
- "description": "Optional. The name of the action associated with the intent.",
- "type": "string"
- },
- "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"
- }
- }
- }
- },
- "BatchUpdateEntityTypesRequest": {
- "description": "The request message for EntityTypes.BatchUpdateEntityTypes.",
- "type": "object",
- "properties": {
- "entityTypeBatchUri": {
- "description": "Warning: Importing entity types from a URI is not implemented yet.\nThis feature is coming soon.\nThe URI to a Google Cloud Storage file containing entity types to update\nor create. The file format can either be a serialized proto (of\nEntityBatch type) or a JSON object. Note: The URI must start with\n\"gs://\".",
- "type": "string"
- },
- "entityTypeBatchInline": {
- "$ref": "EntityTypeBatch",
- "description": "The collection of entity type to update or create."
- },
- "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": {
- "id": "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": {
- "description": "Required. The text corresponding to the example or template,\nif there are no annotations. For\nannotated examples, it is the text for one of the example's parts.",
- "type": "string"
- },
- "entityType": {
- "description": "Optional. The entity type name prefixed with `@`. This field is\nrequired for the annotated part of the text and applies only to\nexamples.",
- "type": "string"
- }
- }
- },
- "IntentBatch": {
- "description": "This message is a wrapper around a collection of intents.",
- "type": "object",
- "properties": {
- "intents": {
- "description": "A collection of intents.",
- "type": "array",
- "items": {
- "$ref": "Intent"
- }
- }
- },
- "id": "IntentBatch"
- },
- "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`.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "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"
- }
- },
- "id": "BatchDeleteEntitiesRequest"
- },
- "IntentMessageListSelect": {
- "id": "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"
- },
- "items": {
- "description": "Required. List items.",
- "type": "array",
- "items": {
- "$ref": "IntentMessageListSelectItem"
- }
- }
- }
- },
- "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"
- },
- "IntentMessageCarouselSelectItem": {
- "id": "IntentMessageCarouselSelectItem",
- "description": "An item in the carousel.",
- "type": "object",
- "properties": {
- "description": {
- "description": "Optional. The body text of the card.",
- "type": "string"
- },
- "info": {
- "description": "Required. Additional info about the option item.",
- "$ref": "IntentMessageSelectItemInfo"
- },
- "title": {
- "description": "Required. Title of the carousel item.",
- "type": "string"
- },
- "image": {
- "$ref": "IntentMessageImage",
- "description": "Optional. The image to display."
- }
- }
- },
- "IntentMessageQuickReplies": {
- "id": "IntentMessageQuickReplies",
- "description": "The quick replies response message.",
- "type": "object",
- "properties": {
- "title": {
- "description": "Optional. The title of the collection of quick replies.",
- "type": "string"
- },
- "quickReplies": {
- "description": "Optional. The collection of quick replies.",
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- }
- },
- "WebhookRequest": {
- "id": "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": {
- "description": "The result of the conversational query or event processing. Contains the\nsame value as `[Streaming]DetectIntentResponse.query_result`.",
- "$ref": "QueryResult"
- },
- "originalDetectIntentRequest": {
- "description": "Optional. The contents of the original request that was passed to\n`[Streaming]DetectIntent` call.",
- "$ref": "OriginalDetectIntentRequest"
- }
- }
- },
- "RestoreAgentRequest": {
- "id": "RestoreAgentRequest",
- "description": "The request message for Agents.RestoreAgent.",
- "type": "object",
- "properties": {
- "agentContent": {
- "description": "The agent to restore.\n\nExample for how to restore an agent via the command line:\n\ncurl \\\n 'https://dialogflow.googleapis.com/v2beta1/projects/\u003cproject_name\u003e/agent:restore\\\n -X POST \\\n -H 'Authorization: Bearer '$(gcloud auth print-access-token) \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n --compressed \\\n --data-binary \"{\n 'agentContent': '$(cat \u003cagent zip file\u003e | base64 -w 0)'\n }\" \\",
- "format": "byte",
- "type": "string"
- },
- "agentUri": {
- "description": "Warning: Restoring agents from a URI is not implemented yet.\nThis feature is coming soon.\n\nThe URI to a Google Cloud Storage file containing the agent to restore.\nNote: The URI must start with \"gs://\".",
- "type": "string"
- }
- }
- },
- "IntentTrainingPhrase": {
- "id": "IntentTrainingPhrase",
- "description": "Represents an example or template that the agent is trained on.",
- "type": "object",
- "properties": {
- "parts": {
- "description": "Required. The collection of training phrase parts (can be annotated).\nFields: `entity_type`, `alias` and `user_defined` should be populated\nonly for the annotated parts of the training phrase.",
- "type": "array",
- "items": {
- "$ref": "IntentTrainingPhrasePart"
- }
- },
- "name": {
- "description": "Required. The unique identifier of this training phrase.",
- "type": "string"
- },
- "timesAddedCount": {
- "description": "Optional. Indicates how many times this example or template was added to\nthe intent. Each time a developer adds an existing sample by editing an\nintent or training, this counter is increased.",
- "format": "int32",
- "type": "integer"
- },
- "type": {
- "description": "Required. The type of the training phrase.",
- "type": "string",
- "enumDescriptions": [
- "Not specified. This value should never be used.",
- "Examples do not contain @-prefixed entity type names, but example parts\ncan be annotated with entity types.",
- "Templates are not annotated with entity types, but they can contain\n@-prefixed entity type names as substrings."
- ],
- "enum": [
- "TYPE_UNSPECIFIED",
- "EXAMPLE",
- "TEMPLATE"
- ]
- }
- }
- },
- "ListIntentsResponse": {
- "description": "The response message for Intents.ListIntents.",
- "type": "object",
- "properties": {
- "intents": {
- "description": "The list of agent intents. There will be a maximum number of items\nreturned based on the page_size field in the request.",
- "type": "array",
- "items": {
- "$ref": "Intent"
- }
- },
- "nextPageToken": {
- "description": "Token to retrieve the next page of results, or empty if there are no\nmore results in the list.",
- "type": "string"
- }
- },
- "id": "ListIntentsResponse"
- },
- "LatLng": {
- "description": "An object representing a latitude/longitude pair. This is expressed as a pair\nof doubles representing degrees latitude and degrees longitude. Unless\nspecified otherwise, this must conform to the\n\u003ca href=\"http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf\"\u003eWGS84\nstandard\u003c/a\u003e. Values must be within normalized ranges.",
- "type": "object",
- "properties": {
- "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"
- },
- "Context": {
- "id": "Context",
- "description": "Represents a context.",
- "type": "object",
- "properties": {
- "name": {
- "description": "Required. The unique identifier of the context. Format:\n`projects/\u003cProject ID\u003e/agent/sessions/\u003cSession ID\u003e/contexts/\u003cContext ID\u003e`.\nNote: The Context ID is always converted to lowercase.",
- "type": "string"
- },
- "parameters": {
- "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",
- "additionalProperties": {
- "description": "Properties of the object.",
- "type": "any"
- }
- },
- "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"
- }
- }
- },
- "ImportAgentRequest": {
- "description": "The request message for Agents.ImportAgent.",
- "type": "object",
- "properties": {
- "agentUri": {
- "description": "Warning: Importing agents from a URI is not implemented yet.\nThis feature is coming soon.\n\nThe URI to a Google Cloud Storage file containing the agent to import.\nNote: The URI must start with \"gs://\".",
- "type": "string"
- },
- "agentContent": {
- "description": "The agent to import.\n\nExample for how to import an agent via the command line:\n\ncurl \\\n 'https://dialogflow.googleapis.com/v2beta1/projects/\u003cproject_name\u003e/agent:import\\\n -X POST \\\n -H 'Authorization: Bearer '$(gcloud auth print-access-token) \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n --compressed \\\n --data-binary \"{\n 'agentContent': '$(cat \u003cagent zip file\u003e | base64 -w 0)'\n }\"",
- "format": "byte",
- "type": "string"
- }
- },
- "id": "ImportAgentRequest"
- },
- "BatchUpdateIntentsResponse": {
- "id": "BatchUpdateIntentsResponse",
- "description": "The response message for Intents.BatchUpdateIntents.",
- "type": "object",
- "properties": {
- "intents": {
- "description": "The collection of updated or created intents.",
- "type": "array",
- "items": {
- "$ref": "Intent"
- }
- }
- }
- },
- "IntentParameter": {
- "description": "Represents intent parameters.",
- "type": "object",
- "properties": {
- "displayName": {
- "description": "Required. The name of the parameter.",
- "type": "string"
- },
- "entityTypeDisplayName": {
- "description": "Optional. The name of the entity type, prefixed with `@`, that\ndescribes values of the parameter. If the parameter is\nrequired, this must be provided.",
- "type": "string"
- },
- "prompts": {
- "description": "Optional. The collection of prompts that the agent can present to the\nuser in order to collect value for the parameter.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "mandatory": {
- "description": "Optional. Indicates whether the parameter is required. That is,\nwhether the intent cannot be completed without collecting the parameter\nvalue.",
- "type": "boolean"
- },
- "defaultValue": {
- "description": "Optional. The default value to use when the `value` yields an empty\nresult.\nDefault values can be extracted from contexts by using the following\nsyntax: `#context_name.parameter_name`.",
- "type": "string"
- },
- "name": {
- "description": "The unique identifier of this parameter.",
- "type": "string"
- },
- "isList": {
- "description": "Optional. Indicates whether the parameter represents a list of values.",
- "type": "boolean"
- },
- "value": {
- "description": "Optional. The definition of the parameter value. It can be:\n- a constant string,\n- a parameter value defined as `$parameter_name`,\n- an original parameter value defined as `$parameter_name.original`,\n- a parameter value from some context defined as\n `#context_name.parameter_name`.",
- "type": "string"
- }
- },
- "id": "IntentParameter"
- },
- "ExportAgentResponse": {
- "description": "The response message for Agents.ExportAgent.",
- "type": "object",
- "properties": {
- "agentUri": {
- "description": "The URI to a file containing the exported agent. This field is populated\nonly if `agent_uri` is specified in `ExportAgentRequest`.",
- "type": "string"
- },
- "agentContent": {
- "description": "The exported agent.\n\nExample for how to export an agent to a zip file via a command line:\n\ncurl \\\n 'https://dialogflow.googleapis.com/v2beta1/projects/\u003cproject_name\u003e/agent:export'\\\n -X POST \\\n -H 'Authorization: Bearer '$(gcloud auth print-access-token) \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n --compressed \\\n --data-binary '{}' \\\n| grep agentContent | sed -e 's/.*\"agentContent\": \"\\([^\"]*\\)\".*/\\1/' \\\n| base64 --decode \u003e \u003cagent zip file\u003e",
- "format": "byte",
- "type": "string"
- }
- },
- "id": "ExportAgentResponse"
- },
- "IntentMessageBasicCardButtonOpenUriAction": {
- "id": "IntentMessageBasicCardButtonOpenUriAction",
- "description": "Opens the given URI.",
- "type": "object",
- "properties": {
- "uri": {
- "description": "Required. The HTTP or HTTPS scheme URI.",
- "type": "string"
- }
- }
- },
- "IntentMessageImage": {
- "description": "The image response message.",
- "type": "object",
- "properties": {
- "imageUri": {
- "description": "Optional. The public URI to an image file.",
- "type": "string"
- }
- },
- "id": "IntentMessageImage"
- },
- "BatchUpdateIntentsRequest": {
- "id": "BatchUpdateIntentsRequest",
- "description": "The request message for Intents.BatchUpdateIntents.",
- "type": "object",
- "properties": {
- "intentBatchInline": {
- "description": "The collection of intents to update or create.",
- "$ref": "IntentBatch"
- },
- "languageCode": {
- "description": "Optional. The language of training phrases, parameters and rich messages\ndefined in `intents`. If not specified, the agent's default language is\nused. [More than a dozen\nlanguages](https://dialogflow.com/docs/reference/language) are supported.\nNote: languages must be enabled in the agent, before they can be used.",
- "type": "string"
- },
- "updateMask": {
- "description": "Optional. The mask to control which fields get updated.",
- "format": "google-fieldmask",
- "type": "string"
- },
- "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"
- }
- }
- },
- "TrainAgentRequest": {
- "id": "TrainAgentRequest",
- "description": "The request message for Agents.TrainAgent.",
- "type": "object",
- "properties": {}
- },
- "SessionEntityType": {
- "description": "Represents a session entity type.\n\nExtends or replaces a developer entity type at the user session level (we\nrefer to the entity types defined at the agent level as \"developer entity\ntypes\").\n\nNote: session entity types apply to all queries, regardless of the language.",
- "type": "object",
- "properties": {
- "name": {
- "description": "Required. The unique identifier of this session entity type. Format:\n`projects/\u003cProject ID\u003e/agent/sessions/\u003cSession ID\u003e/entityTypes/\u003cEntity Type\nDisplay Name\u003e`.",
- "type": "string"
- },
- "entityOverrideMode": {
- "description": "Required. Indicates whether the additional data should override or\nsupplement the developer entity type definition.",
- "type": "string",
- "enumDescriptions": [
- "Not specified. This value should be never used.",
- "The collection of session entities overrides the collection of entities\nin the corresponding developer entity type.",
- "The collection of session entities extends the collection of entities in\nthe corresponding developer entity type.\nCalls to `ListSessionEntityTypes`, `GetSessionEntityType`,\n`CreateSessionEntityType` and `UpdateSessionEntityType` return the full\ncollection of entities from the developer entity type in the agent's\ndefault language and the session entity type."
- ],
- "enum": [
- "ENTITY_OVERRIDE_MODE_UNSPECIFIED",
- "ENTITY_OVERRIDE_MODE_OVERRIDE",
- "ENTITY_OVERRIDE_MODE_SUPPLEMENT"
- ]
- },
- "entities": {
- "description": "Required. The collection of entities associated with this session entity\ntype.",
- "type": "array",
- "items": {
- "$ref": "EntityTypeEntity"
- }
- }
- },
- "id": "SessionEntityType"
- },
- "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": {}
- },
- "BatchUpdateEntitiesRequest": {
- "id": "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"
- }
- }
- },
- "IntentMessageText": {
- "id": "IntentMessageText",
- "description": "The text response message.",
- "type": "object",
- "properties": {
- "text": {
- "description": "Optional. The collection of the agent's responses.",
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- }
- },
- "WebhookResponse": {
- "id": "WebhookResponse",
- "description": "The response message for a webhook call.",
- "type": "object",
- "properties": {
- "source": {
- "description": "Optional. This value is passed directly to `QueryResult.webhook_source`.",
- "type": "string"
- },
- "followupEventInput": {
- "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": {
- "description": "Optional. This value is passed directly to `QueryResult.webhook_payload`.",
- "type": "object",
- "additionalProperties": {
- "description": "Properties of the object.",
- "type": "any"
- }
- }
- }
- },
- "BatchDeleteIntentsRequest": {
- "description": "The request message for Intents.BatchDeleteIntents.",
- "type": "object",
- "properties": {
- "intents": {
- "description": "Required. The collection of intents to delete. Only intent `name` must be\nfilled in.",
- "type": "array",
- "items": {
- "$ref": "Intent"
- }
- }
- },
- "id": "BatchDeleteIntentsRequest"
- },
- "QueryInput": {
- "description": "Represents the query input. It can contain either:\n\n1. An audio config which\n instructs the speech recognizer how to process the speech audio.\n\n2. A conversational query in the form of text,.\n\n3. An event that specifies which intent to trigger.",
- "type": "object",
- "properties": {
- "event": {
- "description": "The event to be processed.",
- "$ref": "EventInput"
- },
- "text": {
- "$ref": "TextInput",
- "description": "The natural language text to be processed."
- },
- "audioConfig": {
- "description": "Instructs the speech recognizer how to process the speech audio.",
- "$ref": "InputAudioConfig"
- }
- },
- "id": "QueryInput"
- },
- "DetectIntentResponse": {
- "description": "The message returned from the DetectIntent method.",
- "type": "object",
- "properties": {
- "queryResult": {
- "$ref": "QueryResult",
- "description": "The results of the conversational query or event processing."
- },
- "webhookStatus": {
- "$ref": "Status",
- "description": "Specifies the status of the webhook request. `webhook_status`\nis never populated in webhook requests."
- },
- "responseId": {
- "description": "The unique identifier of the response. It can be used to\nlocate a response in the training example set or for reporting issues.",
- "type": "string"
- }
- },
- "id": "DetectIntentResponse"
- },
- "IntentFollowupIntentInfo": {
- "description": "Represents a single followup intent in the chain.",
- "type": "object",
- "properties": {
- "followupIntentName": {
- "description": "The unique identifier of the followup intent.\nFormat: `projects/\u003cProject ID\u003e/agent/intents/\u003cIntent ID\u003e`.",
- "type": "string"
- },
- "parentFollowupIntentName": {
- "description": "The unique identifier of the followup intent parent.\nFormat: `projects/\u003cProject ID\u003e/agent/intents/\u003cIntent ID\u003e`.",
- "type": "string"
- }
- },
- "id": "IntentFollowupIntentInfo"
- },
- "ExportAgentRequest": {
- "id": "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"
- }
- }
- },
- "IntentMessageLinkOutSuggestion": {
- "description": "The suggestion chip message that allows the user to jump out to the app\nor website associated with this agent.",
- "type": "object",
- "properties": {
- "destinationName": {
- "description": "Required. The name of the app or site this chip is linking to.",
- "type": "string"
- },
- "uri": {
- "description": "Required. The URI of the app or site to open when the user taps the\nsuggestion chip.",
- "type": "string"
- }
- },
- "id": "IntentMessageLinkOutSuggestion"
- },
- "IntentMessageSelectItemInfo": {
- "description": "Additional info about the select item for when it is triggered in a\ndialog.",
- "type": "object",
- "properties": {
- "synonyms": {
- "description": "Optional. A list of synonyms that can also be used to trigger this\nitem in dialog.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "key": {
- "description": "Required. A unique key that will be sent back to the agent if this\nresponse is given.",
- "type": "string"
- }
- },
- "id": "IntentMessageSelectItemInfo"
- },
- "Operation": {
- "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
- "type": "object",
- "properties": {
- "name": {
- "description": "The server-assigned name, which is only unique within the same service that\noriginally returns it. If you use the default HTTP mapping, the\n`name` should have the format of `operations/some/unique/name`.",
- "type": "string"
- },
- "error": {
- "$ref": "Status",
- "description": "The error result of the operation in case of failure or cancellation."
- },
- "metadata": {
- "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"
- }
- },
- "id": "Operation"
- },
- "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",
- "properties": {
- "name": {
- "description": "Required. The unique identifier of the event.",
- "type": "string"
- },
- "parameters": {
- "additionalProperties": {
- "description": "Properties of the object.",
- "type": "any"
- },
- "description": "Optional. The collection of parameters associated with the event.",
- "type": "object"
- },
- "languageCode": {
- "description": "Required. The language of this query. See [Language\nSupport](https://dialogflow.com/docs/languages) for a list of the\ncurrently supported language codes. Note that queries in the same session\ndo not necessarily need to specify the same language.",
- "type": "string"
- }
- }
- },
- "IntentMessageSuggestions": {
- "description": "The collection of suggestions.",
- "type": "object",
- "properties": {
- "suggestions": {
- "description": "Required. The list of suggested replies.",
- "type": "array",
- "items": {
- "$ref": "IntentMessageSuggestion"
- }
- }
- },
- "id": "IntentMessageSuggestions"
- },
- "EntityType": {
- "id": "EntityType",
- "description": "Represents an entity type.\nEntity types serve as a tool for extracting parameter values from natural\nlanguage queries.",
- "type": "object",
- "properties": {
- "name": {
- "description": "Required for all methods except `create` (`create` populates the name\nautomatically.\nThe unique identifier of the entity type. Format:\n`projects/\u003cProject ID\u003e/agent/entityTypes/\u003cEntity Type ID\u003e`.",
- "type": "string"
- },
- "displayName": {
- "description": "Required. The name of the entity.",
- "type": "string"
- },
- "kind": {
- "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"
- },
- "autoExpansionMode": {
- "description": "Optional. Indicates whether the entity type can be automatically\nexpanded.",
- "type": "string",
- "enumDescriptions": [
- "Auto expansion disabled for the entity.",
- "Allows an agent to recognize values that have not been explicitly\nlisted in the entity."
- ],
- "enum": [
- "AUTO_EXPANSION_MODE_UNSPECIFIED",
- "AUTO_EXPANSION_MODE_DEFAULT"
- ]
- },
- "entities": {
- "description": "Optional. The collection of entities associated with the entity type.",
- "type": "array",
- "items": {
- "$ref": "EntityTypeEntity"
- }
- }
- }
- },
"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"
- }
+ }
+ },
+ "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"
+ "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"
},
"IntentMessage": {
"description": "Corresponds to the `Response` field in API.AI console.",
"type": "object",
"properties": {
+ "card": {
+ "description": "The card response.",
+ "$ref": "IntentMessageCard"
+ },
+ "basicCard": {
+ "description": "The basic card response for Actions on Google.",
+ "$ref": "IntentMessageBasicCard"
+ },
+ "carouselSelect": {
+ "$ref": "IntentMessageCarouselSelect",
+ "description": "The carousel card response for Actions on Google."
+ },
+ "linkOutSuggestion": {
+ "description": "The link out suggestion chip for Actions on Google.",
+ "$ref": "IntentMessageLinkOutSuggestion"
+ },
"simpleResponses": {
- "$ref": "IntentMessageSimpleResponses",
- "description": "The voice and text-only responses for Actions on Google."
+ "description": "The voice and text-only responses for Actions on Google.",
+ "$ref": "IntentMessageSimpleResponses"
},
"image": {
"$ref": "IntentMessageImage",
"description": "The image response."
},
"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."
},
"text": {
"$ref": "IntentMessageText",
@@ -999,59 +1354,76 @@
]
},
"suggestions": {
- "description": "The suggestion chips for Actions on Google.",
- "$ref": "IntentMessageSuggestions"
+ "$ref": "IntentMessageSuggestions",
+ "description": "The suggestion chips for Actions on Google."
},
"listSelect": {
"$ref": "IntentMessageListSelect",
"description": "The list card response for Actions on Google."
},
"quickReplies": {
- "description": "The quick replies response.",
- "$ref": "IntentMessageQuickReplies"
- },
- "card": {
- "description": "The card response.",
- "$ref": "IntentMessageCard"
- },
- "basicCard": {
- "description": "The basic card response for Actions on Google.",
- "$ref": "IntentMessageBasicCard"
- },
- "carouselSelect": {
- "description": "The carousel card response for Actions on Google.",
- "$ref": "IntentMessageCarouselSelect"
- },
- "linkOutSuggestion": {
- "$ref": "IntentMessageLinkOutSuggestion",
- "description": "The link out suggestion chip for Actions on Google."
+ "$ref": "IntentMessageQuickReplies",
+ "description": "The quick replies response."
}
},
"id": "IntentMessage"
},
"ListContextsResponse": {
- "id": "ListContextsResponse",
- "description": "The response message for Contexts.ListContexts.",
- "type": "object",
"properties": {
+ "nextPageToken": {
+ "description": "Token to retrieve the next page of results, or empty if there are no\nmore results in the list.",
+ "type": "string"
+ },
"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"
},
"Agent": {
"id": "Agent",
"description": "Represents a conversational agent.",
"type": "object",
"properties": {
+ "parent": {
+ "description": "Required. The project of this agent.\nFormat: `projects/\u003cProject ID\u003e`.",
+ "type": "string"
+ },
+ "matchMode": {
+ "enumDescriptions": [
+ "Not specified.",
+ "Best for agents with a small number of examples in intents and/or wide\nuse of templates syntax and composite entities.",
+ "Can be used for agents with a large number of examples in intents,\nespecially the ones using @sys.any or very large developer entities."
+ ],
+ "enum": [
+ "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",
@@ -1072,44 +1444,10 @@
"description": {
"description": "Optional. The description of this agent.\nThe maximum length is 500 characters. If exceeded, the request is rejected.",
"type": "string"
- },
- "parent": {
- "description": "Required. The project of this agent.\nFormat: `projects/\u003cProject ID\u003e`.",
- "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.",
- "Can be used for agents with a large number of examples in intents,\nespecially the ones using @sys.any or very large developer entities."
- ],
- "enum": [
- "MATCH_MODE_UNSPECIFIED",
- "MATCH_MODE_HYBRID",
- "MATCH_MODE_ML_ONLY"
- ]
- },
- "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"
}
}
},
"EntityTypeBatch": {
- "id": "EntityTypeBatch",
"description": "This message is a wrapper around a collection of entity types.",
"type": "object",
"properties": {
@@ -1120,13 +1458,18 @@
"$ref": "EntityType"
}
}
- }
+ },
+ "id": "EntityTypeBatch"
},
"OriginalDetectIntentRequest": {
"id": "OriginalDetectIntentRequest",
"description": "Represents the contents of the original request that was passed to\nthe `[Streaming]DetectIntent` call.",
"type": "object",
"properties": {
+ "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": {
"description": "Optional. This field is set to the value of `QueryParameters.payload` field\npassed in the request.",
"type": "object",
@@ -1134,59 +1477,47 @@
"description": "Properties of the object.",
"type": "any"
}
- },
- "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"
}
}
},
"IntentMessageBasicCardButton": {
+ "id": "IntentMessageBasicCardButton",
"description": "The button object that appears at the bottom of a card.",
"type": "object",
"properties": {
- "openUriAction": {
- "description": "Required. Action to take when a user taps on the button.",
- "$ref": "IntentMessageBasicCardButtonOpenUriAction"
- },
"title": {
"description": "Required. The title of the button.",
"type": "string"
+ },
+ "openUriAction": {
+ "$ref": "IntentMessageBasicCardButtonOpenUriAction",
+ "description": "Required. Action to take when a user taps on the button."
}
- },
- "id": "IntentMessageBasicCardButton"
+ }
},
"IntentMessageSimpleResponse": {
- "description": "The simple response message containing speech or text.",
- "type": "object",
"properties": {
- "textToSpeech": {
- "description": "One of text_to_speech or ssml must be provided. The plain text of the\nspeech output. Mutually exclusive with ssml.",
- "type": "string"
- },
"ssml": {
- "description": "One of text_to_speech or ssml must be provided. Structured spoken\nresponse to the user in the SSML format. Mutually exclusive with\ntext_to_speech.",
- "type": "string"
+ "type": "string",
+ "description": "One of text_to_speech or ssml must be provided. Structured spoken\nresponse to the user in the SSML format. Mutually exclusive with\ntext_to_speech."
},
"displayText": {
"description": "Optional. The text to display.",
"type": "string"
+ },
+ "textToSpeech": {
+ "description": "One of text_to_speech or ssml must be provided. The plain text of the\nspeech output. Mutually exclusive with ssml.",
+ "type": "string"
}
},
- "id": "IntentMessageSimpleResponse"
+ "id": "IntentMessageSimpleResponse",
+ "description": "The simple response message containing speech or text.",
+ "type": "object"
},
"IntentMessageListSelectItem": {
"description": "An item in the list.",
"type": "object",
"properties": {
- "description": {
- "description": "Optional. The main text describing the item.",
- "type": "string"
- },
- "info": {
- "description": "Required. Additional information about this option.",
- "$ref": "IntentMessageSelectItemInfo"
- },
"title": {
"description": "Required. The title of the list item.",
"type": "string"
@@ -1194,12 +1525,19 @@
"image": {
"description": "Optional. The image to display.",
"$ref": "IntentMessageImage"
+ },
+ "description": {
+ "description": "Optional. The main text describing the item.",
+ "type": "string"
+ },
+ "info": {
+ "$ref": "IntentMessageSelectItemInfo",
+ "description": "Required. Additional information about this option."
}
},
"id": "IntentMessageListSelectItem"
},
"IntentMessageBasicCard": {
- "id": "IntentMessageBasicCard",
"description": "The basic card message. Useful for displaying information.",
"type": "object",
"properties": {
@@ -1212,8 +1550,8 @@
"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.",
@@ -1226,15 +1564,16 @@
"$ref": "IntentMessageBasicCardButton"
}
}
- }
+ },
+ "id": "IntentMessageBasicCard"
},
"EntityTypeEntity": {
"description": "Optional. Represents an entity.",
"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"
+ "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`.",
@@ -1247,34 +1586,9 @@
"id": "EntityTypeEntity"
},
"InputAudioConfig": {
- "id": "InputAudioConfig",
"description": "Instructs the speech recognizer how to process the audio content.",
"type": "object",
"properties": {
- "audioEncoding": {
- "enumDescriptions": [
- "Not specified.",
- "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 lossless (therefore\nrecognition is not compromised) and requires only about half the\nbandwidth of `LINEAR16`. `FLAC` stream encoding supports 16-bit and\n24-bit samples, however, not all fields in `STREAMINFO` are supported.",
- "8-bit samples that compand 14-bit audio samples using G.711 PCMU/mu-law.",
- "Adaptive Multi-Rate Narrowband codec. `sample_rate_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\nDialogflow 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": [
- "AUDIO_ENCODING_UNSPECIFIED",
- "AUDIO_ENCODING_LINEAR_16",
- "AUDIO_ENCODING_FLAC",
- "AUDIO_ENCODING_MULAW",
- "AUDIO_ENCODING_AMR",
- "AUDIO_ENCODING_AMR_WB",
- "AUDIO_ENCODING_OGG_OPUS",
- "AUDIO_ENCODING_SPEEX_WITH_HEADER_BYTE"
- ],
- "description": "Required. Audio encoding of the audio content to process.",
- "type": "string"
- },
"sampleRateHertz": {
"description": "Required. Sample rate (in Hertz) of the audio content sent in the query.\nRefer to [Cloud Speech API documentation](/speech/docs/basics) for more\ndetails.",
"format": "int32",
@@ -1290,26 +1604,51 @@
"items": {
"type": "string"
}
+ },
+ "audioEncoding": {
+ "enum": [
+ "AUDIO_ENCODING_UNSPECIFIED",
+ "AUDIO_ENCODING_LINEAR_16",
+ "AUDIO_ENCODING_FLAC",
+ "AUDIO_ENCODING_MULAW",
+ "AUDIO_ENCODING_AMR",
+ "AUDIO_ENCODING_AMR_WB",
+ "AUDIO_ENCODING_OGG_OPUS",
+ "AUDIO_ENCODING_SPEEX_WITH_HEADER_BYTE"
+ ],
+ "description": "Required. Audio encoding of the audio content to process.",
+ "type": "string",
+ "enumDescriptions": [
+ "Not specified.",
+ "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 lossless (therefore\nrecognition is not compromised) and requires only about half the\nbandwidth of `LINEAR16`. `FLAC` stream encoding supports 16-bit and\n24-bit samples, however, not all fields in `STREAMINFO` are supported.",
+ "8-bit samples that compand 14-bit audio samples using G.711 PCMU/mu-law.",
+ "Adaptive Multi-Rate Narrowband codec. `sample_rate_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\nDialogflow 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."
+ ]
}
- }
+ },
+ "id": "InputAudioConfig"
},
"ListSessionEntityTypesResponse": {
- "id": "ListSessionEntityTypesResponse",
"description": "The response message for SessionEntityTypes.ListSessionEntityTypes.",
"type": "object",
"properties": {
- "nextPageToken": {
- "description": "Token to retrieve the next page of results, or empty if there are no\nmore results in the list.",
- "type": "string"
- },
"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"
}
+ },
+ "nextPageToken": {
+ "description": "Token to retrieve the next page of results, or empty if there are no\nmore results in the list.",
+ "type": "string"
}
- }
+ },
+ "id": "ListSessionEntityTypesResponse"
},
"IntentMessageCarouselSelect": {
"id": "IntentMessageCarouselSelect",
@@ -1326,9 +1665,6 @@
}
},
"SearchAgentsResponse": {
- "id": "SearchAgentsResponse",
- "description": "The response message for Agents.SearchAgents.",
- "type": "object",
"properties": {
"agents": {
"description": "The list of agents. There will be a maximum number of items returned based\non the page_size field in the request.",
@@ -1338,26 +1674,16 @@
}
},
"nextPageToken": {
- "description": "Token to retrieve the next page of results, or empty if there are no\nmore results in the list.",
- "type": "string"
+ "type": "string",
+ "description": "Token to retrieve the next page of results, or empty if there are no\nmore results in the list."
}
- }
- },
- "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"
- }
- }
- }
+ },
+ "id": "SearchAgentsResponse",
+ "description": "The response message for Agents.SearchAgents.",
+ "type": "object"
},
"BatchCreateEntitiesRequest": {
+ "id": "BatchCreateEntitiesRequest",
"description": "The request message for EntityTypes.BatchCreateEntities.",
"type": "object",
"properties": {
@@ -1372,29 +1698,22 @@
"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"
- },
- "DetectIntentRequest": {
- "id": "DetectIntentRequest",
- "description": "The request to detect user's intent.",
- "type": "object",
- "properties": {
- "inputAudio": {
- "description": "Optional. The natural language speech audio to be processed. This field\nshould be populated iff `query_input` is set to an input audio config.\nA single request can contain up to 1 minute of speech audio data.",
- "format": "byte",
- "type": "string"
- },
- "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."
- }
}
},
+ "IntentMessageSimpleResponses": {
+ "properties": {
+ "simpleResponses": {
+ "description": "Required. The list of simple responses.",
+ "type": "array",
+ "items": {
+ "$ref": "IntentMessageSimpleResponse"
+ }
+ }
+ },
+ "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"
+ },
"TextInput": {
"description": "Represents the natural language text to be processed.",
"type": "object",
@@ -1410,25 +1729,27 @@
},
"id": "TextInput"
},
- "IntentMessageCardButton": {
- "id": "IntentMessageCardButton",
- "description": "Optional. Contains information about a button.",
+ "DetectIntentRequest": {
+ "description": "The request to detect user's intent.",
"type": "object",
"properties": {
- "text": {
- "description": "Optional. The text to show on the button.",
+ "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"
},
- "postback": {
- "description": "Optional. The text to send back to the Dialogflow API or a URI to\nopen.",
- "type": "string"
+ "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": {
+ "description": "Optional. The parameters of this query.",
+ "$ref": "QueryParameters"
}
- }
+ },
+ "id": "DetectIntentRequest"
},
"ListEntityTypesResponse": {
- "id": "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.",
@@ -1441,25 +1762,30 @@
"description": "Token to retrieve the next page of results, or empty if there are no\nmore results in the list.",
"type": "string"
}
+ },
+ "id": "ListEntityTypesResponse",
+ "description": "The response message for EntityTypes.ListEntityTypes.",
+ "type": "object"
+ },
+ "IntentMessageCardButton": {
+ "id": "IntentMessageCardButton",
+ "description": "Optional. Contains information about a button.",
+ "type": "object",
+ "properties": {
+ "text": {
+ "type": "string",
+ "description": "Optional. The text to show on the button."
+ },
+ "postback": {
+ "type": "string",
+ "description": "Optional. The text to send back to the Dialogflow API or a URI to\nopen."
+ }
}
},
"QueryResult": {
"description": "Represents the result of conversational query or event processing.",
"type": "object",
"properties": {
- "parameters": {
- "description": "The collection of extracted parameters.",
- "type": "object",
- "additionalProperties": {
- "description": "Properties of the object.",
- "type": "any"
- }
- },
- "intentDetectionConfidence": {
- "description": "The intent detection confidence. Values range from 0.0\n(completely uncertain) to 1.0 (completely certain).",
- "format": "float",
- "type": "number"
- },
"allRequiredParamsPresent": {
"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"
@@ -1474,16 +1800,16 @@
"type": "string"
},
"diagnosticInfo": {
- "description": "The free-form diagnostic info. For example, this field\ncould contain webhook call latency.",
- "type": "object",
"additionalProperties": {
- "description": "Properties of the object.",
- "type": "any"
- }
+ "type": "any",
+ "description": "Properties of the object."
+ },
+ "description": "The free-form diagnostic info. For example, this field\ncould contain webhook call latency.",
+ "type": "object"
},
"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"
+ "$ref": "Intent",
+ "description": "The intent that matched the conversational query. Some, not\nall fields are filled in this message, including but not limited to:\n`name`, `display_name` and `webhook_state`."
},
"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.",
@@ -1498,8 +1824,8 @@
},
"webhookPayload": {
"additionalProperties": {
- "description": "Properties of the object.",
- "type": "any"
+ "type": "any",
+ "description": "Properties of the object."
},
"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"
@@ -1522,24 +1848,23 @@
"fulfillmentText": {
"description": "The text to be pronounced to the user or shown on the screen.",
"type": "string"
+ },
+ "parameters": {
+ "additionalProperties": {
+ "description": "Properties of the object.",
+ "type": "any"
+ },
+ "description": "The collection of extracted parameters.",
+ "type": "object"
+ },
+ "intentDetectionConfidence": {
+ "description": "The intent detection confidence. Values range from 0.0\n(completely uncertain) to 1.0 (completely certain).",
+ "format": "float",
+ "type": "number"
}
},
"id": "QueryResult"
},
- "BatchDeleteEntityTypesRequest": {
- "id": "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`.",
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- }
- },
"BatchUpdateEntityTypesResponse": {
"id": "BatchUpdateEntityTypesResponse",
"description": "The response message for EntityTypes.BatchUpdateEntityTypes.",
@@ -1554,8 +1879,62 @@
}
}
},
+ "BatchDeleteEntityTypesRequest": {
+ "properties": {
+ "entityTypeNames": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "Required. The names entity types to delete. All names must point to the\nsame agent as `parent`."
+ }
+ },
+ "id": "BatchDeleteEntityTypesRequest",
+ "description": "The request message for EntityTypes.BatchDeleteEntityTypes.",
+ "type": "object"
+ },
+ "QueryParameters": {
+ "description": "Represents the parameters of the conversational query.",
+ "type": "object",
+ "properties": {
+ "payload": {
+ "description": "Optional. This field can be used to pass custom data into the webhook\nassociated with the agent. Arbitrary JSON objects are supported.",
+ "type": "object",
+ "additionalProperties": {
+ "description": "Properties of the object.",
+ "type": "any"
+ }
+ },
+ "geoLocation": {
+ "$ref": "LatLng",
+ "description": "Optional. The geo location of this conversational query."
+ },
+ "resetContexts": {
+ "type": "boolean",
+ "description": "Optional. Specifies whether to delete all contexts in the current session\nbefore the new ones are activated."
+ },
+ "contexts": {
+ "description": "Optional. The collection of contexts to be activated before this query is\nexecuted.",
+ "type": "array",
+ "items": {
+ "$ref": "Context"
+ }
+ },
+ "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"
+ },
"IntentMessageCard": {
- "description": "The card response message.",
"type": "object",
"properties": {
"title": {
@@ -1578,48 +1957,927 @@
"type": "string"
}
},
- "id": "IntentMessageCard"
+ "id": "IntentMessageCard",
+ "description": "The card response message."
},
- "QueryParameters": {
- "description": "Represents the parameters of the conversational query.",
+ "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": {
- "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.",
+ "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": {
- "$ref": "SessionEntityType"
+ "type": "string"
}
},
- "payload": {
- "description": "Optional. This field can be used to pass custom data into the webhook\nassociated with the agent. Arbitrary JSON objects are supported.",
- "type": "object",
- "additionalProperties": {
- "description": "Properties of the object.",
- "type": "any"
+ "webhookState": {
+ "enum": [
+ "WEBHOOK_STATE_UNSPECIFIED",
+ "WEBHOOK_STATE_ENABLED",
+ "WEBHOOK_STATE_ENABLED_FOR_SLOT_FILLING"
+ ],
+ "description": "Required. Indicates whether webhooks are enabled for the intent.",
+ "type": "string",
+ "enumDescriptions": [
+ "Webhook is disabled in the agent and in the intent.",
+ "Webhook is enabled in the agent and in the intent.",
+ "Webhook is enabled in the agent and in the intent. Also, each slot\nfilling prompt is forwarded to the webhook."
+ ]
+ },
+ "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"
}
},
- "geoLocation": {
- "$ref": "LatLng",
- "description": "Optional. The geo location of this conversational query."
+ "displayName": {
+ "description": "Required. The name of this intent.",
+ "type": "string"
},
- "resetContexts": {
- "description": "Optional. Specifies whether to delete all contexts in the current session\nbefore the new ones are activated.",
+ "rootFollowupIntentName": {
+ "description": "The unique identifier of the root intent in the chain of followup intents.\nIt identifies the correct followup intents chain for this intent.\nFormat: `projects/\u003cProject ID\u003e/agent/intents/\u003cIntent ID\u003e`.",
+ "type": "string"
+ },
+ "isFallback": {
+ "description": "Optional. Indicates whether this is a fallback intent.",
"type": "boolean"
},
- "contexts": {
- "description": "Optional. The collection of contexts to be activated before this query is\nexecuted.",
+ "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"
+ },
+ "parameters": {
+ "description": "Optional. The collection of parameters associated with the intent.",
+ "type": "array",
+ "items": {
+ "$ref": "IntentParameter"
+ }
+ },
+ "resetContexts": {
+ "type": "boolean",
+ "description": "Optional. Indicates whether to delete all contexts in the current\nsession when this intent is matched."
+ },
+ "trainingPhrases": {
+ "type": "array",
+ "items": {
+ "$ref": "IntentTrainingPhrase"
+ },
+ "description": "Optional. The collection of examples/templates that the agent is\ntrained on."
+ },
+ "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",
+ "items": {
+ "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": {
+ "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"
+ }
}
},
- "id": "QueryParameters"
+ "id": "Intent"
+ },
+ "BatchUpdateEntityTypesRequest": {
+ "id": "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": {
+ "$ref": "EntityTypeBatch",
+ "description": "The collection of entity type to update or create."
+ }
+ }
+ },
+ "IntentTrainingPhrasePart": {
+ "description": "Represents a part of a training phrase.",
+ "type": "object",
+ "properties": {
+ "entityType": {
+ "description": "Optional. The entity type name prefixed with `@`. This field is\nrequired for the annotated part of the text and applies only to\nexamples.",
+ "type": "string"
+ },
+ "alias": {
+ "type": "string",
+ "description": "Optional. The parameter name for the value extracted from the\nannotated part of the example."
+ },
+ "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"
+ },
+ "IntentBatch": {
+ "id": "IntentBatch",
+ "description": "This message is a wrapper around a collection of intents.",
+ "type": "object",
+ "properties": {
+ "intents": {
+ "type": "array",
+ "items": {
+ "$ref": "Intent"
+ },
+ "description": "A collection of intents."
+ }
+ }
+ },
+ "BatchDeleteEntitiesRequest": {
+ "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`.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "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"
+ }
+ },
+ "id": "BatchDeleteEntitiesRequest",
+ "description": "The request message for EntityTypes.BatchDeleteEntities.",
+ "type": "object"
+ },
+ "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"
+ },
+ "items": {
+ "description": "Required. List items.",
+ "type": "array",
+ "items": {
+ "$ref": "IntentMessageListSelectItem"
+ }
+ }
+ },
+ "id": "IntentMessageListSelect"
+ },
+ "IntentMessageSuggestion": {
+ "description": "The suggestion chip message that the user can tap to quickly post a reply\nto the conversation.",
+ "type": "object",
+ "properties": {
+ "title": {
+ "description": "Required. The text shown the in the suggestion chip.",
+ "type": "string"
+ }
+ },
+ "id": "IntentMessageSuggestion"
+ },
+ "IntentMessageQuickReplies": {
+ "description": "The quick replies response message.",
+ "type": "object",
+ "properties": {
+ "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"
+ },
+ "IntentMessageCarouselSelectItem": {
+ "id": "IntentMessageCarouselSelectItem",
+ "description": "An item in the carousel.",
+ "type": "object",
+ "properties": {
+ "description": {
+ "description": "Optional. The body text of the card.",
+ "type": "string"
+ },
+ "info": {
+ "$ref": "IntentMessageSelectItemInfo",
+ "description": "Required. Additional info about the option item."
+ },
+ "title": {
+ "type": "string",
+ "description": "Required. Title of the carousel item."
+ },
+ "image": {
+ "description": "Optional. The image to display.",
+ "$ref": "IntentMessageImage"
+ }
+ }
+ },
+ "WebhookRequest": {
+ "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": {
+ "description": "The result of the conversational query or event processing. Contains the\nsame value as `[Streaming]DetectIntentResponse.query_result`.",
+ "$ref": "QueryResult"
+ },
+ "originalDetectIntentRequest": {
+ "description": "Optional. The contents of the original request that was passed to\n`[Streaming]DetectIntent` call.",
+ "$ref": "OriginalDetectIntentRequest"
+ }
+ },
+ "id": "WebhookRequest",
+ "description": "The request message for a webhook call."
+ },
+ "IntentTrainingPhrase": {
+ "description": "Represents an example or template that the agent is trained on.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "Required. The unique identifier of this training phrase.",
+ "type": "string"
+ },
+ "timesAddedCount": {
+ "description": "Optional. Indicates how many times this example or template was added to\nthe intent. Each time a developer adds an existing sample by editing an\nintent or training, this counter is increased.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "type": {
+ "description": "Required. The type of the training phrase.",
+ "type": "string",
+ "enumDescriptions": [
+ "Not specified. This value should never be used.",
+ "Examples do not contain @-prefixed entity type names, but example parts\ncan be annotated with entity types.",
+ "Templates are not annotated with entity types, but they can contain\n@-prefixed entity type names as substrings."
+ ],
+ "enum": [
+ "TYPE_UNSPECIFIED",
+ "EXAMPLE",
+ "TEMPLATE"
+ ]
+ },
+ "parts": {
+ "description": "Required. The collection of training phrase parts (can be annotated).\nFields: `entity_type`, `alias` and `user_defined` should be populated\nonly for the annotated parts of the training phrase.",
+ "type": "array",
+ "items": {
+ "$ref": "IntentTrainingPhrasePart"
+ }
+ }
+ },
+ "id": "IntentTrainingPhrase"
+ },
+ "RestoreAgentRequest": {
+ "description": "The request message for Agents.RestoreAgent.",
+ "type": "object",
+ "properties": {
+ "agentContent": {
+ "description": "The agent to restore.\n\nExample for how to restore an agent via the command line:\n\ncurl \\\n 'https://dialogflow.googleapis.com/v2beta1/projects/\u003cproject_name\u003e/agent:restore\\\n -X POST \\\n -H 'Authorization: Bearer '$(gcloud auth print-access-token) \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n --compressed \\\n --data-binary \"{\n 'agentContent': '$(cat \u003cagent zip file\u003e | base64 -w 0)'\n }\" \\",
+ "format": "byte",
+ "type": "string"
+ },
+ "agentUri": {
+ "type": "string",
+ "description": "Warning: Restoring agents from a URI is not implemented yet.\nThis feature is coming soon.\n\nThe URI to a Google Cloud Storage file containing the agent to restore.\nNote: The URI must start with \"gs://\"."
+ }
+ },
+ "id": "RestoreAgentRequest"
+ },
+ "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"
+ }
+ },
+ "id": "LatLng"
+ },
+ "ListIntentsResponse": {
+ "type": "object",
+ "properties": {
+ "intents": {
+ "description": "The list of agent intents. There will be a maximum number of items\nreturned based on the page_size field in the request.",
+ "type": "array",
+ "items": {
+ "$ref": "Intent"
+ }
+ },
+ "nextPageToken": {
+ "description": "Token to retrieve the next page of results, or empty if there are no\nmore results in the list.",
+ "type": "string"
+ }
+ },
+ "id": "ListIntentsResponse",
+ "description": "The response message for Intents.ListIntents."
+ },
+ "Context": {
+ "description": "Represents a context.",
+ "type": "object",
+ "properties": {
+ "lifespanCount": {
+ "description": "Optional. The number of conversational query requests after which the\ncontext expires. If set to `0` (the default) the context expires\nimmediately. Contexts expire automatically after 10 minutes even if there\nare no matching queries.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "name": {
+ "description": "Required. The unique identifier of the context. Format:\n`projects/\u003cProject ID\u003e/agent/sessions/\u003cSession ID\u003e/contexts/\u003cContext ID\u003e`.\nNote: The Context ID is always converted to lowercase.",
+ "type": "string"
+ },
+ "parameters": {
+ "additionalProperties": {
+ "description": "Properties of the object.",
+ "type": "any"
+ },
+ "description": "Optional. The collection of parameters associated with this context.\nRefer to [this doc](https://dialogflow.com/docs/actions-and-parameters) for\nsyntax.",
+ "type": "object"
+ }
+ },
+ "id": "Context"
+ },
+ "ImportAgentRequest": {
+ "properties": {
+ "agentContent": {
+ "description": "The agent to import.\n\nExample for how to import an agent via the command line:\n\ncurl \\\n 'https://dialogflow.googleapis.com/v2beta1/projects/\u003cproject_name\u003e/agent:import\\\n -X POST \\\n -H 'Authorization: Bearer '$(gcloud auth print-access-token) \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n --compressed \\\n --data-binary \"{\n 'agentContent': '$(cat \u003cagent zip file\u003e | base64 -w 0)'\n }\"",
+ "format": "byte",
+ "type": "string"
+ },
+ "agentUri": {
+ "description": "Warning: Importing agents from a URI is not implemented yet.\nThis feature is coming soon.\n\nThe URI to a Google Cloud Storage file containing the agent to import.\nNote: The URI must start with \"gs://\".",
+ "type": "string"
+ }
+ },
+ "id": "ImportAgentRequest",
+ "description": "The request message for Agents.ImportAgent.",
+ "type": "object"
+ },
+ "BatchUpdateIntentsResponse": {
+ "type": "object",
+ "properties": {
+ "intents": {
+ "description": "The collection of updated or created intents.",
+ "type": "array",
+ "items": {
+ "$ref": "Intent"
+ }
+ }
+ },
+ "id": "BatchUpdateIntentsResponse",
+ "description": "The response message for Intents.BatchUpdateIntents."
+ },
+ "IntentParameter": {
+ "description": "Represents intent parameters.",
+ "type": "object",
+ "properties": {
+ "displayName": {
+ "description": "Required. The name of the parameter.",
+ "type": "string"
+ },
+ "entityTypeDisplayName": {
+ "description": "Optional. The name of the entity type, prefixed with `@`, that\ndescribes values of the parameter. If the parameter is\nrequired, this must be provided.",
+ "type": "string"
+ },
+ "prompts": {
+ "description": "Optional. The collection of prompts that the agent can present to the\nuser in order to collect value for the parameter.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "mandatory": {
+ "description": "Optional. Indicates whether the parameter is required. That is,\nwhether the intent cannot be completed without collecting the parameter\nvalue.",
+ "type": "boolean"
+ },
+ "defaultValue": {
+ "description": "Optional. The default value to use when the `value` yields an empty\nresult.\nDefault values can be extracted from contexts by using the following\nsyntax: `#context_name.parameter_name`.",
+ "type": "string"
+ },
+ "isList": {
+ "type": "boolean",
+ "description": "Optional. Indicates whether the parameter represents a list of values."
+ },
+ "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"
+ }
+ },
+ "id": "IntentParameter"
+ },
+ "ExportAgentResponse": {
+ "description": "The response message for Agents.ExportAgent.",
+ "type": "object",
+ "properties": {
+ "agentContent": {
+ "description": "The exported agent.\n\nExample for how to export an agent to a zip file via a command line:\n\ncurl \\\n 'https://dialogflow.googleapis.com/v2beta1/projects/\u003cproject_name\u003e/agent:export'\\\n -X POST \\\n -H 'Authorization: Bearer '$(gcloud auth print-access-token) \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n --compressed \\\n --data-binary '{}' \\\n| grep agentContent | sed -e 's/.*\"agentContent\": \"\\([^\"]*\\)\".*/\\1/' \\\n| base64 --decode \u003e \u003cagent zip file\u003e",
+ "format": "byte",
+ "type": "string"
+ },
+ "agentUri": {
+ "description": "The URI to a file containing the exported agent. This field is populated\nonly if `agent_uri` is specified in `ExportAgentRequest`.",
+ "type": "string"
+ }
+ },
+ "id": "ExportAgentResponse"
+ },
+ "IntentMessageBasicCardButtonOpenUriAction": {
+ "description": "Opens the given URI.",
+ "type": "object",
+ "properties": {
+ "uri": {
+ "description": "Required. The HTTP or HTTPS scheme URI.",
+ "type": "string"
+ }
+ },
+ "id": "IntentMessageBasicCardButtonOpenUriAction"
+ },
+ "IntentMessageImage": {
+ "description": "The image response message.",
+ "type": "object",
+ "properties": {
+ "imageUri": {
+ "description": "Optional. The public URI to an image file.",
+ "type": "string"
+ }
+ },
+ "id": "IntentMessageImage"
+ },
+ "BatchUpdateIntentsRequest": {
+ "description": "The request message for Intents.BatchUpdateIntents.",
+ "type": "object",
+ "properties": {
+ "intentBatchUri": {
+ "description": "Warning: Importing intents from a URI is not implemented yet.\nThis feature is coming soon.\nThe URI to a Google Cloud Storage file containing intents to update or\ncreate. The file format can either be a serialized proto (of IntentBatch\ntype) or JSON object. Note: The URI must start with \"gs://\".",
+ "type": "string"
+ },
+ "intentView": {
+ "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": {
+ "$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"
+ }
+ },
+ "id": "BatchUpdateIntentsRequest"
+ },
+ "TrainAgentRequest": {
+ "type": "object",
+ "properties": {},
+ "id": "TrainAgentRequest",
+ "description": "The request message for Agents.TrainAgent."
+ },
+ "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": {
+ "entityOverrideMode": {
+ "description": "Required. Indicates whether the additional data should override or\nsupplement the developer entity type definition.",
+ "type": "string",
+ "enumDescriptions": [
+ "Not specified. This value should be never used.",
+ "The collection of session entities overrides the collection of entities\nin the corresponding developer entity type.",
+ "The collection of session entities extends the collection of entities in\nthe corresponding developer entity type.\nCalls to `ListSessionEntityTypes`, `GetSessionEntityType`,\n`CreateSessionEntityType` and `UpdateSessionEntityType` return the full\ncollection of entities from the developer entity type in the agent's\ndefault language and the session entity type."
+ ],
+ "enum": [
+ "ENTITY_OVERRIDE_MODE_UNSPECIFIED",
+ "ENTITY_OVERRIDE_MODE_OVERRIDE",
+ "ENTITY_OVERRIDE_MODE_SUPPLEMENT"
+ ]
+ },
+ "entities": {
+ "type": "array",
+ "items": {
+ "$ref": "EntityTypeEntity"
+ },
+ "description": "Required. The collection of entities associated with this session entity\ntype."
+ },
+ "name": {
+ "type": "string",
+ "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`."
+ }
+ },
+ "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": {
+ "type": "string",
+ "description": "Optional. The mask to control which fields get updated.",
+ "format": "google-fieldmask"
+ }
+ },
+ "id": "BatchUpdateEntitiesRequest"
+ },
+ "WebhookResponse": {
+ "type": "object",
+ "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": {
+ "type": "string",
+ "description": "Optional. This value is passed directly to `QueryResult.webhook_source`."
+ }
+ },
+ "id": "WebhookResponse",
+ "description": "The response message for a webhook call."
+ },
+ "BatchDeleteIntentsRequest": {
+ "description": "The request message for Intents.BatchDeleteIntents.",
+ "type": "object",
+ "properties": {
+ "intents": {
+ "description": "Required. The collection of intents to delete. Only intent `name` must be\nfilled in.",
+ "type": "array",
+ "items": {
+ "$ref": "Intent"
+ }
+ }
+ },
+ "id": "BatchDeleteIntentsRequest"
+ },
+ "QueryInput": {
+ "properties": {
+ "audioConfig": {
+ "description": "Instructs the speech recognizer how to process the speech audio.",
+ "$ref": "InputAudioConfig"
+ },
+ "event": {
+ "$ref": "EventInput",
+ "description": "The event to be processed."
+ },
+ "text": {
+ "$ref": "TextInput",
+ "description": "The natural language text to be processed."
+ }
+ },
+ "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": {
+ "description": "Represents a single followup intent in the chain.",
+ "type": "object",
+ "properties": {
+ "followupIntentName": {
+ "description": "The unique identifier of the followup intent.\nFormat: `projects/\u003cProject ID\u003e/agent/intents/\u003cIntent ID\u003e`.",
+ "type": "string"
+ },
+ "parentFollowupIntentName": {
+ "description": "The unique identifier of the followup intent parent.\nFormat: `projects/\u003cProject ID\u003e/agent/intents/\u003cIntent ID\u003e`.",
+ "type": "string"
+ }
+ },
+ "id": "IntentFollowupIntentInfo"
+ },
+ "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."
+ },
+ "webhookStatus": {
+ "$ref": "Status",
+ "description": "Specifies the status of the webhook request. `webhook_status`\nis never populated in webhook requests."
+ }
+ },
+ "id": "DetectIntentResponse"
+ },
+ "IntentMessageLinkOutSuggestion": {
+ "description": "The suggestion chip message that allows the user to jump out to the app\nor website associated with this agent.",
+ "type": "object",
+ "properties": {
+ "destinationName": {
+ "description": "Required. The name of the app or site this chip is linking to.",
+ "type": "string"
+ },
+ "uri": {
+ "description": "Required. The URI of the app or site to open when the user taps the\nsuggestion chip.",
+ "type": "string"
+ }
+ },
+ "id": "IntentMessageLinkOutSuggestion"
+ },
+ "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": {
+ "key": {
+ "description": "Required. A unique key that will be sent back to the agent if this\nresponse is given.",
+ "type": "string"
+ },
+ "synonyms": {
+ "description": "Optional. A list of synonyms that can also be used to trigger this\nitem in dialog.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "id": "IntentMessageSelectItemInfo",
+ "description": "Additional info about the select item for when it is triggered in a\ndialog.",
+ "type": "object"
+ },
+ "Operation": {
+ "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "The server-assigned name, which is only unique within the same service that\noriginally returns it. If you use the default HTTP mapping, the\n`name` should have the format of `operations/some/unique/name`.",
+ "type": "string"
+ },
+ "error": {
+ "$ref": "Status",
+ "description": "The error result of the operation in case of failure or cancellation."
+ },
+ "metadata": {
+ "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": {
+ "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`."
+ }
+ },
+ "id": "Operation"
+ },
+ "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",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "Required. The unique identifier of the event."
+ },
+ "parameters": {
+ "additionalProperties": {
+ "description": "Properties of the object.",
+ "type": "any"
+ },
+ "description": "Optional. The collection of parameters associated with the event.",
+ "type": "object"
+ },
+ "languageCode": {
+ "type": "string",
+ "description": "Required. The language of this query. See [Language\nSupport](https://dialogflow.com/docs/languages) for a list of the\ncurrently supported language codes. Note that queries in the same session\ndo not necessarily need to specify the same language."
+ }
+ }
+ },
+ "IntentMessageSuggestions": {
+ "id": "IntentMessageSuggestions",
+ "description": "The collection of suggestions.",
+ "type": "object",
+ "properties": {
+ "suggestions": {
+ "description": "Required. The list of suggested replies.",
+ "type": "array",
+ "items": {
+ "$ref": "IntentMessageSuggestion"
+ }
+ }
+ }
+ },
+ "EntityType": {
+ "properties": {
+ "autoExpansionMode": {
+ "type": "string",
+ "enumDescriptions": [
+ "Auto expansion disabled for the entity.",
+ "Allows an agent to recognize values that have not been explicitly\nlisted in the entity."
+ ],
+ "enum": [
+ "AUTO_EXPANSION_MODE_UNSPECIFIED",
+ "AUTO_EXPANSION_MODE_DEFAULT"
+ ],
+ "description": "Optional. Indicates whether the entity type can be automatically\nexpanded."
+ },
+ "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"
+ },
+ "displayName": {
+ "description": "Required. The name of the entity.",
+ "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"
+ }
+ },
+ "id": "EntityType",
+ "description": "Represents an entity type.\nEntity types serve as a tool for extracting parameter values from natural\nlanguage queries.",
+ "type": "object"
}
},
"icons": {
@@ -1643,1263 +2901,5 @@
"batchPath": "batch",
"fullyEncodeReservedExpansion": true,
"title": "Dialogflow API",
- "ownerName": "Google",
- "resources": {
- "projects": {
- "methods": {
- "getAgent": {
- "response": {
- "$ref": "Agent"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "GET",
- "parameters": {
- "parent": {
- "description": "Required. The project that the agent to fetch is associated with.\nFormat: `projects/\u003cProject ID\u003e`.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v2beta1/projects/{projectsId}/agent",
- "path": "v2beta1/{+parent}/agent",
- "id": "dialogflow.projects.getAgent",
- "description": "Retrieves the specified agent."
- }
- },
- "resources": {
- "agent": {
- "methods": {
- "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",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "POST",
- "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"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v2beta1/projects/{projectsId}/agent:import"
- },
- "search": {
- "path": "v2beta1/{+parent}/agent:search",
- "id": "dialogflow.projects.agent.search",
- "description": "Returns the list of agents.\n\nSince there is at most one conversational agent per project, this method is\nuseful primarily for listing all agents across projects the caller has\naccess to. One can achieve that with a wildcard project collection id \"-\".\nRefer to [List\nSub-Collections](https://cloud.google.com/apis/design/design_patterns#list_sub-collections).",
- "response": {
- "$ref": "SearchAgentsResponse"
- },
- "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": {
- "description": "Required. The project to list agents from.\nFormat: `projects/\u003cProject ID or '-'\u003e`.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v2beta1/projects/{projectsId}/agent:search"
- },
- "train": {
- "request": {
- "$ref": "TrainAgentRequest"
- },
- "description": "Trains the specified agent.\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 train 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:train",
- "path": "v2beta1/{+parent}/agent:train",
- "id": "dialogflow.projects.agent.train"
- },
- "export": {
- "parameters": {
- "parent": {
- "pattern": "^projects/[^/]+$",
- "location": "path",
- "description": "Required. The project that the agent to export is associated with.\nFormat: `projects/\u003cProject ID\u003e`.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v2beta1/projects/{projectsId}/agent:export",
- "id": "dialogflow.projects.agent.export",
- "path": "v2beta1/{+parent}/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",
- "httpMethod": "POST",
- "parameterOrder": [
- "parent"
- ],
- "response": {
- "$ref": "Operation"
- }
- },
- "restore": {
- "path": "v2beta1/{+parent}/agent:restore",
- "id": "dialogflow.projects.agent.restore",
- "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",
- "request": {
- "$ref": "RestoreAgentRequest"
- },
- "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 restore is associated with.\nFormat: `projects/\u003cProject ID\u003e`.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v2beta1/projects/{projectsId}/agent:restore"
- }
- },
- "resources": {
- "sessions": {
- "methods": {
- "deleteContexts": {
- "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",
- "id": "dialogflow.projects.agent.sessions.deleteContexts",
- "path": "v2beta1/{+parent}/contexts",
- "description": "Deletes all active contexts in the specified session.",
- "httpMethod": "DELETE",
- "parameterOrder": [
- "parent"
- ],
- "response": {
- "$ref": "Empty"
- }
- },
- "detectIntent": {
- "httpMethod": "POST",
- "parameterOrder": [
- "session"
- ],
- "response": {
- "$ref": "DetectIntentResponse"
- },
- "parameters": {
- "session": {
- "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/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v2beta1/projects/{projectsId}/agent/sessions/{sessionsId}:detectIntent",
- "id": "dialogflow.projects.agent.sessions.detectIntent",
- "path": "v2beta1/{+session}:detectIntent",
- "request": {
- "$ref": "DetectIntentRequest"
- },
- "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."
- }
- },
- "resources": {
- "entityTypes": {
- "methods": {
- "delete": {
- "httpMethod": "DELETE",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Empty"
- },
- "parameters": {
- "name": {
- "description": "Required. The name of the entity type to delete. Format:\n`projects/\u003cProject ID\u003e/agent/sessions/\u003cSession ID\u003e/entityTypes/\u003cEntity Type\nDisplay Name\u003e`.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/agent/sessions/[^/]+/entityTypes/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v2beta1/projects/{projectsId}/agent/sessions/{sessionsId}/entityTypes/{entityTypesId}",
- "id": "dialogflow.projects.agent.sessions.entityTypes.delete",
- "path": "v2beta1/{+name}",
- "description": "Deletes the specified session entity type."
- },
- "list": {
- "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": {
- "description": "Required. The session to list all session entity types from.\nFormat: `projects/\u003cProject ID\u003e/agent/sessions/\u003cSession ID\u003e`.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/agent/sessions/[^/]+$",
- "location": "path"
- }
- },
- "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.list",
- "description": "Returns the list of all session entity types in the specified session.",
- "response": {
- "$ref": "ListSessionEntityTypesResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "GET"
- },
- "get": {
- "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"
- ],
- "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": {
- "request": {
- "$ref": "SessionEntityType"
- },
- "description": "Updates the specified session entity type.",
- "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": {
- "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}",
- "path": "v2beta1/{+name}",
- "id": "dialogflow.projects.agent.sessions.entityTypes.patch"
- },
- "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": {
- "create": {
- "parameters": {
- "parent": {
- "description": "Required. The session to create a context 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}/contexts",
- "path": "v2beta1/{+parent}/contexts",
- "id": "dialogflow.projects.agent.sessions.contexts.create",
- "request": {
- "$ref": "Context"
- },
- "description": "Creates a context.",
- "response": {
- "$ref": "Context"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "POST"
- },
- "delete": {
- "description": "Deletes the specified context.",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "DELETE",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "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`.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v2beta1/projects/{projectsId}/agent/sessions/{sessionsId}/contexts/{contextsId}",
- "path": "v2beta1/{+name}",
- "id": "dialogflow.projects.agent.sessions.contexts.delete"
- },
- "list": {
- "path": "v2beta1/{+parent}/contexts",
- "id": "dialogflow.projects.agent.sessions.contexts.list",
- "description": "Returns the list of all contexts in the specified session.",
- "response": {
- "$ref": "ListContextsResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "GET",
- "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"
- },
- "get": {
- "description": "Retrieves the specified context.",
- "response": {
- "$ref": "Context"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/agent/sessions/[^/]+/contexts/[^/]+$",
- "location": "path",
- "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"
- }
- },
- "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.get"
- },
- "patch": {
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "updateMask": {
- "description": "Optional. The mask to control which fields get updated.",
- "format": "google-fieldmask",
- "type": "string",
- "location": "query"
- },
- "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.",
- "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.patch",
- "description": "Updates the specified context.",
- "request": {
- "$ref": "Context"
- },
- "response": {
- "$ref": "Context"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "PATCH"
- }
- }
- }
- }
- },
- "entityTypes": {
- "methods": {
- "patch": {
- "response": {
- "$ref": "EntityType"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "PATCH",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/agent/entityTypes/[^/]+$",
- "location": "path",
- "description": "Required for all methods except `create` (`create` populates the name\nautomatically.\nThe unique identifier of the entity type. Format:\n`projects/\u003cProject ID\u003e/agent/entityTypes/\u003cEntity Type ID\u003e`.",
- "required": true,
- "type": "string"
- },
- "languageCode": {
- "description": "Optional. The language of entity synonyms defined in `entity_type`. If not\nspecified, the agent's default language is used.\n[More than a dozen\nlanguages](https://dialogflow.com/docs/reference/language) are supported.\nNote: languages must be enabled in the agent, before they can be used.",
- "type": "string",
- "location": "query"
- },
- "updateMask": {
- "description": "Optional. The mask to control which fields get updated.",
- "format": "google-fieldmask",
- "type": "string",
- "location": "query"
- }
- },
- "flatPath": "v2beta1/projects/{projectsId}/agent/entityTypes/{entityTypesId}",
- "path": "v2beta1/{+name}",
- "id": "dialogflow.projects.agent.entityTypes.patch",
- "description": "Updates the specified entity type.",
- "request": {
- "$ref": "EntityType"
- }
- },
- "get": {
- "description": "Retrieves the specified entity type.",
- "response": {
- "$ref": "EntityType"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "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}",
- "path": "v2beta1/{+name}",
- "id": "dialogflow.projects.agent.entityTypes.get"
- },
- "batchUpdate": {
- "request": {
- "$ref": "BatchUpdateEntityTypesRequest"
- },
- "description": "Updates/Creates multiple entity types in the specified agent.\n\nOperation \u003cresponse: BatchUpdateEntityTypesResponse,\n metadata: google.protobuf.Struct\u003e",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "POST",
- "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"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v2beta1/projects/{projectsId}/agent/entityTypes:batchUpdate",
- "path": "v2beta1/{+parent}/entityTypes:batchUpdate",
- "id": "dialogflow.projects.agent.entityTypes.batchUpdate"
- },
- "delete": {
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "DELETE",
- "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"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v2beta1/projects/{projectsId}/agent/entityTypes/{entityTypesId}",
- "path": "v2beta1/{+name}",
- "id": "dialogflow.projects.agent.entityTypes.delete",
- "description": "Deletes the specified entity type."
- },
- "list": {
- "response": {
- "$ref": "ListEntityTypesResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "GET",
- "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": {
- "description": "Required. The agent to list all entity types from.\nFormat: `projects/\u003cProject ID\u003e/agent`.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/agent$",
- "location": "path"
- },
- "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",
- "description": "Returns the list of all entity types in the specified agent."
- },
- "batchDelete": {
- "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",
- "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": {
- "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": {
- "description": "Optional. The language of entity synonyms defined in `entity_type`. If not\nspecified, the agent's default language is used.\n[More than a dozen\nlanguages](https://dialogflow.com/docs/reference/language) are supported.\nNote: languages must be enabled in the agent, before they can be used.",
- "type": "string",
- "location": "query"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v2beta1/projects/{projectsId}/agent/entityTypes",
- "path": "v2beta1/{+parent}/entityTypes",
- "id": "dialogflow.projects.agent.entityTypes.create",
- "request": {
- "$ref": "EntityType"
- },
- "description": "Creates an entity type in the specified agent.",
- "response": {
- "$ref": "EntityType"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "POST"
- }
- },
- "resources": {
- "entities": {
- "methods": {
- "batchUpdate": {
- "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",
- "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"
- }
- },
- "batchDelete": {
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "POST",
- "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",
- "path": "v2beta1/{+parent}/entities:batchDelete",
- "id": "dialogflow.projects.agent.entityTypes.entities.batchDelete",
- "request": {
- "$ref": "BatchDeleteEntitiesRequest"
- },
- "description": "Deletes entities in the specified entity type.\n\nOperation \u003cresponse: google.protobuf.Empty,\n metadata: google.protobuf.Struct\u003e"
- },
- "batchCreate": {
- "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"
- },
- "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"
- }
- }
- }
- }
- },
- "intents": {
- "methods": {
- "patch": {
- "path": "v2beta1/{+name}",
- "id": "dialogflow.projects.agent.intents.patch",
- "request": {
- "$ref": "Intent"
- },
- "description": "Updates the specified intent.",
- "response": {
- "$ref": "Intent"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "PATCH",
- "parameters": {
- "languageCode": {
- "location": "query",
- "description": "Optional. The language of training phrases, parameters and rich messages\ndefined in `intent`. If not specified, the agent's default language is\nused. [More than a dozen\nlanguages](https://dialogflow.com/docs/reference/language) are supported.\nNote: languages must be enabled in the agent, before they can be used.",
- "type": "string"
- },
- "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"
- },
- "intentView": {
- "location": "query",
- "enum": [
- "INTENT_VIEW_UNSPECIFIED",
- "INTENT_VIEW_FULL"
- ],
- "description": "Optional. The resource view to apply to the returned intent.",
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v2beta1/projects/{projectsId}/agent/intents/{intentsId}"
- },
- "get": {
- "description": "Retrieves the specified intent.",
- "response": {
- "$ref": "Intent"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "parameters": {
- "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"
- },
- "intentView": {
- "location": "query",
- "enum": [
- "INTENT_VIEW_UNSPECIFIED",
- "INTENT_VIEW_FULL"
- ],
- "description": "Optional. The resource view to apply to the returned intent.",
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v2beta1/projects/{projectsId}/agent/intents/{intentsId}",
- "path": "v2beta1/{+name}",
- "id": "dialogflow.projects.agent.intents.get"
- },
- "batchUpdate": {
- "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",
- "request": {
- "$ref": "BatchUpdateIntentsRequest"
- },
- "description": "Updates/Creates multiple intents in the specified agent.\n\nOperation \u003cresponse: BatchUpdateIntentsResponse\u003e",
- "httpMethod": "POST",
- "parameterOrder": [
- "parent"
- ],
- "response": {
- "$ref": "Operation"
- }
- },
- "delete": {
- "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}",
- "path": "v2beta1/{+name}",
- "id": "dialogflow.projects.agent.intents.delete",
- "description": "Deletes the specified intent."
- },
- "list": {
- "id": "dialogflow.projects.agent.intents.list",
- "path": "v2beta1/{+parent}/intents",
- "description": "Returns the list of all intents in the specified agent.",
- "httpMethod": "GET",
- "parameterOrder": [
- "parent"
- ],
- "response": {
- "$ref": "ListIntentsResponse"
- },
- "parameters": {
- "parent": {
- "pattern": "^projects/[^/]+/agent$",
- "location": "path",
- "description": "Required. The agent to list all intents from.\nFormat: `projects/\u003cProject ID\u003e/agent`.",
- "required": true,
- "type": "string"
- },
- "languageCode": {
- "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"
- },
- "pageToken": {
- "description": "Optional. The next_page_token value returned from a previous list request.",
- "type": "string",
- "location": "query"
- },
- "pageSize": {
- "location": "query",
- "description": "Optional. The maximum number of items to return in a single page. By\ndefault 100 and at most 1000.",
- "format": "int32",
- "type": "integer"
- },
- "intentView": {
- "location": "query",
- "enum": [
- "INTENT_VIEW_UNSPECIFIED",
- "INTENT_VIEW_FULL"
- ],
- "description": "Optional. The resource view to apply to the returned intent.",
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v2beta1/projects/{projectsId}/agent/intents"
- },
- "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",
- "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/intents:batchDelete",
- "path": "v2beta1/{+parent}/intents:batchDelete",
- "id": "dialogflow.projects.agent.intents.batchDelete"
- },
- "create": {
- "path": "v2beta1/{+parent}/intents",
- "id": "dialogflow.projects.agent.intents.create",
- "description": "Creates an intent in the specified agent.",
- "request": {
- "$ref": "Intent"
- },
- "response": {
- "$ref": "Intent"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "POST",
- "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"
- },
- "parent": {
- "description": "Required. The agent to create a intent for.\nFormat: `projects/\u003cProject ID\u003e/agent`.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/agent$",
- "location": "path"
- },
- "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"
- }
- }
- }
- }
- },
- "operations": {
- "methods": {
- "get": {
- "httpMethod": "GET",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Operation"
- },
- "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": "v2beta1/projects/{projectsId}/operations/{operationsId}",
- "id": "dialogflow.projects.operations.get",
- "path": "v2beta1/{+name}",
- "description": "Gets the latest state of a long-running operation. Clients can use this\nmethod to poll the operation result at intervals as recommended by the API\nservice."
- }
- }
- }
- }
- }
- },
- "parameters": {
- "upload_protocol": {
- "location": "query",
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string"
- },
- "prettyPrint": {
- "location": "query",
- "description": "Returns response with indentations and line breaks.",
- "type": "boolean",
- "default": "true"
- },
- "fields": {
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string",
- "location": "query"
- },
- "uploadType": {
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string",
- "location": "query"
- },
- "callback": {
- "description": "JSONP",
- "type": "string",
- "location": "query"
- },
- "$.xgafv": {
- "description": "V1 error format.",
- "type": "string",
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query",
- "enum": [
- "1",
- "2"
- ]
- },
- "alt": {
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query",
- "description": "Data format for response.",
- "default": "json",
- "enum": [
- "json",
- "media",
- "proto"
- ],
- "type": "string"
- },
- "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": "v2beta1",
- "baseUrl": "https://dialogflow.googleapis.com/",
- "servicePath": "",
- "kind": "discovery#restDescription",
- "description": "An end-to-end development suite for conversational interfaces (e.g., chatbots, voice-powered apps and devices).",
- "basePath": "",
- "id": "dialogflow:v2beta1",
- "documentationLink": "https://cloud.google.com/dialogflow-enterprise/",
- "revision": "20171218"
+ "ownerName": "Google"
}
diff --git a/digitalassetlinks/v1/digitalassetlinks-api.json b/digitalassetlinks/v1/digitalassetlinks-api.json
index 9a9ca9e..a21820d 100644
--- a/digitalassetlinks/v1/digitalassetlinks-api.json
+++ b/digitalassetlinks/v1/digitalassetlinks-api.json
@@ -1,6 +1,11 @@
{
- "discoveryVersion": "v1",
+ "batchPath": "batch",
+ "revision": "20180103",
+ "documentationLink": "https://developers.google.com/digital-asset-links/",
+ "id": "digitalassetlinks:v1",
+ "title": "Digital Asset Links API",
"ownerName": "Google",
+ "discoveryVersion": "v1",
"version_module": true,
"resources": {
"statements": {
@@ -13,24 +18,24 @@
"parameterOrder": [],
"httpMethod": "GET",
"parameters": {
- "source.androidApp.certificate.sha256Fingerprint": {
- "location": "query",
- "description": "The uppercase SHA-265 fingerprint of the certificate. From the PEM\n certificate, it can be acquired like this:\n\n $ keytool -printcert -file $CERTFILE | grep SHA256:\n SHA256: 14:6D:E9:83:C5:73:06:50:D8:EE:B9:95:2F:34:FC:64:16:A0:83: \\\n 42:E6:1D:BE:A8:8A:04:96:B2:3F:CF:44:E5\n\nor like this:\n\n $ openssl x509 -in $CERTFILE -noout -fingerprint -sha256\n SHA256 Fingerprint=14:6D:E9:83:C5:73:06:50:D8:EE:B9:95:2F:34:FC:64: \\\n 16:A0:83:42:E6:1D:BE:A8:8A:04:96:B2:3F:CF:44:E5\n\nIn this example, the contents of this field would be `14:6D:E9:83:C5:73:\n06:50:D8:EE:B9:95:2F:34:FC:64:16:A0:83:42:E6:1D:BE:A8:8A:04:96:B2:3F:CF:\n44:E5`.\n\nIf these tools are not available to you, you can convert the PEM\ncertificate into the DER format, compute the SHA-256 hash of that string\nand represent the result as a hexstring (that is, uppercase hexadecimal\nrepresentations of each octet, separated by colons).",
- "type": "string"
- },
- "relation": {
- "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`.",
+ "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"
},
- "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",
+ "location": "query"
+ },
+ "source.androidApp.certificate.sha256Fingerprint": {
+ "description": "The uppercase SHA-265 fingerprint of the certificate. From the PEM\n certificate, it can be acquired like this:\n\n $ keytool -printcert -file $CERTFILE | grep SHA256:\n SHA256: 14:6D:E9:83:C5:73:06:50:D8:EE:B9:95:2F:34:FC:64:16:A0:83: \\\n 42:E6:1D:BE:A8:8A:04:96:B2:3F:CF:44:E5\n\nor like this:\n\n $ openssl x509 -in $CERTFILE -noout -fingerprint -sha256\n SHA256 Fingerprint=14:6D:E9:83:C5:73:06:50:D8:EE:B9:95:2F:34:FC:64: \\\n 16:A0:83:42:E6:1D:BE:A8:8A:04:96:B2:3F:CF:44:E5\n\nIn this example, the contents of this field would be `14:6D:E9:83:C5:73:\n06:50:D8:EE:B9:95:2F:34:FC:64:16:A0:83:42:E6:1D:BE:A8:8A:04:96:B2:3F:CF:\n44:E5`.\n\nIf these tools are not available to you, you can convert the PEM\ncertificate into the DER format, compute the SHA-256 hash of that string\nand represent the result as a hexstring (that is, uppercase hexadecimal\nrepresentations of each octet, separated by colons).",
+ "type": "string",
+ "location": "query"
+ },
+ "relation": {
+ "location": "query",
+ "description": "Use only associations that match the specified relation.\n\nSee the [`Statement`](#Statement) message for a detailed definition of\nrelation strings.\n\nFor a query to match a statement, one of the following must be true:\n\n* both the query's and the statement's relation strings match exactly,\n or\n* the query's relation string is empty or missing.\n\nExample: A query with relation `delegate_permission/common.handle_all_urls`\nmatches an asset link with relation\n`delegate_permission/common.handle_all_urls`.",
"type": "string"
}
},
@@ -43,20 +48,19 @@
"assetlinks": {
"methods": {
"check": {
- "description": "Determines whether the specified (directional) relationship exists between\nthe specified source and target assets.\n\nThe relation describes the intent of the link between the two assets as\nclaimed by the source asset. An example for such relationships is the\ndelegation of privileges or permissions.\n\nThis command is most often used by infrastructure systems to check\npreconditions for an action. For example, a client may want to know if it\nis OK to send a web URL to a particular mobile app instead. The client can\ncheck for the relevant asset link from the website to the mobile app to\ndecide if the operation should be allowed.\n\nA note about security: if you specify a secure asset as the source, such as\nan HTTPS website or an Android app, the API will ensure that any\nstatements used to generate the response have been made in a secure way by\nthe owner of that asset. Conversely, if the source asset is an insecure\nHTTP website (that is, the URL starts with `http://` instead of `https://`),\nthe API cannot verify its statements securely, and it is not possible to\nensure that the website's statements have not been altered by a third\nparty. For more information, see the [Digital Asset Links technical design\nspecification](https://github.com/google/digitalassetlinks/blob/master/well-known/details.md).",
"response": {
"$ref": "CheckResponse"
},
"parameterOrder": [],
"httpMethod": "GET",
"parameters": {
- "target.web.site": {
+ "target.androidApp.certificate.sha256Fingerprint": {
"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",
+ "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"
},
- "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).",
+ "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"
},
@@ -65,39 +69,40 @@
"type": "string",
"location": "query"
},
- "source.web.site": {
- "location": "query",
- "description": "Web assets are identified by a URL that contains only the scheme, hostname\nand port parts. The format is\n\n http[s]://\u003chostname\u003e[:\u003cport\u003e]\n\nHostnames must be fully qualified: they must end in a single period\n(\"`.`\").\n\nOnly the schemes \"http\" and \"https\" are currently allowed.\n\nPort numbers are given as a decimal number, and they must be omitted if the\nstandard port numbers are used: 80 for http and 443 for https.\n\nWe call this limited URL the \"site\". All URLs that share the same scheme,\nhostname and port are considered to be a part of the site and thus belong\nto the web asset.\n\nExample: the asset with the site `https://www.google.com` contains all\nthese URLs:\n\n * `https://www.google.com/`\n * `https://www.google.com:443/`\n * `https://www.google.com/foo`\n * `https://www.google.com/foo?bar`\n * `https://www.google.com/foo#bar`\n * `https://user@password:www.google.com/`\n\nBut it does not contain these URLs:\n\n * `http://www.google.com/` (wrong scheme)\n * `https://google.com/` (hostname does not match)\n * `https://www.google.com:444/` (port does not match)\nREQUIRED",
- "type": "string"
- },
"target.androidApp.packageName": {
"description": "Android App assets are naturally identified by their Java package name.\nFor example, the Google Maps app uses the package name\n`com.google.android.apps.maps`.\nREQUIRED",
"type": "string",
"location": "query"
},
"source.androidApp.certificate.sha256Fingerprint": {
+ "location": "query",
"description": "The uppercase SHA-265 fingerprint of the certificate. From the PEM\n certificate, it can be acquired like this:\n\n $ keytool -printcert -file $CERTFILE | grep SHA256:\n SHA256: 14:6D:E9:83:C5:73:06:50:D8:EE:B9:95:2F:34:FC:64:16:A0:83: \\\n 42:E6:1D:BE:A8:8A:04:96:B2:3F:CF:44:E5\n\nor like this:\n\n $ openssl x509 -in $CERTFILE -noout -fingerprint -sha256\n SHA256 Fingerprint=14:6D:E9:83:C5:73:06:50:D8:EE:B9:95:2F:34:FC:64: \\\n 16:A0:83:42:E6:1D:BE:A8:8A:04:96:B2:3F:CF:44:E5\n\nIn this example, the contents of this field would be `14:6D:E9:83:C5:73:\n06:50:D8:EE:B9:95:2F:34:FC:64:16:A0:83:42:E6:1D:BE:A8:8A:04:96:B2:3F:CF:\n44:E5`.\n\nIf these tools are not available to you, you can convert the PEM\ncertificate into the DER format, compute the SHA-256 hash of that string\nand represent the result as a hexstring (that is, uppercase hexadecimal\nrepresentations of each octet, separated by colons).",
+ "type": "string"
+ },
+ "relation": {
+ "description": "Query string for the relation.\n\nWe identify relations with strings of the format `\u003ckind\u003e/\u003cdetail\u003e`, where\n`\u003ckind\u003e` must be one of a set of pre-defined purpose categories, and\n`\u003cdetail\u003e` is a free-form lowercase alphanumeric string that describes the\nspecific use case of the statement.\n\nRefer to [our API documentation](/digital-asset-links/v1/relation-strings)\nfor the current list of supported relations.\n\nFor a query to match an asset link, both the query's and the asset link's\nrelation strings must match exactly.\n\nExample: A query with relation `delegate_permission/common.handle_all_urls`\nmatches an asset link with relation\n`delegate_permission/common.handle_all_urls`.",
"type": "string",
"location": "query"
},
- "relation": {
+ "target.web.site": {
"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`.",
+ "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"
}
},
"flatPath": "v1/assetlinks:check",
"path": "v1/assetlinks:check",
- "id": "digitalassetlinks.assetlinks.check"
+ "id": "digitalassetlinks.assetlinks.check",
+ "description": "Determines whether the specified (directional) relationship exists between\nthe specified source and target assets.\n\nThe relation describes the intent of the link between the two assets as\nclaimed by the source asset. An example for such relationships is the\ndelegation of privileges or permissions.\n\nThis command is most often used by infrastructure systems to check\npreconditions for an action. For example, a client may want to know if it\nis OK to send a web URL to a particular mobile app instead. The client can\ncheck for the relevant asset link from the website to the mobile app to\ndecide if the operation should be allowed.\n\nA note about security: if you specify a secure asset as the source, such as\nan HTTPS website or an Android app, the API will ensure that any\nstatements used to generate the response have been made in a secure way by\nthe owner of that asset. Conversely, if the source asset is an insecure\nHTTP website (that is, the URL starts with `http://` instead of `https://`),\nthe API cannot verify its statements securely, and it is not possible to\nensure that the website's statements have not been altered by a third\nparty. For more information, see the [Digital Asset Links technical design\nspecification](https://github.com/google/digitalassetlinks/blob/master/well-known/details.md)."
}
}
}
},
"parameters": {
"upload_protocol": {
- "location": "query",
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"prettyPrint": {
"description": "Returns response with indentations and line breaks.",
@@ -106,16 +111,23 @@
"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"
},
- "fields": {
- "location": "query",
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string"
+ "callback": {
+ "description": "JSONP",
+ "type": "string",
+ "location": "query"
},
"$.xgafv": {
+ "description": "V1 error format.",
+ "type": "string",
"enumDescriptions": [
"v1 error format",
"v2 error format"
@@ -124,22 +136,9 @@
"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": [
@@ -147,12 +146,18 @@
"media",
"proto"
],
- "type": "string"
+ "type": "string",
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query"
},
"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.",
@@ -165,46 +170,27 @@
"location": "query"
},
"pp": {
+ "location": "query",
"description": "Pretty-print response.",
"type": "boolean",
- "default": "true",
- "location": "query"
- },
- "oauth_token": {
- "description": "OAuth 2.0 token for the current user.",
- "type": "string",
- "location": "query"
+ "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"
}
},
"schemas": {
- "Asset": {
- "description": "Uniquely identifies an asset.\n\nA digital asset is an identifiable and addressable online entity that\ntypically provides some service or content. Examples of assets are websites,\nAndroid apps, Twitter feeds, and Plus Pages.",
+ "ListResponse": {
+ "description": "Response message for the List call.",
"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"
@@ -228,6 +214,113 @@
"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.",
+ "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"
+ ]
+ }
+ },
+ "statements": {
+ "description": "A list of all the matching statements that have been found.",
+ "type": "array",
+ "items": {
+ "$ref": "Statement"
+ }
+ }
+ },
+ "id": "ListResponse"
+ },
+ "Statement": {
+ "description": "Describes a reliable statement that has been made about the relationship\nbetween a source asset and a target asset.\n\nStatements are always made by the source asset, either directly or by\ndelegating to a statement list that is stored elsewhere.\n\nFor more detailed definitions of statements and assets, please refer\nto our [API documentation landing\npage](/digital-asset-links/v1/getting-started).",
+ "type": "object",
+ "properties": {
+ "target": {
+ "$ref": "Asset",
+ "description": "Every statement has a target asset.\nREQUIRED"
+ },
+ "source": {
+ "description": "Every statement has a source asset.\nREQUIRED",
+ "$ref": "Asset"
+ },
+ "relation": {
+ "description": "The relation identifies the use of the statement as intended by the source\nasset's owner (that is, the person or entity who issued the statement).\nEvery complete statement has a relation.\n\nWe identify relations with strings of the format `\u003ckind\u003e/\u003cdetail\u003e`, where\n`\u003ckind\u003e` must be one of a set of pre-defined purpose categories, and\n`\u003cdetail\u003e` is a free-form lowercase alphanumeric string that describes the\nspecific use case of the statement.\n\nRefer to [our API documentation](/digital-asset-links/v1/relation-strings)\nfor the current list of supported relations.\n\nExample: `delegate_permission/common.handle_all_urls`\nREQUIRED",
+ "type": "string"
+ }
+ },
+ "id": "Statement"
+ },
+ "CertificateInfo": {
+ "description": "Describes an X509 certificate.",
+ "type": "object",
+ "properties": {
+ "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"
+ }
+ },
+ "id": "CertificateInfo"
+ },
+ "AndroidAppAsset": {
+ "description": "Describes an android app asset.",
+ "type": "object",
+ "properties": {
+ "certificate": {
+ "$ref": "CertificateInfo",
+ "description": "Because there is no global enforcement of package name uniqueness, we also\nrequire a signing certificate, which in combination with the package name\nuniquely identifies an app.\n\nSome apps' signing keys are rotated, so they may be signed by different\nkeys over time. We treat these as distinct assets, since we use (package\nname, cert) as the unique ID. This should not normally pose any problems\nas both versions of the app will make the same or similar statements.\nOther assets making statements about the app will have to be updated when a\nkey is rotated, however.\n\n(Note that the syntaxes for publishing and querying for statements contain\nsyntactic sugar to easily let you specify apps that are known by multiple\ncertificates.)\nREQUIRED"
+ },
+ "packageName": {
+ "description": "Android App assets are naturally identified by their Java package name.\nFor example, the Google Maps app uses the package name\n`com.google.android.apps.maps`.\nREQUIRED",
+ "type": "string"
+ }
+ },
+ "id": "AndroidAppAsset"
+ },
+ "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": {
+ "$ref": "AndroidAppAsset",
+ "description": "Set if this is an Android App asset."
+ }
+ },
+ "id": "Asset"
+ },
+ "CheckResponse": {
+ "description": "Response message for the CheckAssetLinks call.",
+ "type": "object",
+ "properties": {
+ "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": {
@@ -246,6 +339,19 @@
],
"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"
@@ -260,114 +366,13 @@
}
},
"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"
- },
- "Statement": {
- "description": "Describes a reliable statement that has been made about the relationship\nbetween a source asset and a target asset.\n\nStatements are always made by the source asset, either directly or by\ndelegating to a statement list that is stored elsewhere.\n\nFor more detailed definitions of statements and assets, please refer\nto our [API documentation landing\npage](/digital-asset-links/v1/getting-started).",
- "type": "object",
- "properties": {
- "target": {
- "$ref": "Asset",
- "description": "Every statement has a target asset.\nREQUIRED"
- },
- "source": {
- "$ref": "Asset",
- "description": "Every statement has a source asset.\nREQUIRED"
- },
- "relation": {
- "description": "The relation identifies the use of the statement as intended by the source\nasset's owner (that is, the person or entity who issued the statement).\nEvery complete statement has a relation.\n\nWe identify relations with strings of the format `\u003ckind\u003e/\u003cdetail\u003e`, where\n`\u003ckind\u003e` must be one of a set of pre-defined purpose categories, and\n`\u003cdetail\u003e` is a free-form lowercase alphanumeric string that describes the\nspecific use case of the statement.\n\nRefer to [our API documentation](/digital-asset-links/v1/relation-strings)\nfor the current list of supported relations.\n\nExample: `delegate_permission/common.handle_all_urls`\nREQUIRED",
- "type": "string"
- }
- },
- "id": "Statement"
- },
- "CertificateInfo": {
- "description": "Describes an X509 certificate.",
- "type": "object",
- "properties": {
- "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"
- }
- },
- "id": "CertificateInfo"
- },
- "AndroidAppAsset": {
- "description": "Describes an android app asset.",
- "type": "object",
- "properties": {
- "packageName": {
- "description": "Android App assets are naturally identified by their Java package name.\nFor example, the Google Maps app uses the package name\n`com.google.android.apps.maps`.\nREQUIRED",
- "type": "string"
- },
- "certificate": {
- "description": "Because there is no global enforcement of package name uniqueness, we also\nrequire a signing certificate, which in combination with the package name\nuniquely identifies an app.\n\nSome apps' signing keys are rotated, so they may be signed by different\nkeys over time. We treat these as distinct assets, since we use (package\nname, cert) as the unique ID. This should not normally pose any problems\nas both versions of the app will make the same or similar statements.\nOther assets making statements about the app will have to be updated when a\nkey is rotated, however.\n\n(Note that the syntaxes for publishing and querying for statements contain\nsyntactic sugar to easily let you specify apps that are known by multiple\ncertificates.)\nREQUIRED",
- "$ref": "CertificateInfo"
- }
- },
- "id": "AndroidAppAsset"
}
},
+ "protocol": "rest",
"icons": {
"x16": "http://www.google.com/images/icons/product/search-16.gif",
"x32": "http://www.google.com/images/icons/product/search-32.gif"
},
- "protocol": "rest",
"version": "v1",
"baseUrl": "https://digitalassetlinks.googleapis.com/",
"kind": "discovery#restDescription",
@@ -376,10 +381,5 @@
"rootUrl": "https://digitalassetlinks.googleapis.com/",
"basePath": "",
"ownerDomain": "google.com",
- "name": "digitalassetlinks",
- "batchPath": "batch",
- "revision": "20171207",
- "documentationLink": "https://developers.google.com/digital-asset-links/",
- "id": "digitalassetlinks:v1",
- "title": "Digital Asset Links API"
+ "name": "digitalassetlinks"
}
diff --git a/dlp/v2beta1/dlp-api.json b/dlp/v2beta1/dlp-api.json
index 8ff1a61..45f8455 100644
--- a/dlp/v2beta1/dlp-api.json
+++ b/dlp/v2beta1/dlp-api.json
@@ -1,5 +1,506 @@
{
+ "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": {
+ "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"
+ },
+ "response": {
+ "$ref": "GooglePrivacyDlpV2beta1InspectContentResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {},
+ "flatPath": "v2beta1/content:inspect",
+ "path": "v2beta1/content:inspect",
+ "id": "dlp.content.inspect"
+ },
+ "redact": {
+ "flatPath": "v2beta1/content:redact",
+ "path": "v2beta1/content:redact",
+ "id": "dlp.content.redact",
+ "description": "Redacts potentially sensitive info from a list of strings.\nThis method has limits on input size, processing time, and output size.",
+ "request": {
+ "$ref": "GooglePrivacyDlpV2beta1RedactContentRequest"
+ },
+ "response": {
+ "$ref": "GooglePrivacyDlpV2beta1RedactContentResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {}
+ },
+ "deidentify": {
+ "response": {
+ "$ref": "GooglePrivacyDlpV2beta1DeidentifyContentResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {},
+ "flatPath": "v2beta1/content:deidentify",
+ "path": "v2beta1/content:deidentify",
+ "id": "dlp.content.deidentify",
+ "description": "De-identifies potentially sensitive info from a list of strings.\nThis method has limits on input size and output size.",
+ "request": {
+ "$ref": "GooglePrivacyDlpV2beta1DeidentifyContentRequest"
+ }
+ }
+ }
+ },
+ "rootCategories": {
+ "methods": {
+ "list": {
+ "httpMethod": "GET",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "GooglePrivacyDlpV2beta1ListRootCategoriesResponse"
+ },
+ "parameters": {
+ "languageCode": {
+ "description": "Optional language code for localized friendly category names.\nIf omitted or if localized strings are not available,\nen-US strings will be returned.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v2beta1/rootCategories",
+ "id": "dlp.rootCategories.list",
+ "path": "v2beta1/rootCategories",
+ "description": "Returns the list of root categories of sensitive information."
+ }
+ },
+ "resources": {
+ "infoTypes": {
+ "methods": {
+ "list": {
+ "description": "Returns sensitive information types for given category.",
+ "response": {
+ "$ref": "GooglePrivacyDlpV2beta1ListInfoTypesResponse"
+ },
+ "parameterOrder": [
+ "category"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "category": {
+ "location": "path",
+ "description": "Category name as returned by ListRootCategories.",
+ "required": true,
+ "type": "string",
+ "pattern": "^[^/]+$"
+ },
+ "languageCode": {
+ "location": "query",
+ "description": "Optional BCP-47 language code for localized info type friendly\nnames. If omitted, or if localized strings are not available,\nen-US strings will be returned.",
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v2beta1/rootCategories/{rootCategoriesId}/infoTypes",
+ "path": "v2beta1/rootCategories/{+category}/infoTypes",
+ "id": "dlp.rootCategories.infoTypes.list"
+ }
+ }
+ }
+ }
+ },
+ "riskAnalysis": {
+ "resources": {
+ "operations": {
+ "methods": {
+ "list": {
+ "flatPath": "v2beta1/riskAnalysis/operations",
+ "id": "dlp.riskAnalysis.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": "^riskAnalysis/operations$",
+ "location": "path"
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "The standard list page token.",
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "The list page size. The maximum allowed value is 256 and the default is 100.",
+ "format": "int32",
+ "type": "integer",
+ "location": "query"
+ },
+ "filter": {
+ "description": "Filters by `done`. That is, `done=true` or `done=false`.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "get": {
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "GoogleLongrunningOperation"
+ },
+ "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}",
+ "id": "dlp.riskAnalysis.operations.get",
+ "path": "v2beta1/{+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."
+ },
+ "cancel": {
+ "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"
+ },
+ "response": {
+ "$ref": "GoogleProtobufEmpty"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The name of the operation resource to be cancelled.",
+ "required": true,
+ "type": "string",
+ "pattern": "^riskAnalysis/operations/[^/]+$",
+ "location": "path"
+ }
+ }
+ },
+ "delete": {
+ "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"
+ ],
+ "flatPath": "v2beta1/riskAnalysis/operations/{operationsId}",
+ "path": "v2beta1/{+name}",
+ "id": "dlp.riskAnalysis.operations.delete",
+ "description": "This method is not supported and the server returns `UNIMPLEMENTED`."
+ }
+ }
+ }
+ }
+ },
+ "dataSource": {
+ "methods": {
+ "analyze": {
+ "request": {
+ "$ref": "GooglePrivacyDlpV2beta1AnalyzeDataSourceRiskRequest"
+ },
+ "description": "Schedules a job to compute risk analysis metrics over content in a Google\nCloud Platform repository.",
+ "response": {
+ "$ref": "GoogleLongrunningOperation"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "parameters": {},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v2beta1/dataSource:analyze",
+ "path": "v2beta1/dataSource:analyze",
+ "id": "dlp.dataSource.analyze"
+ }
+ }
+ },
+ "inspect": {
+ "resources": {
+ "results": {
+ "resources": {
+ "findings": {
+ "methods": {
+ "list": {
+ "response": {
+ "$ref": "GooglePrivacyDlpV2beta1ListInspectFindingsResponse"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "filter": {
+ "location": "query",
+ "description": "Restricts findings to items that match. Supports info_type and likelihood.\n\nExamples:\n\n- info_type=EMAIL_ADDRESS\n- info_type=PHONE_NUMBER,EMAIL_ADDRESS\n- likelihood=VERY_LIKELY\n- likelihood=VERY_LIKELY,LIKELY\n- info_type=EMAIL_ADDRESS,likelihood=VERY_LIKELY,LIKELY",
+ "type": "string"
+ },
+ "name": {
+ "description": "Identifier of the results set returned as metadata of\nthe longrunning operation created by a call to InspectDataSource.\nShould be in the format of `inspect/results/{id}`.",
+ "required": true,
+ "type": "string",
+ "pattern": "^inspect/results/[^/]+$",
+ "location": "path"
+ },
+ "pageToken": {
+ "description": "The value returned by the last `ListInspectFindingsResponse`; indicates\nthat this is a continuation of a prior `ListInspectFindings` call, and that\nthe system should return the next page of data.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageSize": {
+ "location": "query",
+ "description": "Maximum number of results to return.\nIf 0, the implementation selects a reasonable value.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v2beta1/inspect/results/{resultsId}/findings",
+ "path": "v2beta1/{+name}/findings",
+ "id": "dlp.inspect.results.findings.list",
+ "description": "Returns list of results for given inspect operation result set id."
+ }
+ }
+ }
+ }
+ },
+ "operations": {
+ "methods": {
+ "create": {
+ "response": {
+ "$ref": "GoogleLongrunningOperation"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {},
+ "flatPath": "v2beta1/inspect/operations",
+ "path": "v2beta1/inspect/operations",
+ "id": "dlp.inspect.operations.create",
+ "description": "Schedules a job scanning content in a Google Cloud Platform data\nrepository.",
+ "request": {
+ "$ref": "GooglePrivacyDlpV2beta1CreateInspectOperationRequest"
+ }
+ },
+ "cancel": {
+ "description": "Cancels an operation. Use the `inspect.operations.get` to check whether the cancellation succeeded or the operation completed despite cancellation.",
+ "request": {
+ "$ref": "GoogleLongrunningCancelOperationRequest"
+ },
+ "response": {
+ "$ref": "GoogleProtobufEmpty"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "location": "path",
+ "description": "The name of the operation resource to be cancelled.",
+ "required": true,
+ "type": "string",
+ "pattern": "^inspect/operations/[^/]+$"
+ }
+ },
+ "flatPath": "v2beta1/inspect/operations/{operationsId}:cancel",
+ "path": "v2beta1/{+name}:cancel",
+ "id": "dlp.inspect.operations.cancel"
+ },
+ "delete": {
+ "description": "This method is not supported and the server returns `UNIMPLEMENTED`.",
+ "response": {
+ "$ref": "GoogleProtobufEmpty"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "DELETE",
+ "parameters": {
+ "name": {
+ "pattern": "^inspect/operations/[^/]+$",
+ "location": "path",
+ "description": "The name of the operation resource to be deleted.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v2beta1/inspect/operations/{operationsId}",
+ "path": "v2beta1/{+name}",
+ "id": "dlp.inspect.operations.delete"
+ },
+ "list": {
+ "response": {
+ "$ref": "GoogleLongrunningListOperationsResponse"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "filter": {
+ "location": "query",
+ "description": "Filters by `done`. That is, `done=true` or `done=false`.",
+ "type": "string"
+ },
+ "name": {
+ "description": "The name of the operation's parent resource.",
+ "required": true,
+ "type": "string",
+ "pattern": "^inspect/operations$",
+ "location": "path"
+ },
+ "pageToken": {
+ "type": "string",
+ "location": "query",
+ "description": "The standard list page token."
+ },
+ "pageSize": {
+ "description": "The list page size. The maximum allowed value is 256 and the default is 100.",
+ "format": "int32",
+ "type": "integer",
+ "location": "query"
+ }
+ },
+ "flatPath": "v2beta1/inspect/operations",
+ "path": "v2beta1/{+name}",
+ "id": "dlp.inspect.operations.list",
+ "description": "Fetches the list of long running operations."
+ },
+ "get": {
+ "id": "dlp.inspect.operations.get",
+ "path": "v2beta1/{+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": "GoogleLongrunningOperation"
+ },
+ "parameters": {
+ "name": {
+ "description": "The name of the operation resource.",
+ "required": true,
+ "type": "string",
+ "pattern": "^inspect/operations/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v2beta1/inspect/operations/{operationsId}"
+ }
+ }
+ }
+ }
+ }
+ },
"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": {
+ "type": "string",
+ "location": "query",
+ "description": "OAuth bearer token."
+ },
"upload_protocol": {
"location": "query",
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
@@ -11,19 +512,17 @@
"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",
- "location": "query"
+ "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"
@@ -32,15 +531,16 @@
"enum": [
"1",
"2"
- ]
+ ],
+ "description": "V1 error format.",
+ "type": "string"
},
"callback": {
- "type": "string",
"location": "query",
- "description": "JSONP"
+ "description": "JSONP",
+ "type": "string"
},
"alt": {
- "type": "string",
"enumDescriptions": [
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
@@ -53,7 +553,8 @@
"json",
"media",
"proto"
- ]
+ ],
+ "type": "string"
},
"access_token": {
"description": "OAuth access token.",
@@ -61,767 +562,31 @@
"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": {
"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": {
- "location": "query",
- "description": "OAuth 2.0 token for the current user.",
- "type": "string"
- },
- "bearer_token": {
- "location": "query",
- "description": "OAuth bearer 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."
}
},
"version": "v2beta1",
"baseUrl": "https://dlp.googleapis.com/",
"servicePath": "",
- "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.",
+ "kind": "discovery#restDescription",
"basePath": "",
- "id": "dlp:v2beta1",
"documentationLink": "https://cloud.google.com/dlp/docs/",
+ "id": "dlp:v2beta1",
"revision": "20171219",
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
- "GooglePrivacyDlpV2beta1KindExpression": {
- "description": "A representation of a Datastore kind.",
- "type": "object",
- "properties": {
- "name": {
- "description": "The name of the kind.",
- "type": "string"
- }
- },
- "id": "GooglePrivacyDlpV2beta1KindExpression"
- },
- "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": {
- "primitiveTransformation": {
- "description": "Primitive transformation to apply to the info type. [required]",
- "$ref": "GooglePrivacyDlpV2beta1PrimitiveTransformation"
- },
- "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"
- },
- "GooglePrivacyDlpV2beta1AnalyzeDataSourceRiskRequest": {
- "description": "Request for creating a risk analysis operation.",
- "type": "object",
- "properties": {
- "privacyMetric": {
- "$ref": "GooglePrivacyDlpV2beta1PrivacyMetric",
- "description": "Privacy metric to compute."
- },
- "sourceTable": {
- "$ref": "GooglePrivacyDlpV2beta1BigQueryTable",
- "description": "Input dataset to compute metrics over."
- }
- },
- "id": "GooglePrivacyDlpV2beta1AnalyzeDataSourceRiskRequest"
- },
- "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"
- }
- }
- }
- },
- "GooglePrivacyDlpV2beta1Bucket": {
- "type": "object",
- "properties": {
- "min": {
- "$ref": "GooglePrivacyDlpV2beta1Value",
- "description": "Lower bound of the range, inclusive. Type should be the same as max if\nused."
- },
- "max": {
- "description": "Upper bound of the range, exclusive; type must match min.",
- "$ref": "GooglePrivacyDlpV2beta1Value"
- },
- "replacementValue": {
- "description": "Replacement value for this bucket. If not provided\nthe default behavior will be to hyphenate the min-max range.",
- "$ref": "GooglePrivacyDlpV2beta1Value"
- }
- },
- "id": "GooglePrivacyDlpV2beta1Bucket",
- "description": "Buckets represented as ranges, along with replacement values. Ranges must\nbe non-overlapping."
- },
- "GooglePrivacyDlpV2beta1CategoricalStatsHistogramBucket": {
- "description": "Histogram bucket of value frequencies in the column.",
- "type": "object",
- "properties": {
- "bucketSize": {
- "description": "Total number of records in this bucket.",
- "format": "int64",
- "type": "string"
- },
- "valueFrequencyUpperBound": {
- "description": "Upper bound on the value frequency of the values in this bucket.",
- "format": "int64",
- "type": "string"
- },
- "valueFrequencyLowerBound": {
- "type": "string",
- "description": "Lower bound on the value frequency of the values in this bucket.",
- "format": "int64"
- },
- "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": {
- "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"
- },
- "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": {
- "$ref": "GooglePrivacyDlpV2beta1EntityId",
- "description": "Optional message indicating that each distinct entity_id should not\ncontribute to the k-anonymity count more than once per equivalence class.\nIf an entity_id appears on several rows with different quasi-identifier\ntuples, it will contribute to each count exactly once.\n\nThis can lead to unexpected results. Consider a table where ID 1 is\nassociated to quasi-identifier \"foo\", ID 2 to \"bar\", and ID 3 to *both*\nquasi-identifiers \"foo\" and \"bar\" (on separate rows), and where this ID\nis used as entity_id. Then, the anonymity value associated to ID 3 will\nbe 2, even if it is the only ID to be associated to both values \"foo\" and\n\"bar\"."
- },
- "quasiIds": {
- "description": "Set of fields to compute k-anonymity over. When multiple fields are\nspecified, they are considered a single composite key. Structs and\nrepeated data types are not supported; however, nested fields are\nsupported so long as they are not structs themselves or nested within\na repeated field.",
- "type": "array",
- "items": {
- "$ref": "GooglePrivacyDlpV2beta1FieldId"
- }
- }
- },
- "id": "GooglePrivacyDlpV2beta1KAnonymityConfig"
- },
- "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": {
- "id": "GooglePrivacyDlpV2beta1DeidentifyContentRequest",
- "description": "Request to de-identify a list of items.",
- "type": "object",
- "properties": {
- "deidentifyConfig": {
- "$ref": "GooglePrivacyDlpV2beta1DeidentifyConfig",
- "description": "Configuration for the de-identification of the list of content items."
- },
- "inspectConfig": {
- "description": "Configuration for the inspector.",
- "$ref": "GooglePrivacyDlpV2beta1InspectConfig"
- },
- "items": {
- "type": "array",
- "items": {
- "$ref": "GooglePrivacyDlpV2beta1ContentItem"
- },
- "description": "The list of items to inspect. Up to 100 are allowed per request.\nAll items will be treated as text/*."
- }
- }
- },
- "GooglePrivacyDlpV2beta1InspectResult": {
- "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"
- }
- }
- },
- "id": "GooglePrivacyDlpV2beta1InspectResult",
- "description": "All the findings for a single scanned item.",
- "type": "object"
- },
- "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"
- },
- "GooglePrivacyDlpV2beta1ImageLocation": {
- "description": "Bounding box encompassing detected text within an image.",
- "type": "object",
- "properties": {
- "height": {
- "description": "Height of the bounding box in pixels.",
- "format": "int32",
- "type": "integer"
- },
- "top": {
- "description": "Top coordinate of the bounding box. (0,0) is upper left.",
- "format": "int32",
- "type": "integer"
- },
- "left": {
- "description": "Left coordinate of the bounding box. (0,0) is upper left.",
- "format": "int32",
- "type": "integer"
- },
- "width": {
- "description": "Width of the bounding box in pixels.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "GooglePrivacyDlpV2beta1ImageLocation"
- },
- "GooglePrivacyDlpV2beta1ReplaceValueConfig": {
- "description": "Replace each input value with a given `Value`.",
- "type": "object",
- "properties": {
- "newValue": {
- "$ref": "GooglePrivacyDlpV2beta1Value",
- "description": "Value to replace it with."
- }
- },
- "id": "GooglePrivacyDlpV2beta1ReplaceValueConfig"
- },
- "GooglePrivacyDlpV2beta1ContentItem": {
- "type": "object",
- "properties": {
- "value": {
- "type": "string",
- "description": "String data to inspect or redact."
- },
- "table": {
- "description": "Structured content for inspection.",
- "$ref": "GooglePrivacyDlpV2beta1Table"
- },
- "data": {
- "description": "Content data to inspect or redact.",
- "format": "byte",
- "type": "string"
- },
- "type": {
- "description": "Type of the content, as defined in Content-Type HTTP header.\nSupported types are: all \"text\" types, octet streams, PNG images,\nJPEG images.",
- "type": "string"
- }
- },
- "id": "GooglePrivacyDlpV2beta1ContentItem",
- "description": "Container structure for the content to inspect."
- },
- "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": {
- "description": "The key used by the encryption algorithm. [required]",
- "$ref": "GooglePrivacyDlpV2beta1CryptoKey"
- },
- "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": [
- "",
- "[0-9] (radix of 10)",
- "[0-9A-F] (radix of 16)",
- "[0-9A-Z] (radix of 36)",
- "[0-9A-Za-z] (radix of 62)"
- ],
- "enum": [
- "FFX_COMMON_NATIVE_ALPHABET_UNSPECIFIED",
- "NUMERIC",
- "HEXADECIMAL",
- "UPPER_CASE_ALPHA_NUMERIC",
- "ALPHA_NUMERIC"
- ],
- "type": "string"
- },
- "radix": {
- "description": "The native way to select the alphabet. Must be in the range [2, 62].",
- "format": "int32",
- "type": "integer"
- }
- },
- "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].",
- "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"
- },
- "red": {
- "description": "The amount of red in the color as a value in the interval [0, 1].",
- "format": "float",
- "type": "number"
- }
- },
- "id": "GooglePrivacyDlpV2beta1Color"
- },
- "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"
- },
- "GooglePrivacyDlpV2beta1SurrogateType": {
- "description": "Message for detecting output from deidentification transformations\nsuch as\n[`CryptoReplaceFfxFpeConfig`](/dlp/docs/reference/rest/v2beta1/content/deidentify#CryptoReplaceFfxFpeConfig).\nThese types of transformations are\nthose that perform pseudonymization, thereby producing a \"surrogate\" as\noutput. This should be used in conjunction with a field on the\ntransformation such as `surrogate_info_type`. This custom info type does\nnot support the use of `detection_rules`.",
- "type": "object",
- "properties": {},
- "id": "GooglePrivacyDlpV2beta1SurrogateType"
- },
- "GooglePrivacyDlpV2beta1Table": {
- "type": "object",
- "properties": {
- "headers": {
- "type": "array",
- "items": {
- "$ref": "GooglePrivacyDlpV2beta1FieldId"
- }
- },
- "rows": {
- "type": "array",
- "items": {
- "$ref": "GooglePrivacyDlpV2beta1Row"
- }
- }
- },
- "id": "GooglePrivacyDlpV2beta1Table",
- "description": "Structured content to inspect. Up to 50,000 `Value`s per request allowed."
- },
- "GooglePrivacyDlpV2beta1InfoTypeLimit": {
- "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",
- "description": "Max findings configuration per info type, per content item or long running\noperation.",
- "type": "object"
- },
- "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"
- }
- },
- "id": "GooglePrivacyDlpV2beta1CryptoKey"
- },
- "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"
- },
- "GooglePrivacyDlpV2beta1Value": {
- "description": "Set of primitive values supported by the system.\nNote that for the purposes of inspection or transformation, the number\nof bytes considered to comprise a 'Value' is based on its representation\nas a UTF-8 encoded string. For example, if 'integer_value' is set to\n123456789, the number of bytes would be counted as 9, even though an\nint64 only holds up to 8 bytes of data.",
- "type": "object",
- "properties": {
- "timeValue": {
- "$ref": "GoogleTypeTimeOfDay"
- },
- "integerValue": {
- "format": "int64",
- "type": "string"
- },
- "stringValue": {
- "type": "string"
- },
- "dateValue": {
- "$ref": "GoogleTypeDate"
- },
- "timestampValue": {
- "format": "google-datetime",
- "type": "string"
- },
- "booleanValue": {
- "type": "boolean"
- },
- "floatValue": {
- "format": "double",
- "type": "number"
- }
- },
- "id": "GooglePrivacyDlpV2beta1Value"
- },
- "GooglePrivacyDlpV2beta1Condition": {
- "description": "The field type of `value` and `field` do not need to match to be\nconsidered equal, but not all comparisons are possible.\n\nA `value` of type:\n\n- `string` can be compared against all other types\n- `boolean` can only be compared against other booleans\n- `integer` can be compared against doubles or a string if the string value\ncan be parsed as an integer.\n- `double` can be compared against integers or a string if the string can\nbe parsed as a double.\n- `Timestamp` can be compared against strings in RFC 3339 date string\nformat.\n- `TimeOfDay` can be compared against timestamps and strings in the format\nof 'HH:mm:ss'.\n\nIf we fail to compare do to type mismatch, a warning will be given and\nthe condition will evaluate to false.",
- "type": "object",
- "properties": {
- "field": {
- "$ref": "GooglePrivacyDlpV2beta1FieldId",
- "description": "Field within the record this condition is evaluated against. [required]"
- },
- "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",
- "NOT_EQUAL_TO",
- "GREATER_THAN",
- "LESS_THAN",
- "GREATER_THAN_OR_EQUALS",
- "LESS_THAN_OR_EQUALS",
- "EXISTS"
- ],
- "description": "Operator used to compare the field or info type to the value. [required]",
- "type": "string"
- },
- "value": {
- "description": "Value to compare against. [Required, except for `EXISTS` tests.]",
- "$ref": "GooglePrivacyDlpV2beta1Value"
- }
- },
- "id": "GooglePrivacyDlpV2beta1Condition"
- },
- "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"
- },
- "GooglePrivacyDlpV2beta1InspectContentResponse": {
- "id": "GooglePrivacyDlpV2beta1InspectContentResponse",
- "description": "Results of inspecting a list of items.",
- "type": "object",
- "properties": {
- "results": {
- "description": "Each content_item from the request has a result in this list, in the\nsame order as the request.",
- "type": "array",
- "items": {
- "$ref": "GooglePrivacyDlpV2beta1InspectResult"
- }
- }
- }
- },
- "GooglePrivacyDlpV2beta1RedactContentRequest": {
- "description": "Request to search for potentially sensitive info in a list of items\nand replace it with a default or provided content.",
- "type": "object",
- "properties": {
- "items": {
- "description": "The list of items to inspect. Up to 100 are allowed per request.",
- "type": "array",
- "items": {
- "$ref": "GooglePrivacyDlpV2beta1ContentItem"
- }
- },
- "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"
- }
- },
- "imageRedactionConfigs": {
- "description": "The configuration for specifying what content to redact from images.",
- "type": "array",
- "items": {
- "$ref": "GooglePrivacyDlpV2beta1ImageRedactionConfig"
- }
- },
- "inspectConfig": {
- "$ref": "GooglePrivacyDlpV2beta1InspectConfig",
- "description": "Configuration for the inspector."
- }
- },
- "id": "GooglePrivacyDlpV2beta1RedactContentRequest"
- },
- "GooglePrivacyDlpV2beta1WordList": {
- "description": "Message defining a list of words or phrases to search for in the data.",
- "type": "object",
- "properties": {
- "words": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "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]"
- }
- },
- "id": "GooglePrivacyDlpV2beta1WordList"
- },
- "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"
- },
- "GooglePrivacyDlpV2beta1TransformationSummary": {
- "description": "Summary of a single tranformation.\nOnly one of 'transformation', 'field_transformation', or 'record_suppress'\nwill be set.",
- "type": "object",
- "properties": {
- "transformation": {
- "description": "The specific transformation these stats apply to.",
- "$ref": "GooglePrivacyDlpV2beta1PrimitiveTransformation"
- },
- "results": {
- "type": "array",
- "items": {
- "$ref": "GooglePrivacyDlpV2beta1SummaryResult"
- }
- },
- "field": {
- "$ref": "GooglePrivacyDlpV2beta1FieldId",
- "description": "Set if the transformation was limited to a specific FieldId."
- },
- "fieldTransformations": {
- "description": "The field transformation that was applied.\nIf multiple field transformations are requested for a single field,\nthis list will contain all of them; otherwise, only one is supplied.",
- "type": "array",
- "items": {
- "$ref": "GooglePrivacyDlpV2beta1FieldTransformation"
- }
- },
- "transformedBytes": {
- "description": "Total size in bytes that were transformed in some way.",
- "format": "int64",
- "type": "string"
- },
- "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."
- }
- },
- "id": "GooglePrivacyDlpV2beta1TransformationSummary"
- },
- "GoogleLongrunningCancelOperationRequest": {
- "properties": {},
- "id": "GoogleLongrunningCancelOperationRequest",
- "description": "The request message for Operations.CancelOperation.",
- "type": "object"
- },
- "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": {
- "charactersToIgnore": {
- "description": "When masking a string, items in this list will be skipped when replacing.\nFor example, if your string is 555-555-5555 and you ask us to skip `-` and\nmask 5 chars with * we would produce ***-*55-5555.",
- "type": "array",
- "items": {
- "$ref": "GooglePrivacyDlpV2beta1CharsToIgnore"
- }
- },
- "maskingCharacter": {
- "description": "Character to mask the sensitive values—for example, \"*\" for an\nalphabetic string such as name, or \"0\" for a numeric string such as ZIP\ncode or credit card number. String must have length 1. If not supplied, we\nwill default to \"*\" for strings, 0 for digits.",
- "type": "string"
- },
- "reverseOrder": {
- "description": "Mask characters in reverse order. For example, if `masking_character` is\n'0', number_to_mask is 14, and `reverse_order` is false, then\n1234-5678-9012-3456 -\u003e 00000000000000-3456\nIf `masking_character` is '*', `number_to_mask` is 3, and `reverse_order`\nis true, then 12345 -\u003e 12***",
- "type": "boolean"
- },
- "numberToMask": {
- "description": "Number of characters to mask. If not set, all matching chars will be\nmasked. Skipped characters do not count towards this tally.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "GooglePrivacyDlpV2beta1CharacterMaskConfig"
- },
- "GooglePrivacyDlpV2beta1TransientCryptoKey": {
- "description": "Use this to have a random data crypto key generated.\nIt will be discarded after the operation/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": "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": {
- "$ref": "GooglePrivacyDlpV2beta1InspectConfig",
- "description": "Configuration for the inspector."
- },
- "storageConfig": {
- "description": "Specification of the data set to process.",
- "$ref": "GooglePrivacyDlpV2beta1StorageConfig"
- },
- "outputConfig": {
- "$ref": "GooglePrivacyDlpV2beta1OutputStorageConfig",
- "description": "Optional location to store findings."
- }
- },
- "id": "GooglePrivacyDlpV2beta1CreateInspectOperationRequest"
- },
"GooglePrivacyDlpV2beta1TaggedField": {
"description": "A column with a semantic tag attached.",
"type": "object",
"properties": {
+ "field": {
+ "description": "Identifies the column. [required]",
+ "$ref": "GooglePrivacyDlpV2beta1FieldId"
+ },
"customTag": {
"type": "string",
"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)."
@@ -831,48 +596,43 @@
"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": "GooglePrivacyDlpV2beta1FieldId",
- "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": "GooglePrivacyDlpV2beta1TaggedField"
},
+ "GooglePrivacyDlpV2beta1InfoTypeStatistics": {
+ "id": "GooglePrivacyDlpV2beta1InfoTypeStatistics",
+ "description": "Statistics regarding a specific InfoType.",
+ "type": "object",
+ "properties": {
+ "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"
+ }
+ }
+ },
"GooglePrivacyDlpV2beta1RedactContentResponse": {
"description": "Results of redacting a list of items.",
"type": "object",
"properties": {
"items": {
- "description": "The redacted content.",
"type": "array",
"items": {
"$ref": "GooglePrivacyDlpV2beta1ContentItem"
- }
+ },
+ "description": "The redacted content."
}
},
"id": "GooglePrivacyDlpV2beta1RedactContentResponse"
},
- "GooglePrivacyDlpV2beta1InfoTypeStatistics": {
- "description": "Statistics regarding a specific InfoType.",
- "type": "object",
- "properties": {
- "infoType": {
- "description": "The type of finding this stat is for.",
- "$ref": "GooglePrivacyDlpV2beta1InfoType"
- },
- "count": {
- "description": "Number of findings for this info type.",
- "format": "int64",
- "type": "string"
- }
- },
- "id": "GooglePrivacyDlpV2beta1InfoTypeStatistics"
- },
"GooglePrivacyDlpV2beta1PropertyReference": {
- "id": "GooglePrivacyDlpV2beta1PropertyReference",
"description": "A reference to a property relative to the Datastore kind expressions.",
"type": "object",
"properties": {
@@ -880,25 +640,21 @@
"description": "The name of the property.\nIf name includes \".\"s, it may be interpreted as a property name path.",
"type": "string"
}
- }
- },
- "GooglePrivacyDlpV2beta1OutputStorageConfig": {
- "properties": {
- "table": {
- "description": "Store findings in a new table in the dataset.",
- "$ref": "GooglePrivacyDlpV2beta1BigQueryTable"
- },
- "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.",
- "type": "object"
+ "id": "GooglePrivacyDlpV2beta1PropertyReference"
},
"GooglePrivacyDlpV2beta1FieldTransformation": {
+ "description": "The transformation to apply to the field.",
+ "type": "object",
"properties": {
+ "condition": {
+ "description": "Only apply the transformation if the condition evaluates to true for the\ngiven `RecordCondition`. The conditions are allowed to reference fields\nthat are not used in the actual transformation. [optional]\n\nExample Use Cases:\n\n- Apply a different bucket transformation to an age column if the zip code\ncolumn for the same record is within a specific range.\n- Redact a field if the date of birth field is greater than 85.",
+ "$ref": "GooglePrivacyDlpV2beta1RecordCondition"
+ },
+ "infoTypeTransformations": {
+ "$ref": "GooglePrivacyDlpV2beta1InfoTypeTransformations",
+ "description": "Treat the contents of the field as free text, and selectively\ntransform content that matches an `InfoType`."
+ },
"fields": {
"description": "Input field(s) to apply the transformation to. [required]",
"type": "array",
@@ -909,19 +665,24 @@
"primitiveTransformation": {
"$ref": "GooglePrivacyDlpV2beta1PrimitiveTransformation",
"description": "Apply the transformation to the entire field."
- },
- "condition": {
- "$ref": "GooglePrivacyDlpV2beta1RecordCondition",
- "description": "Only apply the transformation if the condition evaluates to true for the\ngiven `RecordCondition`. The conditions are allowed to reference fields\nthat are not used in the actual transformation. [optional]\n\nExample Use Cases:\n\n- Apply a different bucket transformation to an age column if the zip code\ncolumn for the same record is within a specific range.\n- Redact a field if the date of birth field is greater than 85."
- },
- "infoTypeTransformations": {
- "description": "Treat the contents of the field as free text, and selectively\ntransform content that matches an `InfoType`.",
- "$ref": "GooglePrivacyDlpV2beta1InfoTypeTransformations"
}
},
- "id": "GooglePrivacyDlpV2beta1FieldTransformation",
- "description": "The transformation to apply to the field.",
- "type": "object"
+ "id": "GooglePrivacyDlpV2beta1FieldTransformation"
+ },
+ "GooglePrivacyDlpV2beta1OutputStorageConfig": {
+ "id": "GooglePrivacyDlpV2beta1OutputStorageConfig",
+ "description": "Cloud repository for storing output.",
+ "type": "object",
+ "properties": {
+ "storagePath": {
+ "$ref": "GooglePrivacyDlpV2beta1CloudStoragePath",
+ "description": "The path to a Google Cloud Storage location to store output.\nThe bucket must already exist and\nthe Google APIs service account for DLP must have write permission to\nwrite to the given bucket.\nResults are split over multiple csv files with each file name matching\nthe pattern \"[operation_id]_[count].csv\", for example\n`3094877188788974909_1.csv`. The `operation_id` matches the\nidentifier for the Operation, and the `count` is a counter used for\ntracking the number of files written.\n\nThe CSV file(s) contain the following columns regardless of storage type\nscanned:\n- id\n- info_type\n- likelihood\n- byte size of finding\n- quote\n- timestamp\n\nFor Cloud Storage the next columns are:\n\n- file_path\n- start_offset\n\nFor Cloud Datastore the next columns are:\n\n- project_id\n- namespace_id\n- path\n- column_name\n- offset\n\nFor BigQuery the next columns are:\n\n- row_number\n- project_id\n- dataset_id\n- table_id"
+ },
+ "table": {
+ "$ref": "GooglePrivacyDlpV2beta1BigQueryTable",
+ "description": "Store findings in a new table in the dataset."
+ }
+ }
},
"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.",
@@ -937,64 +698,57 @@
"id": "GooglePrivacyDlpV2beta1BucketingConfig"
},
"GooglePrivacyDlpV2beta1DeidentifyContentResponse": {
+ "id": "GooglePrivacyDlpV2beta1DeidentifyContentResponse",
"description": "Results of de-identifying a list of items.",
"type": "object",
"properties": {
+ "summaries": {
+ "type": "array",
+ "items": {
+ "$ref": "GooglePrivacyDlpV2beta1DeidentificationSummary"
+ },
+ "description": "A review of the transformations that took place for each item."
+ },
"items": {
"type": "array",
"items": {
"$ref": "GooglePrivacyDlpV2beta1ContentItem"
}
- },
- "summaries": {
- "description": "A review of the transformations that took place for each item.",
- "type": "array",
- "items": {
- "$ref": "GooglePrivacyDlpV2beta1DeidentificationSummary"
- }
}
- },
- "id": "GooglePrivacyDlpV2beta1DeidentifyContentResponse"
+ }
},
"GooglePrivacyDlpV2beta1KAnonymityEquivalenceClass": {
+ "id": "GooglePrivacyDlpV2beta1KAnonymityEquivalenceClass",
+ "description": "The set of columns' values that share the same k-anonymity value.",
+ "type": "object",
"properties": {
+ "equivalenceClassSize": {
+ "description": "Size of the equivalence class, for example number of rows with the\nabove set of values.",
+ "format": "int64",
+ "type": "string"
+ },
"quasiIdsValues": {
"description": "Set of values defining the equivalence class. One value per\nquasi-identifier column in the original KAnonymity metric message.\nThe order is always the same as the original request.",
"type": "array",
"items": {
"$ref": "GooglePrivacyDlpV2beta1Value"
}
- },
- "equivalenceClassSize": {
- "description": "Size of the equivalence class, for example number of rows with the\nabove set of values.",
- "format": "int64",
- "type": "string"
}
- },
- "id": "GooglePrivacyDlpV2beta1KAnonymityEquivalenceClass",
- "description": "The set of columns' values that share the same k-anonymity value.",
- "type": "object"
+ }
},
"GoogleLongrunningOperation": {
+ "id": "GoogleLongrunningOperation",
"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": "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."
- },
"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"
+ "type": "any",
+ "description": "Properties of the object. Contains field @type with type URL."
},
"description": "This field will contain an InspectOperationResult object for `inspect.operations.create` or a RiskAnalysisOperationResult object for `dataSource.analyze`.",
"type": "object"
@@ -1006,36 +760,24 @@
"error": {
"$ref": "GoogleRpcStatus",
"description": "The error result of the operation in case of failure or cancellation."
- }
- },
- "id": "GoogleLongrunningOperation"
- },
- "GooglePrivacyDlpV2beta1KmsWrappedCryptoKey": {
- "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"
+ "metadata": {
+ "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": "GooglePrivacyDlpV2beta1KmsWrappedCryptoKey",
- "description": "Include to use an existing data crypto key wrapped by KMS.\nAuthorization requires the following IAM permissions when sending a request\nto perform a crypto transformation using a kms-wrapped crypto key:\ndlp.kms.encrypt"
+ }
},
"GooglePrivacyDlpV2beta1InspectOperationMetadata": {
+ "description": "Metadata returned within GetOperation for an inspect request.",
+ "type": "object",
"properties": {
- "createTime": {
- "description": "The time which this request was started.",
- "format": "google-datetime",
- "type": "string"
- },
"requestStorageConfig": {
- "$ref": "GooglePrivacyDlpV2beta1StorageConfig",
- "description": "The storage config used to create the Operation."
+ "description": "The storage config used to create the Operation.",
+ "$ref": "GooglePrivacyDlpV2beta1StorageConfig"
},
"processedBytes": {
"description": "Total size in bytes that were processed.",
@@ -1060,27 +802,50 @@
"requestOutputConfig": {
"$ref": "GooglePrivacyDlpV2beta1OutputStorageConfig",
"description": "Optional location to store findings."
+ },
+ "createTime": {
+ "description": "The time which this request was started.",
+ "format": "google-datetime",
+ "type": "string"
}
},
- "id": "GooglePrivacyDlpV2beta1InspectOperationMetadata",
- "description": "Metadata returned within GetOperation for an inspect request.",
- "type": "object"
+ "id": "GooglePrivacyDlpV2beta1InspectOperationMetadata"
+ },
+ "GooglePrivacyDlpV2beta1KmsWrappedCryptoKey": {
+ "description": "Include to use an existing data crypto key wrapped by KMS.\nAuthorization requires the following IAM permissions when sending a request\nto perform a crypto transformation using a kms-wrapped crypto key:\ndlp.kms.encrypt",
+ "type": "object",
+ "properties": {
+ "wrappedKey": {
+ "description": "The wrapped data crypto key. [required]",
+ "format": "byte",
+ "type": "string"
+ },
+ "cryptoKeyName": {
+ "type": "string",
+ "description": "The resource name of the KMS CryptoKey to use for unwrapping. [required]"
+ }
+ },
+ "id": "GooglePrivacyDlpV2beta1KmsWrappedCryptoKey"
},
"GooglePrivacyDlpV2beta1InfoType": {
- "description": "Type of information detected by the API.",
- "type": "object",
"properties": {
"name": {
"description": "Name of the information type.",
"type": "string"
}
},
- "id": "GooglePrivacyDlpV2beta1InfoType"
+ "id": "GooglePrivacyDlpV2beta1InfoType",
+ "description": "Type of information detected by the API.",
+ "type": "object"
},
"GooglePrivacyDlpV2beta1CharsToIgnore": {
+ "description": "Characters to skip when doing deidentification of a value. These will be left\nalone and skipped.",
+ "type": "object",
"properties": {
+ "charactersToSkip": {
+ "type": "string"
+ },
"commonCharactersToIgnore": {
- "type": "string",
"enumDescriptions": [
"",
"0-9",
@@ -1096,38 +861,39 @@
"ALPHA_LOWER_CASE",
"PUNCTUATION",
"WHITESPACE"
- ]
- },
- "charactersToSkip": {
+ ],
"type": "string"
}
},
- "id": "GooglePrivacyDlpV2beta1CharsToIgnore",
- "description": "Characters to skip when doing deidentification of a value. These will be left\nalone and skipped.",
- "type": "object"
+ "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": {
+ "bucketSize": {
+ "description": "Size of each bucket (except for minimum and maximum buckets). So if\n`lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the\nfollowing buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60,\n60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. [Required].",
+ "format": "double",
+ "type": "number"
+ },
"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": "GooglePrivacyDlpV2beta1Value"
},
"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]."
- },
- "bucketSize": {
- "description": "Size of each bucket (except for minimum and maximum buckets). So if\n`lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the\nfollowing buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60,\n60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. [Required].",
- "format": "double",
- "type": "number"
+ "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"
}
- }
+ },
+ "id": "GooglePrivacyDlpV2beta1FixedSizeBucketingConfig"
},
"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"
},
@@ -1139,18 +905,11 @@
},
"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"
},
"GooglePrivacyDlpV2beta1CategoryDescription": {
- "description": "Info Type Category description.",
- "type": "object",
"properties": {
"name": {
"description": "Internal name of the category.",
@@ -1161,9 +920,12 @@
"type": "string"
}
},
- "id": "GooglePrivacyDlpV2beta1CategoryDescription"
+ "id": "GooglePrivacyDlpV2beta1CategoryDescription",
+ "description": "Info Type Category description.",
+ "type": "object"
},
"GooglePrivacyDlpV2beta1Conditions": {
+ "id": "GooglePrivacyDlpV2beta1Conditions",
"type": "object",
"properties": {
"conditions": {
@@ -1172,14 +934,11 @@
"$ref": "GooglePrivacyDlpV2beta1Condition"
}
}
- },
- "id": "GooglePrivacyDlpV2beta1Conditions"
+ }
},
"GooglePrivacyDlpV2beta1PrimitiveTransformation": {
+ "type": "object",
"properties": {
- "characterMaskConfig": {
- "$ref": "GooglePrivacyDlpV2beta1CharacterMaskConfig"
- },
"redactConfig": {
"$ref": "GooglePrivacyDlpV2beta1RedactConfig"
},
@@ -1203,48 +962,25 @@
},
"fixedSizeBucketingConfig": {
"$ref": "GooglePrivacyDlpV2beta1FixedSizeBucketingConfig"
+ },
+ "characterMaskConfig": {
+ "$ref": "GooglePrivacyDlpV2beta1CharacterMaskConfig"
}
},
"id": "GooglePrivacyDlpV2beta1PrimitiveTransformation",
- "description": "A rule for transforming a value.",
- "type": "object"
+ "description": "A rule for transforming a value."
},
"GooglePrivacyDlpV2beta1CategoricalStatsConfig": {
"description": "Compute numerical stats over an individual column, including\nnumber of distinct values and value count distribution.",
"type": "object",
"properties": {
"field": {
- "$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."
+ "description": "Field to compute categorical stats on. All column types are\nsupported except for arrays and structs. However, it may be more\ninformative to use NumericalStats when the field type is supported,\ndepending on the data.",
+ "$ref": "GooglePrivacyDlpV2beta1FieldId"
}
},
"id": "GooglePrivacyDlpV2beta1CategoricalStatsConfig"
},
- "GooglePrivacyDlpV2beta1KMapEstimationConfig": {
- "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",
- "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"
- }
- }
- },
- "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"
- },
"GooglePrivacyDlpV2beta1Finding": {
"description": "Container structure describing a single finding within a string or image.",
"type": "object",
@@ -1254,9 +990,9 @@
"$ref": "GooglePrivacyDlpV2beta1InfoType"
},
"createTime": {
- "type": "string",
"description": "Timestamp when finding was detected.",
- "format": "google-datetime"
+ "format": "google-datetime",
+ "type": "string"
},
"quote": {
"description": "The specific string that may be potentially sensitive info.",
@@ -1289,10 +1025,39 @@
},
"id": "GooglePrivacyDlpV2beta1Finding"
},
+ "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": {
+ "type": "array",
+ "items": {
+ "$ref": "GooglePrivacyDlpV2beta1AuxiliaryTable"
+ },
+ "description": "Several auxiliary tables can be used in the analysis. Each custom_tag\nused to tag a quasi-identifiers column must appear in exactly one column\nof one auxiliary table."
+ },
+ "quasiIds": {
+ "description": "Fields considered to be quasi-identifiers. No two columns can have the\nsame tag. [required]",
+ "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"
+ },
"GooglePrivacyDlpV2beta1RiskAnalysisOperationMetadata": {
"description": "Metadata returned within the\n[`riskAnalysis.operations.get`](/dlp/docs/reference/rest/v2beta1/riskAnalysis.operations/get)\nfor risk analysis.",
"type": "object",
"properties": {
+ "requestedPrivacyMetric": {
+ "$ref": "GooglePrivacyDlpV2beta1PrivacyMetric",
+ "description": "Privacy metric to compute."
+ },
"createTime": {
"description": "The time which this request was started.",
"format": "google-datetime",
@@ -1301,10 +1066,6 @@
"requestedSourceTable": {
"$ref": "GooglePrivacyDlpV2beta1BigQueryTable",
"description": "Input dataset to compute metrics over."
- },
- "requestedPrivacyMetric": {
- "$ref": "GooglePrivacyDlpV2beta1PrivacyMetric",
- "description": "Privacy metric to compute."
}
},
"id": "GooglePrivacyDlpV2beta1RiskAnalysisOperationMetadata"
@@ -1313,16 +1074,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"
@@ -1346,28 +1107,33 @@
"id": "GoogleProtobufEmpty"
},
"GooglePrivacyDlpV2beta1ListInspectFindingsResponse": {
+ "id": "GooglePrivacyDlpV2beta1ListInspectFindingsResponse",
"description": "Response to the ListInspectFindings request.",
"type": "object",
"properties": {
- "nextPageToken": {
- "description": "If not empty, indicates that there may be more results that match the\nrequest; this value should be passed in a new `ListInspectFindingsRequest`.",
- "type": "string"
- },
"result": {
"$ref": "GooglePrivacyDlpV2beta1InspectResult",
"description": "The results."
+ },
+ "nextPageToken": {
+ "description": "If not empty, indicates that there may be more results that match the\nrequest; this value should be passed in a new `ListInspectFindingsRequest`.",
+ "type": "string"
}
- },
- "id": "GooglePrivacyDlpV2beta1ListInspectFindingsResponse"
+ }
},
"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": {
+ "maxAnonymity": {
+ "description": "Always greater than or equal to min_anonymity.",
+ "format": "int64",
+ "type": "string"
+ },
"bucketSize": {
- "type": "string",
"description": "Number of records within these anonymity bounds.",
- "format": "int64"
+ "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.",
@@ -1380,11 +1146,6 @@
"description": "Always positive.",
"format": "int64",
"type": "string"
- },
- "maxAnonymity": {
- "description": "Always greater than or equal to min_anonymity.",
- "format": "int64",
- "type": "string"
}
},
"id": "GooglePrivacyDlpV2beta1KMapEstimationHistogramBucket"
@@ -1395,6 +1156,7 @@
"type": "object",
"properties": {
"logicalOperator": {
+ "type": "string",
"enumDescriptions": [
"",
""
@@ -1403,8 +1165,7 @@
"LOGICAL_OPERATOR_UNSPECIFIED",
"AND"
],
- "description": "The operator to apply to the result of conditions. Default and currently\nonly supported value is `AND`.",
- "type": "string"
+ "description": "The operator to apply to the result of conditions. Default and currently\nonly supported value is `AND`."
},
"conditions": {
"$ref": "GooglePrivacyDlpV2beta1Conditions"
@@ -1412,17 +1173,16 @@
}
},
"GooglePrivacyDlpV2beta1CloudStorageOptions": {
- "description": "Options defining a file or a set of files (path ending with *) within\na Google Cloud Storage bucket.",
"type": "object",
"properties": {
"fileSet": {
"$ref": "GooglePrivacyDlpV2beta1FileSet"
}
},
- "id": "GooglePrivacyDlpV2beta1CloudStorageOptions"
+ "id": "GooglePrivacyDlpV2beta1CloudStorageOptions",
+ "description": "Options defining a file or a set of files (path ending with *) within\na Google Cloud Storage bucket."
},
"GooglePrivacyDlpV2beta1CloudStoragePath": {
- "description": "A location in Cloud Storage.",
"type": "object",
"properties": {
"path": {
@@ -1430,16 +1190,24 @@
"type": "string"
}
},
- "id": "GooglePrivacyDlpV2beta1CloudStoragePath"
+ "id": "GooglePrivacyDlpV2beta1CloudStoragePath",
+ "description": "A location in Cloud Storage."
},
"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": {
- "type": "string",
"description": "Lower bound on the size of the equivalence classes in this bucket.",
- "format": "int64"
+ "format": "int64",
+ "type": "string"
},
"equivalenceClassSizeUpperBound": {
"description": "Upper bound on the size of the equivalence classes in this bucket.",
@@ -1450,30 +1218,22 @@
"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.",
- "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"
+ "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 `inspect/results/{id}`."
}
},
- "id": "GooglePrivacyDlpV2beta1InspectOperationResult"
+ "id": "GooglePrivacyDlpV2beta1InspectOperationResult",
+ "description": "The operational data.",
+ "type": "object"
},
"GooglePrivacyDlpV2beta1LDiversityResult": {
- "id": "GooglePrivacyDlpV2beta1LDiversityResult",
"description": "Result of the l-diversity computation.",
"type": "object",
"properties": {
@@ -1484,7 +1244,8 @@
"$ref": "GooglePrivacyDlpV2beta1LDiversityHistogramBucket"
}
}
- }
+ },
+ "id": "GooglePrivacyDlpV2beta1LDiversityResult"
},
"GooglePrivacyDlpV2beta1CategoricalStatsResult": {
"id": "GooglePrivacyDlpV2beta1CategoricalStatsResult",
@@ -1518,9 +1279,18 @@
"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": {
+ "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",
@@ -1530,27 +1300,18 @@
"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": {
- "type": "integer",
- "description": "Minutes of hour of day. Must be from 0 to 59.",
- "format": "int32"
- },
- "hours": {
- "type": "integer",
- "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"
}
},
- "id": "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`."
},
"GooglePrivacyDlpV2beta1DeidentifyConfig": {
"description": "The configuration that controls how the data will change.",
"type": "object",
"properties": {
"recordTransformations": {
- "$ref": "GooglePrivacyDlpV2beta1RecordTransformations",
- "description": "Treat the dataset as structured. Transformations can be applied to\nspecific locations within structured datasets, such as transforming\na column within a table."
+ "description": "Treat the dataset as structured. Transformations can be applied to\nspecific locations within structured datasets, such as transforming\na column within a table.",
+ "$ref": "GooglePrivacyDlpV2beta1RecordTransformations"
},
"infoTypeTransformations": {
"$ref": "GooglePrivacyDlpV2beta1InfoTypeTransformations",
@@ -1560,13 +1321,12 @@
"id": "GooglePrivacyDlpV2beta1DeidentifyConfig"
},
"GooglePrivacyDlpV2beta1LDiversityConfig": {
- "id": "GooglePrivacyDlpV2beta1LDiversityConfig",
"description": "l-diversity metric, used for analysis of reidentification risk.",
"type": "object",
"properties": {
"sensitiveAttribute": {
- "description": "Sensitive field for computing the l-value.",
- "$ref": "GooglePrivacyDlpV2beta1FieldId"
+ "$ref": "GooglePrivacyDlpV2beta1FieldId",
+ "description": "Sensitive field for computing the l-value."
},
"quasiIds": {
"description": "Set of quasi-identifiers indicating how equivalence classes are\ndefined for the l-diversity computation. When multiple fields are\nspecified, they are considered a single composite key.",
@@ -1575,27 +1335,46 @@
"$ref": "GooglePrivacyDlpV2beta1FieldId"
}
}
- }
+ },
+ "id": "GooglePrivacyDlpV2beta1LDiversityConfig"
},
"GooglePrivacyDlpV2beta1StorageConfig": {
"description": "Shared message indicating Cloud storage type.",
"type": "object",
"properties": {
+ "cloudStorageOptions": {
+ "description": "Google Cloud Storage options specification.",
+ "$ref": "GooglePrivacyDlpV2beta1CloudStorageOptions"
+ },
"datastoreOptions": {
- "$ref": "GooglePrivacyDlpV2beta1DatastoreOptions",
- "description": "Google Cloud Datastore options specification."
+ "description": "Google Cloud Datastore options specification.",
+ "$ref": "GooglePrivacyDlpV2beta1DatastoreOptions"
},
"bigQueryOptions": {
"$ref": "GooglePrivacyDlpV2beta1BigQueryOptions",
"description": "BigQuery options specification."
- },
- "cloudStorageOptions": {
- "description": "Google Cloud Storage options specification.",
- "$ref": "GooglePrivacyDlpV2beta1CloudStorageOptions"
}
},
"id": "GooglePrivacyDlpV2beta1StorageConfig"
},
+ "GooglePrivacyDlpV2beta1BigQueryOptions": {
+ "id": "GooglePrivacyDlpV2beta1BigQueryOptions",
+ "description": "Options defining BigQuery table and row identifiers.",
+ "type": "object",
+ "properties": {
+ "tableReference": {
+ "$ref": "GooglePrivacyDlpV2beta1BigQueryTable",
+ "description": "Complete BigQuery table reference."
+ },
+ "identifyingFields": {
+ "description": "References to fields uniquely identifying rows within the table.\nNested fields in the format, like `person.birthdate.year`, are allowed.",
+ "type": "array",
+ "items": {
+ "$ref": "GooglePrivacyDlpV2beta1FieldId"
+ }
+ }
+ }
+ },
"GooglePrivacyDlpV2beta1OperationConfig": {
"description": "Additional configuration for inspect long running operations.",
"type": "object",
@@ -1608,28 +1387,16 @@
},
"id": "GooglePrivacyDlpV2beta1OperationConfig"
},
- "GooglePrivacyDlpV2beta1BigQueryOptions": {
- "description": "Options defining BigQuery table and row identifiers.",
- "type": "object",
- "properties": {
- "identifyingFields": {
- "description": "References to fields uniquely identifying rows within the table.\nNested fields in the format, like `person.birthdate.year`, are allowed.",
- "type": "array",
- "items": {
- "$ref": "GooglePrivacyDlpV2beta1FieldId"
- }
- },
- "tableReference": {
- "$ref": "GooglePrivacyDlpV2beta1BigQueryTable",
- "description": "Complete BigQuery table reference."
- }
- },
- "id": "GooglePrivacyDlpV2beta1BigQueryOptions"
- },
"GooglePrivacyDlpV2beta1PrivacyMetric": {
"description": "Privacy metric to compute for reidentification risk analysis.",
"type": "object",
"properties": {
+ "kMapEstimationConfig": {
+ "$ref": "GooglePrivacyDlpV2beta1KMapEstimationConfig"
+ },
+ "lDiversityConfig": {
+ "$ref": "GooglePrivacyDlpV2beta1LDiversityConfig"
+ },
"numericalStatsConfig": {
"$ref": "GooglePrivacyDlpV2beta1NumericalStatsConfig"
},
@@ -1638,12 +1405,6 @@
},
"categoricalStatsConfig": {
"$ref": "GooglePrivacyDlpV2beta1CategoricalStatsConfig"
- },
- "kMapEstimationConfig": {
- "$ref": "GooglePrivacyDlpV2beta1KMapEstimationConfig"
- },
- "lDiversityConfig": {
- "$ref": "GooglePrivacyDlpV2beta1LDiversityConfig"
}
},
"id": "GooglePrivacyDlpV2beta1PrivacyMetric"
@@ -1652,8 +1413,8 @@
"type": "object",
"properties": {
"infoType": {
- "$ref": "GooglePrivacyDlpV2beta1InfoType",
- "description": "Type of information to replace. Only one ReplaceConfig per info_type\nshould be provided. If ReplaceConfig does not have an info_type, the DLP\nAPI matches it against all info_types that are found but not specified in\nanother ReplaceConfig."
+ "description": "Type of information to replace. Only one ReplaceConfig per info_type\nshould be provided. If ReplaceConfig does not have an info_type, the DLP\nAPI matches it against all info_types that are found but not specified in\nanother ReplaceConfig.",
+ "$ref": "GooglePrivacyDlpV2beta1InfoType"
},
"replaceWith": {
"description": "Content replacing sensitive information of given type. Max 256 chars.",
@@ -1705,40 +1466,39 @@
"id": "GooglePrivacyDlpV2beta1LDiversityEquivalenceClass"
},
"GooglePrivacyDlpV2beta1DeidentificationSummary": {
+ "description": "High level summary of deidentification.",
"type": "object",
"properties": {
- "transformationSummaries": {
- "type": "array",
- "items": {
- "$ref": "GooglePrivacyDlpV2beta1TransformationSummary"
- },
- "description": "Transformations applied to the dataset."
- },
"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"
+ }
}
},
- "id": "GooglePrivacyDlpV2beta1DeidentificationSummary",
- "description": "High level summary of deidentification."
+ "id": "GooglePrivacyDlpV2beta1DeidentificationSummary"
},
"GooglePrivacyDlpV2beta1RecordCondition": {
+ "id": "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.",
- "type": "object"
+ }
},
"GooglePrivacyDlpV2beta1TimePartConfig": {
"description": "For use with `Date`, `Timestamp`, and `TimeOfDay`, extract or preserve a\nportion of the value.",
"type": "object",
"properties": {
"partToExtract": {
- "type": "string",
"enumDescriptions": [
"",
"[000-9999]",
@@ -1756,14 +1516,13 @@
"DAY_OF_WEEK",
"WEEK_OF_YEAR",
"HOUR_OF_DAY"
- ]
+ ],
+ "type": "string"
}
},
"id": "GooglePrivacyDlpV2beta1TimePartConfig"
},
"GooglePrivacyDlpV2beta1ListInfoTypesResponse": {
- "description": "Response to the ListInfoTypes request.",
- "type": "object",
"properties": {
"infoTypes": {
"description": "Set of sensitive info types belonging to a category.",
@@ -1773,33 +1532,32 @@
}
}
},
- "id": "GooglePrivacyDlpV2beta1ListInfoTypesResponse"
+ "id": "GooglePrivacyDlpV2beta1ListInfoTypesResponse",
+ "description": "Response to the ListInfoTypes request.",
+ "type": "object"
},
"GooglePrivacyDlpV2beta1CloudStorageKey": {
- "id": "GooglePrivacyDlpV2beta1CloudStorageKey",
"description": "Record key for a finding in a Cloud Storage file.",
"type": "object",
"properties": {
+ "startOffset": {
+ "description": "Byte offset of the referenced data in the file.",
+ "format": "int64",
+ "type": "string"
+ },
"filePath": {
"description": "Path to the file.",
"type": "string"
- },
- "startOffset": {
- "type": "string",
- "description": "Byte offset of the referenced data in the file.",
- "format": "int64"
}
- }
+ },
+ "id": "GooglePrivacyDlpV2beta1CloudStorageKey"
},
"GooglePrivacyDlpV2beta1NumericalStatsResult": {
+ "type": "object",
"properties": {
- "minValue": {
- "$ref": "GooglePrivacyDlpV2beta1Value",
- "description": "Minimum value appearing in the column."
- },
"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.",
@@ -1807,19 +1565,22 @@
"items": {
"$ref": "GooglePrivacyDlpV2beta1Value"
}
+ },
+ "minValue": {
+ "description": "Minimum value appearing in the column.",
+ "$ref": "GooglePrivacyDlpV2beta1Value"
}
},
"id": "GooglePrivacyDlpV2beta1NumericalStatsResult",
- "description": "Result of the numerical stats computation.",
- "type": "object"
+ "description": "Result of the numerical stats computation."
},
"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": {
"wordList": {
- "$ref": "GooglePrivacyDlpV2beta1WordList",
- "description": "List of words or phrases to search for."
+ "description": "List of words or phrases to search for.",
+ "$ref": "GooglePrivacyDlpV2beta1WordList"
}
},
"id": "GooglePrivacyDlpV2beta1Dictionary"
@@ -1831,8 +1592,8 @@
"$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.",
@@ -1871,7 +1632,19 @@
"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": {
+ "description": "Only returns findings equal or above this threshold.",
"type": "string",
"enumDescriptions": [
"Default value; information with all likelihoods is included.",
@@ -1888,8 +1661,7 @@
"POSSIBLE",
"LIKELY",
"VERY_LIKELY"
- ],
- "description": "Only returns findings equal or above this threshold."
+ ]
},
"infoTypeLimits": {
"description": "Configuration of findings limit given for specified info types.",
@@ -1899,37 +1671,25 @@
}
},
"maxFindings": {
+ "type": "integer",
"description": "Limits the number of findings per content item or long running operation.",
- "format": "int32",
- "type": "integer"
+ "format": "int32"
},
"infoTypes": {
- "description": "Restricts what info_types to look for. The values must correspond to\nInfoType values returned by ListInfoTypes or found in documentation.\nEmpty info_types runs all enabled detectors.",
"type": "array",
"items": {
"$ref": "GooglePrivacyDlpV2beta1InfoType"
- }
+ },
+ "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."
},
"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"
},
"GooglePrivacyDlpV2beta1Projection": {
- "id": "GooglePrivacyDlpV2beta1Projection",
"description": "A representation of a Datastore property in a projection.",
"type": "object",
"properties": {
@@ -1937,13 +1697,14 @@
"description": "The property to project.",
"$ref": "GooglePrivacyDlpV2beta1PropertyReference"
}
- }
+ },
+ "id": "GooglePrivacyDlpV2beta1Projection"
},
"GooglePrivacyDlpV2beta1RedactConfig": {
- "id": "GooglePrivacyDlpV2beta1RedactConfig",
- "description": "Redact a given value. For example, if used with an `InfoTypeTransformation`\ntransforming PHONE_NUMBER, and input 'My phone number is 206-555-0123', the\noutput would be 'My phone number is '.",
"type": "object",
- "properties": {}
+ "properties": {},
+ "id": "GooglePrivacyDlpV2beta1RedactConfig",
+ "description": "Redact a given value. For example, if used with an `InfoTypeTransformation`\ntransforming PHONE_NUMBER, and input 'My phone number is 206-555-0123', the\noutput would be 'My phone number is '."
},
"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.",
@@ -1957,37 +1718,37 @@
"id": "GooglePrivacyDlpV2beta1CryptoHashConfig"
},
"GooglePrivacyDlpV2beta1Key": {
+ "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.",
"type": "object",
"properties": {
- "partitionId": {
- "$ref": "GooglePrivacyDlpV2beta1PartitionId",
- "description": "Entities are partitioned into subsets, currently identified by a project\nID and namespace ID.\nQueries are scoped to a single partition."
- },
"path": {
"description": "The entity path.\nAn entity path consists of one or more elements composed of a kind and a\nstring or numerical identifier, which identify entities. The first\nelement identifies a _root entity_, the second element identifies\na _child_ of the root entity, the third element identifies a child of the\nsecond entity, and so forth. The entities identified by all prefixes of\nthe path are called the element's _ancestors_.\n\nA path can never be empty, and a path can have at most 100 elements.",
"type": "array",
"items": {
"$ref": "GooglePrivacyDlpV2beta1PathElement"
}
+ },
+ "partitionId": {
+ "description": "Entities are partitioned into subsets, currently identified by a project\nID and namespace ID.\nQueries are scoped to a single partition.",
+ "$ref": "GooglePrivacyDlpV2beta1PartitionId"
}
- },
- "id": "GooglePrivacyDlpV2beta1Key"
+ }
},
"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": {
- "$ref": "GooglePrivacyDlpV2beta1InspectConfig",
- "description": "Configuration for the inspector."
}
},
"id": "GooglePrivacyDlpV2beta1InspectContentRequest"
@@ -2014,41 +1775,42 @@
},
"id": "GoogleTypeDate"
},
+ "GooglePrivacyDlpV2beta1ReplaceWithInfoTypeConfig": {
+ "properties": {},
+ "id": "GooglePrivacyDlpV2beta1ReplaceWithInfoTypeConfig",
+ "description": "Replace each matching finding with the name of the info_type.",
+ "type": "object"
+ },
"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": {
- "description": "Only one per info_type should be provided per request. If not\nspecified, and redact_all_text is false, the DLP API will redact all\ntext that it matches against all info_types that are found, but not\nspecified in another ImageRedactionConfig.",
- "$ref": "GooglePrivacyDlpV2beta1InfoType"
- },
- "redactionColor": {
- "$ref": "GooglePrivacyDlpV2beta1Color",
- "description": "The color to use when redacting content from an image. If not specified,\nthe default is black."
+ "$ref": "GooglePrivacyDlpV2beta1InfoType",
+ "description": "Only one per info_type should be provided per request. If not\nspecified, and redact_all_text is false, the DLP API will redact all\ntext that it matches against all info_types that are found, but not\nspecified in another ImageRedactionConfig."
}
},
- "id": "GooglePrivacyDlpV2beta1ImageRedactionConfig"
- },
- "GooglePrivacyDlpV2beta1ReplaceWithInfoTypeConfig": {
- "description": "Replace each matching finding with the name of the info_type.",
- "type": "object",
- "properties": {},
- "id": "GooglePrivacyDlpV2beta1ReplaceWithInfoTypeConfig"
+ "id": "GooglePrivacyDlpV2beta1ImageRedactionConfig",
+ "description": "Configuration for determining how redaction of images should occur.",
+ "type": "object"
},
"GooglePrivacyDlpV2beta1Location": {
+ "description": "Specifies the location of a finding within its source item.",
"type": "object",
"properties": {
"tableLocation": {
- "description": "Location within a `ContentItem.Table`.",
- "$ref": "GooglePrivacyDlpV2beta1TableLocation"
+ "$ref": "GooglePrivacyDlpV2beta1TableLocation",
+ "description": "Location within a `ContentItem.Table`."
},
"codepointRange": {
- "$ref": "GooglePrivacyDlpV2beta1Range",
- "description": "Character offsets within a content item, included when content type\nis a text. Default charset assumed to be UTF-8."
+ "description": "Character offsets within a content item, included when content type\nis a text. Default charset assumed to be UTF-8.",
+ "$ref": "GooglePrivacyDlpV2beta1Range"
},
"fieldId": {
"$ref": "GooglePrivacyDlpV2beta1FieldId",
@@ -2066,12 +1828,11 @@
"description": "Zero-based byte offsets within a content item."
},
"recordKey": {
- "description": "Key of the finding.",
- "$ref": "GooglePrivacyDlpV2beta1RecordKey"
+ "$ref": "GooglePrivacyDlpV2beta1RecordKey",
+ "description": "Key of the finding."
}
},
- "id": "GooglePrivacyDlpV2beta1Location",
- "description": "Specifies the location of a finding within its source item."
+ "id": "GooglePrivacyDlpV2beta1Location"
},
"GooglePrivacyDlpV2beta1RecordSuppression": {
"description": "Configuration to suppress records whose suppression conditions evaluate to\ntrue.",
@@ -2084,6 +1845,8 @@
"id": "GooglePrivacyDlpV2beta1RecordSuppression"
},
"GooglePrivacyDlpV2beta1InfoTypeDescription": {
+ "description": "Description of the information type (infoType).",
+ "type": "object",
"properties": {
"categories": {
"description": "List of categories this infoType belongs to.",
@@ -2101,32 +1864,28 @@
"type": "string"
}
},
- "id": "GooglePrivacyDlpV2beta1InfoTypeDescription",
- "description": "Description of the information type (infoType).",
- "type": "object"
+ "id": "GooglePrivacyDlpV2beta1InfoTypeDescription"
},
"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": {
+ "surrogateType": {
+ "$ref": "GooglePrivacyDlpV2beta1SurrogateType",
+ "description": "Surrogate info type."
+ },
"infoType": {
- "$ref": "GooglePrivacyDlpV2beta1InfoType",
- "description": "Info type configuration. All custom info types must have configurations\nthat do not conflict with built-in info types or other custom info types."
+ "description": "Info type configuration. All custom info types must have configurations\nthat do not conflict with built-in info types or other custom info types.",
+ "$ref": "GooglePrivacyDlpV2beta1InfoType"
},
"dictionary": {
"$ref": "GooglePrivacyDlpV2beta1Dictionary",
"description": "Dictionary-based custom info type."
- },
- "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.",
- "type": "object",
"properties": {
"key": {
"description": "The AES 128/192/256 bit key. [required]",
@@ -2134,28 +1893,25 @@
"type": "string"
}
},
- "id": "GooglePrivacyDlpV2beta1UnwrappedCryptoKey"
+ "id": "GooglePrivacyDlpV2beta1UnwrappedCryptoKey",
+ "description": "Using raw keys is prone to security risks due to accidentally\nleaking the key. Choose another type of key if possible.",
+ "type": "object"
},
"GooglePrivacyDlpV2beta1EntityId": {
+ "id": "GooglePrivacyDlpV2beta1EntityId",
"description": "An entity in a dataset is a field or set of fields that correspond to a\nsingle person. For example, in medical records the `EntityId` might be\na patient identifier, or for financial records it might be an account\nidentifier. This message is used when generalizations or analysis must be\nconsistent across multiple rows pertaining to the same entity.",
"type": "object",
"properties": {
"field": {
- "description": "Composite key indicating which field contains the entity identifier.",
- "$ref": "GooglePrivacyDlpV2beta1FieldId"
+ "$ref": "GooglePrivacyDlpV2beta1FieldId",
+ "description": "Composite key indicating which field contains the entity identifier."
}
- },
- "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": {
- "table": {
- "$ref": "GooglePrivacyDlpV2beta1BigQueryTable",
- "description": "Auxiliary table location. [required]"
- },
"quasiIds": {
"description": "Quasi-identifier columns. [required]",
"type": "array",
@@ -2164,10 +1920,42 @@
}
},
"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]"
+ "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]"
}
- }
+ },
+ "id": "GooglePrivacyDlpV2beta1AuxiliaryTable"
+ },
+ "GoogleRpcStatus": {
+ "properties": {
+ "message": {
+ "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
+ "type": "string"
+ },
+ "details": {
+ "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ }
+ }
+ },
+ "code": {
+ "description": "The status code, which should be an enum value of google.rpc.Code.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "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"
},
"GooglePrivacyDlpV2beta1KMapEstimationResult": {
"description": "Result of the reidentifiability analysis. Note that these results are an\nestimation, not exact values.",
@@ -2183,33 +1971,6 @@
},
"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": {
- "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"
- },
"GooglePrivacyDlpV2beta1KMapEstimationQuasiIdValues": {
"description": "A tuple of values for the quasi-identifier columns.",
"type": "object",
@@ -2220,18 +1981,16 @@
"type": "string"
},
"quasiIdsValues": {
+ "description": "The quasi-identifier values.",
"type": "array",
"items": {
"$ref": "GooglePrivacyDlpV2beta1Value"
- },
- "description": "The quasi-identifier values."
+ }
}
},
"id": "GooglePrivacyDlpV2beta1KMapEstimationQuasiIdValues"
},
"GooglePrivacyDlpV2beta1PathElement": {
- "description": "A (kind, ID/name) pair used to construct a key path.\n\nIf either name or ID is set, the element is complete.\nIf neither is set, the element is incomplete.",
- "type": "object",
"properties": {
"name": {
"description": "The name of the entity.\nA name matching regex `__.*__` is reserved/read-only.\nA name must not be more than 1500 bytes when UTF-8 encoded.\nCannot be `\"\"`.",
@@ -2247,7 +2006,28 @@
"type": "string"
}
},
- "id": "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"
+ },
+ "GooglePrivacyDlpV2beta1BigQueryTable": {
+ "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.",
+ "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"
},
"GooglePrivacyDlpV2beta1SummaryResult": {
"description": "A collection that informs the user the number of times a particular\n`TransformationResultCode` and error details occurred.",
@@ -2262,7 +2042,6 @@
"type": "string"
},
"code": {
- "type": "string",
"enumDescriptions": [
"",
"",
@@ -2272,30 +2051,12 @@
"TRANSFORMATION_RESULT_CODE_UNSPECIFIED",
"SUCCESS",
"ERROR"
- ]
+ ],
+ "type": "string"
}
},
"id": "GooglePrivacyDlpV2beta1SummaryResult"
},
- "GooglePrivacyDlpV2beta1BigQueryTable": {
- "type": "object",
- "properties": {
- "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"
- },
- "tableId": {
- "description": "Name of the table.",
- "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`."
- },
"GooglePrivacyDlpV2beta1ListRootCategoriesResponse": {
"id": "GooglePrivacyDlpV2beta1ListRootCategoriesResponse",
"description": "Response for ListRootCategories request.",
@@ -2311,6 +2072,9 @@
}
},
"GooglePrivacyDlpV2beta1InfoTypeTransformations": {
+ "id": "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": {
"type": "array",
@@ -2319,496 +2083,732 @@
},
"description": "Transformation for each info type. Cannot specify more than one\nfor a given info type. [required]"
}
+ }
+ },
+ "GooglePrivacyDlpV2beta1KindExpression": {
+ "description": "A representation of a Datastore kind.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "The name of the kind.",
+ "type": "string"
+ }
},
- "id": "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.",
+ "id": "GooglePrivacyDlpV2beta1KindExpression"
+ },
+ "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"
+ },
+ "GooglePrivacyDlpV2beta1InfoTypeTransformation": {
+ "description": "A transformation to apply to text that is identified as a specific\ninfo_type.",
+ "type": "object",
+ "properties": {
+ "primitiveTransformation": {
+ "$ref": "GooglePrivacyDlpV2beta1PrimitiveTransformation",
+ "description": "Primitive transformation to apply to the info type. [required]"
+ },
+ "infoTypes": {
+ "description": "Info types to apply the transformation to. Empty list will match all\navailable info types for this transformation.",
+ "type": "array",
+ "items": {
+ "$ref": "GooglePrivacyDlpV2beta1InfoType"
+ }
+ }
+ },
+ "id": "GooglePrivacyDlpV2beta1InfoTypeTransformation"
+ },
+ "GooglePrivacyDlpV2beta1AnalyzeDataSourceRiskRequest": {
+ "description": "Request for creating a risk analysis operation.",
+ "type": "object",
+ "properties": {
+ "sourceTable": {
+ "$ref": "GooglePrivacyDlpV2beta1BigQueryTable",
+ "description": "Input dataset to compute metrics over."
+ },
+ "privacyMetric": {
+ "$ref": "GooglePrivacyDlpV2beta1PrivacyMetric",
+ "description": "Privacy metric to compute."
+ }
+ },
+ "id": "GooglePrivacyDlpV2beta1AnalyzeDataSourceRiskRequest"
+ },
+ "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"
+ },
+ "GooglePrivacyDlpV2beta1Bucket": {
+ "description": "Buckets represented as ranges, along with replacement values. Ranges must\nbe non-overlapping.",
+ "type": "object",
+ "properties": {
+ "min": {
+ "description": "Lower bound of the range, inclusive. Type should be the same as max if\nused.",
+ "$ref": "GooglePrivacyDlpV2beta1Value"
+ },
+ "max": {
+ "description": "Upper bound of the range, exclusive; type must match min.",
+ "$ref": "GooglePrivacyDlpV2beta1Value"
+ },
+ "replacementValue": {
+ "description": "Replacement value for this bucket. If not provided\nthe default behavior will be to hyphenate the min-max range.",
+ "$ref": "GooglePrivacyDlpV2beta1Value"
+ }
+ },
+ "id": "GooglePrivacyDlpV2beta1Bucket"
+ },
+ "GooglePrivacyDlpV2beta1CategoricalStatsHistogramBucket": {
+ "id": "GooglePrivacyDlpV2beta1CategoricalStatsHistogramBucket",
+ "description": "Histogram bucket of value frequencies in the column.",
+ "type": "object",
+ "properties": {
+ "bucketSize": {
+ "type": "string",
+ "description": "Total number of records in this bucket.",
+ "format": "int64"
+ },
+ "valueFrequencyUpperBound": {
+ "description": "Upper bound on the value frequency of the values in this bucket.",
+ "format": "int64",
+ "type": "string"
+ },
+ "valueFrequencyLowerBound": {
+ "type": "string",
+ "description": "Lower bound on the value frequency of the values in this bucket.",
+ "format": "int64"
+ },
+ "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"
+ }
+ }
+ }
+ },
+ "GooglePrivacyDlpV2beta1TableLocation": {
+ "id": "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"
+ }
+ }
+ },
+ "GooglePrivacyDlpV2beta1DatastoreKey": {
+ "description": "Record key for a finding in Cloud Datastore.",
+ "type": "object",
+ "properties": {
+ "entityKey": {
+ "$ref": "GooglePrivacyDlpV2beta1Key",
+ "description": "Datastore entity key."
+ }
+ },
+ "id": "GooglePrivacyDlpV2beta1DatastoreKey"
+ },
+ "GooglePrivacyDlpV2beta1KAnonymityConfig": {
+ "properties": {
+ "entityId": {
+ "$ref": "GooglePrivacyDlpV2beta1EntityId",
+ "description": "Optional message indicating that each distinct entity_id should not\ncontribute to the k-anonymity count more than once per equivalence class.\nIf an entity_id appears on several rows with different quasi-identifier\ntuples, it will contribute to each count exactly once.\n\nThis can lead to unexpected results. Consider a table where ID 1 is\nassociated to quasi-identifier \"foo\", ID 2 to \"bar\", and ID 3 to *both*\nquasi-identifiers \"foo\" and \"bar\" (on separate rows), and where this ID\nis used as entity_id. Then, the anonymity value associated to ID 3 will\nbe 2, even if it is the only ID to be associated to both values \"foo\" and\n\"bar\"."
+ },
+ "quasiIds": {
+ "description": "Set of fields to compute k-anonymity over. When multiple fields are\nspecified, they are considered a single composite key. Structs and\nrepeated data types are not supported; however, nested fields are\nsupported so long as they are not structs themselves or nested within\na repeated field.",
+ "type": "array",
+ "items": {
+ "$ref": "GooglePrivacyDlpV2beta1FieldId"
+ }
+ }
+ },
+ "id": "GooglePrivacyDlpV2beta1KAnonymityConfig",
+ "description": "k-anonymity metric, used for analysis of reidentification risk.",
+ "type": "object"
+ },
+ "GooglePrivacyDlpV2beta1RecordKey": {
+ "id": "GooglePrivacyDlpV2beta1RecordKey",
+ "description": "Message for a unique key indicating a record that contains a finding.",
+ "type": "object",
+ "properties": {
+ "cloudStorageKey": {
+ "$ref": "GooglePrivacyDlpV2beta1CloudStorageKey"
+ },
+ "datastoreKey": {
+ "$ref": "GooglePrivacyDlpV2beta1DatastoreKey"
+ }
+ }
+ },
+ "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": {
+ "description": "Configuration for the inspector.",
+ "$ref": "GooglePrivacyDlpV2beta1InspectConfig"
+ }
+ },
+ "id": "GooglePrivacyDlpV2beta1DeidentifyContentRequest"
+ },
+ "GooglePrivacyDlpV2beta1InspectResult": {
+ "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"
+ }
+ }
+ },
+ "id": "GooglePrivacyDlpV2beta1InspectResult",
+ "description": "All the findings for a single scanned item."
+ },
+ "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"
+ },
+ "GooglePrivacyDlpV2beta1ImageLocation": {
+ "description": "Bounding box encompassing detected text within an image.",
+ "type": "object",
+ "properties": {
+ "height": {
+ "type": "integer",
+ "description": "Height of the bounding box in pixels.",
+ "format": "int32"
+ },
+ "top": {
+ "type": "integer",
+ "description": "Top coordinate of the bounding box. (0,0) is upper left.",
+ "format": "int32"
+ },
+ "left": {
+ "type": "integer",
+ "description": "Left coordinate of the bounding box. (0,0) is upper left.",
+ "format": "int32"
+ },
+ "width": {
+ "description": "Width of the bounding box in pixels.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "GooglePrivacyDlpV2beta1ImageLocation"
+ },
+ "GooglePrivacyDlpV2beta1ReplaceValueConfig": {
+ "type": "object",
+ "properties": {
+ "newValue": {
+ "$ref": "GooglePrivacyDlpV2beta1Value",
+ "description": "Value to replace it with."
+ }
+ },
+ "id": "GooglePrivacyDlpV2beta1ReplaceValueConfig",
+ "description": "Replace each input value with a given `Value`."
+ },
+ "GooglePrivacyDlpV2beta1ContentItem": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "description": "Type of the content, as defined in Content-Type HTTP header.\nSupported types are: all \"text\" types, octet streams, PNG images,\nJPEG images.",
+ "type": "string"
+ },
+ "value": {
+ "description": "String data to inspect or redact.",
+ "type": "string"
+ },
+ "table": {
+ "$ref": "GooglePrivacyDlpV2beta1Table",
+ "description": "Structured content for inspection."
+ },
+ "data": {
+ "description": "Content data to inspect or redact.",
+ "format": "byte",
+ "type": "string"
+ }
+ },
+ "id": "GooglePrivacyDlpV2beta1ContentItem",
+ "description": "Container structure for the content to inspect."
+ },
+ "GooglePrivacyDlpV2beta1CryptoReplaceFfxFpeConfig": {
+ "type": "object",
+ "properties": {
+ "customAlphabet": {
+ "description": "This is supported by mapping these to the alphanumeric characters\nthat the FFX mode natively supports. This happens before/after\nencryption/decryption.\nEach character listed must appear only once.\nNumber of characters must be in the range [2, 62].\nThis must be encoded as ASCII.\nThe order of characters does not matter.",
+ "type": "string"
+ },
+ "cryptoKey": {
+ "description": "The key used by the encryption algorithm. [required]",
+ "$ref": "GooglePrivacyDlpV2beta1CryptoKey"
+ },
+ "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": {
+ "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"
+ }
+ },
+ "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."
+ },
+ "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].",
+ "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"
+ },
+ "red": {
+ "description": "The amount of red in the color as a value in the interval [0, 1].",
+ "format": "float",
+ "type": "number"
+ }
+ },
+ "id": "GooglePrivacyDlpV2beta1Color"
+ },
+ "GooglePrivacyDlpV2beta1Table": {
+ "properties": {
+ "headers": {
+ "type": "array",
+ "items": {
+ "$ref": "GooglePrivacyDlpV2beta1FieldId"
+ }
+ },
+ "rows": {
+ "type": "array",
+ "items": {
+ "$ref": "GooglePrivacyDlpV2beta1Row"
+ }
+ }
+ },
+ "id": "GooglePrivacyDlpV2beta1Table",
+ "description": "Structured content to inspect. Up to 50,000 `Value`s per request allowed.",
+ "type": "object"
+ },
+ "GooglePrivacyDlpV2beta1SurrogateType": {
+ "description": "Message for detecting output from deidentification transformations\nsuch as\n[`CryptoReplaceFfxFpeConfig`](/dlp/docs/reference/rest/v2beta1/content/deidentify#CryptoReplaceFfxFpeConfig).\nThese types of transformations are\nthose that perform pseudonymization, thereby producing a \"surrogate\" as\noutput. This should be used in conjunction with a field on the\ntransformation such as `surrogate_info_type`. This custom info type does\nnot support the use of `detection_rules`.",
+ "type": "object",
+ "properties": {},
+ "id": "GooglePrivacyDlpV2beta1SurrogateType"
+ },
+ "GooglePrivacyDlpV2beta1ValueFrequency": {
+ "id": "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": {
+ "description": "A value contained in the field in question.",
+ "$ref": "GooglePrivacyDlpV2beta1Value"
+ }
+ }
+ },
+ "GooglePrivacyDlpV2beta1CryptoKey": {
+ "id": "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": {
+ "transient": {
+ "$ref": "GooglePrivacyDlpV2beta1TransientCryptoKey"
+ },
+ "kmsWrapped": {
+ "$ref": "GooglePrivacyDlpV2beta1KmsWrappedCryptoKey"
+ },
+ "unwrapped": {
+ "$ref": "GooglePrivacyDlpV2beta1UnwrappedCryptoKey"
+ }
+ }
+ },
+ "GooglePrivacyDlpV2beta1InfoTypeLimit": {
+ "description": "Max findings configuration per info type, per content item or long running\noperation.",
+ "type": "object",
+ "properties": {
+ "infoType": {
+ "description": "Type of information the findings limit applies to. Only one limit per\ninfo_type should be provided. If InfoTypeLimit does not have an\ninfo_type, the DLP API applies the limit against all info_types that are\nfound but not specified in another InfoTypeLimit.",
+ "$ref": "GooglePrivacyDlpV2beta1InfoType"
+ },
+ "maxFindings": {
+ "description": "Max findings limit for the given infoType.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "GooglePrivacyDlpV2beta1InfoTypeLimit"
+ },
+ "GooglePrivacyDlpV2beta1LDiversityHistogramBucket": {
+ "description": "Histogram bucket of sensitive value frequencies in the table.",
+ "type": "object",
+ "properties": {
+ "sensitiveValueFrequencyLowerBound": {
+ "description": "Lower bound on the sensitive value frequencies of the equivalence\nclasses in this bucket.",
+ "format": "int64",
+ "type": "string"
+ },
+ "bucketValues": {
+ "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"
+ },
+ "sensitiveValueFrequencyUpperBound": {
+ "description": "Upper bound on the sensitive value frequencies of the equivalence\nclasses in this bucket.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "id": "GooglePrivacyDlpV2beta1LDiversityHistogramBucket"
+ },
+ "GooglePrivacyDlpV2beta1Value": {
+ "description": "Set of primitive values supported by the system.\nNote that for the purposes of inspection or transformation, the number\nof bytes considered to comprise a 'Value' is based on its representation\nas a UTF-8 encoded string. For example, if 'integer_value' is set to\n123456789, the number of bytes would be counted as 9, even though an\nint64 only holds up to 8 bytes of data.",
+ "type": "object",
+ "properties": {
+ "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"
+ },
+ "dateValue": {
+ "$ref": "GoogleTypeDate"
+ }
+ },
+ "id": "GooglePrivacyDlpV2beta1Value"
+ },
+ "GooglePrivacyDlpV2beta1Condition": {
+ "description": "The field type of `value` and `field` do not need to match to be\nconsidered equal, but not all comparisons are possible.\n\nA `value` of type:\n\n- `string` can be compared against all other types\n- `boolean` can only be compared against other booleans\n- `integer` can be compared against doubles or a string if the string value\ncan be parsed as an integer.\n- `double` can be compared against integers or a string if the string can\nbe parsed as a double.\n- `Timestamp` can be compared against strings in RFC 3339 date string\nformat.\n- `TimeOfDay` can be compared against timestamps and strings in the format\nof 'HH:mm:ss'.\n\nIf we fail to compare do to type mismatch, a warning will be given and\nthe condition will evaluate to false.",
+ "type": "object",
+ "properties": {
+ "field": {
+ "$ref": "GooglePrivacyDlpV2beta1FieldId",
+ "description": "Field within the record this condition is evaluated against. [required]"
+ },
+ "operator": {
+ "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"
+ ],
+ "enum": [
+ "RELATIONAL_OPERATOR_UNSPECIFIED",
+ "EQUAL_TO",
+ "NOT_EQUAL_TO",
+ "GREATER_THAN",
+ "LESS_THAN",
+ "GREATER_THAN_OR_EQUALS",
+ "LESS_THAN_OR_EQUALS",
+ "EXISTS"
+ ]
+ },
+ "value": {
+ "description": "Value to compare against. [Required, except for `EXISTS` tests.]",
+ "$ref": "GooglePrivacyDlpV2beta1Value"
+ }
+ },
+ "id": "GooglePrivacyDlpV2beta1Condition"
+ },
+ "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"
+ },
+ "GooglePrivacyDlpV2beta1InspectContentResponse": {
+ "id": "GooglePrivacyDlpV2beta1InspectContentResponse",
+ "description": "Results of inspecting a list of items.",
+ "type": "object",
+ "properties": {
+ "results": {
+ "description": "Each content_item from the request has a result in this list, in the\nsame order as the request.",
+ "type": "array",
+ "items": {
+ "$ref": "GooglePrivacyDlpV2beta1InspectResult"
+ }
+ }
+ }
+ },
+ "GooglePrivacyDlpV2beta1RedactContentRequest": {
+ "description": "Request to search for potentially sensitive info in a list of items\nand replace it with a default or provided content.",
+ "type": "object",
+ "properties": {
+ "items": {
+ "type": "array",
+ "items": {
+ "$ref": "GooglePrivacyDlpV2beta1ContentItem"
+ },
+ "description": "The list of items to inspect. Up to 100 are allowed per request."
+ },
+ "replaceConfigs": {
+ "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.",
+ "type": "array",
+ "items": {
+ "$ref": "GooglePrivacyDlpV2beta1ImageRedactionConfig"
+ }
+ },
+ "inspectConfig": {
+ "$ref": "GooglePrivacyDlpV2beta1InspectConfig",
+ "description": "Configuration for the inspector."
+ }
+ },
+ "id": "GooglePrivacyDlpV2beta1RedactContentRequest"
+ },
+ "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"
+ },
+ "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"
+ },
+ "GooglePrivacyDlpV2beta1TransformationSummary": {
+ "description": "Summary of a single tranformation.\nOnly one of 'transformation', 'field_transformation', or 'record_suppress'\nwill be set.",
+ "type": "object",
+ "properties": {
+ "transformedBytes": {
+ "description": "Total size in bytes that were transformed in some way.",
+ "format": "int64",
+ "type": "string"
+ },
+ "recordSuppress": {
+ "$ref": "GooglePrivacyDlpV2beta1RecordSuppression",
+ "description": "The specific suppression option these stats apply to."
+ },
+ "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."
+ },
+ "field": {
+ "$ref": "GooglePrivacyDlpV2beta1FieldId",
+ "description": "Set if the transformation was limited to a specific FieldId."
+ },
+ "results": {
+ "type": "array",
+ "items": {
+ "$ref": "GooglePrivacyDlpV2beta1SummaryResult"
+ }
+ },
+ "fieldTransformations": {
+ "description": "The field transformation that was applied.\nIf multiple field transformations are requested for a single field,\nthis list will contain all of them; otherwise, only one is supplied.",
+ "type": "array",
+ "items": {
+ "$ref": "GooglePrivacyDlpV2beta1FieldTransformation"
+ }
+ }
+ },
+ "id": "GooglePrivacyDlpV2beta1TransformationSummary"
+ },
+ "GoogleLongrunningCancelOperationRequest": {
+ "type": "object",
+ "properties": {},
+ "id": "GoogleLongrunningCancelOperationRequest",
+ "description": "The request message for Operations.CancelOperation."
+ },
+ "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": {
+ "numberToMask": {
+ "description": "Number of characters to mask. If not set, all matching chars will be\nmasked. Skipped characters do not count towards this tally.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "charactersToIgnore": {
+ "description": "When masking a string, items in this list will be skipped when replacing.\nFor example, if your string is 555-555-5555 and you ask us to skip `-` and\nmask 5 chars with * we would produce ***-*55-5555.",
+ "type": "array",
+ "items": {
+ "$ref": "GooglePrivacyDlpV2beta1CharsToIgnore"
+ }
+ },
+ "maskingCharacter": {
+ "description": "Character to mask the sensitive values—for example, \"*\" for an\nalphabetic string such as name, or \"0\" for a numeric string such as ZIP\ncode or credit card number. String must have length 1. If not supplied, we\nwill default to \"*\" for strings, 0 for digits.",
+ "type": "string"
+ },
+ "reverseOrder": {
+ "description": "Mask characters in reverse order. For example, if `masking_character` is\n'0', number_to_mask is 14, and `reverse_order` is false, then\n1234-5678-9012-3456 -\u003e 00000000000000-3456\nIf `masking_character` is '*', `number_to_mask` is 3, and `reverse_order`\nis true, then 12345 -\u003e 12***",
+ "type": "boolean"
+ }
+ },
+ "id": "GooglePrivacyDlpV2beta1CharacterMaskConfig"
+ },
+ "GooglePrivacyDlpV2beta1TransientCryptoKey": {
+ "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": "GooglePrivacyDlpV2beta1TransientCryptoKey",
+ "description": "Use this to have a random data crypto key generated.\nIt will be discarded after the operation/request finishes."
+ },
+ "GooglePrivacyDlpV2beta1CreateInspectOperationRequest": {
+ "description": "Request for scheduling a scan of a data subset from a Google Platform data\nrepository.",
+ "type": "object",
+ "properties": {
+ "outputConfig": {
+ "description": "Optional location to store findings.",
+ "$ref": "GooglePrivacyDlpV2beta1OutputStorageConfig"
+ },
+ "operationConfig": {
+ "$ref": "GooglePrivacyDlpV2beta1OperationConfig",
+ "description": "Additional configuration settings for long running operations."
+ },
+ "inspectConfig": {
+ "$ref": "GooglePrivacyDlpV2beta1InspectConfig",
+ "description": "Configuration for the inspector."
+ },
+ "storageConfig": {
+ "$ref": "GooglePrivacyDlpV2beta1StorageConfig",
+ "description": "Specification of the data set to process."
+ }
+ },
+ "id": "GooglePrivacyDlpV2beta1CreateInspectOperationRequest"
}
},
- "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": "DLP",
- "auth": {
- "oauth2": {
- "scopes": {
- "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"
},
- "rootUrl": "https://dlp.googleapis.com/",
- "ownerDomain": "google.com",
- "name": "dlp",
- "batchPath": "batch",
- "fullyEncodeReservedExpansion": true,
- "title": "DLP API",
- "ownerName": "Google",
- "resources": {
- "content": {
- "methods": {
- "deidentify": {
- "response": {
- "$ref": "GooglePrivacyDlpV2beta1DeidentifyContentResponse"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {},
- "flatPath": "v2beta1/content:deidentify",
- "path": "v2beta1/content:deidentify",
- "id": "dlp.content.deidentify",
- "description": "De-identifies potentially sensitive info from a list of strings.\nThis method has limits on input size and output size.",
- "request": {
- "$ref": "GooglePrivacyDlpV2beta1DeidentifyContentRequest"
- }
- },
- "inspect": {
- "response": {
- "$ref": "GooglePrivacyDlpV2beta1InspectContentResponse"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {},
- "flatPath": "v2beta1/content:inspect",
- "path": "v2beta1/content:inspect",
- "id": "dlp.content.inspect",
- "description": "Finds potentially sensitive info in a list of strings.\nThis method has limits on input size, processing time, and output size.",
- "request": {
- "$ref": "GooglePrivacyDlpV2beta1InspectContentRequest"
- }
- },
- "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": {
- "resources": {
- "infoTypes": {
- "methods": {
- "list": {
- "response": {
- "$ref": "GooglePrivacyDlpV2beta1ListInfoTypesResponse"
- },
- "parameterOrder": [
- "category"
- ],
- "httpMethod": "GET",
- "parameters": {
- "languageCode": {
- "location": "query",
- "description": "Optional BCP-47 language code for localized info type friendly\nnames. If omitted, or if localized strings are not available,\nen-US strings will be returned.",
- "type": "string"
- },
- "category": {
- "description": "Category name as returned by ListRootCategories.",
- "required": true,
- "type": "string",
- "pattern": "^[^/]+$",
- "location": "path"
- }
- },
- "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."
- }
- }
- }
- },
- "methods": {
- "list": {
- "httpMethod": "GET",
- "response": {
- "$ref": "GooglePrivacyDlpV2beta1ListRootCategoriesResponse"
- },
- "parameterOrder": [],
- "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"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v2beta1/rootCategories",
- "id": "dlp.rootCategories.list",
- "path": "v2beta1/rootCategories",
- "description": "Returns the list of root categories of sensitive information."
- }
- }
- },
- "riskAnalysis": {
- "resources": {
- "operations": {
- "methods": {
- "cancel": {
- "description": "Cancels an operation. Use the `inspect.operations.get` to check whether the cancellation succeeded or the operation completed despite cancellation.",
- "request": {
- "$ref": "GoogleLongrunningCancelOperationRequest"
- },
- "response": {
- "$ref": "GoogleProtobufEmpty"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "description": "The name of the operation resource to be cancelled.",
- "required": true,
- "type": "string",
- "pattern": "^riskAnalysis/operations/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v2beta1/riskAnalysis/operations/{operationsId}:cancel",
- "path": "v2beta1/{+name}:cancel",
- "id": "dlp.riskAnalysis.operations.cancel"
- },
- "delete": {
- "description": "This method is not supported and the server returns `UNIMPLEMENTED`.",
- "httpMethod": "DELETE",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "GoogleProtobufEmpty"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "required": true,
- "type": "string",
- "pattern": "^riskAnalysis/operations/[^/]+$",
- "location": "path",
- "description": "The name of the operation resource to be deleted."
- }
- },
- "flatPath": "v2beta1/riskAnalysis/operations/{operationsId}",
- "id": "dlp.riskAnalysis.operations.delete",
- "path": "v2beta1/{+name}"
- },
- "list": {
- "id": "dlp.riskAnalysis.operations.list",
- "path": "v2beta1/{+name}",
- "description": "Fetches the list of long running operations.",
- "httpMethod": "GET",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "GoogleLongrunningListOperationsResponse"
- },
- "parameters": {
- "filter": {
- "description": "Filters by `done`. That is, `done=true` or `done=false`.",
- "type": "string",
- "location": "query"
- },
- "name": {
- "pattern": "^riskAnalysis/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 list page size. The maximum allowed value is 256 and the default is 100.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v2beta1/riskAnalysis/operations"
- },
- "get": {
- "response": {
- "$ref": "GoogleLongrunningOperation"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "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",
- "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."
- }
- }
- }
- }
- },
- "dataSource": {
- "methods": {
- "analyze": {
- "request": {
- "$ref": "GooglePrivacyDlpV2beta1AnalyzeDataSourceRiskRequest"
- },
- "description": "Schedules a job to compute risk analysis metrics over content in a Google\nCloud Platform repository.",
- "response": {
- "$ref": "GoogleLongrunningOperation"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "parameters": {},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v2beta1/dataSource:analyze",
- "path": "v2beta1/dataSource:analyze",
- "id": "dlp.dataSource.analyze"
- }
- }
- },
- "inspect": {
- "resources": {
- "results": {
- "resources": {
- "findings": {
- "methods": {
- "list": {
- "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": {
- "description": "Maximum number of results to return.\nIf 0, the implementation selects a reasonable value.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "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.",
- "response": {
- "$ref": "GooglePrivacyDlpV2beta1ListInspectFindingsResponse"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET"
- }
- }
- }
- }
- },
- "operations": {
- "methods": {
- "list": {
- "description": "Fetches the list of long running operations.",
- "httpMethod": "GET",
- "response": {
- "$ref": "GoogleLongrunningListOperationsResponse"
- },
- "parameterOrder": [
- "name"
- ],
- "parameters": {
- "name": {
- "location": "path",
- "description": "The name of the operation's parent resource.",
- "required": true,
- "type": "string",
- "pattern": "^inspect/operations$"
- },
- "pageToken": {
- "location": "query",
- "description": "The standard list page token.",
- "type": "string"
- },
- "pageSize": {
- "location": "query",
- "description": "The list page size. The maximum allowed value is 256 and the default is 100.",
- "format": "int32",
- "type": "integer"
- },
- "filter": {
- "description": "Filters by `done`. That is, `done=true` or `done=false`.",
- "type": "string",
- "location": "query"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v2beta1/inspect/operations",
- "id": "dlp.inspect.operations.list",
- "path": "v2beta1/{+name}"
- },
- "get": {
- "response": {
- "$ref": "GoogleLongrunningOperation"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "pattern": "^inspect/operations/[^/]+$",
- "location": "path",
- "description": "The name of the operation resource.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v2beta1/inspect/operations/{operationsId}",
- "path": "v2beta1/{+name}",
- "id": "dlp.inspect.operations.get",
- "description": "Gets the latest state of a long-running operation. Clients can use this\nmethod to poll the operation result at intervals as recommended by the API\nservice."
- },
- "create": {
- "request": {
- "$ref": "GooglePrivacyDlpV2beta1CreateInspectOperationRequest"
- },
- "description": "Schedules a job scanning content in a Google Cloud Platform data\nrepository.",
- "response": {
- "$ref": "GoogleLongrunningOperation"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "parameters": {},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v2beta1/inspect/operations",
- "path": "v2beta1/inspect/operations",
- "id": "dlp.inspect.operations.create"
- },
- "cancel": {
- "response": {
- "$ref": "GoogleProtobufEmpty"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "POST",
- "parameters": {
- "name": {
- "description": "The name of the operation resource to be cancelled.",
- "required": true,
- "type": "string",
- "pattern": "^inspect/operations/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v2beta1/inspect/operations/{operationsId}:cancel",
- "path": "v2beta1/{+name}:cancel",
- "id": "dlp.inspect.operations.cancel",
- "request": {
- "$ref": "GoogleLongrunningCancelOperationRequest"
- },
- "description": "Cancels an operation. Use the `inspect.operations.get` to check whether the cancellation succeeded or the operation completed despite cancellation."
- },
- "delete": {
- "response": {
- "$ref": "GoogleProtobufEmpty"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "DELETE",
- "parameters": {
- "name": {
- "pattern": "^inspect/operations/[^/]+$",
- "location": "path",
- "description": "The name of the operation resource to be deleted.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v2beta1/inspect/operations/{operationsId}",
- "path": "v2beta1/{+name}",
- "id": "dlp.inspect.operations.delete",
- "description": "This method is not supported and the server returns `UNIMPLEMENTED`."
- }
- }
- }
- }
- }
- }
+ "canonicalName": "DLP"
}
diff --git a/dlp/v2beta2/dlp-api.json b/dlp/v2beta2/dlp-api.json
index 8253c2a..cef48c3 100644
--- a/dlp/v2beta2/dlp-api.json
+++ b/dlp/v2beta2/dlp-api.json
@@ -1,13 +1,40 @@
{
- "rootUrl": "https://dlp.googleapis.com/",
- "ownerDomain": "google.com",
- "name": "dlp",
"batchPath": "batch",
"fullyEncodeReservedExpansion": true,
"title": "DLP API",
"ownerName": "Google",
"resources": {
- "projects": {
+ "infoTypes": {
+ "methods": {
+ "list": {
+ "flatPath": "v2beta2/infoTypes",
+ "path": "v2beta2/infoTypes",
+ "id": "dlp.infoTypes.list",
+ "description": "Returns sensitive information types DLP supports.",
+ "response": {
+ "$ref": "GooglePrivacyDlpV2beta2ListInfoTypesResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "GET",
+ "parameters": {
+ "languageCode": {
+ "description": "Optional BCP-47 language code for localized infoType friendly\nnames. If omitted, or if localized strings are not available,\nen-US strings will be returned.",
+ "type": "string",
+ "location": "query"
+ },
+ "filter": {
+ "type": "string",
+ "location": "query",
+ "description": "Optional filter to only return infoTypes supported by certain parts of the\nAPI. Defaults to supported_by=INSPECT."
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ }
+ }
+ },
+ "organizations": {
"resources": {
"deidentifyTemplates": {
"methods": {
@@ -20,23 +47,27 @@
"name"
],
"httpMethod": "DELETE",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
"parameters": {
"name": {
"description": "Resource name of the organization and deidentify template to be deleted,\nfor example `organizations/433245324/deidentifyTemplates/432452342`.",
"required": true,
"type": "string",
- "pattern": "^projects/[^/]+/deidentifyTemplates/[^/]+$",
+ "pattern": "^organizations/[^/]+/deidentifyTemplates/[^/]+$",
"location": "path"
}
},
- "flatPath": "v2beta2/projects/{projectsId}/deidentifyTemplates/{deidentifyTemplatesId}",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v2beta2/organizations/{organizationsId}/deidentifyTemplates/{deidentifyTemplatesId}",
"path": "v2beta2/{+name}",
- "id": "dlp.projects.deidentifyTemplates.delete"
+ "id": "dlp.organizations.deidentifyTemplates.delete"
},
"patch": {
+ "description": "Updates the inspect template.",
+ "request": {
+ "$ref": "GooglePrivacyDlpV2beta2UpdateDeidentifyTemplateRequest"
+ },
"response": {
"$ref": "GooglePrivacyDlpV2beta2DeidentifyTemplate"
},
@@ -44,29 +75,146 @@
"name"
],
"httpMethod": "PATCH",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
"parameters": {
"name": {
"location": "path",
"description": "Resource name of organization and deidentify template to be updated, for\nexample `organizations/433245324/deidentifyTemplates/432452342`.",
"required": true,
"type": "string",
- "pattern": "^projects/[^/]+/deidentifyTemplates/[^/]+$"
+ "pattern": "^organizations/[^/]+/deidentifyTemplates/[^/]+$"
+ }
+ },
+ "flatPath": "v2beta2/organizations/{organizationsId}/deidentifyTemplates/{deidentifyTemplatesId}",
+ "path": "v2beta2/{+name}",
+ "id": "dlp.organizations.deidentifyTemplates.patch"
+ },
+ "get": {
+ "description": "Gets an inspect template.",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "GooglePrivacyDlpV2beta2DeidentifyTemplate"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "location": "path",
+ "description": "Resource name of the organization and deidentify template to be read, for\nexample `organizations/433245324/deidentifyTemplates/432452342`.",
+ "required": true,
+ "type": "string",
+ "pattern": "^organizations/[^/]+/deidentifyTemplates/[^/]+$"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
- "flatPath": "v2beta2/projects/{projectsId}/deidentifyTemplates/{deidentifyTemplatesId}",
- "path": "v2beta2/{+name}",
- "id": "dlp.projects.deidentifyTemplates.patch",
- "request": {
- "$ref": "GooglePrivacyDlpV2beta2UpdateDeidentifyTemplateRequest"
+ "flatPath": "v2beta2/organizations/{organizationsId}/deidentifyTemplates/{deidentifyTemplatesId}",
+ "id": "dlp.organizations.deidentifyTemplates.get",
+ "path": "v2beta2/{+name}"
+ },
+ "list": {
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "parent"
+ ],
+ "response": {
+ "$ref": "GooglePrivacyDlpV2beta2ListDeidentifyTemplatesResponse"
},
- "description": "Updates the inspect template."
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "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": "^organizations/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v2beta2/organizations/{organizationsId}/deidentifyTemplates",
+ "id": "dlp.organizations.deidentifyTemplates.list",
+ "path": "v2beta2/{+parent}/deidentifyTemplates",
+ "description": "Lists inspect templates."
+ },
+ "create": {
+ "path": "v2beta2/{+parent}/deidentifyTemplates",
+ "id": "dlp.organizations.deidentifyTemplates.create",
+ "request": {
+ "$ref": "GooglePrivacyDlpV2beta2CreateDeidentifyTemplateRequest"
+ },
+ "description": "Creates an Deidentify template for re-using frequently used configuration\nfor Deidentifying content, images, and storage.",
+ "response": {
+ "$ref": "GooglePrivacyDlpV2beta2DeidentifyTemplate"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "parent": {
+ "location": "path",
+ "description": "The parent resource name, for example projects/my-project-id or\norganizations/my-org-id.",
+ "required": true,
+ "type": "string",
+ "pattern": "^organizations/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v2beta2/organizations/{organizationsId}/deidentifyTemplates"
+ }
+ }
+ },
+ "inspectTemplates": {
+ "methods": {
+ "patch": {
+ "flatPath": "v2beta2/organizations/{organizationsId}/inspectTemplates/{inspectTemplatesId}",
+ "id": "dlp.organizations.inspectTemplates.patch",
+ "path": "v2beta2/{+name}",
+ "request": {
+ "$ref": "GooglePrivacyDlpV2beta2UpdateInspectTemplateRequest"
+ },
+ "description": "Updates the inspect template.",
+ "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": "^organizations/[^/]+/inspectTemplates/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
},
"get": {
"response": {
- "$ref": "GooglePrivacyDlpV2beta2DeidentifyTemplate"
+ "$ref": "GooglePrivacyDlpV2beta2InspectTemplate"
},
"parameterOrder": [
"name"
@@ -77,17 +225,220 @@
],
"parameters": {
"name": {
- "description": "Resource name of the organization and deidentify template to be read, for\nexample `organizations/433245324/deidentifyTemplates/432452342`.",
+ "description": "Resource name of the organization and inspectTemplate to be read, for\nexample `organizations/433245324/inspectTemplates/432452342`.",
"required": true,
"type": "string",
- "pattern": "^projects/[^/]+/deidentifyTemplates/[^/]+$",
+ "pattern": "^organizations/[^/]+/inspectTemplates/[^/]+$",
"location": "path"
}
},
+ "flatPath": "v2beta2/organizations/{organizationsId}/inspectTemplates/{inspectTemplatesId}",
+ "path": "v2beta2/{+name}",
+ "id": "dlp.organizations.inspectTemplates.get",
+ "description": "Gets an inspect template."
+ },
+ "list": {
+ "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": {
+ "location": "query",
+ "description": "Optional size of the page, can be limited by server. If zero server returns\na page of max size 100.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "parent": {
+ "pattern": "^organizations/[^/]+$",
+ "location": "path",
+ "description": "The parent resource name, for example projects/my-project-id or\norganizations/my-org-id.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v2beta2/organizations/{organizationsId}/inspectTemplates",
+ "path": "v2beta2/{+parent}/inspectTemplates",
+ "id": "dlp.organizations.inspectTemplates.list",
+ "description": "Lists inspect templates."
+ },
+ "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"
+ },
+ "delete": {
+ "description": "Deletes inspect templates.",
+ "httpMethod": "DELETE",
+ "response": {
+ "$ref": "GoogleProtobufEmpty"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "location": "path",
+ "description": "Resource name of the organization and inspectTemplate to be deleted, for\nexample `organizations/433245324/inspectTemplates/432452342`.",
+ "required": true,
+ "type": "string",
+ "pattern": "^organizations/[^/]+/inspectTemplates/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v2beta2/organizations/{organizationsId}/inspectTemplates/{inspectTemplatesId}",
+ "id": "dlp.organizations.inspectTemplates.delete",
+ "path": "v2beta2/{+name}"
+ }
+ }
+ }
+ }
+ },
+ "projects": {
+ "resources": {
+ "deidentifyTemplates": {
+ "methods": {
+ "create": {
+ "request": {
+ "$ref": "GooglePrivacyDlpV2beta2CreateDeidentifyTemplateRequest"
+ },
+ "description": "Creates an Deidentify template for re-using frequently used configuration\nfor Deidentifying content, images, and storage.",
+ "response": {
+ "$ref": "GooglePrivacyDlpV2beta2DeidentifyTemplate"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "parent": {
+ "pattern": "^projects/[^/]+$",
+ "location": "path",
+ "description": "The parent resource name, for example projects/my-project-id or\norganizations/my-org-id.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v2beta2/projects/{projectsId}/deidentifyTemplates",
+ "path": "v2beta2/{+parent}/deidentifyTemplates",
+ "id": "dlp.projects.deidentifyTemplates.create"
+ },
+ "delete": {
+ "response": {
+ "$ref": "GoogleProtobufEmpty"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "DELETE",
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+/deidentifyTemplates/[^/]+$",
+ "location": "path",
+ "description": "Resource name of the organization and deidentify template to be deleted,\nfor example `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": {
+ "description": "Updates the inspect template.",
+ "request": {
+ "$ref": "GooglePrivacyDlpV2beta2UpdateDeidentifyTemplateRequest"
+ },
+ "httpMethod": "PATCH",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "GooglePrivacyDlpV2beta2DeidentifyTemplate"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+/deidentifyTemplates/[^/]+$",
+ "location": "path",
+ "description": "Resource name of organization and deidentify template to be updated, for\nexample `organizations/433245324/deidentifyTemplates/432452342`.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v2beta2/projects/{projectsId}/deidentifyTemplates/{deidentifyTemplatesId}",
+ "id": "dlp.projects.deidentifyTemplates.patch",
+ "path": "v2beta2/{+name}"
+ },
+ "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 deidentify template to be read, for\nexample `organizations/433245324/deidentifyTemplates/432452342`.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v2beta2/projects/{projectsId}/deidentifyTemplates/{deidentifyTemplatesId}",
"id": "dlp.projects.deidentifyTemplates.get",
- "description": "Gets an inspect template."
+ "path": "v2beta2/{+name}"
},
"list": {
"response": {
@@ -99,9 +450,9 @@
"httpMethod": "GET",
"parameters": {
"pageToken": {
- "location": "query",
"description": "Optional page token to continue retrieval. Comes from previous call\nto `ListDeidentifyTemplates`.",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"pageSize": {
"location": "query",
@@ -124,34 +475,6 @@
"path": "v2beta2/{+parent}/deidentifyTemplates",
"id": "dlp.projects.deidentifyTemplates.list",
"description": "Lists inspect templates."
- },
- "create": {
- "flatPath": "v2beta2/projects/{projectsId}/deidentifyTemplates",
- "path": "v2beta2/{+parent}/deidentifyTemplates",
- "id": "dlp.projects.deidentifyTemplates.create",
- "request": {
- "$ref": "GooglePrivacyDlpV2beta2CreateDeidentifyTemplateRequest"
- },
- "description": "Creates an Deidentify template for re-using frequently used configuration\nfor Deidentifying content, images, and storage.",
- "response": {
- "$ref": "GooglePrivacyDlpV2beta2DeidentifyTemplate"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "POST",
- "parameters": {
- "parent": {
- "location": "path",
- "description": "The parent resource name, for example projects/my-project-id or\norganizations/my-org-id.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
}
}
},
@@ -189,15 +512,66 @@
},
"dlpJobs": {
"methods": {
- "list": {
- "httpMethod": "GET",
- "parameterOrder": [
- "parent"
- ],
+ "cancel": {
"response": {
- "$ref": "GooglePrivacyDlpV2beta2ListDlpJobsResponse"
+ "$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."
+ },
+ "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",
+ "parameters": {
+ "name": {
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/dlpJobs/[^/]+$",
+ "location": "path",
+ "description": "The name of the DlpJob resource to be deleted."
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v2beta2/projects/{projectsId}/dlpJobs/{dlpJobsId}",
+ "path": "v2beta2/{+name}",
+ "id": "dlp.projects.dlpJobs.delete"
+ },
+ "list": {
+ "parameters": {
+ "pageToken": {
+ "description": "The standard list page token.",
+ "type": "string",
+ "location": "query"
+ },
"pageSize": {
"description": "The standard list page size.",
"format": "int32",
@@ -205,14 +579,14 @@
"location": "query"
},
"type": {
- "description": "The type of job. Defaults to `DlpJobType.INSPECT`",
- "type": "string",
"location": "query",
"enum": [
"DLP_JOB_TYPE_UNSPECIFIED",
"INSPECT_JOB",
"RISK_ANALYSIS_JOB"
- ]
+ ],
+ "description": "The type of job. Defaults to `DlpJobType.INSPECT`",
+ "type": "string"
},
"parent": {
"description": "The parent resource name, for example projects/my-project-id.",
@@ -225,23 +599,24 @@
"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": {
- "description": "The standard list page token.",
- "type": "string",
- "location": "query"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v2beta2/projects/{projectsId}/dlpJobs",
- "id": "dlp.projects.dlpJobs.list",
"path": "v2beta2/{+parent}/dlpJobs",
- "description": "Lists DlpJobs that match the specified filter in the request."
+ "id": "dlp.projects.dlpJobs.list",
+ "description": "Lists DlpJobs that match the specified filter in the request.",
+ "response": {
+ "$ref": "GooglePrivacyDlpV2beta2ListDlpJobsResponse"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "GET"
},
"get": {
- "description": "Gets the latest state of a long-running DlpJob.",
"response": {
"$ref": "GooglePrivacyDlpV2beta2DlpJob"
},
@@ -251,11 +626,11 @@
"httpMethod": "GET",
"parameters": {
"name": {
+ "pattern": "^projects/[^/]+/dlpJobs/[^/]+$",
+ "location": "path",
"description": "The name of the DlpJob resource.",
"required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/dlpJobs/[^/]+$",
- "location": "path"
+ "type": "string"
}
},
"scopes": [
@@ -263,41 +638,15 @@
],
"flatPath": "v2beta2/projects/{projectsId}/dlpJobs/{dlpJobsId}",
"path": "v2beta2/{+name}",
- "id": "dlp.projects.dlpJobs.get"
- },
- "cancel": {
- "request": {
- "$ref": "GooglePrivacyDlpV2beta2CancelDlpJobRequest"
- },
- "description": "Starts asynchronous cancellation on a long-running DlpJob. The server\nmakes a best effort to cancel the DlpJob, but success is not\nguaranteed.",
- "response": {
- "$ref": "GoogleProtobufEmpty"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "POST",
- "parameters": {
- "name": {
- "location": "path",
- "description": "The name of the DlpJob resource to be cancelled.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/dlpJobs/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v2beta2/projects/{projectsId}/dlpJobs/{dlpJobsId}:cancel",
- "path": "v2beta2/{+name}:cancel",
- "id": "dlp.projects.dlpJobs.cancel"
- },
+ "id": "dlp.projects.dlpJobs.get",
+ "description": "Gets the latest state of a long-running DlpJob."
+ }
+ }
+ },
+ "inspectTemplates": {
+ "methods": {
"delete": {
- "flatPath": "v2beta2/projects/{projectsId}/dlpJobs/{dlpJobsId}",
- "path": "v2beta2/{+name}",
- "id": "dlp.projects.dlpJobs.delete",
- "description": "Deletes a long-running DlpJob. This method indicates that the client is\nno longer interested in the DlpJob result. The job will be cancelled if\npossible.",
+ "description": "Deletes inspect templates.",
"response": {
"$ref": "GoogleProtobufEmpty"
},
@@ -305,31 +654,23 @@
"name"
],
"httpMethod": "DELETE",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
"parameters": {
"name": {
"location": "path",
- "description": "The name of the DlpJob resource to be deleted.",
+ "description": "Resource name of the organization and inspectTemplate to be deleted, for\nexample `organizations/433245324/inspectTemplates/432452342`.",
"required": true,
"type": "string",
- "pattern": "^projects/[^/]+/dlpJobs/[^/]+$"
+ "pattern": "^projects/[^/]+/inspectTemplates/[^/]+$"
}
- }
- }
- }
- },
- "inspectTemplates": {
- "methods": {
- "patch": {
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
"flatPath": "v2beta2/projects/{projectsId}/inspectTemplates/{inspectTemplatesId}",
"path": "v2beta2/{+name}",
- "id": "dlp.projects.inspectTemplates.patch",
- "request": {
- "$ref": "GooglePrivacyDlpV2beta2UpdateInspectTemplateRequest"
- },
- "description": "Updates the inspect template.",
+ "id": "dlp.projects.inspectTemplates.delete"
+ },
+ "patch": {
"response": {
"$ref": "GooglePrivacyDlpV2beta2InspectTemplate"
},
@@ -339,33 +680,11 @@
"httpMethod": "PATCH",
"parameters": {
"name": {
- "location": "path",
- "description": "Resource name of organization and inspectTemplate to be updated, for\nexample `organizations/433245324/inspectTemplates/432452342`.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/inspectTemplates/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- },
- "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"
+ "location": "path",
+ "description": "Resource name of organization and inspectTemplate to be updated, for\nexample `organizations/433245324/inspectTemplates/432452342`."
}
},
"scopes": [
@@ -373,13 +692,38 @@
],
"flatPath": "v2beta2/projects/{projectsId}/inspectTemplates/{inspectTemplatesId}",
"path": "v2beta2/{+name}",
- "id": "dlp.projects.inspectTemplates.get"
+ "id": "dlp.projects.inspectTemplates.patch",
+ "request": {
+ "$ref": "GooglePrivacyDlpV2beta2UpdateInspectTemplateRequest"
+ },
+ "description": "Updates the inspect template."
+ },
+ "get": {
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "GooglePrivacyDlpV2beta2InspectTemplate"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "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"
+ }
+ },
+ "flatPath": "v2beta2/projects/{projectsId}/inspectTemplates/{inspectTemplatesId}",
+ "id": "dlp.projects.inspectTemplates.get",
+ "path": "v2beta2/{+name}",
+ "description": "Gets an inspect template."
},
"list": {
- "flatPath": "v2beta2/projects/{projectsId}/inspectTemplates",
- "path": "v2beta2/{+parent}/inspectTemplates",
- "id": "dlp.projects.inspectTemplates.list",
- "description": "Lists inspect templates.",
"response": {
"$ref": "GooglePrivacyDlpV2beta2ListInspectTemplatesResponse"
},
@@ -403,22 +747,23 @@
"type": "integer"
},
"parent": {
- "location": "path",
"description": "The parent resource name, for example projects/my-project-id or\norganizations/my-org-id.",
"required": true,
"type": "string",
- "pattern": "^projects/[^/]+$"
+ "pattern": "^projects/[^/]+$",
+ "location": "path"
}
- }
- },
- "create": {
+ },
"flatPath": "v2beta2/projects/{projectsId}/inspectTemplates",
"path": "v2beta2/{+parent}/inspectTemplates",
- "id": "dlp.projects.inspectTemplates.create",
+ "id": "dlp.projects.inspectTemplates.list",
+ "description": "Lists inspect templates."
+ },
+ "create": {
+ "description": "Creates an inspect template for re-using frequently used configuration\nfor inspecting content, images, and storage.",
"request": {
"$ref": "GooglePrivacyDlpV2beta2CreateInspectTemplateRequest"
},
- "description": "Creates an inspect template for re-using frequently used configuration\nfor inspecting content, images, and storage.",
"response": {
"$ref": "GooglePrivacyDlpV2beta2InspectTemplate"
},
@@ -426,109 +771,31 @@
"parent"
],
"httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
"parameters": {
"parent": {
+ "pattern": "^projects/[^/]+$",
"location": "path",
"description": "The parent resource name, for example projects/my-project-id or\norganizations/my-org-id.",
"required": true,
- "type": "string",
- "pattern": "^projects/[^/]+$"
+ "type": "string"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- },
- "delete": {
- "response": {
- "$ref": "GoogleProtobufEmpty"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "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": "^projects/[^/]+/inspectTemplates/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v2beta2/projects/{projectsId}/inspectTemplates/{inspectTemplatesId}",
- "path": "v2beta2/{+name}",
- "id": "dlp.projects.inspectTemplates.delete",
- "description": "Deletes inspect templates."
+ "flatPath": "v2beta2/projects/{projectsId}/inspectTemplates",
+ "path": "v2beta2/{+parent}/inspectTemplates",
+ "id": "dlp.projects.inspectTemplates.create"
}
}
},
"content": {
"methods": {
- "reidentify": {
- "flatPath": "v2beta2/projects/{projectsId}/content: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": {
- "location": "path",
- "description": "The parent resource name.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- },
- "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)",
- "httpMethod": "POST",
- "parameterOrder": [
- "parent"
- ],
- "response": {
- "$ref": "GooglePrivacyDlpV2beta2DeidentifyContentResponse"
- },
- "parameters": {
- "parent": {
- "location": "path",
- "description": "The parent resource name, for example projects/my-project-id.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v2beta2/projects/{projectsId}/content:deidentify",
- "id": "dlp.projects.content.deidentify",
- "path": "v2beta2/{+parent}/content:deidentify"
- },
"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"
},
+ "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)",
"response": {
"$ref": "GooglePrivacyDlpV2beta2InspectContentResponse"
},
@@ -536,69 +803,6 @@
"parent"
],
"httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "parent": {
- "location": "path",
- "description": "The parent resource name, for example projects/my-project-id.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+$"
- }
- },
- "flatPath": "v2beta2/projects/{projectsId}/content:inspect",
- "path": "v2beta2/{+parent}/content:inspect",
- "id": "dlp.projects.content.inspect"
- }
- }
- },
- "dataSource": {
- "methods": {
- "inspect": {
- "flatPath": "v2beta2/projects/{projectsId}/dataSource:inspect",
- "path": "v2beta2/{+parent}/dataSource:inspect",
- "id": "dlp.projects.dataSource.inspect",
- "request": {
- "$ref": "GooglePrivacyDlpV2beta2InspectDataSourceRequest"
- },
- "description": "Schedules a job scanning content in a Google Cloud Platform data\nrepository. [How-to guide](/dlp/docs/inspecting-storage)",
- "response": {
- "$ref": "GooglePrivacyDlpV2beta2DlpJob"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "POST",
- "parameters": {
- "parent": {
- "location": "path",
- "description": "The parent resource name, for example projects/my-project-id.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- },
- "analyze": {
- "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)",
- "response": {
- "$ref": "GooglePrivacyDlpV2beta2DlpJob"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "POST",
"parameters": {
"parent": {
"description": "The parent resource name, for example projects/my-project-id.",
@@ -610,142 +814,20 @@
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
- ]
- }
- }
- }
- }
- },
- "infoTypes": {
- "methods": {
- "list": {
- "description": "Returns sensitive information types DLP supports.",
- "response": {
- "$ref": "GooglePrivacyDlpV2beta2ListInfoTypesResponse"
- },
- "parameterOrder": [],
- "httpMethod": "GET",
- "parameters": {
- "languageCode": {
- "location": "query",
- "description": "Optional BCP-47 language code for localized infoType friendly\nnames. If omitted, or if localized strings are not available,\nen-US strings will be returned.",
- "type": "string"
+ ],
+ "flatPath": "v2beta2/projects/{projectsId}/content:inspect",
+ "path": "v2beta2/{+parent}/content:inspect",
+ "id": "dlp.projects.content.inspect"
},
- "filter": {
- "location": "query",
- "description": "Optional filter to only return infoTypes supported by certain parts of the\nAPI. Defaults to supported_by=INSPECT.",
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v2beta2/infoTypes",
- "path": "v2beta2/infoTypes",
- "id": "dlp.infoTypes.list"
- }
- }
- },
- "organizations": {
- "resources": {
- "inspectTemplates": {
- "methods": {
- "patch": {
- "description": "Updates the inspect template.",
+ "reidentify": {
+ "path": "v2beta2/{+parent}/content:reidentify",
+ "id": "dlp.projects.content.reidentify",
+ "description": "Re-identify content that has been de-identified.",
"request": {
- "$ref": "GooglePrivacyDlpV2beta2UpdateInspectTemplateRequest"
+ "$ref": "GooglePrivacyDlpV2beta2ReidentifyContentRequest"
},
"response": {
- "$ref": "GooglePrivacyDlpV2beta2InspectTemplate"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "PATCH",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "location": "path",
- "description": "Resource name of organization and inspectTemplate to be updated, for\nexample `organizations/433245324/inspectTemplates/432452342`.",
- "required": true,
- "type": "string",
- "pattern": "^organizations/[^/]+/inspectTemplates/[^/]+$"
- }
- },
- "flatPath": "v2beta2/organizations/{organizationsId}/inspectTemplates/{inspectTemplatesId}",
- "path": "v2beta2/{+name}",
- "id": "dlp.organizations.inspectTemplates.patch"
- },
- "get": {
- "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}",
- "path": "v2beta2/{+name}",
- "id": "dlp.organizations.inspectTemplates.get",
- "description": "Gets an inspect template."
- },
- "list": {
- "description": "Lists inspect templates.",
- "response": {
- "$ref": "GooglePrivacyDlpV2beta2ListInspectTemplatesResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "GET",
- "parameters": {
- "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"
- },
- "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",
- "path": "v2beta2/{+parent}/inspectTemplates",
- "id": "dlp.organizations.inspectTemplates.list"
- },
- "create": {
- "description": "Creates an inspect template for re-using frequently used configuration\nfor inspecting content, images, and storage.",
- "request": {
- "$ref": "GooglePrivacyDlpV2beta2CreateInspectTemplateRequest"
- },
- "response": {
- "$ref": "GooglePrivacyDlpV2beta2InspectTemplate"
+ "$ref": "GooglePrivacyDlpV2beta2ReidentifyContentResponse"
},
"parameterOrder": [
"parent"
@@ -756,187 +838,102 @@
],
"parameters": {
"parent": {
- "description": "The parent resource name, for example projects/my-project-id or\norganizations/my-org-id.",
- "required": true,
- "type": "string",
- "pattern": "^organizations/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v2beta2/organizations/{organizationsId}/inspectTemplates",
- "path": "v2beta2/{+parent}/inspectTemplates",
- "id": "dlp.organizations.inspectTemplates.create"
- },
- "delete": {
- "flatPath": "v2beta2/organizations/{organizationsId}/inspectTemplates/{inspectTemplatesId}",
- "path": "v2beta2/{+name}",
- "id": "dlp.organizations.inspectTemplates.delete",
- "description": "Deletes inspect templates.",
- "response": {
- "$ref": "GoogleProtobufEmpty"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "DELETE",
- "parameters": {
- "name": {
+ "pattern": "^projects/[^/]+$",
"location": "path",
- "description": "Resource name of the organization and inspectTemplate to be deleted, for\nexample `organizations/433245324/inspectTemplates/432452342`.",
+ "description": "The parent resource name.",
"required": true,
- "type": "string",
- "pattern": "^organizations/[^/]+/inspectTemplates/[^/]+$"
+ "type": "string"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- }
- }
- },
- "deidentifyTemplates": {
- "methods": {
- "patch": {
- "httpMethod": "PATCH",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "GooglePrivacyDlpV2beta2DeidentifyTemplate"
- },
- "parameters": {
- "name": {
- "description": "Resource name of organization and deidentify template to be updated, for\nexample `organizations/433245324/deidentifyTemplates/432452342`.",
- "required": true,
- "type": "string",
- "pattern": "^organizations/[^/]+/deidentifyTemplates/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v2beta2/organizations/{organizationsId}/deidentifyTemplates/{deidentifyTemplatesId}",
- "id": "dlp.organizations.deidentifyTemplates.patch",
- "path": "v2beta2/{+name}",
+ "flatPath": "v2beta2/projects/{projectsId}/content:reidentify"
+ },
+ "deidentify": {
+ "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": "GooglePrivacyDlpV2beta2UpdateDeidentifyTemplateRequest"
+ "$ref": "GooglePrivacyDlpV2beta2DeidentifyContentRequest"
},
- "description": "Updates the inspect template."
- },
- "get": {
"response": {
- "$ref": "GooglePrivacyDlpV2beta2DeidentifyTemplate"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "parameters": {
- "name": {
- "description": "Resource name of the organization and deidentify template to be read, for\nexample `organizations/433245324/deidentifyTemplates/432452342`.",
- "required": true,
- "type": "string",
- "pattern": "^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": {
- "flatPath": "v2beta2/organizations/{organizationsId}/deidentifyTemplates",
- "path": "v2beta2/{+parent}/deidentifyTemplates",
- "id": "dlp.organizations.deidentifyTemplates.list",
- "description": "Lists inspect templates.",
- "response": {
- "$ref": "GooglePrivacyDlpV2beta2ListDeidentifyTemplatesResponse"
+ "$ref": "GooglePrivacyDlpV2beta2DeidentifyContentResponse"
},
"parameterOrder": [
"parent"
],
- "httpMethod": "GET",
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
"parameters": {
- "pageSize": {
- "location": "query",
- "description": "Optional size of the page, can be limited by server. If zero server returns\na page of max size 100.",
- "format": "int32",
- "type": "integer"
- },
"parent": {
- "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 `ListDeidentifyTemplates`.",
+ "pattern": "^projects/[^/]+$",
+ "location": "path",
+ "description": "The parent resource name, for example projects/my-project-id."
+ }
+ }
+ }
+ }
+ },
+ "dataSource": {
+ "methods": {
+ "inspect": {
+ "path": "v2beta2/{+parent}/dataSource:inspect",
+ "id": "dlp.projects.dataSource.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": {
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+$",
+ "location": "path",
+ "description": "The parent resource name, for example projects/my-project-id."
+ }
+ },
+ "flatPath": "v2beta2/projects/{projectsId}/dataSource:inspect"
+ },
+ "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"
- ]
- },
- "create": {
- "httpMethod": "POST",
- "parameterOrder": [
- "parent"
],
- "response": {
- "$ref": "GooglePrivacyDlpV2beta2DeidentifyTemplate"
- },
- "parameters": {
- "parent": {
- "location": "path",
- "description": "The parent resource name, for example projects/my-project-id or\norganizations/my-org-id.",
- "required": true,
- "type": "string",
- "pattern": "^organizations/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v2beta2/organizations/{organizationsId}/deidentifyTemplates",
- "id": "dlp.organizations.deidentifyTemplates.create",
- "path": "v2beta2/{+parent}/deidentifyTemplates",
+ "flatPath": "v2beta2/projects/{projectsId}/dataSource:analyze",
+ "path": "v2beta2/{+parent}/dataSource:analyze",
+ "id": "dlp.projects.dataSource.analyze",
"request": {
- "$ref": "GooglePrivacyDlpV2beta2CreateDeidentifyTemplateRequest"
+ "$ref": "GooglePrivacyDlpV2beta2AnalyzeDataSourceRiskRequest"
},
- "description": "Creates an Deidentify template for re-using frequently used configuration\nfor Deidentifying content, images, and storage."
- },
- "delete": {
- "description": "Deletes inspect templates.",
- "response": {
- "$ref": "GoogleProtobufEmpty"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "DELETE",
- "parameters": {
- "name": {
- "description": "Resource name of the organization and deidentify template to be deleted,\nfor example `organizations/433245324/deidentifyTemplates/432452342`.",
- "required": true,
- "type": "string",
- "pattern": "^organizations/[^/]+/deidentifyTemplates/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v2beta2/organizations/{organizationsId}/deidentifyTemplates/{deidentifyTemplatesId}",
- "path": "v2beta2/{+name}",
- "id": "dlp.organizations.deidentifyTemplates.delete"
+ "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)"
}
}
}
@@ -944,10 +941,26 @@
}
},
"parameters": {
+ "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"
+ "location": "query",
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")."
},
"prettyPrint": {
"location": "query",
@@ -956,21 +969,23 @@
"default": "true"
},
"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": {
- "description": "JSONP",
"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"
@@ -979,9 +994,7 @@
"enum": [
"1",
"2"
- ],
- "description": "V1 error format.",
- "type": "string"
+ ]
},
"alt": {
"enum": [
@@ -1005,70 +1018,1975 @@
"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.",
- "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."
},
"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"
- },
- "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"
+ "description": "Available 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": "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",
+ "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": "",
- "documentationLink": "https://cloud.google.com/dlp/docs/",
"id": "dlp:v2beta2",
+ "documentationLink": "https://cloud.google.com/dlp/docs/",
"revision": "20171219",
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
- "GooglePrivacyDlpV2beta1ValueFrequency": {
- "description": "A value of a field, including its frequency.",
+ "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": {
- "value": {
- "$ref": "GooglePrivacyDlpV2beta1Value",
- "description": "A value contained in the field in question."
+ "displayName": {
+ "description": "Display name (max 256 chars).",
+ "type": "string"
},
- "count": {
- "description": "How many times the value is contained in the field.",
+ "description": {
+ "description": "Short description (max 256 chars).",
+ "type": "string"
+ },
+ "createTime": {
+ "description": "The creation timestamp of a inspectTemplate, output only field.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "updateTime": {
+ "description": "The last update timestamp of a inspectTemplate, output only field.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "name": {
+ "description": "The template name. Output only.\n\nThe template will have one of the following formats:\n`projects/PROJECT_ID/inspectTemplates/TEMPLATE_ID` OR\n`organizations/ORGANIZATION_ID/inspectTemplates/TEMPLATE_ID`",
+ "type": "string"
+ },
+ "inspectConfig": {
+ "$ref": "GooglePrivacyDlpV2beta2InspectConfig",
+ "description": "The core content of the template. Configuration of the scanning process."
+ }
+ },
+ "id": "GooglePrivacyDlpV2beta2InspectTemplate"
+ },
+ "GooglePrivacyDlpV2beta2CharsToIgnore": {
+ "description": "Characters to skip when doing deidentification of a value. These will be left\nalone and skipped.",
+ "type": "object",
+ "properties": {
+ "commonCharactersToIgnore": {
+ "enum": [
+ "COMMON_CHARS_TO_IGNORE_UNSPECIFIED",
+ "NUMERIC",
+ "ALPHA_UPPER_CASE",
+ "ALPHA_LOWER_CASE",
+ "PUNCTUATION",
+ "WHITESPACE"
+ ],
+ "type": "string",
+ "enumDescriptions": [
+ "",
+ "0-9",
+ "A-Z",
+ "a-z",
+ "US Punctuation, one of !\"#$%&'()*+,-./:;\u003c=\u003e?@[\\]^_`{|}~",
+ "Whitespace character, one of [ \\t\\n\\x0B\\f\\r]"
+ ]
+ },
+ "charactersToSkip": {
+ "type": "string"
+ }
+ },
+ "id": "GooglePrivacyDlpV2beta2CharsToIgnore"
+ },
+ "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"
+ },
+ "GooglePrivacyDlpV2beta2RedactConfig": {
+ "properties": {},
+ "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"
+ },
+ "GooglePrivacyDlpV2beta2FieldId": {
+ "description": "General identifier of a data field in a storage service.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "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",
+ "description": "Configuration for this risk analysis job."
+ }
+ }
+ },
+ "GooglePrivacyDlpV2beta2DeidentifyContentRequest": {
+ "description": "Request to de-identify a list of items.",
+ "type": "object",
+ "properties": {
+ "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."
+ },
+ "inspectConfig": {
+ "description": "Configuration for the inspector.\nItems specified here will override the template referenced by the\ninspect_template_name argument.",
+ "$ref": "GooglePrivacyDlpV2beta2InspectConfig"
+ },
+ "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"
+ },
+ "GooglePrivacyDlpV2beta1KMapEstimationHistogramBucket": {
+ "description": "A KMapEstimationHistogramBucket message with the following values:\n min_anonymity: 3\n max_anonymity: 5\n frequency: 42\nmeans that there are 42 records whose quasi-identifier values correspond\nto 3, 4 or 5 people in the overlying population. An important particular\ncase is when min_anonymity = max_anonymity = 1: the frequency field then\ncorresponds to the number of uniquely identifiable records.",
+ "type": "object",
+ "properties": {
+ "bucketValues": {
+ "description": "Sample of quasi-identifier tuple values in this bucket. The total\nnumber of classes returned per bucket is capped at 20.",
+ "type": "array",
+ "items": {
+ "$ref": "GooglePrivacyDlpV2beta1KMapEstimationQuasiIdValues"
+ }
+ },
+ "minAnonymity": {
+ "description": "Always positive.",
+ "format": "int64",
+ "type": "string"
+ },
+ "maxAnonymity": {
+ "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": "GooglePrivacyDlpV2beta1ValueFrequency"
+ "id": "GooglePrivacyDlpV2beta1KMapEstimationHistogramBucket"
},
- "GooglePrivacyDlpV2beta1SurrogateType": {
- "description": "Message for detecting output from deidentification transformations\nsuch as\n[`CryptoReplaceFfxFpeConfig`](/dlp/docs/reference/rest/v2beta1/content/deidentify#CryptoReplaceFfxFpeConfig).\nThese types of transformations are\nthose that perform pseudonymization, thereby producing a \"surrogate\" as\noutput. This should be used in conjunction with a field on the\ntransformation such as `surrogate_info_type`. This custom info type does\nnot support the use of `detection_rules`.",
+ "GooglePrivacyDlpV2beta1CloudStorageOptions": {
+ "id": "GooglePrivacyDlpV2beta1CloudStorageOptions",
+ "description": "Options defining a file or a set of files (path ending with *) within\na Google Cloud Storage bucket.",
+ "type": "object",
+ "properties": {
+ "fileSet": {
+ "$ref": "GooglePrivacyDlpV2beta1FileSet"
+ }
+ }
+ },
+ "GooglePrivacyDlpV2beta2InspectConfig": {
+ "description": "Configuration description of the scanning process.\nWhen used with redactContent only info_types and min_likelihood are currently\nused.",
+ "type": "object",
+ "properties": {
+ "customInfoTypes": {
+ "type": "array",
+ "items": {
+ "$ref": "GooglePrivacyDlpV2beta2CustomInfoType"
+ },
+ "description": "Custom infoTypes provided by the user."
+ },
+ "limits": {
+ "$ref": "GooglePrivacyDlpV2beta2FindingLimits"
+ },
+ "excludeInfoTypes": {
+ "type": "boolean",
+ "description": "When true, excludes type information of the findings."
+ },
+ "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",
+ "items": {
+ "$ref": "GooglePrivacyDlpV2beta2InfoType"
+ }
+ },
+ "includeQuote": {
+ "description": "When true, a contextual quote from the data that triggered a finding is\nincluded in the response; see Finding.quote.",
+ "type": "boolean"
+ }
+ },
+ "id": "GooglePrivacyDlpV2beta2InspectConfig"
+ },
+ "GooglePrivacyDlpV2beta2BigQueryOptions": {
+ "description": "Options defining BigQuery table and row identifiers.",
+ "type": "object",
+ "properties": {
+ "tableReference": {
+ "description": "Complete BigQuery table reference.",
+ "$ref": "GooglePrivacyDlpV2beta2BigQueryTable"
+ },
+ "identifyingFields": {
+ "description": "References to fields uniquely identifying rows within the table.\nNested fields in the format, like `person.birthdate.year`, are allowed.",
+ "type": "array",
+ "items": {
+ "$ref": "GooglePrivacyDlpV2beta2FieldId"
+ }
+ }
+ },
+ "id": "GooglePrivacyDlpV2beta2BigQueryOptions"
+ },
+ "GooglePrivacyDlpV2beta2AnalyzeDataSourceRiskDetails": {
+ "id": "GooglePrivacyDlpV2beta2AnalyzeDataSourceRiskDetails",
+ "description": "Result of a risk analysis operation request.",
+ "type": "object",
+ "properties": {
+ "lDiversityResult": {
+ "$ref": "GooglePrivacyDlpV2beta2LDiversityResult"
+ },
+ "requestedSourceTable": {
+ "description": "Input dataset to compute metrics over.",
+ "$ref": "GooglePrivacyDlpV2beta2BigQueryTable"
+ },
+ "requestedPrivacyMetric": {
+ "$ref": "GooglePrivacyDlpV2beta2PrivacyMetric",
+ "description": "Privacy metric to compute."
+ },
+ "categoricalStatsResult": {
+ "$ref": "GooglePrivacyDlpV2beta2CategoricalStatsResult"
+ },
+ "numericalStatsResult": {
+ "$ref": "GooglePrivacyDlpV2beta2NumericalStatsResult"
+ },
+ "kAnonymityResult": {
+ "$ref": "GooglePrivacyDlpV2beta2KAnonymityResult"
+ },
+ "kMapEstimationResult": {
+ "$ref": "GooglePrivacyDlpV2beta2KMapEstimationResult"
+ }
+ }
+ },
+ "GooglePrivacyDlpV2beta2QuasiIdField": {
+ "id": "GooglePrivacyDlpV2beta2QuasiIdField",
+ "description": "A quasi-identifier column has a custom_tag, used to know which column\nin the data corresponds to which column in the statistical model.",
+ "type": "object",
+ "properties": {
+ "customTag": {
+ "type": "string"
+ },
+ "field": {
+ "$ref": "GooglePrivacyDlpV2beta2FieldId"
+ }
+ }
+ },
+ "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"
+ },
+ "GooglePrivacyDlpV2beta1KAnonymityHistogramBucket": {
+ "description": "Histogram bucket of equivalence class sizes in the table.",
+ "type": "object",
+ "properties": {
+ "equivalenceClassSizeLowerBound": {
+ "type": "string",
+ "description": "Lower bound on the size of the equivalence classes in this bucket.",
+ "format": "int64"
+ },
+ "equivalenceClassSizeUpperBound": {
+ "description": "Upper bound on the size of the equivalence classes in this bucket.",
+ "format": "int64",
+ "type": "string"
+ },
+ "bucketSize": {
+ "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": {
+ "properties": {
+ "name": {
+ "description": "The server-assigned name, which is only unique within the same service that\noriginally returns it. If you use the default HTTP mapping, the\n`name` should have the format of `inspect/results/{id}`.",
+ "type": "string"
+ }
+ },
+ "id": "GooglePrivacyDlpV2beta1InspectOperationResult",
+ "description": "The operational data.",
+ "type": "object"
+ },
+ "GooglePrivacyDlpV2beta2TransformationOverview": {
+ "description": "Overview of the modifications that occurred.",
+ "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": "GooglePrivacyDlpV2beta2TransformationSummary"
+ }
+ }
+ },
+ "id": "GooglePrivacyDlpV2beta2TransformationOverview"
+ },
+ "GooglePrivacyDlpV2beta2ListInspectTemplatesResponse": {
+ "description": "Response message for ListInspectTemplates.",
+ "type": "object",
+ "properties": {
+ "nextPageToken": {
+ "type": "string",
+ "description": "If the next page is available then the next page token to be used\nin following ListInspectTemplates request."
+ },
+ "inspectTemplates": {
+ "description": "List of inspectTemplates, up to page_size in ListInspectTemplatesRequest.",
+ "type": "array",
+ "items": {
+ "$ref": "GooglePrivacyDlpV2beta2InspectTemplate"
+ }
+ }
+ },
+ "id": "GooglePrivacyDlpV2beta2ListInspectTemplatesResponse"
+ },
+ "GooglePrivacyDlpV2beta1CategoricalStatsResult": {
+ "properties": {
+ "valueFrequencyHistogramBuckets": {
+ "description": "Histogram of value frequencies in the column.",
+ "type": "array",
+ "items": {
+ "$ref": "GooglePrivacyDlpV2beta1CategoricalStatsHistogramBucket"
+ }
+ }
+ },
+ "id": "GooglePrivacyDlpV2beta1CategoricalStatsResult",
+ "description": "Result of the categorical stats computation.",
+ "type": "object"
+ },
+ "GooglePrivacyDlpV2beta1LDiversityResult": {
+ "id": "GooglePrivacyDlpV2beta1LDiversityResult",
+ "description": "Result of the l-diversity computation.",
+ "type": "object",
+ "properties": {
+ "sensitiveValueFrequencyHistogramBuckets": {
+ "description": "Histogram of l-diversity equivalence class sensitive value frequencies.",
+ "type": "array",
+ "items": {
+ "$ref": "GooglePrivacyDlpV2beta1LDiversityHistogramBucket"
+ }
+ }
+ }
+ },
+ "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": {
+ "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": "GoogleTypeTimeOfDay"
+ },
+ "GooglePrivacyDlpV2beta2LDiversityEquivalenceClass": {
+ "description": "The set of columns' values that share the same ldiversity value.",
+ "type": "object",
+ "properties": {
+ "quasiIdsValues": {
+ "description": "Quasi-identifier values defining the k-anonymity equivalence\nclass. The order is always the same as the original request.",
+ "type": "array",
+ "items": {
+ "$ref": "GooglePrivacyDlpV2beta2Value"
+ }
+ },
+ "numDistinctSensitiveValues": {
+ "description": "Number of distinct sensitive values in this equivalence class.",
+ "format": "int64",
+ "type": "string"
+ },
+ "topSensitiveValues": {
+ "description": "Estimated frequencies of top sensitive values.",
+ "type": "array",
+ "items": {
+ "$ref": "GooglePrivacyDlpV2beta2ValueFrequency"
+ }
+ },
+ "equivalenceClassSize": {
+ "description": "Size of the k-anonymity equivalence class.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "id": "GooglePrivacyDlpV2beta2LDiversityEquivalenceClass"
+ },
+ "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."
+ }
+ },
+ "id": "GooglePrivacyDlpV2beta2CategoricalStatsConfig"
+ },
+ "GooglePrivacyDlpV2beta1LDiversityConfig": {
+ "properties": {
+ "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"
+ }
+ },
+ "sensitiveAttribute": {
+ "$ref": "GooglePrivacyDlpV2beta1FieldId",
+ "description": "Sensitive field for computing the l-value."
+ }
+ },
+ "id": "GooglePrivacyDlpV2beta1LDiversityConfig",
+ "description": "l-diversity metric, used for analysis of reidentification risk.",
+ "type": "object"
+ },
+ "GooglePrivacyDlpV2beta2ValueFrequency": {
+ "id": "GooglePrivacyDlpV2beta2ValueFrequency",
+ "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": {
+ "description": "A value contained in the field in question.",
+ "$ref": "GooglePrivacyDlpV2beta2Value"
+ }
+ }
+ },
+ "GooglePrivacyDlpV2beta2ReplaceValueConfig": {
+ "description": "Replace each input value with a given `Value`.",
+ "type": "object",
+ "properties": {
+ "newValue": {
+ "description": "Value to replace it with.",
+ "$ref": "GooglePrivacyDlpV2beta2Value"
+ }
+ },
+ "id": "GooglePrivacyDlpV2beta2ReplaceValueConfig"
+ },
+ "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": {
+ "quasiIds": {
+ "description": "Quasi-identifier columns. [required]",
+ "type": "array",
+ "items": {
+ "$ref": "GooglePrivacyDlpV2beta2QuasiIdField"
+ }
+ },
+ "relativeFrequency": {
+ "description": "The relative frequency column must contain a floating-point number\nbetween 0 and 1 (inclusive). Null values are assumed to be zero.\n[required]",
+ "$ref": "GooglePrivacyDlpV2beta2FieldId"
+ },
+ "table": {
+ "description": "Auxiliary table location. [required]",
+ "$ref": "GooglePrivacyDlpV2beta2BigQueryTable"
+ }
+ },
+ "id": "GooglePrivacyDlpV2beta2AuxiliaryTable"
+ },
+ "GooglePrivacyDlpV2beta1StorageConfig": {
+ "description": "Shared message indicating Cloud storage type.",
+ "type": "object",
+ "properties": {
+ "cloudStorageOptions": {
+ "$ref": "GooglePrivacyDlpV2beta1CloudStorageOptions",
+ "description": "Google Cloud Storage options specification."
+ },
+ "datastoreOptions": {
+ "description": "Google Cloud Datastore options specification.",
+ "$ref": "GooglePrivacyDlpV2beta1DatastoreOptions"
+ },
+ "bigQueryOptions": {
+ "description": "BigQuery options specification.",
+ "$ref": "GooglePrivacyDlpV2beta1BigQueryOptions"
+ }
+ },
+ "id": "GooglePrivacyDlpV2beta1StorageConfig"
+ },
+ "GooglePrivacyDlpV2beta1BigQueryOptions": {
+ "description": "Options defining BigQuery table and row identifiers.",
+ "type": "object",
+ "properties": {
+ "tableReference": {
+ "description": "Complete BigQuery table reference.",
+ "$ref": "GooglePrivacyDlpV2beta1BigQueryTable"
+ },
+ "identifyingFields": {
+ "description": "References to fields uniquely identifying rows within the table.\nNested fields in the format, like `person.birthdate.year`, are allowed.",
+ "type": "array",
+ "items": {
+ "$ref": "GooglePrivacyDlpV2beta1FieldId"
+ }
+ }
+ },
+ "id": "GooglePrivacyDlpV2beta1BigQueryOptions"
+ },
+ "GooglePrivacyDlpV2beta1PrivacyMetric": {
+ "description": "Privacy metric to compute for reidentification risk analysis.",
+ "type": "object",
+ "properties": {
+ "numericalStatsConfig": {
+ "$ref": "GooglePrivacyDlpV2beta1NumericalStatsConfig"
+ },
+ "kAnonymityConfig": {
+ "$ref": "GooglePrivacyDlpV2beta1KAnonymityConfig"
+ },
+ "categoricalStatsConfig": {
+ "$ref": "GooglePrivacyDlpV2beta1CategoricalStatsConfig"
+ },
+ "kMapEstimationConfig": {
+ "$ref": "GooglePrivacyDlpV2beta1KMapEstimationConfig"
+ },
+ "lDiversityConfig": {
+ "$ref": "GooglePrivacyDlpV2beta1LDiversityConfig"
+ }
+ },
+ "id": "GooglePrivacyDlpV2beta1PrivacyMetric"
+ },
+ "GooglePrivacyDlpV2beta2Location": {
+ "id": "GooglePrivacyDlpV2beta2Location",
+ "description": "Specifies the location of a finding within its source item.",
+ "type": "object",
+ "properties": {
+ "tableLocation": {
+ "$ref": "GooglePrivacyDlpV2beta2TableLocation",
+ "description": "Location within a `ContentItem.Table`."
+ },
+ "codepointRange": {
+ "$ref": "GooglePrivacyDlpV2beta2Range",
+ "description": "Character offsets within a content item, included when content type\nis a text. Default charset assumed to be UTF-8."
+ },
+ "fieldId": {
+ "description": "Field id of the field containing the finding.",
+ "$ref": "GooglePrivacyDlpV2beta2FieldId"
+ },
+ "imageBoxes": {
+ "description": "Location within an image's pixels.",
+ "type": "array",
+ "items": {
+ "$ref": "GooglePrivacyDlpV2beta2ImageLocation"
+ }
+ },
+ "byteRange": {
+ "description": "Zero-based byte offsets within a content item.",
+ "$ref": "GooglePrivacyDlpV2beta2Range"
+ },
+ "recordKey": {
+ "$ref": "GooglePrivacyDlpV2beta2RecordKey",
+ "description": "Key of the finding."
+ }
+ }
+ },
+ "GooglePrivacyDlpV2beta2ReidentifyContentResponse": {
+ "properties": {
+ "overview": {
+ "description": "An overview of the changes that were made to the `item`.",
+ "$ref": "GooglePrivacyDlpV2beta2TransformationOverview"
+ },
+ "item": {
+ "$ref": "GooglePrivacyDlpV2beta2ContentItem",
+ "description": "The re-identified item."
+ }
+ },
+ "id": "GooglePrivacyDlpV2beta2ReidentifyContentResponse",
+ "description": "Results of re-identifying a item.",
+ "type": "object"
+ },
+ "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"
+ },
+ "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": {
+ "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.",
+ "format": "int64",
+ "type": "string"
+ },
+ "topSensitiveValues": {
+ "type": "array",
+ "items": {
+ "$ref": "GooglePrivacyDlpV2beta1ValueFrequency"
+ },
+ "description": "Estimated frequencies of top sensitive values."
+ }
+ },
+ "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."
+ }
+ },
+ "id": "GooglePrivacyDlpV2beta1NumericalStatsConfig"
+ },
+ "GooglePrivacyDlpV2beta2InfoTypeTransformation": {
+ "description": "A transformation to apply to text that is identified as a specific\ninfo_type.",
+ "type": "object",
+ "properties": {
+ "primitiveTransformation": {
+ "description": "Primitive transformation to apply to the infoType. [required]",
+ "$ref": "GooglePrivacyDlpV2beta2PrimitiveTransformation"
+ },
+ "infoTypes": {
+ "description": "InfoTypes to apply the transformation to. Empty list will match all\navailable infoTypes for this transformation.",
+ "type": "array",
+ "items": {
+ "$ref": "GooglePrivacyDlpV2beta2InfoType"
+ }
+ }
+ },
+ "id": "GooglePrivacyDlpV2beta2InfoTypeTransformation"
+ },
+ "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": "GooglePrivacyDlpV2beta2CloudStorageOptions"
+ },
+ "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": {
+ "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",
+ "NOT_EQUAL_TO",
+ "GREATER_THAN",
+ "LESS_THAN",
+ "GREATER_THAN_OR_EQUALS",
+ "LESS_THAN_OR_EQUALS",
+ "EXISTS"
+ ],
+ "description": "Operator used to compare the field or infoType to the value. [required]",
+ "type": "string"
+ },
+ "value": {
+ "$ref": "GooglePrivacyDlpV2beta2Value",
+ "description": "Value to compare against. [Required, except for `EXISTS` tests.]"
+ },
+ "field": {
+ "description": "Field within the record this condition is evaluated against. [required]",
+ "$ref": "GooglePrivacyDlpV2beta2FieldId"
+ }
+ },
+ "id": "GooglePrivacyDlpV2beta2Condition"
+ },
+ "GooglePrivacyDlpV2beta2TableLocation": {
+ "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": "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.",
+ "type": "array",
+ "items": {
+ "$ref": "GooglePrivacyDlpV2beta2KMapEstimationHistogramBucket"
+ }
+ }
+ },
+ "id": "GooglePrivacyDlpV2beta2KMapEstimationResult"
+ },
+ "GooglePrivacyDlpV2beta2PrimitiveTransformation": {
+ "description": "A rule for transforming a value.",
+ "type": "object",
+ "properties": {
+ "replaceConfig": {
+ "$ref": "GooglePrivacyDlpV2beta2ReplaceValueConfig"
+ },
+ "fixedSizeBucketingConfig": {
+ "$ref": "GooglePrivacyDlpV2beta2FixedSizeBucketingConfig"
+ },
+ "timePartConfig": {
+ "$ref": "GooglePrivacyDlpV2beta2TimePartConfig"
+ },
+ "characterMaskConfig": {
+ "$ref": "GooglePrivacyDlpV2beta2CharacterMaskConfig"
+ },
+ "bucketingConfig": {
+ "$ref": "GooglePrivacyDlpV2beta2BucketingConfig"
+ },
+ "redactConfig": {
+ "$ref": "GooglePrivacyDlpV2beta2RedactConfig"
+ },
+ "replaceWithInfoTypeConfig": {
+ "$ref": "GooglePrivacyDlpV2beta2ReplaceWithInfoTypeConfig"
+ },
+ "cryptoHashConfig": {
+ "$ref": "GooglePrivacyDlpV2beta2CryptoHashConfig"
+ },
+ "cryptoReplaceFfxFpeConfig": {
+ "$ref": "GooglePrivacyDlpV2beta2CryptoReplaceFfxFpeConfig"
+ }
+ },
+ "id": "GooglePrivacyDlpV2beta2PrimitiveTransformation"
+ },
+ "GooglePrivacyDlpV2beta2KAnonymityEquivalenceClass": {
+ "description": "The set of columns' values that share the same ldiversity value",
+ "type": "object",
+ "properties": {
+ "equivalenceClassSize": {
+ "description": "Size of the equivalence class, for example number of rows with the\nabove set of values.",
+ "format": "int64",
+ "type": "string"
+ },
+ "quasiIdsValues": {
+ "description": "Set of values defining the equivalence class. One value per\nquasi-identifier column in the original KAnonymity metric message.\nThe order is always the same as the original request.",
+ "type": "array",
+ "items": {
+ "$ref": "GooglePrivacyDlpV2beta2Value"
+ }
+ }
+ },
+ "id": "GooglePrivacyDlpV2beta2KAnonymityEquivalenceClass"
+ },
+ "GooglePrivacyDlpV2beta1NumericalStatsResult": {
+ "description": "Result of the numerical stats computation.",
+ "type": "object",
+ "properties": {
+ "minValue": {
+ "description": "Minimum value appearing in the column.",
+ "$ref": "GooglePrivacyDlpV2beta1Value"
+ },
+ "maxValue": {
+ "description": "Maximum value appearing in the column.",
+ "$ref": "GooglePrivacyDlpV2beta1Value"
+ },
+ "quantileValues": {
+ "description": "List of 99 values that partition the set of field values into 100 equal\nsized buckets.",
+ "type": "array",
+ "items": {
+ "$ref": "GooglePrivacyDlpV2beta1Value"
+ }
+ }
+ },
+ "id": "GooglePrivacyDlpV2beta1NumericalStatsResult"
+ },
+ "GooglePrivacyDlpV2beta2InfoType": {
+ "description": "Type of information detected by the API.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "Name of the information type."
+ }
+ },
+ "id": "GooglePrivacyDlpV2beta2InfoType"
+ },
+ "GooglePrivacyDlpV2beta2ListDlpJobsResponse": {
+ "id": "GooglePrivacyDlpV2beta2ListDlpJobsResponse",
+ "description": "The response message for listing DLP jobs.",
+ "type": "object",
+ "properties": {
+ "jobs": {
+ "description": "A list of DlpJobs that matches the specified filter in the request.",
+ "type": "array",
+ "items": {
+ "$ref": "GooglePrivacyDlpV2beta2DlpJob"
+ }
+ },
+ "nextPageToken": {
+ "description": "The standard List next-page token.",
+ "type": "string"
+ }
+ }
+ },
+ "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": {
+ "wordList": {
+ "$ref": "GooglePrivacyDlpV2beta1WordList",
+ "description": "List of words or phrases to search for."
+ }
+ },
+ "id": "GooglePrivacyDlpV2beta1Dictionary"
+ },
+ "GooglePrivacyDlpV2beta1DatastoreOptions": {
+ "description": "Options defining a data set within Google Cloud Datastore.",
+ "type": "object",
+ "properties": {
+ "partitionId": {
+ "description": "A partition ID identifies a grouping of entities. The grouping is always\nby project and namespace, however the namespace ID may be empty.",
+ "$ref": "GooglePrivacyDlpV2beta1PartitionId"
+ },
+ "kind": {
+ "$ref": "GooglePrivacyDlpV2beta1KindExpression",
+ "description": "The kind to process."
+ },
+ "projection": {
+ "description": "Properties to scan. If none are specified, all properties will be scanned\nby default.",
+ "type": "array",
+ "items": {
+ "$ref": "GooglePrivacyDlpV2beta1Projection"
+ }
+ }
+ },
+ "id": "GooglePrivacyDlpV2beta1DatastoreOptions"
+ },
+ "GooglePrivacyDlpV2beta2RiskAnalysisJobConfig": {
+ "description": "Configuration for a risk analysis job.",
+ "type": "object",
+ "properties": {
+ "privacyMetric": {
+ "$ref": "GooglePrivacyDlpV2beta2PrivacyMetric",
+ "description": "Privacy metric to compute."
+ },
+ "sourceTable": {
+ "description": "Input dataset to compute metrics over.",
+ "$ref": "GooglePrivacyDlpV2beta2BigQueryTable"
+ }
+ },
+ "id": "GooglePrivacyDlpV2beta2RiskAnalysisJobConfig"
+ },
+ "GooglePrivacyDlpV2beta2StorageConfig": {
+ "description": "Shared message indicating Cloud storage type.",
+ "type": "object",
+ "properties": {
+ "cloudStorageOptions": {
+ "$ref": "GooglePrivacyDlpV2beta2CloudStorageOptions",
+ "description": "Google Cloud Storage options specification."
+ },
+ "datastoreOptions": {
+ "$ref": "GooglePrivacyDlpV2beta2DatastoreOptions",
+ "description": "Google Cloud Datastore options specification."
+ },
+ "bigQueryOptions": {
+ "description": "BigQuery options specification.",
+ "$ref": "GooglePrivacyDlpV2beta2BigQueryOptions"
+ }
+ },
+ "id": "GooglePrivacyDlpV2beta2StorageConfig"
+ },
+ "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]",
+ "format": "byte",
+ "type": "string"
+ }
+ },
+ "id": "GooglePrivacyDlpV2beta2UnwrappedCryptoKey"
+ },
+ "GooglePrivacyDlpV2beta2InfoTypeTransformations": {
+ "description": "A type of transformation that will scan unstructured text and\napply various `PrimitiveTransformation`s to each finding, where the\ntransformation is applied to only values that were identified as a specific\ninfo_type.",
+ "type": "object",
+ "properties": {
+ "transformations": {
+ "description": "Transformation for each infoType. Cannot specify more than one\nfor a given infoType. [required]",
+ "type": "array",
+ "items": {
+ "$ref": "GooglePrivacyDlpV2beta2InfoTypeTransformation"
+ }
+ }
+ },
+ "id": "GooglePrivacyDlpV2beta2InfoTypeTransformations"
+ },
+ "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",
+ "type": "string"
+ },
+ "equivalenceClassSizeUpperBound": {
+ "type": "string",
+ "description": "Upper bound on the size of the equivalence classes in this bucket.",
+ "format": "int64"
+ },
+ "bucketSize": {
+ "description": "Total number of equivalence classes in this bucket.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "id": "GooglePrivacyDlpV2beta2KAnonymityHistogramBucket"
+ },
+ "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": {
+ "type": "array",
+ "items": {
+ "$ref": "GooglePrivacyDlpV2beta1InfoTypeLimit"
+ },
+ "description": "Configuration of findings limit given for specified info types."
+ },
+ "maxFindings": {
+ "description": "Limits the number of findings per content item or long running operation.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "infoTypes": {
+ "description": "Restricts what info_types to look for. The values must correspond to\nInfoType values returned by ListInfoTypes or found in documentation.\nEmpty info_types runs all enabled detectors.",
+ "type": "array",
+ "items": {
+ "$ref": "GooglePrivacyDlpV2beta1InfoType"
+ }
+ },
+ "includeQuote": {
+ "type": "boolean",
+ "description": "When true, a contextual quote from the data that triggered a finding is\nincluded in the response; see Finding.quote."
+ },
+ "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"
+ },
+ "GooglePrivacyDlpV2beta2Value": {
+ "description": "Set of primitive values supported by the system.\nNote that for the purposes of inspection or transformation, the number\nof bytes considered to comprise a 'Value' is based on its representation\nas a UTF-8 encoded string. For example, if 'integer_value' is set to\n123456789, the number of bytes would be counted as 9, even though an\nint64 only holds up to 8 bytes of data.",
+ "type": "object",
+ "properties": {
+ "timestampValue": {
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "booleanValue": {
+ "type": "boolean"
+ },
+ "floatValue": {
+ "format": "double",
+ "type": "number"
+ },
+ "timeValue": {
+ "$ref": "GoogleTypeTimeOfDay"
+ },
+ "integerValue": {
+ "format": "int64",
+ "type": "string"
+ },
+ "stringValue": {
+ "type": "string"
+ },
+ "dateValue": {
+ "$ref": "GoogleTypeDate"
+ }
+ },
+ "id": "GooglePrivacyDlpV2beta2Value"
+ },
+ "GooglePrivacyDlpV2beta1Projection": {
+ "description": "A representation of a Datastore property in a projection.",
+ "type": "object",
+ "properties": {
+ "property": {
+ "$ref": "GooglePrivacyDlpV2beta1PropertyReference",
+ "description": "The property to project."
+ }
+ },
+ "id": "GooglePrivacyDlpV2beta1Projection"
+ },
+ "GooglePrivacyDlpV2beta2ImageRedactionConfig": {
+ "description": "Configuration for determining how redaction of images should occur.",
+ "type": "object",
+ "properties": {
+ "redactionColor": {
+ "$ref": "GooglePrivacyDlpV2beta2Color",
+ "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": {
+ "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": {
+ "properties": {
+ "year": {
+ "type": "integer",
+ "description": "Year of date. Must be from 1 to 9999, or 0 if specifying a date without\na year.",
+ "format": "int32"
+ },
+ "day": {
+ "description": "Day of month. Must be from 1 to 31 and valid for the year and month, or 0\nif specifying a year/month where the day is not significant.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "month": {
+ "description": "Month of year. Must be from 1 to 12.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "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"
+ },
+ "GooglePrivacyDlpV2beta2ListInfoTypesResponse": {
+ "description": "Response to the ListInfoTypes request.",
+ "type": "object",
+ "properties": {
+ "infoTypes": {
+ "description": "Set of sensitive infoTypes.",
+ "type": "array",
+ "items": {
+ "$ref": "GooglePrivacyDlpV2beta2InfoTypeDescription"
+ }
+ }
+ },
+ "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"
+ },
+ "GooglePrivacyDlpV2beta1CustomInfoType": {
+ "description": "Custom information type provided by the user. Used to find domain-specific\nsensitive information configurable to the data in question.",
+ "type": "object",
+ "properties": {
+ "infoType": {
+ "description": "Info type configuration. All custom info types must have configurations\nthat do not conflict with built-in info types or other custom info types.",
+ "$ref": "GooglePrivacyDlpV2beta1InfoType"
+ },
+ "dictionary": {
+ "$ref": "GooglePrivacyDlpV2beta1Dictionary",
+ "description": "Dictionary-based custom info type."
+ },
+ "surrogateType": {
+ "$ref": "GooglePrivacyDlpV2beta1SurrogateType",
+ "description": "Surrogate info type."
+ }
+ },
+ "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."
+ }
+ },
+ "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": {
+ "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"
+ }
+ }
+ },
+ "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": {
+ "type": "string",
+ "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client."
+ },
+ "details": {
+ "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ }
+ }
+ }
+ },
+ "id": "GoogleRpcStatus"
+ },
+ "GooglePrivacyDlpV2beta1KMapEstimationResult": {
+ "description": "Result of the reidentifiability analysis. Note that these results are an\nestimation, not exact values.",
+ "type": "object",
+ "properties": {
+ "kMapEstimationHistogram": {
+ "description": "The intervals [min_anonymity, max_anonymity] do not overlap. If a value\ndoesn't correspond to any such interval, the associated frequency is\nzero. For example, the following records:\n {min_anonymity: 1, max_anonymity: 1, frequency: 17}\n {min_anonymity: 2, max_anonymity: 3, frequency: 42}\n {min_anonymity: 5, max_anonymity: 10, frequency: 99}\nmean that there are no record with an estimated anonymity of 4, 5, or\nlarger than 10.",
+ "type": "array",
+ "items": {
+ "$ref": "GooglePrivacyDlpV2beta1KMapEstimationHistogramBucket"
+ }
+ }
+ },
+ "id": "GooglePrivacyDlpV2beta1KMapEstimationResult"
+ },
+ "GooglePrivacyDlpV2beta2CreateDeidentifyTemplateRequest": {
+ "properties": {
+ "templateId": {
+ "description": "The template id can contain uppercase and lowercase letters,\nnumbers, and hyphens; that is, it must match the regular\nexpression: `[a-zA-Z\\\\d-]+`. The maximum length is 100\ncharacters. Can be empty to allow the system to generate one.",
+ "type": "string"
+ },
+ "deidentifyTemplate": {
+ "$ref": "GooglePrivacyDlpV2beta2DeidentifyTemplate",
+ "description": "The DeidentifyTemplate to create."
+ }
+ },
+ "id": "GooglePrivacyDlpV2beta2CreateDeidentifyTemplateRequest",
+ "description": "Request message for CreateDeidentifyTemplate.",
+ "type": "object"
+ },
+ "GooglePrivacyDlpV2beta2RedactImageRequest": {
+ "description": "Request to search for potentially sensitive info in a list of items\nand replace it with a default or provided content.",
+ "type": "object",
+ "properties": {
+ "inspectConfig": {
+ "$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"
+ },
+ "imageRedactionConfigs": {
+ "description": "The configuration for specifying what content to redact from images.",
+ "type": "array",
+ "items": {
+ "$ref": "GooglePrivacyDlpV2beta2ImageRedactionConfig"
+ }
+ }
+ },
+ "id": "GooglePrivacyDlpV2beta2RedactImageRequest"
+ },
+ "GooglePrivacyDlpV2beta1KMapEstimationQuasiIdValues": {
+ "description": "A tuple of values for the quasi-identifier columns.",
+ "type": "object",
+ "properties": {
+ "quasiIdsValues": {
+ "description": "The quasi-identifier values.",
+ "type": "array",
+ "items": {
+ "$ref": "GooglePrivacyDlpV2beta1Value"
+ }
+ },
+ "estimatedAnonymity": {
+ "description": "The estimated anonymity for these quasi-identifier values.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "id": "GooglePrivacyDlpV2beta1KMapEstimationQuasiIdValues"
+ },
+ "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]",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "id": "GooglePrivacyDlpV2beta2WordList"
+ },
+ "GooglePrivacyDlpV2beta2ContentItem": {
+ "description": "Container structure for the content to inspect.",
+ "type": "object",
+ "properties": {
+ "type": {
+ "description": "Type of the content, as defined in Content-Type HTTP header.\nSupported types are: all \"text\" types, octet streams, PNG images,\nJPEG images.",
+ "type": "string"
+ },
+ "value": {
+ "description": "String data to inspect or redact.",
+ "type": "string"
+ },
+ "table": {
+ "description": "Structured content for inspection.",
+ "$ref": "GooglePrivacyDlpV2beta2Table"
+ },
+ "data": {
+ "description": "Content data to inspect or redact.",
+ "format": "byte",
+ "type": "string"
+ }
+ },
+ "id": "GooglePrivacyDlpV2beta2ContentItem"
+ },
+ "GooglePrivacyDlpV2beta2CategoricalStatsResult": {
+ "description": "Result of the categorical stats computation.",
+ "type": "object",
+ "properties": {
+ "valueFrequencyHistogramBuckets": {
+ "description": "Histogram of value frequencies in the column.",
+ "type": "array",
+ "items": {
+ "$ref": "GooglePrivacyDlpV2beta2CategoricalStatsHistogramBucket"
+ }
+ }
+ },
+ "id": "GooglePrivacyDlpV2beta2CategoricalStatsResult"
+ },
+ "GooglePrivacyDlpV2beta2ReplaceWithInfoTypeConfig": {
+ "description": "Replace each matching finding with the name of the info_type.",
"type": "object",
"properties": {},
- "id": "GooglePrivacyDlpV2beta1SurrogateType"
+ "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.",
+ "type": "array",
+ "items": {
+ "$ref": "GooglePrivacyDlpV2beta2PathElement"
+ }
+ },
+ "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."
+ }
+ }
+ },
+ "GooglePrivacyDlpV2beta1BigQueryTable": {
+ "description": "Message defining the location of a BigQuery table. A table is uniquely\nidentified by its project_id, dataset_id, and table_name. Within a query\na table is often referenced with a string in the format of:\n`\u003cproject_id\u003e:\u003cdataset_id\u003e.\u003ctable_id\u003e` or\n`\u003cproject_id\u003e.\u003cdataset_id\u003e.\u003ctable_id\u003e`.",
+ "type": "object",
+ "properties": {
+ "datasetId": {
+ "description": "Dataset ID of the table.",
+ "type": "string"
+ },
+ "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"
+ }
+ },
+ "id": "GooglePrivacyDlpV2beta1BigQueryTable"
+ },
+ "GooglePrivacyDlpV2beta2FieldTransformation": {
+ "type": "object",
+ "properties": {
+ "infoTypeTransformations": {
+ "$ref": "GooglePrivacyDlpV2beta2InfoTypeTransformations",
+ "description": "Treat the contents of the field as free text, and selectively\ntransform content that matches an `InfoType`."
+ },
+ "fields": {
+ "description": "Input field(s) to apply the transformation to. [required]",
+ "type": "array",
+ "items": {
+ "$ref": "GooglePrivacyDlpV2beta2FieldId"
+ }
+ },
+ "primitiveTransformation": {
+ "description": "Apply the transformation to the entire field.",
+ "$ref": "GooglePrivacyDlpV2beta2PrimitiveTransformation"
+ },
+ "condition": {
+ "description": "Only apply the transformation if the condition evaluates to true for the\ngiven `RecordCondition`. The conditions are allowed to reference fields\nthat are not used in the actual transformation. [optional]\n\nExample Use Cases:\n\n- Apply a different bucket transformation to an age column if the zip code\ncolumn for the same record is within a specific range.\n- Redact a field if the date of birth field is greater than 85.",
+ "$ref": "GooglePrivacyDlpV2beta2RecordCondition"
+ }
+ },
+ "id": "GooglePrivacyDlpV2beta2FieldTransformation",
+ "description": "The transformation to apply to the field."
+ },
+ "GooglePrivacyDlpV2beta2PathElement": {
+ "id": "GooglePrivacyDlpV2beta2PathElement",
+ "description": "A (kind, ID/name) pair used to construct a key path.\n\nIf either name or ID is set, the element is complete.\nIf neither is set, the element is incomplete.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "The name of the entity.\nA name matching regex `__.*__` is reserved/read-only.\nA name must not be more than 1500 bytes when UTF-8 encoded.\nCannot be `\"\"`.",
+ "type": "string"
+ },
+ "kind": {
+ "description": "The kind of the entity.\nA kind matching regex `__.*__` is reserved/read-only.\nA kind must not contain more than 1500 bytes when UTF-8 encoded.\nCannot be `\"\"`.",
+ "type": "string"
+ },
+ "id": {
+ "description": "The auto-allocated ID of the entity.\nNever equal to zero. Values less than zero are discouraged and may not\nbe supported in the future.",
+ "format": "int64",
+ "type": "string"
+ }
+ }
+ },
+ "GooglePrivacyDlpV2beta2RecordSuppression": {
+ "properties": {
+ "condition": {
+ "description": "A condition that when it evaluates to true will result in the record being\nevaluated to be suppressed from the transformed content.",
+ "$ref": "GooglePrivacyDlpV2beta2RecordCondition"
+ }
+ },
+ "id": "GooglePrivacyDlpV2beta2RecordSuppression",
+ "description": "Configuration to suppress records whose suppression conditions evaluate to\ntrue.",
+ "type": "object"
+ },
+ "GooglePrivacyDlpV2beta1KindExpression": {
+ "description": "A representation of a Datastore kind.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "The name of the kind.",
+ "type": "string"
+ }
+ },
+ "id": "GooglePrivacyDlpV2beta1KindExpression"
+ },
+ "GooglePrivacyDlpV2beta2NumericalStatsConfig": {
+ "description": "Compute numerical stats over an individual column, including\nmin, max, and quantiles.",
+ "type": "object",
+ "properties": {
+ "field": {
+ "description": "Field to compute numerical stats on. Supported types are\ninteger, float, date, datetime, timestamp, time.",
+ "$ref": "GooglePrivacyDlpV2beta2FieldId"
+ }
+ },
+ "id": "GooglePrivacyDlpV2beta2NumericalStatsConfig"
+ },
+ "GooglePrivacyDlpV2beta2OutputStorageConfig": {
+ "description": "Cloud repository for storing output.",
+ "type": "object",
+ "properties": {
+ "table": {
+ "description": "Store findings in a new table in an existing dataset.",
+ "$ref": "GooglePrivacyDlpV2beta2BigQueryTable"
+ }
+ },
+ "id": "GooglePrivacyDlpV2beta2OutputStorageConfig"
+ },
+ "GooglePrivacyDlpV2beta2InfoTypeLimit": {
+ "id": "GooglePrivacyDlpV2beta2InfoTypeLimit",
+ "description": "Max findings configuration per infoType, per content item or long\nrunning DlpJob.",
+ "type": "object",
+ "properties": {
+ "infoType": {
+ "$ref": "GooglePrivacyDlpV2beta2InfoType",
+ "description": "Type of information the findings limit applies to. Only one limit per\ninfo_type should be provided. If InfoTypeLimit does not have an\ninfo_type, the DLP API applies the limit against all info_types that\nare found but not specified in another InfoTypeLimit."
+ },
+ "maxFindings": {
+ "description": "Max findings limit for the given infoType.",
+ "format": "int32",
+ "type": "integer"
+ }
+ }
+ },
+ "GooglePrivacyDlpV2beta1FileSet": {
+ "description": "Set of files to scan.",
+ "type": "object",
+ "properties": {
+ "url": {
+ "type": "string",
+ "description": "The url, in the format `gs://\u003cbucket\u003e/\u003cpath\u003e`. Trailing wildcard in the\npath is allowed."
+ }
+ },
+ "id": "GooglePrivacyDlpV2beta1FileSet"
+ },
+ "GooglePrivacyDlpV2beta2InfoTypeStatistics": {
+ "description": "Statistics regarding a specific InfoType.",
+ "type": "object",
+ "properties": {
+ "count": {
+ "description": "Number of findings for this infoType.",
+ "format": "int64",
+ "type": "string"
+ },
+ "infoType": {
+ "$ref": "GooglePrivacyDlpV2beta2InfoType",
+ "description": "The type of finding this stat is for."
+ }
+ },
+ "id": "GooglePrivacyDlpV2beta2InfoTypeStatistics"
+ },
+ "GooglePrivacyDlpV2beta2LDiversityConfig": {
+ "description": "l-diversity metric, used for analysis of reidentification risk.",
+ "type": "object",
+ "properties": {
+ "sensitiveAttribute": {
+ "description": "Sensitive field for computing the l-value.",
+ "$ref": "GooglePrivacyDlpV2beta2FieldId"
+ },
+ "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": "GooglePrivacyDlpV2beta2FieldId"
+ }
+ }
+ },
+ "id": "GooglePrivacyDlpV2beta2LDiversityConfig"
+ },
+ "GooglePrivacyDlpV2beta2RecordTransformations": {
+ "id": "GooglePrivacyDlpV2beta2RecordTransformations",
+ "description": "A type of transformation that is applied over structured data such as a\ntable.",
+ "type": "object",
+ "properties": {
+ "recordSuppressions": {
+ "description": "Configuration defining which records get suppressed entirely. Records that\nmatch any suppression rule are omitted from the output [optional].",
+ "type": "array",
+ "items": {
+ "$ref": "GooglePrivacyDlpV2beta2RecordSuppression"
+ }
+ },
+ "fieldTransformations": {
+ "description": "Transform the record by applying various field transformations.",
+ "type": "array",
+ "items": {
+ "$ref": "GooglePrivacyDlpV2beta2FieldTransformation"
+ }
+ }
+ }
+ },
+ "GooglePrivacyDlpV2beta2Table": {
+ "type": "object",
+ "properties": {
+ "rows": {
+ "type": "array",
+ "items": {
+ "$ref": "GooglePrivacyDlpV2beta2Row"
+ }
+ },
+ "headers": {
+ "type": "array",
+ "items": {
+ "$ref": "GooglePrivacyDlpV2beta2FieldId"
+ }
+ }
+ },
+ "id": "GooglePrivacyDlpV2beta2Table",
+ "description": "Structured content to inspect. Up to 50,000 `Value`s per request allowed."
+ },
+ "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": {
+ "id": "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"
+ }
+ }
+ }
+ },
+ "GooglePrivacyDlpV2beta2SummaryResult": {
+ "properties": {
+ "details": {
+ "description": "A place for warnings or errors to show up if a transformation didn't\nwork as expected.",
+ "type": "string"
+ },
+ "count": {
+ "type": "string",
+ "format": "int64"
+ },
+ "code": {
+ "enum": [
+ "TRANSFORMATION_RESULT_CODE_UNSPECIFIED",
+ "SUCCESS",
+ "ERROR"
+ ],
+ "type": "string",
+ "enumDescriptions": [
+ "",
+ "",
+ ""
+ ]
+ }
+ },
+ "id": "GooglePrivacyDlpV2beta2SummaryResult",
+ "description": "A collection that informs the user the number of times a particular\n`TransformationResultCode` and error details occurred.",
+ "type": "object"
+ },
+ "GooglePrivacyDlpV2beta1KAnonymityConfig": {
+ "type": "object",
+ "properties": {
+ "entityId": {
+ "$ref": "GooglePrivacyDlpV2beta1EntityId",
+ "description": "Optional message indicating that each distinct entity_id should not\ncontribute to the k-anonymity count more than once per equivalence class.\nIf an entity_id appears on several rows with different quasi-identifier\ntuples, it will contribute to each count exactly once.\n\nThis can lead to unexpected results. Consider a table where ID 1 is\nassociated to quasi-identifier \"foo\", ID 2 to \"bar\", and ID 3 to *both*\nquasi-identifiers \"foo\" and \"bar\" (on separate rows), and where this ID\nis used as entity_id. Then, the anonymity value associated to ID 3 will\nbe 2, even if it is the only ID to be associated to both values \"foo\" and\n\"bar\"."
+ },
+ "quasiIds": {
+ "description": "Set of fields to compute k-anonymity over. When multiple fields are\nspecified, they are considered a single composite key. Structs and\nrepeated data types are not supported; however, nested fields are\nsupported so long as they are not structs themselves or nested within\na repeated field.",
+ "type": "array",
+ "items": {
+ "$ref": "GooglePrivacyDlpV2beta1FieldId"
+ }
+ }
+ },
+ "id": "GooglePrivacyDlpV2beta1KAnonymityConfig",
+ "description": "k-anonymity metric, used for analysis of reidentification risk."
+ },
+ "GooglePrivacyDlpV2beta2Range": {
+ "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": "GooglePrivacyDlpV2beta2Range"
+ },
+ "GooglePrivacyDlpV2beta2DeidentifyConfig": {
+ "properties": {
+ "recordTransformations": {
+ "$ref": "GooglePrivacyDlpV2beta2RecordTransformations",
+ "description": "Treat the dataset as structured. Transformations can be applied to\nspecific locations within structured datasets, such as transforming\na column within a table."
+ },
+ "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"
+ },
+ "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.",
+ "type": "array",
+ "items": {
+ "$ref": "GooglePrivacyDlpV2beta2AuxiliaryTable"
+ }
+ },
+ "quasiIds": {
+ "description": "Fields considered to be quasi-identifiers. No two columns can have the\nsame tag. [required]",
+ "type": "array",
+ "items": {
+ "$ref": "GooglePrivacyDlpV2beta2TaggedField"
+ }
+ },
+ "regionCode": {
+ "description": "ISO 3166-1 alpha-2 region code to use in the statistical modeling.\nRequired if no column is tagged with a region-specific InfoType (like\nUS_ZIP_5) or a region code.",
+ "type": "string"
+ }
+ },
+ "id": "GooglePrivacyDlpV2beta2KMapEstimationConfig"
+ },
+ "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": {
+ "description": "Set of buckets. Ranges must be non-overlapping.",
+ "type": "array",
+ "items": {
+ "$ref": "GooglePrivacyDlpV2beta2Bucket"
+ }
+ }
+ },
+ "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": {
+ "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"
+ }
+ },
+ "minAnonymity": {
+ "description": "Always positive.",
+ "format": "int64",
+ "type": "string"
+ },
+ "maxAnonymity": {
+ "description": "Always greater than or equal to min_anonymity.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "id": "GooglePrivacyDlpV2beta2KMapEstimationHistogramBucket"
+ },
+ "GooglePrivacyDlpV2beta2PrivacyMetric": {
+ "description": "Privacy metric to compute for reidentification risk analysis.",
+ "type": "object",
+ "properties": {
+ "lDiversityConfig": {
+ "$ref": "GooglePrivacyDlpV2beta2LDiversityConfig"
+ },
+ "numericalStatsConfig": {
+ "$ref": "GooglePrivacyDlpV2beta2NumericalStatsConfig"
+ },
+ "kAnonymityConfig": {
+ "$ref": "GooglePrivacyDlpV2beta2KAnonymityConfig"
+ },
+ "categoricalStatsConfig": {
+ "$ref": "GooglePrivacyDlpV2beta2CategoricalStatsConfig"
+ },
+ "kMapEstimationConfig": {
+ "$ref": "GooglePrivacyDlpV2beta2KMapEstimationConfig"
+ }
+ },
+ "id": "GooglePrivacyDlpV2beta2PrivacyMetric"
+ },
+ "GooglePrivacyDlpV2beta1QuasiIdField": {
+ "properties": {
+ "field": {
+ "$ref": "GooglePrivacyDlpV2beta1FieldId"
+ },
+ "customTag": {
+ "type": "string"
+ }
+ },
+ "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"
+ },
+ "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"
+ },
+ "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": {
+ "type": "object",
+ "properties": {
+ "totalEstimatedBytes": {
+ "description": "Estimate of the number of bytes to process.",
+ "format": "int64",
+ "type": "string"
+ },
+ "infoTypeStats": {
+ "description": "Statistics of how many instances of each info type were found during\ninspect job.",
+ "type": "array",
+ "items": {
+ "$ref": "GooglePrivacyDlpV2beta2InfoTypeStatistics"
+ }
+ },
+ "processedBytes": {
+ "description": "Total size in bytes that were processed.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "id": "GooglePrivacyDlpV2beta2Result"
+ },
+ "GooglePrivacyDlpV2beta2CustomInfoType": {
+ "description": "Custom information type provided by the user. Used to find domain-specific\nsensitive information configurable to the data in question.",
+ "type": "object",
+ "properties": {
+ "surrogateType": {
+ "$ref": "GooglePrivacyDlpV2beta2SurrogateType",
+ "description": "Surrogate info type."
+ },
+ "infoType": {
+ "description": "Info type configuration. All custom info types must have configurations\nthat do not conflict with built-in info types or other custom info types.",
+ "$ref": "GooglePrivacyDlpV2beta2InfoType"
+ },
+ "dictionary": {
+ "$ref": "GooglePrivacyDlpV2beta2Dictionary",
+ "description": "Dictionary-based custom info type."
+ }
+ },
+ "id": "GooglePrivacyDlpV2beta2CustomInfoType"
+ },
+ "GooglePrivacyDlpV2beta2DeidentifyContentResponse": {
+ "description": "Results of de-identifying a ContentItem.",
+ "type": "object",
+ "properties": {
+ "overview": {
+ "$ref": "GooglePrivacyDlpV2beta2TransformationOverview",
+ "description": "An overview of the changes that were made on the `item`."
+ },
+ "item": {
+ "description": "The de-identified item.",
+ "$ref": "GooglePrivacyDlpV2beta2ContentItem"
+ }
+ },
+ "id": "GooglePrivacyDlpV2beta2DeidentifyContentResponse"
},
"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": {
+ "context": {
+ "$ref": "GooglePrivacyDlpV2beta2FieldId",
+ "description": "The 'tweak', a context may be used for higher security since the same\nidentifier in two different contexts won't be given the same surrogate. If\nthe context is not set, a default tweak will be used.\n\nIf the context is set but:\n\n1. there is no record present when transforming a given value or\n1. the field is not present when transforming a given value,\n\na default tweak will be used.\n\nNote that case (1) is expected when an `InfoTypeTransformation` is\napplied to both structured and non-structured `ContentItem`s.\nCurrently, the referenced field may be of value type integer or string.\n\nThe tweak is constructed as a sequence of bytes in big endian byte order\nsuch that:\n\n- a 64 bit integer is encoded followed by a single byte of value 1\n- a string is encoded in UTF-8 format followed by a single byte of value\n å 2"
+ },
"surrogateInfoType": {
"$ref": "GooglePrivacyDlpV2beta2InfoType",
"description": "The custom infoType to annotate the surrogate with.\nThis annotation will be applied to the surrogate by prefixing it with\nthe name of the custom infoType followed by the number of\ncharacters comprising the surrogate. The following scheme defines the\nformat: info_type_name(surrogate_character_count):surrogate\n\nFor example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and\nthe surrogate is 'abc', the full replacement value\nwill be: 'MY_TOKEN_INFO_TYPE(3):abc'\n\nThis annotation identifies the surrogate when inspecting content using the\ncustom infoType\n[`SurrogateType`](/dlp/docs/reference/rest/v2beta2/InspectConfig#surrogatetype).\nThis facilitates reversal of the surrogate when it occurs in free text.\n\nIn order for inspection to work properly, the name of this infoType must\nnot occur naturally anywhere in your data; otherwise, inspection may\nfind a surrogate that does not correspond to an actual identifier.\nTherefore, choose your custom infoType name carefully after considering\nwhat your data looks like. One way to select a name that has a high chance\nof yielding reliable detection is to include one or more unicode characters\nthat are highly improbable to exist in your data.\nFor example, assuming your data is entered from a regular ASCII keyboard,\nthe symbol with the hex code point 29DD might be used like so:\n⧝MY_TOKEN_TYPE"
@@ -1100,28 +3018,46 @@
"type": "string"
},
"cryptoKey": {
- "description": "The key used by the encryption algorithm. [required]",
- "$ref": "GooglePrivacyDlpV2beta2CryptoKey"
- },
- "context": {
- "$ref": "GooglePrivacyDlpV2beta2FieldId",
- "description": "The 'tweak', a context may be used for higher security since the same\nidentifier in two different contexts won't be given the same surrogate. If\nthe context is not set, a default tweak will be used.\n\nIf the context is set but:\n\n1. there is no record present when transforming a given value or\n1. the field is not present when transforming a given value,\n\na default tweak will be used.\n\nNote that case (1) is expected when an `InfoTypeTransformation` is\napplied to both structured and non-structured `ContentItem`s.\nCurrently, the referenced field may be of value type integer or string.\n\nThe tweak is constructed as a sequence of bytes in big endian byte order\nsuch that:\n\n- a 64 bit integer is encoded followed by a single byte of value 1\n- a string is encoded in UTF-8 format followed by a single byte of value\n å 2"
+ "$ref": "GooglePrivacyDlpV2beta2CryptoKey",
+ "description": "The key used by the encryption algorithm. [required]"
}
},
"id": "GooglePrivacyDlpV2beta2CryptoReplaceFfxFpeConfig"
},
+ "GooglePrivacyDlpV2beta1SurrogateType": {
+ "properties": {},
+ "id": "GooglePrivacyDlpV2beta1SurrogateType",
+ "description": "Message for detecting output from deidentification transformations\nsuch as\n[`CryptoReplaceFfxFpeConfig`](/dlp/docs/reference/rest/v2beta1/content/deidentify#CryptoReplaceFfxFpeConfig).\nThese types of transformations are\nthose that perform pseudonymization, thereby producing a \"surrogate\" as\noutput. This should be used in conjunction with a field on the\ntransformation such as `surrogate_info_type`. This custom info type does\nnot support the use of `detection_rules`.",
+ "type": "object"
+ },
+ "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"
+ },
"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"
+ },
+ "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"
@@ -1150,23 +3086,8 @@
"id": "GooglePrivacyDlpV2beta2FindingLimits"
},
"GooglePrivacyDlpV2beta2DlpJob": {
- "description": "Combines all of the information about a DLP job.",
"type": "object",
"properties": {
- "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",
@@ -1220,14 +3141,39 @@
"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"
+ ]
}
},
- "id": "GooglePrivacyDlpV2beta2DlpJob"
+ "id": "GooglePrivacyDlpV2beta2DlpJob",
+ "description": "Combines all of the information about a DLP job."
},
"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": {
+ "type": "string",
+ "description": "Upper bound on the sensitive value frequencies of the equivalence\nclasses in this bucket.",
+ "format": "int64"
+ },
"sensitiveValueFrequencyLowerBound": {
"description": "Lower bound on the sensitive value frequencies of the equivalence\nclasses in this bucket.",
"format": "int64",
@@ -1239,34 +3185,22 @@
"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"
},
"GooglePrivacyDlpV2beta2Dictionary": {
- "description": "Custom information type based on a dictionary of words or phrases. This can\nbe used to match sensitive information specific to the data, such as a list\nof employee IDs or job titles.\n\nDictionary words are case-insensitive and all characters other than letters\nand digits in the unicode [Basic Multilingual\nPlane](https://en.wikipedia.org/wiki/Plane_%28Unicode%29#Basic_Multilingual_Plane)\nwill be replaced with whitespace when scanning for matches, so the\ndictionary phrase \"Sam Johnson\" will match all three phrases \"sam johnson\",\n\"Sam, Johnson\", and \"Sam (Johnson)\". Additionally, the characters\nsurrounding any match must be of a different type than the adjacent\ncharacters within the word, so letters must be next to non-letters and\ndigits next to non-digits. For example, the dictionary word \"jen\" will\nmatch the first three letters of the text \"jen123\" but will return no\nmatches for \"jennifer\".\n\nDictionary words containing a large number of characters that are not\nletters or digits may result in unexpected findings because such characters\nare treated as whitespace.",
"type": "object",
"properties": {
"wordList": {
- "$ref": "GooglePrivacyDlpV2beta2WordList",
- "description": "List of words or phrases to search for."
+ "description": "List of words or phrases to search for.",
+ "$ref": "GooglePrivacyDlpV2beta2WordList"
}
},
- "id": "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."
},
"GooglePrivacyDlpV2beta1Value": {
- "description": "Set of primitive values supported by the system.\nNote that for the purposes of inspection or transformation, the number\nof bytes considered to comprise a 'Value' is based on its representation\nas a UTF-8 encoded string. For example, if 'integer_value' is set to\n123456789, the number of bytes would be counted as 9, even though an\nint64 only holds up to 8 bytes of data.",
- "type": "object",
"properties": {
"timestampValue": {
"format": "google-datetime",
@@ -1279,13 +3213,13 @@
"format": "double",
"type": "number"
},
+ "timeValue": {
+ "$ref": "GoogleTypeTimeOfDay"
+ },
"integerValue": {
"format": "int64",
"type": "string"
},
- "timeValue": {
- "$ref": "GoogleTypeTimeOfDay"
- },
"stringValue": {
"type": "string"
},
@@ -1293,27 +3227,25 @@
"$ref": "GoogleTypeDate"
}
},
- "id": "GooglePrivacyDlpV2beta1Value"
+ "id": "GooglePrivacyDlpV2beta1Value",
+ "description": "Set of primitive values supported by the system.\nNote that for the purposes of inspection or transformation, the number\nof bytes considered to comprise a 'Value' is based on its representation\nas a UTF-8 encoded string. For example, if 'integer_value' is set to\n123456789, the number of bytes would be counted as 9, even though an\nint64 only holds up to 8 bytes of data.",
+ "type": "object"
},
"GooglePrivacyDlpV2beta2RecordCondition": {
"description": "A condition for determining whether a transformation should be applied to\na field.",
"type": "object",
"properties": {
"expressions": {
- "description": "An expression.",
- "$ref": "GooglePrivacyDlpV2beta2Expressions"
+ "$ref": "GooglePrivacyDlpV2beta2Expressions",
+ "description": "An expression."
}
},
"id": "GooglePrivacyDlpV2beta2RecordCondition"
},
"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",
@@ -1330,9 +3262,13 @@
"items": {
"$ref": "GooglePrivacyDlpV2beta2LDiversityEquivalenceClass"
}
+ },
+ "bucketSize": {
+ "description": "Total number of equivalence classes in this bucket.",
+ "format": "int64",
+ "type": "string"
}
- },
- "id": "GooglePrivacyDlpV2beta2LDiversityHistogramBucket"
+ }
},
"GooglePrivacyDlpV2beta2KindExpression": {
"description": "A representation of a Datastore kind.",
@@ -1346,34 +3282,34 @@
"id": "GooglePrivacyDlpV2beta2KindExpression"
},
"GooglePrivacyDlpV2beta1PartitionId": {
+ "id": "GooglePrivacyDlpV2beta1PartitionId",
"description": "Datastore partition ID.\nA partition ID identifies a grouping of entities. The grouping is always\nby project and namespace, however the namespace ID may be empty.\n\nA partition ID contains several dimensions:\nproject ID and namespace ID.",
"type": "object",
"properties": {
- "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"
+ }
},
"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"
+ },
+ "findings": {
+ "type": "array",
+ "items": {
+ "$ref": "GooglePrivacyDlpV2beta2Finding"
+ },
+ "description": "List of findings for an item."
}
},
"id": "GooglePrivacyDlpV2beta2InspectResult"
@@ -1383,15 +3319,13 @@
"type": "object",
"properties": {
"cryptoKey": {
- "description": "The key used by the hash function.",
- "$ref": "GooglePrivacyDlpV2beta2CryptoKey"
+ "$ref": "GooglePrivacyDlpV2beta2CryptoKey",
+ "description": "The key used by the hash function."
}
},
"id": "GooglePrivacyDlpV2beta2CryptoHashConfig"
},
"GooglePrivacyDlpV2beta2TimePartConfig": {
- "description": "For use with `Date`, `Timestamp`, and `TimeOfDay`, extract or preserve a\nportion of the value.",
- "type": "object",
"properties": {
"partToExtract": {
"type": "string",
@@ -1415,21 +3349,9 @@
]
}
},
- "id": "GooglePrivacyDlpV2beta2TimePartConfig"
- },
- "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"
- }
- }
- },
- "id": "GooglePrivacyDlpV2beta1WordList"
+ "id": "GooglePrivacyDlpV2beta2TimePartConfig",
+ "description": "For use with `Date`, `Timestamp`, and `TimeOfDay`, extract or preserve a\nportion of the value.",
+ "type": "object"
},
"GooglePrivacyDlpV2beta2ImageLocation": {
"description": "Bounding box encompassing detected text within an image.",
@@ -1451,13 +3373,27 @@
"type": "integer"
},
"width": {
+ "type": "integer",
"description": "Width of the bounding box in pixels.",
- "format": "int32",
- "type": "integer"
+ "format": "int32"
}
},
"id": "GooglePrivacyDlpV2beta2ImageLocation"
},
+ "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"
+ }
+ }
+ },
+ "id": "GooglePrivacyDlpV2beta1WordList"
+ },
"GooglePrivacyDlpV2beta1FieldId": {
"description": "General identifier of a data field in a storage service.",
"type": "object",
@@ -1470,6 +3406,7 @@
"id": "GooglePrivacyDlpV2beta1FieldId"
},
"GooglePrivacyDlpV2beta2UpdateInspectTemplateRequest": {
+ "id": "GooglePrivacyDlpV2beta2UpdateInspectTemplateRequest",
"description": "Request message for UpdateInspectTemplate.",
"type": "object",
"properties": {
@@ -1479,33 +3416,10 @@
"type": "string"
},
"inspectTemplate": {
- "description": "New InspectTemplate value.",
- "$ref": "GooglePrivacyDlpV2beta2InspectTemplate"
+ "$ref": "GooglePrivacyDlpV2beta2InspectTemplate",
+ "description": "New InspectTemplate value."
}
- },
- "id": "GooglePrivacyDlpV2beta2UpdateInspectTemplateRequest"
- },
- "GooglePrivacyDlpV2beta2Expressions": {
- "description": "An expression, consisting or an operator and conditions.",
- "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": {
"description": "Request for scheduling a scan of a data subset from a Google Platform data\nrepository.",
@@ -1518,19 +3432,32 @@
},
"id": "GooglePrivacyDlpV2beta2InspectDataSourceRequest"
},
+ "GooglePrivacyDlpV2beta2Expressions": {
+ "description": "An expression, consisting or an operator and conditions.",
+ "type": "object",
+ "properties": {
+ "logicalOperator": {
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "enum": [
+ "LOGICAL_OPERATOR_UNSPECIFIED",
+ "AND"
+ ],
+ "description": "The operator to apply to the result of conditions. Default and currently\nonly supported value is `AND`.",
+ "type": "string"
+ },
+ "conditions": {
+ "$ref": "GooglePrivacyDlpV2beta2Conditions"
+ }
+ },
+ "id": "GooglePrivacyDlpV2beta2Expressions"
+ },
"GooglePrivacyDlpV2beta2TransformationSummary": {
"description": "Summary of a single tranformation.\nOnly one of 'transformation', 'field_transformation', or 'record_suppress'\nwill be set.",
"type": "object",
"properties": {
- "transformedBytes": {
- "description": "Total size in bytes that were transformed in some way.",
- "format": "int64",
- "type": "string"
- },
- "recordSuppress": {
- "$ref": "GooglePrivacyDlpV2beta2RecordSuppression",
- "description": "The specific suppression option these stats apply to."
- },
"infoType": {
"$ref": "GooglePrivacyDlpV2beta2InfoType",
"description": "Set if the transformation was limited to a specific info_type."
@@ -1539,22 +3466,31 @@
"$ref": "GooglePrivacyDlpV2beta2PrimitiveTransformation",
"description": "The specific transformation these stats apply to."
},
- "field": {
- "description": "Set if the transformation was limited to a specific FieldId.",
- "$ref": "GooglePrivacyDlpV2beta2FieldId"
- },
"results": {
"type": "array",
"items": {
"$ref": "GooglePrivacyDlpV2beta2SummaryResult"
}
},
+ "field": {
+ "description": "Set if the transformation was limited to a specific FieldId.",
+ "$ref": "GooglePrivacyDlpV2beta2FieldId"
+ },
"fieldTransformations": {
"description": "The field transformation that was applied.\nIf multiple field transformations are requested for a single field,\nthis list will contain all of them; otherwise, only one is supplied.",
"type": "array",
"items": {
"$ref": "GooglePrivacyDlpV2beta2FieldTransformation"
}
+ },
+ "transformedBytes": {
+ "description": "Total size in bytes that were transformed in some way.",
+ "format": "int64",
+ "type": "string"
+ },
+ "recordSuppress": {
+ "description": "The specific suppression option these stats apply to.",
+ "$ref": "GooglePrivacyDlpV2beta2RecordSuppression"
}
},
"id": "GooglePrivacyDlpV2beta2TransformationSummary"
@@ -1601,9 +3537,29 @@
"description": "Container structure describing a single finding within a string or image.",
"type": "object",
"properties": {
+ "likelihood": {
+ "enum": [
+ "LIKELIHOOD_UNSPECIFIED",
+ "VERY_UNLIKELY",
+ "UNLIKELY",
+ "POSSIBLE",
+ "LIKELY",
+ "VERY_LIKELY"
+ ],
+ "description": "Estimate of how likely it is that the info_type is correct.",
+ "type": "string",
+ "enumDescriptions": [
+ "Default value; information with all likelihoods is included.",
+ "Few matching elements.",
+ "",
+ "Some matching elements.",
+ "",
+ "Many matching elements."
+ ]
+ },
"infoType": {
- "description": "The specific type of info the string might be.",
- "$ref": "GooglePrivacyDlpV2beta2InfoType"
+ "$ref": "GooglePrivacyDlpV2beta2InfoType",
+ "description": "The specific type of info the string might be."
},
"createTime": {
"description": "Timestamp when finding was detected.",
@@ -1615,28 +3571,8 @@
"type": "string"
},
"location": {
- "description": "Location of the info found.",
- "$ref": "GooglePrivacyDlpV2beta2Location"
- },
- "likelihood": {
- "enumDescriptions": [
- "Default value; information with all likelihoods is included.",
- "Few matching elements.",
- "",
- "Some matching elements.",
- "",
- "Many matching elements."
- ],
- "enum": [
- "LIKELIHOOD_UNSPECIFIED",
- "VERY_UNLIKELY",
- "UNLIKELY",
- "POSSIBLE",
- "LIKELY",
- "VERY_LIKELY"
- ],
- "description": "Estimate of how likely it is that the info_type is correct.",
- "type": "string"
+ "$ref": "GooglePrivacyDlpV2beta2Location",
+ "description": "Location of the info found."
}
},
"id": "GooglePrivacyDlpV2beta2Finding"
@@ -1645,21 +3581,21 @@
"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"
+ },
"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"
},
"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": {
- "description": "Identifies the column. [required]",
- "$ref": "GooglePrivacyDlpV2beta1FieldId"
- },
- "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"
+ "$ref": "GoogleProtobufEmpty",
+ "description": "If no semantic tag is indicated, we infer the statistical model from\nthe distribution of values in the input data"
}
},
"id": "GooglePrivacyDlpV2beta1TaggedField"
@@ -1668,17 +3604,57 @@
"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": {
+ "type": "string",
+ "description": "If not empty, the ID of the namespace to which the entities belong."
+ },
"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": "GooglePrivacyDlpV2beta2PartitionId"
},
+ "GooglePrivacyDlpV2beta2Conditions": {
+ "description": "A collection of conditions.",
+ "type": "object",
+ "properties": {
+ "conditions": {
+ "type": "array",
+ "items": {
+ "$ref": "GooglePrivacyDlpV2beta2Condition"
+ }
+ }
+ },
+ "id": "GooglePrivacyDlpV2beta2Conditions"
+ },
+ "GooglePrivacyDlpV2beta2CharacterMaskConfig": {
+ "description": "Partially mask a string by replacing a given number of characters with a\nfixed character. Masking can start from the beginning or end of the string.\nThis can be used on data of any type (numbers, longs, and so on) and when\nde-identifying structured data we'll attempt to preserve the original data's\ntype. (This allows you to take a long like 123 and modify it to a string like\n**3.",
+ "type": "object",
+ "properties": {
+ "maskingCharacter": {
+ "description": "Character to mask the sensitive values—for example, \"*\" for an\nalphabetic string such as name, or \"0\" for a numeric string such as ZIP\ncode or credit card number. String must have length 1. If not supplied, we\nwill default to \"*\" for strings, 0 for digits.",
+ "type": "string"
+ },
+ "reverseOrder": {
+ "description": "Mask characters in reverse order. For example, if `masking_character` is\n'0', number_to_mask is 14, and `reverse_order` is false, then\n1234-5678-9012-3456 -\u003e 00000000000000-3456\nIf `masking_character` is '*', `number_to_mask` is 3, and `reverse_order`\nis true, then 12345 -\u003e 12***",
+ "type": "boolean"
+ },
+ "numberToMask": {
+ "description": "Number of characters to mask. If not set, all matching chars will be\nmasked. Skipped characters do not count towards this tally.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "charactersToIgnore": {
+ "description": "When masking a string, items in this list will be skipped when replacing.\nFor example, if your string is 555-555-5555 and you ask us to skip `-` and\nmask 5 chars with * we would produce ***-*55-5555.",
+ "type": "array",
+ "items": {
+ "$ref": "GooglePrivacyDlpV2beta2CharsToIgnore"
+ }
+ }
+ },
+ "id": "GooglePrivacyDlpV2beta2CharacterMaskConfig"
+ },
"GooglePrivacyDlpV2beta2KMapEstimationQuasiIdValues": {
"description": "A tuple of values for the quasi-identifier columns.",
"type": "object",
@@ -1698,64 +3674,6 @@
},
"id": "GooglePrivacyDlpV2beta2KMapEstimationQuasiIdValues"
},
- "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": {
- "reverseOrder": {
- "description": "Mask characters in reverse order. For example, if `masking_character` is\n'0', number_to_mask is 14, and `reverse_order` is false, then\n1234-5678-9012-3456 -\u003e 00000000000000-3456\nIf `masking_character` is '*', `number_to_mask` is 3, and `reverse_order`\nis true, then 12345 -\u003e 12***",
- "type": "boolean"
- },
- "numberToMask": {
- "description": "Number of characters to mask. If not set, all matching chars will be\nmasked. Skipped characters do not count towards this tally.",
- "format": "int32",
- "type": "integer"
- },
- "charactersToIgnore": {
- "description": "When masking a string, items in this list will be skipped when replacing.\nFor example, if your string is 555-555-5555 and you ask us to skip `-` and\nmask 5 chars with * we would produce ***-*55-5555.",
- "type": "array",
- "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": {
- "description": "A collection of conditions.",
- "type": "object",
- "properties": {
- "conditions": {
- "type": "array",
- "items": {
- "$ref": "GooglePrivacyDlpV2beta2Condition"
- }
- }
- },
- "id": "GooglePrivacyDlpV2beta2Conditions"
- },
- "GooglePrivacyDlpV2beta2ListDeidentifyTemplatesResponse": {
- "description": "Response message for ListDeidentifyTemplates.",
- "type": "object",
- "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 deidentify templates, up to page_size in\nListDeidentifyTemplatesRequest.",
- "type": "array",
- "items": {
- "$ref": "GooglePrivacyDlpV2beta2DeidentifyTemplate"
- }
- }
- },
- "id": "GooglePrivacyDlpV2beta2ListDeidentifyTemplatesResponse"
- },
"GooglePrivacyDlpV2beta2InspectJobConfig": {
"type": "object",
"properties": {
@@ -1778,7 +3696,26 @@
},
"id": "GooglePrivacyDlpV2beta2InspectJobConfig"
},
+ "GooglePrivacyDlpV2beta2ListDeidentifyTemplatesResponse": {
+ "description": "Response message for ListDeidentifyTemplates.",
+ "type": "object",
+ "properties": {
+ "deidentifyTemplates": {
+ "description": "List of deidentify templates, up to page_size in\nListDeidentifyTemplatesRequest.",
+ "type": "array",
+ "items": {
+ "$ref": "GooglePrivacyDlpV2beta2DeidentifyTemplate"
+ }
+ },
+ "nextPageToken": {
+ "description": "If the next page is available then the next page token to be used\nin following ListDeidentifyTemplates request.",
+ "type": "string"
+ }
+ },
+ "id": "GooglePrivacyDlpV2beta2ListDeidentifyTemplatesResponse"
+ },
"GooglePrivacyDlpV2beta2UpdateDeidentifyTemplateRequest": {
+ "id": "GooglePrivacyDlpV2beta2UpdateDeidentifyTemplateRequest",
"description": "Request message for UpdateDeidentifyTemplate.",
"type": "object",
"properties": {
@@ -1788,27 +3725,10 @@
"type": "string"
},
"deidentifyTemplate": {
- "$ref": "GooglePrivacyDlpV2beta2DeidentifyTemplate",
- "description": "New DeidentifyTemplate value."
+ "description": "New DeidentifyTemplate value.",
+ "$ref": "GooglePrivacyDlpV2beta2DeidentifyTemplate"
}
- },
- "id": "GooglePrivacyDlpV2beta2UpdateDeidentifyTemplateRequest"
- },
- "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": {
- "unwrapped": {
- "$ref": "GooglePrivacyDlpV2beta2UnwrappedCryptoKey"
- },
- "transient": {
- "$ref": "GooglePrivacyDlpV2beta2TransientCryptoKey"
- },
- "kmsWrapped": {
- "$ref": "GooglePrivacyDlpV2beta2KmsWrappedCryptoKey"
- }
- },
- "id": "GooglePrivacyDlpV2beta2CryptoKey"
+ }
},
"GooglePrivacyDlpV2beta2SurrogateType": {
"description": "Message for detecting output from deidentification transformations\nsuch as\n[`CryptoReplaceFfxFpeConfig`](/dlp/docs/reference/rest/v2beta1/content/deidentify#CryptoReplaceFfxFpeConfig).\nThese types of transformations are\nthose that perform pseudonymization, thereby producing a \"surrogate\" as\noutput. This should be used in conjunction with a field on the\ntransformation such as `surrogate_info_type`. This custom info type does\nnot support the use of `detection_rules`.",
@@ -1816,40 +3736,55 @@
"properties": {},
"id": "GooglePrivacyDlpV2beta2SurrogateType"
},
- "GooglePrivacyDlpV2beta1InfoTypeStatistics": {
- "description": "Statistics regarding a specific InfoType.",
+ "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": {
- "infoType": {
- "$ref": "GooglePrivacyDlpV2beta1InfoType",
- "description": "The type of finding this stat is for."
+ "transient": {
+ "$ref": "GooglePrivacyDlpV2beta2TransientCryptoKey"
},
+ "kmsWrapped": {
+ "$ref": "GooglePrivacyDlpV2beta2KmsWrappedCryptoKey"
+ },
+ "unwrapped": {
+ "$ref": "GooglePrivacyDlpV2beta2UnwrappedCryptoKey"
+ }
+ },
+ "id": "GooglePrivacyDlpV2beta2CryptoKey"
+ },
+ "GooglePrivacyDlpV2beta1InfoTypeStatistics": {
+ "properties": {
"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"
+ "id": "GooglePrivacyDlpV2beta1InfoTypeStatistics",
+ "description": "Statistics regarding a specific InfoType.",
+ "type": "object"
},
"GooglePrivacyDlpV2beta2CloudStorageKey": {
"description": "Record key for a finding in a Cloud Storage file.",
"type": "object",
"properties": {
+ "filePath": {
+ "description": "Path to the file.",
+ "type": "string"
+ },
"startOffset": {
"description": "Byte offset of the referenced data in the file.",
"format": "int64",
"type": "string"
- },
- "filePath": {
- "description": "Path to the file.",
- "type": "string"
}
},
"id": "GooglePrivacyDlpV2beta2CloudStorageKey"
},
"GooglePrivacyDlpV2beta1PropertyReference": {
- "description": "A reference to a property relative to the Datastore kind expressions.",
"type": "object",
"properties": {
"name": {
@@ -1857,28 +3792,28 @@
"type": "string"
}
},
- "id": "GooglePrivacyDlpV2beta1PropertyReference"
+ "id": "GooglePrivacyDlpV2beta1PropertyReference",
+ "description": "A reference to a property relative to the Datastore kind expressions."
},
"GooglePrivacyDlpV2beta2KAnonymityConfig": {
"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": "GooglePrivacyDlpV2beta2EntityId"
+ },
"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": "GooglePrivacyDlpV2beta2FieldId"
}
- },
- "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": "GooglePrivacyDlpV2beta2EntityId"
}
},
"id": "GooglePrivacyDlpV2beta2KAnonymityConfig"
},
"GooglePrivacyDlpV2beta2InfoTypeDescription": {
- "description": "InfoType description.",
"type": "object",
"properties": {
"name": {
@@ -1890,54 +3825,27 @@
"type": "string"
},
"supportedBy": {
+ "type": "array",
+ "items": {
+ "enum": [
+ "ENUM_TYPE_UNSPECIFIED",
+ "INSPECT",
+ "RISK_ANALYSIS"
+ ],
+ "type": "string"
+ },
"enumDescriptions": [
"",
"Supported by the inspect operations.",
"Supported by the risk analysis operations."
],
- "description": "Which parts of the API supports this InfoType.",
- "type": "array",
- "items": {
- "type": "string",
- "enum": [
- "ENUM_TYPE_UNSPECIFIED",
- "INSPECT",
- "RISK_ANALYSIS"
- ]
- }
+ "description": "Which parts of the API supports this InfoType."
}
},
- "id": "GooglePrivacyDlpV2beta2InfoTypeDescription"
- },
- "GooglePrivacyDlpV2beta2ReidentifyContentRequest": {
- "description": "Request to re-identify an item.",
- "type": "object",
- "properties": {
- "item": {
- "description": "The item to re-identify. Will be treated as text.",
- "$ref": "GooglePrivacyDlpV2beta2ContentItem"
- },
- "reidentifyTemplateName": {
- "description": "Optional template to use. References an instance of `DeidentifyTemplate`.\nAny configuration directly specified in `reidentify_config` or\n`inspect_config` will override those set in the template. Singular fields\nthat are set in this request will replace their corresponding fields in the\ntemplate. Repeated fields are appended. Singular sub-messages and groups\nare recursively merged.",
- "type": "string"
- },
- "inspectConfig": {
- "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"
- },
- "reidentifyConfig": {
- "description": "Configuration for the re-identification of the content item.\nThis field shares the same proto message type that is used for\nde-identification, however its usage here is for the reversal of the\nprevious de-identification. Re-identification is performed by examining\nthe transformations used to de-identify the items and executing the\nreverse. This requires that only reversible transformations\nbe provided here. The reversible transformations are:\n\n - `CryptoReplaceFfxFpeConfig`",
- "$ref": "GooglePrivacyDlpV2beta2DeidentifyConfig"
- }
- },
- "id": "GooglePrivacyDlpV2beta2ReidentifyContentRequest"
+ "id": "GooglePrivacyDlpV2beta2InfoTypeDescription",
+ "description": "InfoType description."
},
"GooglePrivacyDlpV2beta2InspectDataSourceDetails": {
- "description": "The results of an inspect DataSource job.",
"type": "object",
"properties": {
"result": {
@@ -1949,10 +3857,37 @@
"description": "The configuration used for this job."
}
},
- "id": "GooglePrivacyDlpV2beta2InspectDataSourceDetails"
+ "id": "GooglePrivacyDlpV2beta2InspectDataSourceDetails",
+ "description": "The results of an inspect DataSource job."
+ },
+ "GooglePrivacyDlpV2beta2ReidentifyContentRequest": {
+ "type": "object",
+ "properties": {
+ "inspectConfig": {
+ "$ref": "GooglePrivacyDlpV2beta2InspectConfig",
+ "description": "Configuration for the inspector."
+ },
+ "inspectTemplateName": {
+ "description": "Optional template to use. Any configuration directly specified in\n`inspect_config` will override those set in the template. Singular fields\nthat are set in this request will replace their corresponding fields in the\ntemplate. Repeated fields are appended. Singular sub-messages and groups\nare recursively merged.",
+ "type": "string"
+ },
+ "reidentifyConfig": {
+ "description": "Configuration for the re-identification of the content item.\nThis field shares the same proto message type that is used for\nde-identification, however its usage here is for the reversal of the\nprevious de-identification. Re-identification is performed by examining\nthe transformations used to de-identify the items and executing the\nreverse. This requires that only reversible transformations\nbe provided here. The reversible transformations are:\n\n - `CryptoReplaceFfxFpeConfig`",
+ "$ref": "GooglePrivacyDlpV2beta2DeidentifyConfig"
+ },
+ "item": {
+ "$ref": "GooglePrivacyDlpV2beta2ContentItem",
+ "description": "The item to re-identify. Will be treated as text."
+ },
+ "reidentifyTemplateName": {
+ "description": "Optional template to use. References an instance of `DeidentifyTemplate`.\nAny configuration directly specified in `reidentify_config` or\n`inspect_config` will override those set in the template. Singular fields\nthat are set in this request will replace their corresponding fields in the\ntemplate. Repeated fields are appended. Singular sub-messages and groups\nare recursively merged.",
+ "type": "string"
+ }
+ },
+ "id": "GooglePrivacyDlpV2beta2ReidentifyContentRequest",
+ "description": "Request to re-identify an item."
},
"GooglePrivacyDlpV2beta2LDiversityResult": {
- "description": "Result of the l-diversity computation.",
"type": "object",
"properties": {
"sensitiveValueFrequencyHistogramBuckets": {
@@ -1963,28 +3898,11 @@
}
}
},
- "id": "GooglePrivacyDlpV2beta2LDiversityResult"
- },
- "GooglePrivacyDlpV2beta2InspectContentResponse": {
- "description": "Results of inspecting an item.",
- "type": "object",
- "properties": {
- "result": {
- "description": "The findings.",
- "$ref": "GooglePrivacyDlpV2beta2InspectResult"
- }
- },
- "id": "GooglePrivacyDlpV2beta2InspectContentResponse"
+ "id": "GooglePrivacyDlpV2beta2LDiversityResult",
+ "description": "Result of the l-diversity computation."
},
"GooglePrivacyDlpV2beta2Color": {
- "description": "Represents a color in the RGB color space.",
- "type": "object",
"properties": {
- "red": {
- "description": "The amount of red in the color as a value in the interval [0, 1].",
- "format": "float",
- "type": "number"
- },
"green": {
"description": "The amount of green in the color as a value in the interval [0, 1].",
"format": "float",
@@ -1994,27 +3912,44 @@
"description": "The amount of blue in the color as a value in the interval [0, 1].",
"format": "float",
"type": "number"
+ },
+ "red": {
+ "description": "The amount of red in the color as a value in the interval [0, 1].",
+ "format": "float",
+ "type": "number"
}
},
- "id": "GooglePrivacyDlpV2beta2Color"
+ "id": "GooglePrivacyDlpV2beta2Color",
+ "description": "Represents a color in the RGB color space.",
+ "type": "object"
+ },
+ "GooglePrivacyDlpV2beta2InspectContentResponse": {
+ "type": "object",
+ "properties": {
+ "result": {
+ "$ref": "GooglePrivacyDlpV2beta2InspectResult",
+ "description": "The findings."
+ }
+ },
+ "id": "GooglePrivacyDlpV2beta2InspectContentResponse",
+ "description": "Results of inspecting an item."
},
"GooglePrivacyDlpV2beta1OutputStorageConfig": {
"description": "Cloud repository for storing output.",
"type": "object",
"properties": {
- "table": {
- "$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"
+ },
+ "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": {
"equivalenceClassSize": {
@@ -2030,15 +3965,26 @@
}
}
},
- "id": "GooglePrivacyDlpV2beta1KAnonymityEquivalenceClass"
+ "id": "GooglePrivacyDlpV2beta1KAnonymityEquivalenceClass",
+ "description": "The set of columns' values that share the same k-anonymity value."
+ },
+ "GooglePrivacyDlpV2beta2DatastoreKey": {
+ "description": "Record key for a finding in Cloud Datastore.",
+ "type": "object",
+ "properties": {
+ "entityKey": {
+ "description": "Datastore entity key.",
+ "$ref": "GooglePrivacyDlpV2beta2Key"
+ }
+ },
+ "id": "GooglePrivacyDlpV2beta2DatastoreKey"
},
"GooglePrivacyDlpV2beta2BigQueryTable": {
- "description": "Message defining the location of a BigQuery table. A table is uniquely\nidentified by its project_id, dataset_id, and table_name. Within a query\na table is often referenced with a string in the format of:\n`\u003cproject_id\u003e:\u003cdataset_id\u003e.\u003ctable_id\u003e` or\n`\u003cproject_id\u003e.\u003cdataset_id\u003e.\u003ctable_id\u003e`.",
"type": "object",
"properties": {
"tableId": {
- "description": "Name of the table.",
- "type": "string"
+ "type": "string",
+ "description": "Name of the table."
},
"projectId": {
"description": "The Google Cloud Platform project ID of the project containing the table.\nIf omitted, project ID is inferred from the API call.",
@@ -2049,18 +3995,8 @@
"type": "string"
}
},
- "id": "GooglePrivacyDlpV2beta2BigQueryTable"
- },
- "GooglePrivacyDlpV2beta2DatastoreKey": {
- "description": "Record key for a finding in Cloud Datastore.",
- "type": "object",
- "properties": {
- "entityKey": {
- "$ref": "GooglePrivacyDlpV2beta2Key",
- "description": "Datastore entity key."
- }
- },
- "id": "GooglePrivacyDlpV2beta2DatastoreKey"
+ "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`."
},
"GooglePrivacyDlpV2beta2RedactImageResponse": {
"description": "Results of redacting an image.",
@@ -2082,17 +4018,21 @@
"description": "Metadata returned within GetOperation for an inspect request.",
"type": "object",
"properties": {
- "processedBytes": {
- "description": "Total size in bytes that were processed.",
- "format": "int64",
- "type": "string"
+ "requestOutputConfig": {
+ "description": "Optional location to store findings.",
+ "$ref": "GooglePrivacyDlpV2beta1OutputStorageConfig"
+ },
+ "createTime": {
+ "type": "string",
+ "description": "The time which this request was started.",
+ "format": "google-datetime"
},
"requestStorageConfig": {
"$ref": "GooglePrivacyDlpV2beta1StorageConfig",
"description": "The storage config used to create the Operation."
},
- "totalEstimatedBytes": {
- "description": "Estimate of the number of bytes to process.",
+ "processedBytes": {
+ "description": "Total size in bytes that were processed.",
"format": "int64",
"type": "string"
},
@@ -2102,35 +4042,18 @@
"$ref": "GooglePrivacyDlpV2beta1InfoTypeStatistics"
}
},
- "requestInspectConfig": {
- "description": "The inspect config used to create the Operation.",
- "$ref": "GooglePrivacyDlpV2beta1InspectConfig"
- },
- "requestOutputConfig": {
- "$ref": "GooglePrivacyDlpV2beta1OutputStorageConfig",
- "description": "Optional location to store findings."
- },
- "createTime": {
- "description": "The time which this request was started.",
- "format": "google-datetime",
+ "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."
}
},
"id": "GooglePrivacyDlpV2beta1InspectOperationMetadata"
},
- "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"
- },
"GooglePrivacyDlpV2beta1InfoType": {
"description": "Type of information detected by the API.",
"type": "object",
@@ -2142,25 +4065,32 @@
},
"id": "GooglePrivacyDlpV2beta1InfoType"
},
+ "GooglePrivacyDlpV2beta2RecordKey": {
+ "description": "Message for a unique key indicating a record that contains a finding.",
+ "type": "object",
+ "properties": {
+ "cloudStorageKey": {
+ "$ref": "GooglePrivacyDlpV2beta2CloudStorageKey"
+ },
+ "datastoreKey": {
+ "$ref": "GooglePrivacyDlpV2beta2DatastoreKey"
+ }
+ },
+ "id": "GooglePrivacyDlpV2beta2RecordKey"
+ },
"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": {
- "description": "Bucket is represented as a range, along with replacement values.",
- "type": "object",
"properties": {
- "min": {
- "$ref": "GooglePrivacyDlpV2beta2Value",
- "description": "Lower bound of the range, inclusive. Type should be the same as max if\nused."
- },
"max": {
"$ref": "GooglePrivacyDlpV2beta2Value",
"description": "Upper bound of the range, exclusive; type must match min."
@@ -2168,29 +4098,23 @@
"replacementValue": {
"description": "Replacement value for this bucket. If not provided\nthe default behavior will be to hyphenate the min-max range.",
"$ref": "GooglePrivacyDlpV2beta2Value"
- }
- },
- "id": "GooglePrivacyDlpV2beta2Bucket"
- },
- "GooglePrivacyDlpV2beta2CreateInspectTemplateRequest": {
- "description": "Request message for CreateInspectTemplate.",
- "type": "object",
- "properties": {
- "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": {
- "description": "The InspectTemplate to create.",
- "$ref": "GooglePrivacyDlpV2beta2InspectTemplate"
+ "min": {
+ "$ref": "GooglePrivacyDlpV2beta2Value",
+ "description": "Lower bound of the range, inclusive. Type should be the same as max if\nused."
}
},
- "id": "GooglePrivacyDlpV2beta2CreateInspectTemplateRequest"
+ "id": "GooglePrivacyDlpV2beta2Bucket",
+ "description": "Bucket is represented as a range, along with replacement values.",
+ "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"
},
@@ -2202,13 +4126,25 @@
},
"kMapEstimationResult": {
"$ref": "GooglePrivacyDlpV2beta1KMapEstimationResult"
- },
- "kAnonymityResult": {
- "$ref": "GooglePrivacyDlpV2beta1KAnonymityResult"
}
},
"id": "GooglePrivacyDlpV2beta1RiskAnalysisOperationResult"
},
+ "GooglePrivacyDlpV2beta2CreateInspectTemplateRequest": {
+ "description": "Request message for CreateInspectTemplate.",
+ "type": "object",
+ "properties": {
+ "inspectTemplate": {
+ "$ref": "GooglePrivacyDlpV2beta2InspectTemplate",
+ "description": "The InspectTemplate to create."
+ },
+ "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"
+ }
+ },
+ "id": "GooglePrivacyDlpV2beta2CreateInspectTemplateRequest"
+ },
"GooglePrivacyDlpV2beta1CategoricalStatsConfig": {
"description": "Compute numerical stats over an individual column, including\nnumber of distinct values and value count distribution.",
"type": "object",
@@ -2223,16 +4159,6 @@
"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",
- "type": "string"
- },
"valueFrequencyLowerBound": {
"description": "Lower bound on the value frequency of the values in this bucket.",
"format": "int64",
@@ -2244,6 +4170,16 @@
"items": {
"$ref": "GooglePrivacyDlpV2beta2ValueFrequency"
}
+ },
+ "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",
+ "type": "string"
}
},
"id": "GooglePrivacyDlpV2beta2CategoricalStatsHistogramBucket"
@@ -2277,10 +4213,6 @@
"description": "Result of the numerical stats computation.",
"type": "object",
"properties": {
- "minValue": {
- "description": "Minimum value appearing in the column.",
- "$ref": "GooglePrivacyDlpV2beta2Value"
- },
"maxValue": {
"description": "Maximum value appearing in the column.",
"$ref": "GooglePrivacyDlpV2beta2Value"
@@ -2291,6 +4223,10 @@
"items": {
"$ref": "GooglePrivacyDlpV2beta2Value"
}
+ },
+ "minValue": {
+ "$ref": "GooglePrivacyDlpV2beta2Value",
+ "description": "Minimum value appearing in the column."
}
},
"id": "GooglePrivacyDlpV2beta2NumericalStatsResult"
@@ -2300,17 +4236,17 @@
"type": "object",
"properties": {
"createTime": {
+ "type": "string",
"description": "The time which this request was started.",
- "format": "google-datetime",
- "type": "string"
+ "format": "google-datetime"
},
"requestedSourceTable": {
"$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"
@@ -2319,21 +4255,21 @@
"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": "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": {
"$ref": "GoogleProtobufEmpty",
"description": "If no semantic tag is indicated, we infer the statistical model from\nthe distribution of values in the input data"
},
"field": {
- "description": "Identifies the column. [required]",
- "$ref": "GooglePrivacyDlpV2beta2FieldId"
- },
- "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"
+ "$ref": "GooglePrivacyDlpV2beta2FieldId",
+ "description": "Identifies the column. [required]"
}
},
"id": "GooglePrivacyDlpV2beta2TaggedField"
@@ -2351,8 +4287,8 @@
"type": "string"
},
"item": {
- "description": "The item to inspect.",
- "$ref": "GooglePrivacyDlpV2beta2ContentItem"
+ "$ref": "GooglePrivacyDlpV2beta2ContentItem",
+ "description": "The item to inspect."
}
},
"id": "GooglePrivacyDlpV2beta2InspectContentRequest"
@@ -2361,31 +4297,31 @@
"description": "The DeidentifyTemplates contains instructions on how to deidentify content.",
"type": "object",
"properties": {
- "displayName": {
- "description": "Display name (max 256 chars).",
+ "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"
},
"description": {
"description": "Short description (max 256 chars).",
"type": "string"
},
+ "displayName": {
+ "description": "Display name (max 256 chars).",
+ "type": "string"
+ },
"deidentifyConfig": {
"$ref": "GooglePrivacyDlpV2beta2DeidentifyConfig",
"description": "///////////// // The core content of the template // ///////////////"
},
"createTime": {
+ "type": "string",
"description": "The creation timestamp of a inspectTemplate, output only field.",
- "format": "google-datetime",
- "type": "string"
+ "format": "google-datetime"
},
"updateTime": {
"description": "The last update timestamp of a inspectTemplate, output only field.",
"format": "google-datetime",
"type": "string"
- },
- "name": {
- "description": "The template name. Output only.\n\nThe template will have one of the following formats:\n`projects/PROJECT_ID/deidentifyTemplates/TEMPLATE_ID` OR\n`organizations/ORGANIZATION_ID/deidentifyTemplates/TEMPLATE_ID`",
- "type": "string"
}
},
"id": "GooglePrivacyDlpV2beta2DeidentifyTemplate"
@@ -2395,1961 +4331,22 @@
"type": "object",
"properties": {
"kind": {
- "$ref": "GooglePrivacyDlpV2beta2KindExpression",
- "description": "The kind to process."
+ "description": "The kind to process.",
+ "$ref": "GooglePrivacyDlpV2beta2KindExpression"
},
"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."
- }
- },
- "id": "GooglePrivacyDlpV2beta2DatastoreOptions"
- },
- "GooglePrivacyDlpV2beta2InspectTemplate": {
- "description": "The inspectTemplate contains a configuration (set of types of sensitive data\nto be detected) to be used anywhere you otherwise would normally specify\nInspectConfig.",
- "type": "object",
- "properties": {
- "inspectConfig": {
- "description": "The core content of the template. Configuration of the scanning process.",
- "$ref": "GooglePrivacyDlpV2beta2InspectConfig"
- },
- "displayName": {
- "description": "Display name (max 256 chars).",
- "type": "string"
- },
- "description": {
- "description": "Short description (max 256 chars).",
- "type": "string"
- },
- "createTime": {
- "description": "The creation timestamp of a inspectTemplate, output only field.",
- "format": "google-datetime",
- "type": "string"
- },
- "updateTime": {
- "description": "The last update timestamp of a inspectTemplate, output only field.",
- "format": "google-datetime",
- "type": "string"
- },
- "name": {
- "description": "The template name. Output only.\n\nThe template will have one of the following formats:\n`projects/PROJECT_ID/inspectTemplates/TEMPLATE_ID` OR\n`organizations/ORGANIZATION_ID/inspectTemplates/TEMPLATE_ID`",
- "type": "string"
- }
- },
- "id": "GooglePrivacyDlpV2beta2InspectTemplate"
- },
- "GooglePrivacyDlpV2beta2CharsToIgnore": {
- "description": "Characters to skip when doing deidentification of a value. These will be left\nalone and skipped.",
- "type": "object",
- "properties": {
- "charactersToSkip": {
- "type": "string"
- },
- "commonCharactersToIgnore": {
- "enumDescriptions": [
- "",
- "0-9",
- "A-Z",
- "a-z",
- "US Punctuation, one of !\"#$%&'()*+,-./:;\u003c=\u003e?@[\\]^_`{|}~",
- "Whitespace character, one of [ \\t\\n\\x0B\\f\\r]"
- ],
- "enum": [
- "COMMON_CHARS_TO_IGNORE_UNSPECIFIED",
- "NUMERIC",
- "ALPHA_UPPER_CASE",
- "ALPHA_LOWER_CASE",
- "PUNCTUATION",
- "WHITESPACE"
- ],
- "type": "string"
- }
- },
- "id": "GooglePrivacyDlpV2beta2CharsToIgnore"
- },
- "GoogleProtobufEmpty": {
- "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
- "type": "object",
- "properties": {},
- "id": "GoogleProtobufEmpty"
- },
- "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"
- },
- "GooglePrivacyDlpV2beta2FieldId": {
- "description": "General identifier of a data field in a storage service.",
- "type": "object",
- "properties": {
- "name": {
- "description": "Name describing the field.",
- "type": "string"
- }
- },
- "id": "GooglePrivacyDlpV2beta2FieldId"
- },
- "GooglePrivacyDlpV2beta2AnalyzeDataSourceRiskRequest": {
- "description": "Request for creating a risk analysis DlpJob.",
- "type": "object",
- "properties": {
- "jobConfig": {
- "description": "Configuration for this risk analysis job.",
- "$ref": "GooglePrivacyDlpV2beta2RiskAnalysisJobConfig"
- }
- },
- "id": "GooglePrivacyDlpV2beta2AnalyzeDataSourceRiskRequest"
- },
- "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."
- },
- "inspectConfig": {
- "description": "Configuration for the inspector.\nItems specified here will override the template referenced by the\ninspect_template_name argument.",
- "$ref": "GooglePrivacyDlpV2beta2InspectConfig"
- },
- "inspectTemplateName": {
- "description": "Optional template to use. Any configuration directly specified in\ninspect_config will override those set in the template. Singular fields\nthat are set in this request will replace their corresponding fields in the\ntemplate. Repeated fields are appended. Singular sub-messages and groups\nare recursively merged.",
- "type": "string"
- }
- },
- "id": "GooglePrivacyDlpV2beta2DeidentifyContentRequest"
- },
- "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": {
- "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": "GooglePrivacyDlpV2beta1KMapEstimationQuasiIdValues"
- }
- },
- "minAnonymity": {
- "description": "Always positive.",
- "format": "int64",
- "type": "string"
- }
- },
- "id": "GooglePrivacyDlpV2beta1KMapEstimationHistogramBucket"
- },
- "GooglePrivacyDlpV2beta2InspectConfig": {
- "description": "Configuration description of the scanning process.\nWhen used with redactContent only info_types and min_likelihood are currently\nused.",
- "type": "object",
- "properties": {
- "excludeInfoTypes": {
- "description": "When true, excludes type information of the findings.",
- "type": "boolean"
- },
- "minLikelihood": {
- "description": "Only returns findings equal or above this threshold. The default is\nPOSSIBLE.",
- "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"
- ]
- },
- "infoTypes": {
- "description": "Restricts what info_types to look for. The values must correspond to\nInfoType values returned by ListInfoTypes or found in documentation.\nEmpty info_types runs all enabled detectors.",
- "type": "array",
- "items": {
- "$ref": "GooglePrivacyDlpV2beta2InfoType"
- }
- },
- "includeQuote": {
- "description": "When true, a contextual quote from the data that triggered a finding is\nincluded in the response; see Finding.quote.",
- "type": "boolean"
- },
- "customInfoTypes": {
- "description": "Custom infoTypes provided by the user.",
- "type": "array",
- "items": {
- "$ref": "GooglePrivacyDlpV2beta2CustomInfoType"
- }
- },
- "limits": {
- "$ref": "GooglePrivacyDlpV2beta2FindingLimits"
- }
- },
- "id": "GooglePrivacyDlpV2beta2InspectConfig"
- },
- "GooglePrivacyDlpV2beta1CloudStorageOptions": {
- "description": "Options defining a file or a set of files (path ending with *) within\na Google Cloud Storage bucket.",
- "type": "object",
- "properties": {
- "fileSet": {
- "$ref": "GooglePrivacyDlpV2beta1FileSet"
- }
- },
- "id": "GooglePrivacyDlpV2beta1CloudStorageOptions"
- },
- "GooglePrivacyDlpV2beta2QuasiIdField": {
- "description": "A quasi-identifier column has a custom_tag, used to know which column\nin the data corresponds to which column in the statistical model.",
- "type": "object",
- "properties": {
- "field": {
- "$ref": "GooglePrivacyDlpV2beta2FieldId"
- },
- "customTag": {
- "type": "string"
- }
- },
- "id": "GooglePrivacyDlpV2beta2QuasiIdField"
- },
- "GooglePrivacyDlpV2beta2AnalyzeDataSourceRiskDetails": {
- "description": "Result of a risk analysis operation request.",
- "type": "object",
- "properties": {
- "kMapEstimationResult": {
- "$ref": "GooglePrivacyDlpV2beta2KMapEstimationResult"
- },
- "lDiversityResult": {
- "$ref": "GooglePrivacyDlpV2beta2LDiversityResult"
- },
- "requestedSourceTable": {
- "description": "Input dataset to compute metrics over.",
- "$ref": "GooglePrivacyDlpV2beta2BigQueryTable"
- },
- "requestedPrivacyMetric": {
- "$ref": "GooglePrivacyDlpV2beta2PrivacyMetric",
- "description": "Privacy metric to compute."
- },
- "categoricalStatsResult": {
- "$ref": "GooglePrivacyDlpV2beta2CategoricalStatsResult"
- },
- "numericalStatsResult": {
- "$ref": "GooglePrivacyDlpV2beta2NumericalStatsResult"
- },
- "kAnonymityResult": {
- "$ref": "GooglePrivacyDlpV2beta2KAnonymityResult"
- }
- },
- "id": "GooglePrivacyDlpV2beta2AnalyzeDataSourceRiskDetails"
- },
- "GooglePrivacyDlpV2beta2BigQueryOptions": {
- "description": "Options defining BigQuery table and row identifiers.",
- "type": "object",
- "properties": {
- "tableReference": {
- "description": "Complete BigQuery table reference.",
- "$ref": "GooglePrivacyDlpV2beta2BigQueryTable"
- },
- "identifyingFields": {
- "description": "References to fields uniquely identifying rows within the table.\nNested fields in the format, like `person.birthdate.year`, are allowed.",
- "type": "array",
- "items": {
- "$ref": "GooglePrivacyDlpV2beta2FieldId"
- }
- }
- },
- "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"
- },
- "GooglePrivacyDlpV2beta2TransformationOverview": {
- "description": "Overview of the modifications that occurred.",
- "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": "GooglePrivacyDlpV2beta2TransformationSummary"
- }
- }
- },
- "id": "GooglePrivacyDlpV2beta2TransformationOverview"
- },
- "GooglePrivacyDlpV2beta1InspectOperationResult": {
- "description": "The operational data.",
- "type": "object",
- "properties": {
- "name": {
- "description": "The server-assigned name, which is only unique within the same service that\noriginally returns it. If you use the default HTTP mapping, the\n`name` should have the format of `inspect/results/{id}`.",
- "type": "string"
- }
- },
- "id": "GooglePrivacyDlpV2beta1InspectOperationResult"
- },
- "GooglePrivacyDlpV2beta1KAnonymityHistogramBucket": {
- "description": "Histogram bucket of equivalence class sizes in the table.",
- "type": "object",
- "properties": {
- "equivalenceClassSizeLowerBound": {
- "description": "Lower bound on the size of the equivalence classes in this bucket.",
- "format": "int64",
- "type": "string"
- },
- "equivalenceClassSizeUpperBound": {
- "description": "Upper bound on the size of the equivalence classes in this bucket.",
- "format": "int64",
- "type": "string"
- },
- "bucketSize": {
- "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": {
- "description": "Response message for ListInspectTemplates.",
- "type": "object",
- "properties": {
- "nextPageToken": {
- "description": "If the next page is available then the next page token to be used\nin following ListInspectTemplates request.",
- "type": "string"
- },
- "inspectTemplates": {
- "description": "List of inspectTemplates, up to page_size in ListInspectTemplatesRequest.",
- "type": "array",
- "items": {
- "$ref": "GooglePrivacyDlpV2beta2InspectTemplate"
- }
- }
- },
- "id": "GooglePrivacyDlpV2beta2ListInspectTemplatesResponse"
- },
- "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.",
- "type": "object",
- "properties": {
- "sensitiveValueFrequencyHistogramBuckets": {
- "description": "Histogram of l-diversity equivalence class sensitive value frequencies.",
- "type": "array",
- "items": {
- "$ref": "GooglePrivacyDlpV2beta1LDiversityHistogramBucket"
- }
- }
- },
- "id": "GooglePrivacyDlpV2beta1LDiversityResult"
- },
- "GoogleTypeTimeOfDay": {
- "description": "Represents a time of day. The date and time zone are either not significant\nor are specified elsewhere. An API may choose to allow leap seconds. Related\ntypes are google.type.Date and `google.protobuf.Timestamp`.",
- "type": "object",
- "properties": {
- "hours": {
- "description": "Hours of day in 24 hour format. Should be from 0 to 23. An API may choose\nto allow the value \"24:00:00\" for scenarios like business closing time.",
- "format": "int32",
- "type": "integer"
- },
- "nanos": {
- "description": "Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.",
- "format": "int32",
- "type": "integer"
- },
- "seconds": {
- "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": "GoogleTypeTimeOfDay"
- },
- "GooglePrivacyDlpV2beta2LDiversityEquivalenceClass": {
- "description": "The set of columns' values that share the same ldiversity 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": "GooglePrivacyDlpV2beta2Value"
- }
- },
- "numDistinctSensitiveValues": {
- "description": "Number of distinct sensitive values in this equivalence class.",
- "format": "int64",
- "type": "string"
- },
- "topSensitiveValues": {
- "description": "Estimated frequencies of top sensitive values.",
- "type": "array",
- "items": {
- "$ref": "GooglePrivacyDlpV2beta2ValueFrequency"
- }
- }
- },
- "id": "GooglePrivacyDlpV2beta2LDiversityEquivalenceClass"
- },
- "GooglePrivacyDlpV2beta2CategoricalStatsConfig": {
- "description": "Compute numerical stats over an individual column, including\nnumber of distinct values and value count distribution.",
- "type": "object",
- "properties": {
- "field": {
- "description": "Field to compute categorical stats on. All column types are\nsupported except for arrays and structs. However, it may be more\ninformative to use NumericalStats when the field type is supported,\ndepending on the data.",
- "$ref": "GooglePrivacyDlpV2beta2FieldId"
- }
- },
- "id": "GooglePrivacyDlpV2beta2CategoricalStatsConfig"
- },
- "GooglePrivacyDlpV2beta1LDiversityConfig": {
- "description": "l-diversity metric, used for analysis of reidentification risk.",
- "type": "object",
- "properties": {
- "sensitiveAttribute": {
- "description": "Sensitive field for computing the l-value.",
- "$ref": "GooglePrivacyDlpV2beta1FieldId"
- },
- "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"
- }
- }
- },
- "id": "GooglePrivacyDlpV2beta1LDiversityConfig"
- },
- "GooglePrivacyDlpV2beta2ValueFrequency": {
- "description": "A value of a field, including its frequency.",
- "type": "object",
- "properties": {
- "value": {
- "$ref": "GooglePrivacyDlpV2beta2Value",
- "description": "A value contained in the field in question."
- },
- "count": {
- "description": "How many times the value is contained in the field.",
- "format": "int64",
- "type": "string"
- }
- },
- "id": "GooglePrivacyDlpV2beta2ValueFrequency"
- },
- "GooglePrivacyDlpV2beta2ReplaceValueConfig": {
- "description": "Replace each input value with a given `Value`.",
- "type": "object",
- "properties": {
- "newValue": {
- "description": "Value to replace it with.",
- "$ref": "GooglePrivacyDlpV2beta2Value"
- }
- },
- "id": "GooglePrivacyDlpV2beta2ReplaceValueConfig"
- },
- "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": {
- "$ref": "GooglePrivacyDlpV2beta2BigQueryTable",
- "description": "Auxiliary table location. [required]"
- },
- "quasiIds": {
- "description": "Quasi-identifier columns. [required]",
- "type": "array",
- "items": {
- "$ref": "GooglePrivacyDlpV2beta2QuasiIdField"
- }
- },
- "relativeFrequency": {
- "$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.",
- "type": "object",
- "properties": {
- "cloudStorageOptions": {
- "description": "Google Cloud Storage options specification.",
- "$ref": "GooglePrivacyDlpV2beta1CloudStorageOptions"
- },
- "datastoreOptions": {
- "description": "Google Cloud Datastore options specification.",
- "$ref": "GooglePrivacyDlpV2beta1DatastoreOptions"
- },
- "bigQueryOptions": {
- "$ref": "GooglePrivacyDlpV2beta1BigQueryOptions",
- "description": "BigQuery options specification."
- }
- },
- "id": "GooglePrivacyDlpV2beta1StorageConfig"
- },
- "GooglePrivacyDlpV2beta1BigQueryOptions": {
- "description": "Options defining BigQuery table and row identifiers.",
- "type": "object",
- "properties": {
- "tableReference": {
- "description": "Complete BigQuery table reference.",
- "$ref": "GooglePrivacyDlpV2beta1BigQueryTable"
- },
- "identifyingFields": {
- "description": "References to fields uniquely identifying rows within the table.\nNested fields in the format, like `person.birthdate.year`, are allowed.",
- "type": "array",
- "items": {
- "$ref": "GooglePrivacyDlpV2beta1FieldId"
- }
- }
- },
- "id": "GooglePrivacyDlpV2beta1BigQueryOptions"
- },
- "GooglePrivacyDlpV2beta1PrivacyMetric": {
- "description": "Privacy metric to compute for reidentification risk analysis.",
- "type": "object",
- "properties": {
- "lDiversityConfig": {
- "$ref": "GooglePrivacyDlpV2beta1LDiversityConfig"
- },
- "numericalStatsConfig": {
- "$ref": "GooglePrivacyDlpV2beta1NumericalStatsConfig"
- },
- "kAnonymityConfig": {
- "$ref": "GooglePrivacyDlpV2beta1KAnonymityConfig"
- },
- "categoricalStatsConfig": {
- "$ref": "GooglePrivacyDlpV2beta1CategoricalStatsConfig"
- },
- "kMapEstimationConfig": {
- "$ref": "GooglePrivacyDlpV2beta1KMapEstimationConfig"
- }
- },
- "id": "GooglePrivacyDlpV2beta1PrivacyMetric"
- },
- "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"
- },
- "codepointRange": {
- "description": "Character offsets within a content item, included when content type\nis a text. Default charset assumed to be UTF-8.",
- "$ref": "GooglePrivacyDlpV2beta2Range"
- },
- "fieldId": {
- "$ref": "GooglePrivacyDlpV2beta2FieldId",
- "description": "Field id of the field containing the finding."
- },
- "imageBoxes": {
- "description": "Location within an image's pixels.",
- "type": "array",
- "items": {
- "$ref": "GooglePrivacyDlpV2beta2ImageLocation"
- }
- },
- "byteRange": {
- "description": "Zero-based byte offsets within a content item.",
- "$ref": "GooglePrivacyDlpV2beta2Range"
- }
- },
- "id": "GooglePrivacyDlpV2beta2Location"
- },
- "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`."
- },
- "item": {
- "description": "The re-identified item.",
- "$ref": "GooglePrivacyDlpV2beta2ContentItem"
- }
- },
- "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"
- },
- "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"
- }
- },
- "numDistinctSensitiveValues": {
- "description": "Number of distinct sensitive values in this equivalence class.",
- "format": "int64",
- "type": "string"
- },
- "topSensitiveValues": {
- "description": "Estimated frequencies of top sensitive values.",
- "type": "array",
- "items": {
- "$ref": "GooglePrivacyDlpV2beta1ValueFrequency"
- }
- }
- },
- "id": "GooglePrivacyDlpV2beta1LDiversityEquivalenceClass"
- },
- "GooglePrivacyDlpV2beta1NumericalStatsConfig": {
- "description": "Compute numerical stats over an individual column, including\nmin, max, and quantiles.",
- "type": "object",
- "properties": {
- "field": {
- "description": "Field to compute numerical stats on. Supported types are\ninteger, float, date, datetime, timestamp, time.",
- "$ref": "GooglePrivacyDlpV2beta1FieldId"
- }
- },
- "id": "GooglePrivacyDlpV2beta1NumericalStatsConfig"
- },
- "GooglePrivacyDlpV2beta2InfoTypeTransformation": {
- "description": "A transformation to apply to text that is identified as a specific\ninfo_type.",
- "type": "object",
- "properties": {
- "primitiveTransformation": {
- "description": "Primitive transformation to apply to the infoType. [required]",
- "$ref": "GooglePrivacyDlpV2beta2PrimitiveTransformation"
- },
- "infoTypes": {
- "description": "InfoTypes to apply the transformation to. Empty list will match all\navailable infoTypes for this transformation.",
- "type": "array",
- "items": {
- "$ref": "GooglePrivacyDlpV2beta2InfoType"
- }
- }
- },
- "id": "GooglePrivacyDlpV2beta2InfoTypeTransformation"
- },
- "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": "GooglePrivacyDlpV2beta2CloudStorageOptions"
- },
- "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": {
- "description": "Field within the record this condition is evaluated against. [required]",
- "$ref": "GooglePrivacyDlpV2beta2FieldId"
- },
- "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",
- "NOT_EQUAL_TO",
- "GREATER_THAN",
- "LESS_THAN",
- "GREATER_THAN_OR_EQUALS",
- "LESS_THAN_OR_EQUALS",
- "EXISTS"
- ],
- "description": "Operator used to compare the field or infoType to the value. [required]",
- "type": "string"
- },
- "value": {
- "$ref": "GooglePrivacyDlpV2beta2Value",
- "description": "Value to compare against. [Required, except for `EXISTS` tests.]"
- }
- },
- "id": "GooglePrivacyDlpV2beta2Condition"
- },
- "GooglePrivacyDlpV2beta2TableLocation": {
- "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": "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.",
- "type": "array",
- "items": {
- "$ref": "GooglePrivacyDlpV2beta2KMapEstimationHistogramBucket"
- }
- }
- },
- "id": "GooglePrivacyDlpV2beta2KMapEstimationResult"
- },
- "GooglePrivacyDlpV2beta2PrimitiveTransformation": {
- "description": "A rule for transforming a value.",
- "type": "object",
- "properties": {
- "replaceWithInfoTypeConfig": {
- "$ref": "GooglePrivacyDlpV2beta2ReplaceWithInfoTypeConfig"
- },
- "cryptoHashConfig": {
- "$ref": "GooglePrivacyDlpV2beta2CryptoHashConfig"
- },
- "cryptoReplaceFfxFpeConfig": {
- "$ref": "GooglePrivacyDlpV2beta2CryptoReplaceFfxFpeConfig"
- },
- "replaceConfig": {
- "$ref": "GooglePrivacyDlpV2beta2ReplaceValueConfig"
- },
- "timePartConfig": {
- "$ref": "GooglePrivacyDlpV2beta2TimePartConfig"
- },
- "fixedSizeBucketingConfig": {
- "$ref": "GooglePrivacyDlpV2beta2FixedSizeBucketingConfig"
- },
- "characterMaskConfig": {
- "$ref": "GooglePrivacyDlpV2beta2CharacterMaskConfig"
- },
- "redactConfig": {
- "$ref": "GooglePrivacyDlpV2beta2RedactConfig"
- },
- "bucketingConfig": {
- "$ref": "GooglePrivacyDlpV2beta2BucketingConfig"
- }
- },
- "id": "GooglePrivacyDlpV2beta2PrimitiveTransformation"
- },
- "GooglePrivacyDlpV2beta2KAnonymityEquivalenceClass": {
- "description": "The set of columns' values that share the same ldiversity value",
- "type": "object",
- "properties": {
- "equivalenceClassSize": {
- "description": "Size of the equivalence class, for example number of rows with the\nabove set of values.",
- "format": "int64",
- "type": "string"
- },
- "quasiIdsValues": {
- "description": "Set of values defining the equivalence class. One value per\nquasi-identifier column in the original KAnonymity metric message.\nThe order is always the same as the original request.",
- "type": "array",
- "items": {
- "$ref": "GooglePrivacyDlpV2beta2Value"
- }
- }
- },
- "id": "GooglePrivacyDlpV2beta2KAnonymityEquivalenceClass"
- },
- "GooglePrivacyDlpV2beta1NumericalStatsResult": {
- "description": "Result of the numerical stats computation.",
- "type": "object",
- "properties": {
- "maxValue": {
- "$ref": "GooglePrivacyDlpV2beta1Value",
- "description": "Maximum value appearing in the column."
- },
- "quantileValues": {
- "description": "List of 99 values that partition the set of field values into 100 equal\nsized buckets.",
- "type": "array",
- "items": {
- "$ref": "GooglePrivacyDlpV2beta1Value"
- }
- },
- "minValue": {
- "description": "Minimum value appearing in the column.",
- "$ref": "GooglePrivacyDlpV2beta1Value"
- }
- },
- "id": "GooglePrivacyDlpV2beta1NumericalStatsResult"
- },
- "GooglePrivacyDlpV2beta2InfoType": {
- "description": "Type of information detected by the API.",
- "type": "object",
- "properties": {
- "name": {
- "description": "Name of the information type.",
- "type": "string"
- }
- },
- "id": "GooglePrivacyDlpV2beta2InfoType"
- },
- "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"
- }
- }
- },
- "id": "GooglePrivacyDlpV2beta2ListDlpJobsResponse"
- },
- "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": {
- "wordList": {
- "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": {
- "kind": {
- "$ref": "GooglePrivacyDlpV2beta1KindExpression",
- "description": "The kind to process."
- },
- "projection": {
- "description": "Properties to scan. If none are specified, all properties will be scanned\nby default.",
- "type": "array",
- "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"
- },
- "GooglePrivacyDlpV2beta2RiskAnalysisJobConfig": {
- "description": "Configuration for a risk analysis job.",
- "type": "object",
- "properties": {
- "privacyMetric": {
- "$ref": "GooglePrivacyDlpV2beta2PrivacyMetric",
- "description": "Privacy metric to compute."
- },
- "sourceTable": {
- "$ref": "GooglePrivacyDlpV2beta2BigQueryTable",
- "description": "Input dataset to compute metrics over."
- }
- },
- "id": "GooglePrivacyDlpV2beta2RiskAnalysisJobConfig"
- },
- "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]",
- "format": "byte",
- "type": "string"
- }
- },
- "id": "GooglePrivacyDlpV2beta2UnwrappedCryptoKey"
- },
- "GooglePrivacyDlpV2beta2StorageConfig": {
- "description": "Shared message indicating Cloud storage type.",
- "type": "object",
- "properties": {
- "cloudStorageOptions": {
- "$ref": "GooglePrivacyDlpV2beta2CloudStorageOptions",
- "description": "Google Cloud Storage options specification."
- },
- "datastoreOptions": {
- "description": "Google Cloud Datastore options specification.",
- "$ref": "GooglePrivacyDlpV2beta2DatastoreOptions"
- },
- "bigQueryOptions": {
- "$ref": "GooglePrivacyDlpV2beta2BigQueryOptions",
- "description": "BigQuery options specification."
- }
- },
- "id": "GooglePrivacyDlpV2beta2StorageConfig"
- },
- "GooglePrivacyDlpV2beta2InfoTypeTransformations": {
- "description": "A type of transformation that will scan unstructured text and\napply various `PrimitiveTransformation`s to each finding, where the\ntransformation is applied to only values that were identified as a specific\ninfo_type.",
- "type": "object",
- "properties": {
- "transformations": {
- "description": "Transformation for each infoType. Cannot specify more than one\nfor a given infoType. [required]",
- "type": "array",
- "items": {
- "$ref": "GooglePrivacyDlpV2beta2InfoTypeTransformation"
- }
- }
- },
- "id": "GooglePrivacyDlpV2beta2InfoTypeTransformations"
- },
- "GooglePrivacyDlpV2beta2KAnonymityHistogramBucket": {
- "type": "object",
- "properties": {
- "equivalenceClassSizeLowerBound": {
- "description": "Lower bound on the size of the equivalence classes in this bucket.",
- "format": "int64",
- "type": "string"
- },
- "equivalenceClassSizeUpperBound": {
- "description": "Upper bound on the size of the equivalence classes in this bucket.",
- "format": "int64",
- "type": "string"
- },
- "bucketSize": {
- "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": {
- "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": {
- "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",
- "items": {
- "$ref": "GooglePrivacyDlpV2beta1InfoTypeLimit"
- }
- },
- "maxFindings": {
- "description": "Limits the number of findings per content item or long running operation.",
- "format": "int32",
- "type": "integer"
- },
- "infoTypes": {
- "description": "Restricts what info_types to look for. The values must correspond to\nInfoType values returned by ListInfoTypes or found in documentation.\nEmpty info_types runs all enabled detectors.",
- "type": "array",
- "items": {
- "$ref": "GooglePrivacyDlpV2beta1InfoType"
- }
- },
- "includeQuote": {
- "description": "When true, a contextual quote from the data that triggered a finding is\nincluded in the response; see Finding.quote.",
- "type": "boolean"
- }
- },
- "id": "GooglePrivacyDlpV2beta1InspectConfig"
- },
- "GooglePrivacyDlpV2beta2Value": {
- "description": "Set of primitive values supported by the system.\nNote that for the purposes of inspection or transformation, the number\nof bytes considered to comprise a 'Value' is based on its representation\nas a UTF-8 encoded string. For example, if 'integer_value' is set to\n123456789, the number of bytes would be counted as 9, even though an\nint64 only holds up to 8 bytes of data.",
- "type": "object",
- "properties": {
- "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"
- }
- },
- "id": "GooglePrivacyDlpV2beta2Value"
- },
- "GooglePrivacyDlpV2beta1Projection": {
- "description": "A representation of a Datastore property in a projection.",
- "type": "object",
- "properties": {
- "property": {
- "description": "The property to project.",
- "$ref": "GooglePrivacyDlpV2beta1PropertyReference"
- }
- },
- "id": "GooglePrivacyDlpV2beta1Projection"
- },
- "GooglePrivacyDlpV2beta2ImageRedactionConfig": {
- "description": "Configuration for determining how redaction of images should occur.",
- "type": "object",
- "properties": {
- "infoType": {
- "description": "Only one per info_type should be provided per request. If not\nspecified, and redact_all_text is false, the DLP API will redact all\ntext that it matches against all info_types that are found, but not\nspecified in another ImageRedactionConfig.",
- "$ref": "GooglePrivacyDlpV2beta2InfoType"
- },
- "redactionColor": {
- "description": "The color to use when redacting content from an image. If not specified,\nthe default is black.",
- "$ref": "GooglePrivacyDlpV2beta2Color"
- },
- "redactAllText": {
- "description": "If true, all text found in the image, regardless whether it matches an\ninfo_type, is redacted.",
- "type": "boolean"
- }
- },
- "id": "GooglePrivacyDlpV2beta2ImageRedactionConfig"
- },
- "GooglePrivacyDlpV2beta2RequestedOptions": {
- "type": "object",
- "properties": {
- "snapshotInspectTemplate": {
- "$ref": "GooglePrivacyDlpV2beta2InspectTemplate",
- "description": "If run with an inspect template, a snapshot of it's state at the time of\nthis run."
- },
- "jobConfig": {
- "$ref": "GooglePrivacyDlpV2beta2InspectJobConfig"
- }
- },
- "id": "GooglePrivacyDlpV2beta2RequestedOptions"
- },
- "GoogleTypeDate": {
- "description": "Represents a whole calendar date, e.g. date of birth. The time of day and\ntime zone are either specified elsewhere or are not significant. The date\nis relative to the Proleptic Gregorian Calendar. The day may be 0 to\nrepresent a year and month where the day is not significant, e.g. credit card\nexpiration date. The year may be 0 to represent a month and day independent\nof year, e.g. anniversary date. Related types are google.type.TimeOfDay\nand `google.protobuf.Timestamp`.",
- "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": "GoogleTypeDate"
- },
- "GooglePrivacyDlpV2beta2ListInfoTypesResponse": {
- "description": "Response to the ListInfoTypes request.",
- "type": "object",
- "properties": {
- "infoTypes": {
- "description": "Set of sensitive infoTypes.",
- "type": "array",
- "items": {
- "$ref": "GooglePrivacyDlpV2beta2InfoTypeDescription"
- }
- }
- },
- "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"
- },
- "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": {
- "description": "Composite key indicating which field contains the entity identifier.",
- "$ref": "GooglePrivacyDlpV2beta1FieldId"
- }
- },
- "id": "GooglePrivacyDlpV2beta1EntityId"
- },
- "GooglePrivacyDlpV2beta1CustomInfoType": {
- "description": "Custom information type provided by the user. Used to find domain-specific\nsensitive information configurable to the data in question.",
- "type": "object",
- "properties": {
- "infoType": {
- "description": "Info type configuration. All custom info types must have configurations\nthat do not conflict with built-in info types or other custom info types.",
- "$ref": "GooglePrivacyDlpV2beta1InfoType"
- },
- "dictionary": {
- "description": "Dictionary-based custom info type.",
- "$ref": "GooglePrivacyDlpV2beta1Dictionary"
- },
- "surrogateType": {
- "description": "Surrogate info type.",
- "$ref": "GooglePrivacyDlpV2beta1SurrogateType"
- }
- },
- "id": "GooglePrivacyDlpV2beta1CustomInfoType"
- },
- "GooglePrivacyDlpV2beta1AuxiliaryTable": {
- "description": "An auxiliary table contains statistical information on the relative\nfrequency of different quasi-identifiers values. It has one or several\nquasi-identifiers columns, and one column that indicates the relative\nfrequency of each quasi-identifier tuple.\nIf a tuple is present in the data but not in the auxiliary table, the\ncorresponding relative frequency is assumed to be zero (and thus, the\ntuple is highly reidentifiable).",
- "type": "object",
- "properties": {
- "quasiIds": {
- "description": "Quasi-identifier columns. [required]",
- "type": "array",
- "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]"
- },
- "table": {
- "description": "Auxiliary table location. [required]",
- "$ref": "GooglePrivacyDlpV2beta1BigQueryTable"
- }
- },
- "id": "GooglePrivacyDlpV2beta1AuxiliaryTable"
- },
- "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"
- }
- }
- },
- "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": {
- "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": "GoogleRpcStatus"
- },
- "GooglePrivacyDlpV2beta2CreateDeidentifyTemplateRequest": {
- "description": "Request message for CreateDeidentifyTemplate.",
- "type": "object",
- "properties": {
- "templateId": {
- "description": "The template id can contain uppercase and lowercase letters,\nnumbers, and hyphens; that is, it must match the regular\nexpression: `[a-zA-Z\\\\d-]+`. The maximum length is 100\ncharacters. Can be empty to allow the system to generate one.",
- "type": "string"
- },
- "deidentifyTemplate": {
- "description": "The DeidentifyTemplate to create.",
- "$ref": "GooglePrivacyDlpV2beta2DeidentifyTemplate"
- }
- },
- "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": {
- "inspectConfig": {
- "$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"
- },
- "imageRedactionConfigs": {
- "description": "The configuration for specifying what content to redact from images.",
- "type": "array",
- "items": {
- "$ref": "GooglePrivacyDlpV2beta2ImageRedactionConfig"
- }
- }
- },
- "id": "GooglePrivacyDlpV2beta2RedactImageRequest"
- },
- "GooglePrivacyDlpV2beta1KMapEstimationQuasiIdValues": {
- "description": "A tuple of values for the quasi-identifier columns.",
- "type": "object",
- "properties": {
- "estimatedAnonymity": {
- "description": "The estimated anonymity for these quasi-identifier values.",
- "format": "int64",
- "type": "string"
- },
- "quasiIdsValues": {
- "description": "The quasi-identifier values.",
- "type": "array",
- "items": {
- "$ref": "GooglePrivacyDlpV2beta1Value"
- }
- }
- },
- "id": "GooglePrivacyDlpV2beta1KMapEstimationQuasiIdValues"
- },
- "GooglePrivacyDlpV2beta2ContentItem": {
- "description": "Container structure for the content to inspect.",
- "type": "object",
- "properties": {
- "table": {
- "$ref": "GooglePrivacyDlpV2beta2Table",
- "description": "Structured content for inspection."
- },
- "data": {
- "description": "Content data to inspect or redact.",
- "format": "byte",
- "type": "string"
- },
- "type": {
- "description": "Type of the content, as defined in Content-Type HTTP header.\nSupported types are: all \"text\" types, octet streams, PNG images,\nJPEG images.",
- "type": "string"
- },
- "value": {
- "description": "String data to inspect or redact.",
- "type": "string"
- }
- },
- "id": "GooglePrivacyDlpV2beta2ContentItem"
- },
- "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]",
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "id": "GooglePrivacyDlpV2beta2WordList"
- },
- "GooglePrivacyDlpV2beta2CategoricalStatsResult": {
- "description": "Result of the categorical stats computation.",
- "type": "object",
- "properties": {
- "valueFrequencyHistogramBuckets": {
- "description": "Histogram of value frequencies in the column.",
- "type": "array",
- "items": {
- "$ref": "GooglePrivacyDlpV2beta2CategoricalStatsHistogramBucket"
- }
- }
- },
- "id": "GooglePrivacyDlpV2beta2CategoricalStatsResult"
- },
- "GooglePrivacyDlpV2beta2ReplaceWithInfoTypeConfig": {
- "description": "Replace each matching finding with the name of the info_type.",
- "type": "object",
- "properties": {},
- "id": "GooglePrivacyDlpV2beta2ReplaceWithInfoTypeConfig"
- },
- "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.",
- "type": "array",
- "items": {
- "$ref": "GooglePrivacyDlpV2beta2PathElement"
- }
- },
- "partitionId": {
- "description": "Entities are partitioned into subsets, currently identified by a project\nID and namespace ID.\nQueries are scoped to a single partition.",
+ "description": "A partition ID identifies a grouping of entities. The grouping is always\nby project and namespace, however the namespace ID may be empty.",
"$ref": "GooglePrivacyDlpV2beta2PartitionId"
}
},
- "id": "GooglePrivacyDlpV2beta2Key"
- },
- "GooglePrivacyDlpV2beta1BigQueryTable": {
- "description": "Message defining the location of a BigQuery table. A table is uniquely\nidentified by its project_id, dataset_id, and table_name. Within a query\na table is often referenced with a string in the format of:\n`\u003cproject_id\u003e:\u003cdataset_id\u003e.\u003ctable_id\u003e` or\n`\u003cproject_id\u003e.\u003cdataset_id\u003e.\u003ctable_id\u003e`.",
- "type": "object",
- "properties": {
- "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": "GooglePrivacyDlpV2beta1BigQueryTable"
- },
- "GooglePrivacyDlpV2beta2FieldTransformation": {
- "description": "The transformation to apply to the field.",
- "type": "object",
- "properties": {
- "infoTypeTransformations": {
- "$ref": "GooglePrivacyDlpV2beta2InfoTypeTransformations",
- "description": "Treat the contents of the field as free text, and selectively\ntransform content that matches an `InfoType`."
- },
- "fields": {
- "description": "Input field(s) to apply the transformation to. [required]",
- "type": "array",
- "items": {
- "$ref": "GooglePrivacyDlpV2beta2FieldId"
- }
- },
- "primitiveTransformation": {
- "$ref": "GooglePrivacyDlpV2beta2PrimitiveTransformation",
- "description": "Apply the transformation to the entire field."
- },
- "condition": {
- "$ref": "GooglePrivacyDlpV2beta2RecordCondition",
- "description": "Only apply the transformation if the condition evaluates to true for the\ngiven `RecordCondition`. The conditions are allowed to reference fields\nthat are not used in the actual transformation. [optional]\n\nExample Use Cases:\n\n- Apply a different bucket transformation to an age column if the zip code\ncolumn for the same record is within a specific range.\n- Redact a field if the date of birth field is greater than 85."
- }
- },
- "id": "GooglePrivacyDlpV2beta2FieldTransformation"
- },
- "GooglePrivacyDlpV2beta2PathElement": {
- "description": "A (kind, ID/name) pair used to construct a key path.\n\nIf either name or ID is set, the element is complete.\nIf neither is set, the element is incomplete.",
- "type": "object",
- "properties": {
- "name": {
- "description": "The name of the entity.\nA name matching regex `__.*__` is reserved/read-only.\nA name must not be more than 1500 bytes when UTF-8 encoded.\nCannot be `\"\"`.",
- "type": "string"
- },
- "kind": {
- "description": "The kind of the entity.\nA kind matching regex `__.*__` is reserved/read-only.\nA kind must not contain more than 1500 bytes when UTF-8 encoded.\nCannot be `\"\"`.",
- "type": "string"
- },
- "id": {
- "description": "The auto-allocated ID of the entity.\nNever equal to zero. Values less than zero are discouraged and may not\nbe supported in the future.",
- "format": "int64",
- "type": "string"
- }
- },
- "id": "GooglePrivacyDlpV2beta2PathElement"
- },
- "GooglePrivacyDlpV2beta2RecordSuppression": {
- "description": "Configuration to suppress records whose suppression conditions evaluate to\ntrue.",
- "type": "object",
- "properties": {
- "condition": {
- "description": "A condition that when it evaluates to true will result in the record being\nevaluated to be suppressed from the transformed content.",
- "$ref": "GooglePrivacyDlpV2beta2RecordCondition"
- }
- },
- "id": "GooglePrivacyDlpV2beta2RecordSuppression"
- },
- "GooglePrivacyDlpV2beta1KindExpression": {
- "description": "A representation of a Datastore kind.",
- "type": "object",
- "properties": {
- "name": {
- "description": "The name of the kind.",
- "type": "string"
- }
- },
- "id": "GooglePrivacyDlpV2beta1KindExpression"
- },
- "GooglePrivacyDlpV2beta2NumericalStatsConfig": {
- "description": "Compute numerical stats over an individual column, including\nmin, max, and quantiles.",
- "type": "object",
- "properties": {
- "field": {
- "$ref": "GooglePrivacyDlpV2beta2FieldId",
- "description": "Field to compute numerical stats on. Supported types are\ninteger, float, date, datetime, timestamp, time."
- }
- },
- "id": "GooglePrivacyDlpV2beta2NumericalStatsConfig"
- },
- "GooglePrivacyDlpV2beta2OutputStorageConfig": {
- "description": "Cloud repository for storing output.",
- "type": "object",
- "properties": {
- "table": {
- "$ref": "GooglePrivacyDlpV2beta2BigQueryTable",
- "description": "Store findings in a new table in an existing dataset."
- }
- },
- "id": "GooglePrivacyDlpV2beta2OutputStorageConfig"
- },
- "GooglePrivacyDlpV2beta2InfoTypeLimit": {
- "description": "Max findings configuration per infoType, per content item or long\nrunning DlpJob.",
- "type": "object",
- "properties": {
- "infoType": {
- "$ref": "GooglePrivacyDlpV2beta2InfoType",
- "description": "Type of information the findings limit applies to. Only one limit per\ninfo_type should be provided. If InfoTypeLimit does not have an\ninfo_type, the DLP API applies the limit against all info_types that\nare found but not specified in another InfoTypeLimit."
- },
- "maxFindings": {
- "description": "Max findings limit for the given infoType.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "GooglePrivacyDlpV2beta2InfoTypeLimit"
- },
- "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"
- },
- "GooglePrivacyDlpV2beta2InfoTypeStatistics": {
- "description": "Statistics regarding a specific InfoType.",
- "type": "object",
- "properties": {
- "infoType": {
- "description": "The type of finding this stat is for.",
- "$ref": "GooglePrivacyDlpV2beta2InfoType"
- },
- "count": {
- "description": "Number of findings for this infoType.",
- "format": "int64",
- "type": "string"
- }
- },
- "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.",
- "$ref": "GooglePrivacyDlpV2beta2FieldId"
- },
- "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": "GooglePrivacyDlpV2beta2FieldId"
- }
- }
- },
- "id": "GooglePrivacyDlpV2beta2LDiversityConfig"
- },
- "GooglePrivacyDlpV2beta2RecordTransformations": {
- "description": "A type of transformation that is applied over structured data such as a\ntable.",
- "type": "object",
- "properties": {
- "recordSuppressions": {
- "description": "Configuration defining which records get suppressed entirely. Records that\nmatch any suppression rule are omitted from the output [optional].",
- "type": "array",
- "items": {
- "$ref": "GooglePrivacyDlpV2beta2RecordSuppression"
- }
- },
- "fieldTransformations": {
- "description": "Transform the record by applying various field transformations.",
- "type": "array",
- "items": {
- "$ref": "GooglePrivacyDlpV2beta2FieldTransformation"
- }
- }
- },
- "id": "GooglePrivacyDlpV2beta2RecordTransformations"
- },
- "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"
- },
- "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": {
- "description": "Histogram bucket of value frequencies in the column.",
- "type": "object",
- "properties": {
- "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"
- }
- },
- "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"
- }
- },
- "id": "GooglePrivacyDlpV2beta1CategoricalStatsHistogramBucket"
- },
- "GooglePrivacyDlpV2beta2SummaryResult": {
- "description": "A collection that informs the user the number of times a particular\n`TransformationResultCode` and error details occurred.",
- "type": "object",
- "properties": {
- "details": {
- "description": "A place for warnings or errors to show up if a transformation didn't\nwork as expected.",
- "type": "string"
- },
- "count": {
- "format": "int64",
- "type": "string"
- },
- "code": {
- "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",
- "description": "Optional message indicating that each distinct entity_id should not\ncontribute to the k-anonymity count more than once per equivalence class.\nIf an entity_id appears on several rows with different quasi-identifier\ntuples, it will contribute to each count exactly once.\n\nThis can lead to unexpected results. Consider a table where ID 1 is\nassociated to quasi-identifier \"foo\", ID 2 to \"bar\", and ID 3 to *both*\nquasi-identifiers \"foo\" and \"bar\" (on separate rows), and where this ID\nis used as entity_id. Then, the anonymity value associated to ID 3 will\nbe 2, even if it is the only ID to be associated to both values \"foo\" and\n\"bar\"."
- },
- "quasiIds": {
- "description": "Set of fields to compute k-anonymity over. When multiple fields are\nspecified, they are considered a single composite key. Structs and\nrepeated data types are not supported; however, nested fields are\nsupported so long as they are not structs themselves or nested within\na repeated field.",
- "type": "array",
- "items": {
- "$ref": "GooglePrivacyDlpV2beta1FieldId"
- }
- }
- },
- "id": "GooglePrivacyDlpV2beta1KAnonymityConfig"
- },
- "GooglePrivacyDlpV2beta2Range": {
- "description": "Generic half-open interval [start, end)",
- "type": "object",
- "properties": {
- "end": {
- "description": "Index of the last character of the range (exclusive).",
- "format": "int64",
- "type": "string"
- },
- "start": {
- "description": "Index of the first character of the range (inclusive).",
- "format": "int64",
- "type": "string"
- }
- },
- "id": "GooglePrivacyDlpV2beta2Range"
- },
- "GooglePrivacyDlpV2beta2DeidentifyConfig": {
- "description": "The configuration that controls how the data will change.",
- "type": "object",
- "properties": {
- "recordTransformations": {
- "$ref": "GooglePrivacyDlpV2beta2RecordTransformations",
- "description": "Treat the dataset as structured. Transformations can be applied to\nspecific locations within structured datasets, such as transforming\na column within a table."
- },
- "infoTypeTransformations": {
- "$ref": "GooglePrivacyDlpV2beta2InfoTypeTransformations",
- "description": "Treat the dataset as free-form text and apply the same free text\ntransformation everywhere."
- }
- },
- "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.",
- "type": "array",
- "items": {
- "$ref": "GooglePrivacyDlpV2beta2AuxiliaryTable"
- }
- },
- "quasiIds": {
- "description": "Fields considered to be quasi-identifiers. No two columns can have the\nsame tag. [required]",
- "type": "array",
- "items": {
- "$ref": "GooglePrivacyDlpV2beta2TaggedField"
- }
- },
- "regionCode": {
- "description": "ISO 3166-1 alpha-2 region code to use in the statistical modeling.\nRequired if no column is tagged with a region-specific InfoType (like\nUS_ZIP_5) or a region code.",
- "type": "string"
- }
- },
- "id": "GooglePrivacyDlpV2beta2KMapEstimationConfig"
- },
- "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": {
- "description": "Set of buckets. Ranges must be non-overlapping.",
- "type": "array",
- "items": {
- "$ref": "GooglePrivacyDlpV2beta2Bucket"
- }
- }
- },
- "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": {
- "description": "Privacy metric to compute for reidentification risk analysis.",
- "type": "object",
- "properties": {
- "lDiversityConfig": {
- "$ref": "GooglePrivacyDlpV2beta2LDiversityConfig"
- },
- "numericalStatsConfig": {
- "$ref": "GooglePrivacyDlpV2beta2NumericalStatsConfig"
- },
- "kAnonymityConfig": {
- "$ref": "GooglePrivacyDlpV2beta2KAnonymityConfig"
- },
- "categoricalStatsConfig": {
- "$ref": "GooglePrivacyDlpV2beta2CategoricalStatsConfig"
- },
- "kMapEstimationConfig": {
- "$ref": "GooglePrivacyDlpV2beta2KMapEstimationConfig"
- }
- },
- "id": "GooglePrivacyDlpV2beta2PrivacyMetric"
- },
- "GooglePrivacyDlpV2beta1QuasiIdField": {
- "description": "A quasi-identifier column has a custom_tag, used to know which column\nin the data corresponds to which column in the statistical model.",
- "type": "object",
- "properties": {
- "field": {
- "$ref": "GooglePrivacyDlpV2beta1FieldId"
- },
- "customTag": {
- "type": "string"
- }
- },
- "id": "GooglePrivacyDlpV2beta1QuasiIdField"
- },
- "GooglePrivacyDlpV2beta2KmsWrappedCryptoKey": {
- "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"
- },
- "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": {
- "description": "Statistics of how many instances of each info type were found during\ninspect job.",
- "type": "array",
- "items": {
- "$ref": "GooglePrivacyDlpV2beta2InfoTypeStatistics"
- }
- },
- "processedBytes": {
- "description": "Total size in bytes that were processed.",
- "format": "int64",
- "type": "string"
- }
- },
- "id": "GooglePrivacyDlpV2beta2Result"
- },
- "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": {
- "description": "Surrogate info type.",
- "$ref": "GooglePrivacyDlpV2beta2SurrogateType"
- }
- },
- "id": "GooglePrivacyDlpV2beta2CustomInfoType"
- },
- "GooglePrivacyDlpV2beta2DeidentifyContentResponse": {
- "description": "Results of de-identifying a ContentItem.",
- "type": "object",
- "properties": {
- "overview": {
- "description": "An overview of the changes that were made on the `item`.",
- "$ref": "GooglePrivacyDlpV2beta2TransformationOverview"
- },
- "item": {
- "description": "The de-identified item.",
- "$ref": "GooglePrivacyDlpV2beta2ContentItem"
- }
- },
- "id": "GooglePrivacyDlpV2beta2DeidentifyContentResponse"
+ "id": "GooglePrivacyDlpV2beta2DatastoreOptions"
}
},
- "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": "DLP",
"auth": {
"oauth2": {
@@ -4359,5 +4356,8 @@
}
}
}
- }
+ },
+ "rootUrl": "https://dlp.googleapis.com/",
+ "ownerDomain": "google.com",
+ "name": "dlp"
}
diff --git a/firebasedynamiclinks/v1/firebasedynamiclinks-api.json b/firebasedynamiclinks/v1/firebasedynamiclinks-api.json
index 7b574da..65fafad 100644
--- a/firebasedynamiclinks/v1/firebasedynamiclinks-api.json
+++ b/firebasedynamiclinks/v1/firebasedynamiclinks-api.json
@@ -1,34 +1,31 @@
{
- "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",
+ "id": "firebasedynamiclinks.shortLinks.create",
"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."
+ "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",
+ "parameters": {},
+ "scopes": [
+ "https://www.googleapis.com/auth/firebase"
+ ]
}
}
},
"v1": {
"methods": {
"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": {
"$ref": "DynamicLinkStats"
},
@@ -55,56 +52,96 @@
},
"flatPath": "v1/{dynamicLink}/linkStats",
"path": "v1/{dynamicLink}/linkStats",
- "id": "firebasedynamiclinks.getLinkStats"
+ "id": "firebasedynamiclinks.getLinkStats",
+ "description": "Fetches analytics stats of a short Dynamic Link for a given\nduration. Metrics include number of clicks, redirects, installs,\napp first opens, and app reopens."
},
"installAttribution": {
- "description": "Get iOS strong/weak-match info for post-install attribution.",
"request": {
"$ref": "GetIosPostInstallAttributionRequest"
},
+ "description": "Get iOS strong/weak-match info for post-install attribution.",
+ "httpMethod": "POST",
+ "parameterOrder": [],
"response": {
"$ref": "GetIosPostInstallAttributionResponse"
},
- "parameterOrder": [],
- "httpMethod": "POST",
+ "parameters": {},
"scopes": [
"https://www.googleapis.com/auth/firebase"
],
- "parameters": {},
"flatPath": "v1/installAttribution",
- "path": "v1/installAttribution",
- "id": "firebasedynamiclinks.installAttribution"
+ "id": "firebasedynamiclinks.installAttribution",
+ "path": "v1/installAttribution"
}
}
}
},
"parameters": {
- "alt": {
+ "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": {
+ "location": "query",
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string"
+ },
+ "callback": {
+ "location": "query",
+ "description": "JSONP",
+ "type": "string"
+ },
+ "$.xgafv": {
"enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
+ "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"
+ },
+ "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.",
- "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.",
@@ -116,371 +153,29 @@
"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"
- },
- "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": {
- "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": {
- "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"
}
},
"version": "v1",
"baseUrl": "https://firebasedynamiclinks-ipv6.googleapis.com/",
- "servicePath": "",
"description": "Programmatically creates and manages Firebase Dynamic Links.",
"kind": "discovery#restDescription",
+ "servicePath": "",
"basePath": "",
- "revision": "20171222",
+ "revision": "20180102",
"documentationLink": "https://firebase.google.com/docs/dynamic-links/",
"id": "firebasedynamiclinks:v1",
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
- "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": {
- "$ref": "AndroidInfo",
- "description": "Android related information. See Android related parameters in the\n[documentation](https://firebase.google.com/docs/dynamic-links/create-manually)."
- },
- "navigationInfo": {
- "$ref": "NavigationInfo",
- "description": "Information of navigation behavior of a Firebase Dynamic Links."
- },
- "analyticsInfo": {
- "$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": {
- "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"
- },
- "timezone": {
- "description": "Device timezone setting.",
- "type": "string"
- },
- "screenResolutionHeight": {
- "description": "Device display resolution height.",
- "format": "int64",
- "type": "string"
- },
- "languageCode": {
- "description": "Device language code setting.",
- "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": {
- "properties": {
- "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"
- },
- "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"
- }
- },
- "id": "GetIosPostInstallAttributionResponse",
- "description": "Response for iSDK to execute strong match flow for post-install attribution.",
- "type": "object"
- },
- "SocialMetaTagInfo": {
- "description": "Parameters for social meta tag params.\nUsed to set meta tag data for link previews on social sites.",
- "type": "object",
- "properties": {
- "socialTitle": {
- "description": "Title to be displayed. Optional.",
- "type": "string"
- },
- "socialImageLink": {
- "description": "An image url string. Optional.",
- "type": "string"
- },
- "socialDescription": {
- "description": "A short description of the link. Optional.",
- "type": "string"
- }
- },
- "id": "SocialMetaTagInfo"
- },
- "DynamicLinkStats": {
- "description": "Analytics stats of a Dynamic Link for a given timeframe.",
- "type": "object",
- "properties": {
- "linkEventStats": {
- "description": "Dynamic Link event stats.",
- "type": "array",
- "items": {
- "$ref": "DynamicLinkEventStat"
- }
- }
- },
- "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": {
- "enumDescriptions": [
- "Unknown code.",
- "The Android package does not match any in developer's DevConsole project.",
- "The Android minimum version code has to be a valid integer.",
- "Android package min version param is not needed, e.g. when\n'apn' is missing.",
- "Android link is not a valid URI.",
- "Android link param is not needed, e.g. when param 'al' and 'link' have\nthe same value..",
- "Android fallback link is not a valid URI.",
- "Android fallback link has an invalid (non http/https) URI scheme.",
- "The iOS bundle ID does not match any in developer's DevConsole project.",
- "The iPad bundle ID does not match any in developer's DevConsole project.",
- "iOS URL scheme is not needed, e.g. when 'ibi' are 'ipbi' are all missing.",
- "iOS app store ID format is incorrect, e.g. not numeric.",
- "iOS app store ID is not needed.",
- "iOS fallback link is not a valid URI.",
- "iOS fallback link has an invalid (non http/https) URI scheme.",
- "iPad fallback link is not a valid URI.",
- "iPad fallback link has an invalid (non http/https) URI scheme.",
- "Debug param format is incorrect.",
- "isAd param format is incorrect.",
- "Indicates a certain param is deprecated.",
- "Indicates certain paramater is not recognized.",
- "Indicates certain paramater is too long.",
- "Social meta tag image link is not a valid URI.",
- "Social meta tag image link has an invalid (non http/https) URI scheme.",
- "",
- "",
- "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"
- ],
- "description": "The warning code.",
- "type": "string"
- }
- },
- "id": "DynamicLinkWarning"
- },
- "AndroidInfo": {
- "description": "Android related attributes to the Dynamic Link.",
- "type": "object",
- "properties": {
- "androidFallbackLink": {
- "description": "Link to open on Android if the app is not installed.",
- "type": "string"
- },
- "androidPackageName": {
- "description": "Android package name of the app.",
- "type": "string"
- },
- "androidMinPackageVersionCode": {
- "description": "Minimum version code for the Android app. If the installed app’s version\ncode is lower, then the user is taken to the Play Store.",
- "type": "string"
- },
- "androidLink": {
- "description": "If specified, this overrides the ‘link’ parameter on Android.",
- "type": "string"
- }
- },
- "id": "AndroidInfo"
- },
"NavigationInfo": {
"description": "Information of navigation behavior.",
"type": "object",
@@ -496,18 +191,6 @@
"description": "iOS related attributes to the Dynamic Link..",
"type": "object",
"properties": {
- "iosIpadBundleId": {
- "description": "iPad bundle ID of the app.",
- "type": "string"
- },
- "iosCustomScheme": {
- "description": "Custom (destination) scheme to use for iOS. By default, we’ll use the\nbundle ID as the custom scheme. Developer can override this behavior using\nthis param.",
- "type": "string"
- },
- "iosBundleId": {
- "description": "iOS bundle ID of the app.",
- "type": "string"
- },
"iosFallbackLink": {
"description": "Link to open on iOS if the app is not installed.",
"type": "string"
@@ -519,11 +202,25 @@
"iosIpadFallbackLink": {
"description": "If specified, this overrides the ios_fallback_link value on iPads.",
"type": "string"
+ },
+ "iosIpadBundleId": {
+ "description": "iPad bundle ID of the app.",
+ "type": "string"
+ },
+ "iosCustomScheme": {
+ "description": "Custom (destination) scheme to use for iOS. By default, we’ll use the\nbundle ID as the custom scheme. Developer can override this behavior using\nthis param.",
+ "type": "string"
+ },
+ "iosBundleId": {
+ "description": "iOS bundle ID of the app.",
+ "type": "string"
}
},
"id": "IosInfo"
},
"AnalyticsInfo": {
+ "description": "Tracking parameters supported by Dynamic Link.",
+ "type": "object",
"properties": {
"itunesConnectAnalytics": {
"$ref": "ITunesConnectAnalytics",
@@ -534,14 +231,16 @@
"$ref": "GooglePlayAnalytics"
}
},
- "id": "AnalyticsInfo",
- "description": "Tracking parameters supported by Dynamic Link.",
- "type": "object"
+ "id": "AnalyticsInfo"
},
"CreateShortDynamicLinkRequest": {
"description": "Request to create a short Dynamic Link.",
"type": "object",
"properties": {
+ "suffix": {
+ "description": "Short Dynamic Link suffix. Optional.",
+ "$ref": "Suffix"
+ },
"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)."
@@ -549,10 +248,6 @@
"longDynamicLink": {
"description": "Full long Dynamic Link URL with desired query parameters specified.\nFor example,\n\"https://sample.app.goo.gl/?link=http://www.google.com&apn=com.sample\",\n[Learn more](https://firebase.google.com/docs/dynamic-links/android#create-a-dynamic-link-programmatically).",
"type": "string"
- },
- "suffix": {
- "$ref": "Suffix",
- "description": "Short Dynamic Link suffix. Optional."
}
},
"id": "CreateShortDynamicLinkRequest"
@@ -617,11 +312,9 @@
"id": "DynamicLinkEventStat"
},
"GetIosPostInstallAttributionRequest": {
+ "description": "Request for iSDK to execute strong match flow for post-install attribution.\nThis is meant for iOS requests only. Requests from other platforms will\nnot be honored.",
+ "type": "object",
"properties": {
- "sdkVersion": {
- "description": "Google SDK version.",
- "type": "string"
- },
"bundleId": {
"description": "APP bundle ID.",
"type": "string"
@@ -644,6 +337,12 @@
"type": "string"
},
"retrievalMethod": {
+ "enumDescriptions": [
+ "Unknown method.",
+ "iSDK performs a server lookup by device fingerprint in the background\nwhen app is first-opened; no API called by developer.",
+ "iSDK performs a server lookup by device fingerprint upon a dev API call.",
+ "iSDK performs a strong match only if weak match is found upon a dev\nAPI call."
+ ],
"enum": [
"UNKNOWN_PAYLOAD_RETRIEVAL_METHOD",
"IMPLICIT_WEAK_MATCH",
@@ -651,13 +350,7 @@
"EXPLICIT_STRONG_AFTER_WEAK_MATCH"
],
"description": "App post install attribution retrieval information. Disambiguates\nmechanism (iSDK or developer invoked) to retrieve payload from\nclicked link.",
- "type": "string",
- "enumDescriptions": [
- "Unknown method.",
- "iSDK performs a server lookup by device fingerprint in the background\nwhen app is first-opened; no API called by developer.",
- "iSDK performs a server lookup by device fingerprint upon a dev API call.",
- "iSDK performs a strong match only if weak match is found upon a dev\nAPI call."
- ]
+ "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.",
@@ -672,11 +365,13 @@
"DEFAULT_STYLE",
"CUSTOM_STYLE"
]
+ },
+ "sdkVersion": {
+ "description": "Google SDK version.",
+ "type": "string"
}
},
- "id": "GetIosPostInstallAttributionRequest",
- "description": "Request for iSDK to execute strong match flow for post-install attribution.\nThis is meant for iOS requests only. Requests from other platforms will\nnot be honored.",
- "type": "object"
+ "id": "GetIosPostInstallAttributionRequest"
},
"CreateShortDynamicLinkResponse": {
"description": "Response to create a short Dynamic Link.",
@@ -701,8 +396,12 @@
"id": "CreateShortDynamicLinkResponse"
},
"Suffix": {
+ "description": "Short Dynamic Link suffix.",
+ "type": "object",
"properties": {
"option": {
+ "description": "Suffix option.",
+ "type": "string",
"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.",
@@ -712,23 +411,15 @@
"OPTION_UNSPECIFIED",
"UNGUESSABLE",
"SHORT"
- ],
- "description": "Suffix option.",
- "type": "string"
+ ]
}
},
- "id": "Suffix",
- "description": "Short Dynamic Link suffix.",
- "type": "object"
+ "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": {
- "utmSource": {
- "description": "Campaign source; used to identify a search engine, newsletter, or other\nsource.",
- "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"
@@ -748,9 +439,320 @@
"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"
}
},
"id": "GooglePlayAnalytics"
+ },
+ "DynamicLinkInfo": {
+ "description": "Information about a Dynamic Link.",
+ "type": "object",
+ "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": {
+ "description": "Desktop related information. See desktop related parameters in the\n[documentation](https://firebase.google.com/docs/dynamic-links/create-manually).",
+ "$ref": "DesktopInfo"
+ },
+ "link": {
+ "description": "The link your app will open, You can specify any URL your app can handle.\nThis link must be a well-formatted URL, be properly URL-encoded, and use\nthe HTTP or HTTPS scheme. See 'link' parameters in the\n[documentation](https://firebase.google.com/docs/dynamic-links/create-manually).\n\nRequired.",
+ "type": "string"
+ },
+ "iosInfo": {
+ "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"
+ },
+ "DeviceInfo": {
+ "description": "Signals associated with the device making the request.",
+ "type": "object",
+ "properties": {
+ "deviceModelName": {
+ "description": "Device model name.",
+ "type": "string"
+ },
+ "languageCodeFromWebview": {
+ "description": "Device language code setting obtained by executing JavaScript code in\nWebView.",
+ "type": "string"
+ },
+ "languageCodeRaw": {
+ "description": "Device language code raw setting.\niOS does returns language code in different format than iOS WebView.\nFor example WebView returns en_US, but iOS returns en-US.\nField below will return raw value returned by iOS.",
+ "type": "string"
+ },
+ "screenResolutionWidth": {
+ "description": "Device display resolution width.",
+ "format": "int64",
+ "type": "string"
+ },
+ "timezone": {
+ "description": "Device timezone setting.",
+ "type": "string"
+ },
+ "screenResolutionHeight": {
+ "description": "Device display resolution height.",
+ "format": "int64",
+ "type": "string"
+ },
+ "languageCode": {
+ "description": "Device language code setting.",
+ "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": {
+ "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"
+ },
+ "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"
+ },
+ "invitationId": {
+ "description": "Invitation ID attributed post-install via one of several techniques\n(fingerprint, copy unique).",
+ "type": "string"
+ },
+ "deepLink": {
+ "description": "The deep-link attributed post-install via one of several techniques\n(fingerprint, copy unique).",
+ "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"
+ },
+ "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"
+ },
+ "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"
+ }
+ },
+ "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": {
+ "socialTitle": {
+ "description": "Title to be displayed. Optional.",
+ "type": "string"
+ },
+ "socialImageLink": {
+ "description": "An image url string. Optional.",
+ "type": "string"
+ },
+ "socialDescription": {
+ "description": "A short description of the link. Optional.",
+ "type": "string"
+ }
+ },
+ "id": "SocialMetaTagInfo"
+ },
+ "DynamicLinkStats": {
+ "description": "Analytics stats of a Dynamic Link for a given timeframe.",
+ "type": "object",
+ "properties": {
+ "linkEventStats": {
+ "description": "Dynamic Link event stats.",
+ "type": "array",
+ "items": {
+ "$ref": "DynamicLinkEventStat"
+ }
+ }
+ },
+ "id": "DynamicLinkStats"
+ },
+ "DynamicLinkWarning": {
+ "description": "Dynamic Links warning messages.",
+ "type": "object",
+ "properties": {
+ "warningDocumentLink": {
+ "description": "The document describing the warning, and helps resolve.",
+ "type": "string"
+ },
+ "warningCode": {
+ "description": "The warning code.",
+ "type": "string",
+ "enumDescriptions": [
+ "Unknown code.",
+ "The Android package does not match any in developer's DevConsole project.",
+ "The Android minimum version code has to be a valid integer.",
+ "Android package min version param is not needed, e.g. when\n'apn' is missing.",
+ "Android link is not a valid URI.",
+ "Android link param is not needed, e.g. when param 'al' and 'link' have\nthe same value..",
+ "Android fallback link is not a valid URI.",
+ "Android fallback link has an invalid (non http/https) URI scheme.",
+ "The iOS bundle ID does not match any in developer's DevConsole project.",
+ "The iPad bundle ID does not match any in developer's DevConsole project.",
+ "iOS URL scheme is not needed, e.g. when 'ibi' are 'ipbi' are all missing.",
+ "iOS app store ID format is incorrect, e.g. not numeric.",
+ "iOS app store ID is not needed.",
+ "iOS fallback link is not a valid URI.",
+ "iOS fallback link has an invalid (non http/https) URI scheme.",
+ "iPad fallback link is not a valid URI.",
+ "iPad fallback link has an invalid (non http/https) URI scheme.",
+ "Debug param format is incorrect.",
+ "isAd param format is incorrect.",
+ "Indicates a certain param is deprecated.",
+ "Indicates certain paramater is not recognized.",
+ "Indicates certain paramater is too long.",
+ "Social meta tag image link is not a valid URI.",
+ "Social meta tag image link has an invalid (non http/https) URI scheme.",
+ "",
+ "",
+ "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"
+ }
+ },
+ "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"
+ },
+ "androidPackageName": {
+ "description": "Android package name of the app.",
+ "type": "string"
+ },
+ "androidMinPackageVersionCode": {
+ "description": "Minimum version code for the Android app. If the installed app’s version\ncode is lower, then the user is taken to the Play Store.",
+ "type": "string"
+ }
+ },
+ "id": "AndroidInfo"
}
},
"icons": {
@@ -770,5 +772,7 @@
},
"rootUrl": "https://firebasedynamiclinks-ipv6.googleapis.com/",
"ownerDomain": "google.com",
- "name": "firebasedynamiclinks"
+ "name": "firebasedynamiclinks",
+ "batchPath": "batch",
+ "title": "Firebase Dynamic Links API"
}
diff --git a/firebasedynamiclinks/v1/firebasedynamiclinks-gen.go b/firebasedynamiclinks/v1/firebasedynamiclinks-gen.go
index 823aa23..e095479 100644
--- a/firebasedynamiclinks/v1/firebasedynamiclinks-gen.go
+++ b/firebasedynamiclinks/v1/firebasedynamiclinks-gen.go
@@ -295,6 +295,11 @@
// LanguageCode: Device language code setting.
LanguageCode string `json:"languageCode,omitempty"`
+ // LanguageCodeFromWebview: Device language code setting obtained by
+ // executing JavaScript code in
+ // WebView.
+ LanguageCodeFromWebview string `json:"languageCodeFromWebview,omitempty"`
+
// LanguageCodeRaw: Device language code raw setting.
// iOS does returns language code in different format than iOS
// WebView.
diff --git a/firebaseremoteconfig/v1/firebaseremoteconfig-api.json b/firebaseremoteconfig/v1/firebaseremoteconfig-api.json
index a5378e6..4480232 100644
--- a/firebaseremoteconfig/v1/firebaseremoteconfig-api.json
+++ b/firebaseremoteconfig/v1/firebaseremoteconfig-api.json
@@ -20,11 +20,11 @@
"httpMethod": "GET",
"parameters": {
"project": {
+ "pattern": "^projects/[^/]+$",
"location": "path",
"description": "The GMP project identifier. Required.\nSee note at the beginning of this file regarding project ids.",
"required": true,
- "type": "string",
- "pattern": "^projects/[^/]+$"
+ "type": "string"
}
},
"flatPath": "v1/projects/{projectsId}/remoteConfig",
@@ -33,6 +33,10 @@
"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": {
+ "request": {
+ "$ref": "RemoteConfig"
+ },
+ "description": "Update a RemoteConfig. We treat this as an always-existing\nresource (when it is not found in our data store, we treat it as version\n0, a template with zero conditions and zero parameters). Hence there are\nno Create or Delete operations. Returns the updated template when\nsuccessful (and the updated eTag as a response header), or an error if\nthings go wrong.\nPossible error messages:\n* VALIDATION_ERROR (HTTP status 400) with additional details if the\ntemplate being passed in can not be validated.\n* AUTHENTICATION_ERROR (HTTP status 401) if the request can not be\nauthenticate (e.g. no access token, or invalid access token).\n* AUTHORIZATION_ERROR (HTTP status 403) if the request can not be\nauthorized (e.g. the user has no access to the specified project id).\n* VERSION_MISMATCH (HTTP status 412) when trying to update when the\nexpected eTag (passed in via the \"If-match\" header) is not specified, or\nis specified but does does not match the current eTag.\n* Internal error (HTTP status 500) for Database problems or other internal\nerrors.",
"response": {
"$ref": "RemoteConfig"
},
@@ -41,81 +45,38 @@
],
"httpMethod": "PUT",
"parameters": {
- "project": {
- "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/[^/]+$"
- },
"validateOnly": {
"description": "Optional. Defaults to \u003ccode\u003efalse\u003c/code\u003e (UpdateRemoteConfig call should\nupdate the backend if there are no validation/interal errors). May be set\nto \u003ccode\u003etrue\u003c/code\u003e to indicate that, should no validation errors occur,\nthe call should return a \"200 OK\" instead of performing the update. Note\nthat other error messages (500 Internal Error, 412 Version Mismatch, etc)\nmay still result after flipping to \u003ccode\u003efalse\u003c/code\u003e, even if getting a\n\"200 OK\" when calling with \u003ccode\u003etrue\u003c/code\u003e.",
"type": "boolean",
"location": "query"
+ },
+ "project": {
+ "description": "The GMP project identifier. Required.\nSee note at the beginning of this file regarding project ids.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+$",
+ "location": "path"
}
},
"flatPath": "v1/projects/{projectsId}/remoteConfig",
"path": "v1/{+project}/remoteConfig",
- "id": "firebaseremoteconfig.projects.updateRemoteConfig",
- "request": {
- "$ref": "RemoteConfig"
- },
- "description": "Update a RemoteConfig. We treat this as an always-existing\nresource (when it is not found in our data store, we treat it as version\n0, a template with zero conditions and zero parameters). Hence there are\nno Create or Delete operations. Returns the updated template when\nsuccessful (and the updated eTag as a response header), or an error if\nthings go wrong.\nPossible error messages:\n* VALIDATION_ERROR (HTTP status 400) with additional details if the\ntemplate being passed in can not be validated.\n* AUTHENTICATION_ERROR (HTTP status 401) if the request can not be\nauthenticate (e.g. no access token, or invalid access token).\n* AUTHORIZATION_ERROR (HTTP status 403) if the request can not be\nauthorized (e.g. the user has no access to the specified project id).\n* VERSION_MISMATCH (HTTP status 412) when trying to update when the\nexpected eTag (passed in via the \"If-match\" header) is not specified, or\nis specified but does does not match the current eTag.\n* Internal error (HTTP status 500) for Database problems or other internal\nerrors."
+ "id": "firebaseremoteconfig.projects.updateRemoteConfig"
}
}
}
},
"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.",
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
"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"
- },
"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": {
- "description": "V1 error format.",
- "type": "string",
"enumDescriptions": [
"v1 error format",
"v2 error format"
@@ -124,9 +85,22 @@
"enum": [
"1",
"2"
- ]
+ ],
+ "description": "V1 error format.",
+ "type": "string"
+ },
+ "callback": {
+ "type": "string",
+ "location": "query",
+ "description": "JSONP"
},
"alt": {
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
+ "type": "string",
"enumDescriptions": [
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
@@ -134,88 +108,63 @@
],
"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"
+ "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": {
+ "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://firebaseremoteconfig.googleapis.com/",
- "servicePath": "",
"kind": "discovery#restDescription",
"description": "Firebase Remote Config API allows the 3P clients to manage Remote Config conditions and parameters for Firebase applications.",
+ "servicePath": "",
"basePath": "",
"id": "firebaseremoteconfig:v1",
- "documentationLink": "https://firebase.google.com/docs/remote-config/",
"revision": "20171129",
+ "documentationLink": "https://firebase.google.com/docs/remote-config/",
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
- "RemoteConfigCondition": {
- "description": "A single RemoteConfig Condition. A list of these (because order matters) are\npart of a single RemoteConfig template.",
- "type": "object",
- "properties": {
- "name": {
- "description": "Required.\nA non empty and unique name of this condition.",
- "type": "string"
- },
- "description": {
- "description": "Optional.\nA description for this Condition. Length must be less than or equal to\n100 characters (or more precisely, unicode code points, which is defined in\njava/com/google/wireless/android/config/ConstsExporter.java).\nA description may contain any Unicode characters",
- "type": "string"
- },
- "expression": {
- "type": "string",
- "description": "Required."
- },
- "tagColor": {
- "description": "Optional.\nThe display (tag) color of this condition. This serves as part of a tag\n(in the future, we may add tag text as well as tag color, but that is not\nyet implemented in the UI).\nThis value has no affect on the semantics of the delivered config and it\nis ignored by the backend, except for passing it through write/read\nrequests.\nNot having this value or having the \"CONDITION_DISPLAY_COLOR_UNSPECIFIED\"\nvalue (0) have the same meaning: Let the UI choose any valid color when\ndisplaying the condition.",
- "type": "string",
- "enumDescriptions": [
- "",
- "Blue",
- "Brown",
- "Cyan",
- "aka \"Red Orange\"",
- "Green",
- "Indigo\n*",
- "Lime - Approved deviation from Material color palette",
- "Orange",
- "Pink",
- "Purple",
- "Teal"
- ],
- "enum": [
- "CONDITION_DISPLAY_COLOR_UNSPECIFIED",
- "BLUE",
- "BROWN",
- "CYAN",
- "DEEP_ORANGE",
- "GREEN",
- "INDIGO",
- "LIME",
- "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",
@@ -236,11 +185,11 @@
"type": "object",
"properties": {
"parameters": {
+ "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",
"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.",
@@ -253,7 +202,6 @@
"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": {
"defaultValue": {
@@ -272,12 +220,64 @@
}
}
},
- "id": "RemoteConfigParameter"
+ "id": "RemoteConfigParameter",
+ "description": "While default_value and conditional_values are each optional, at least one of\nthe two is required - otherwise, the parameter is meaningless (and an\nexception will be thrown by the validation logic)."
+ },
+ "RemoteConfigCondition": {
+ "description": "A single RemoteConfig Condition. A list of these (because order matters) are\npart of a single RemoteConfig template.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "Required.\nA non empty and unique name of this condition.",
+ "type": "string"
+ },
+ "description": {
+ "description": "Optional.\nA description for this Condition. Length must be less than or equal to\n100 characters (or more precisely, unicode code points, which is defined in\njava/com/google/wireless/android/config/ConstsExporter.java).\nA description may contain any Unicode characters",
+ "type": "string"
+ },
+ "expression": {
+ "description": "Required.",
+ "type": "string"
+ },
+ "tagColor": {
+ "enum": [
+ "CONDITION_DISPLAY_COLOR_UNSPECIFIED",
+ "BLUE",
+ "BROWN",
+ "CYAN",
+ "DEEP_ORANGE",
+ "GREEN",
+ "INDIGO",
+ "LIME",
+ "ORANGE",
+ "PINK",
+ "PURPLE",
+ "TEAL"
+ ],
+ "description": "Optional.\nThe display (tag) color of this condition. This serves as part of a tag\n(in the future, we may add tag text as well as tag color, but that is not\nyet implemented in the UI).\nThis value has no affect on the semantics of the delivered config and it\nis ignored by the backend, except for passing it through write/read\nrequests.\nNot having this value or having the \"CONDITION_DISPLAY_COLOR_UNSPECIFIED\"\nvalue (0) have the same meaning: Let the UI choose any valid color when\ndisplaying the condition.",
+ "type": "string",
+ "enumDescriptions": [
+ "",
+ "Blue",
+ "Brown",
+ "Cyan",
+ "aka \"Red Orange\"",
+ "Green",
+ "Indigo\n*",
+ "Lime - Approved deviation from Material color palette",
+ "Orange",
+ "Pink",
+ "Purple",
+ "Teal"
+ ]
+ }
+ },
+ "id": "RemoteConfigCondition"
}
},
"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"
}
diff --git a/firebaserules/v1/firebaserules-api.json b/firebaserules/v1/firebaserules-api.json
index 59852e2..b823fb6 100644
--- a/firebaserules/v1/firebaserules-api.json
+++ b/firebaserules/v1/firebaserules-api.json
@@ -1,15 +1,164 @@
{
+ "revision": "20171108",
+ "documentationLink": "https://firebase.google.com/docs/storage/security",
+ "id": "firebaserules:v1",
+ "discoveryVersion": "v1",
"version_module": true,
"schemas": {
- "File": {
- "description": "`File` containing source content.",
+ "Source": {
+ "description": "`Source` is one or more `File` messages comprising a logical set of rules.",
"type": "object",
"properties": {
- "fingerprint": {
- "description": "Fingerprint (e.g. github sha) associated with the `File`.",
- "format": "byte",
+ "files": {
+ "description": "`File` set constituting the `Source` bundle.",
+ "type": "array",
+ "items": {
+ "$ref": "File"
+ }
+ }
+ },
+ "id": "Source"
+ },
+ "Result": {
+ "description": "Possible result values from the function mock invocation.",
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "The result is an actual value. The type of the value must match that\nof the type declared by the service.",
+ "type": "any"
+ },
+ "undefined": {
+ "$ref": "Empty",
+ "description": "The result is undefined, meaning the result could not be computed."
+ }
+ },
+ "id": "Result"
+ },
+ "SourcePosition": {
+ "properties": {
+ "line": {
+ "description": "Line number of the source fragment. 1-based.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "column": {
+ "description": "First column on the source line associated with the source fragment.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "fileName": {
+ "description": "Name of the `File`.",
+ "type": "string"
+ }
+ },
+ "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.",
+ "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.",
+ "type": "object",
+ "properties": {
+ "resource": {
+ "description": "Optional resource value as it appears in persistent storage before the\nrequest is fulfilled.\n\nThe resource type depends on the `request.path` value.",
+ "type": "any"
+ },
+ "functionMocks": {
+ "description": "Optional function mocks for service-defined functions. If not set, any\nservice defined function is expected to return an error, which may or may\nnot influence the test outcome.",
+ "type": "array",
+ "items": {
+ "$ref": "FunctionMock"
+ }
+ },
+ "expectation": {
+ "enumDescriptions": [
+ "Unspecified expectation.",
+ "Expect an allowed result.",
+ "Expect a denied result."
+ ],
+ "enum": [
+ "EXPECTATION_UNSPECIFIED",
+ "ALLOW",
+ "DENY"
+ ],
+ "description": "Test expectation.",
"type": "string"
},
+ "request": {
+ "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"
+ },
+ "Issue": {
+ "description": "Issues include warnings, errors, and deprecation notices.",
+ "type": "object",
+ "properties": {
+ "severity": {
+ "enum": [
+ "SEVERITY_UNSPECIFIED",
+ "DEPRECATION",
+ "WARNING",
+ "ERROR"
+ ],
+ "description": "The severity of the issue.",
+ "type": "string",
+ "enumDescriptions": [
+ "An unspecified severity.",
+ "Deprecation issue for statements and method that may no longer be\nsupported or maintained.",
+ "Warnings such as: unused variables.",
+ "Errors such as: unmatched curly braces or variable redefinition."
+ ]
+ },
+ "description": {
+ "description": "Short error description.",
+ "type": "string"
+ },
+ "sourcePosition": {
+ "$ref": "SourcePosition",
+ "description": "Position of the issue in the `Source`."
+ }
+ },
+ "id": "Issue"
+ },
+ "TestRulesetRequest": {
+ "properties": {
+ "source": {
+ "$ref": "Source",
+ "description": "Optional `Source` to be checked for correctness.\n\nThis field must not be set when the resource name refers to a `Ruleset`."
+ },
+ "testSuite": {
+ "description": "Inline `TestSuite` to run.",
+ "$ref": "TestSuite"
+ }
+ },
+ "id": "TestRulesetRequest",
+ "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": {
+ "name": {
+ "description": "Name of the `Ruleset`. The ruleset_id is auto generated by the service.\nFormat: `projects/{project_id}/rulesets/{ruleset_id}`\nOutput only.",
+ "type": "string"
+ },
+ "source": {
+ "description": "`Source` for the `Ruleset`.",
+ "$ref": "Source"
+ },
+ "createTime": {
+ "description": "Time the `Ruleset` was created.\nOutput only.",
+ "format": "google-datetime",
+ "type": "string"
+ }
+ },
+ "id": "Ruleset"
+ },
+ "File": {
+ "properties": {
"name": {
"description": "File name.",
"type": "string"
@@ -17,9 +166,16 @@
"content": {
"description": "Textual Content.",
"type": "string"
+ },
+ "fingerprint": {
+ "description": "Fingerprint (e.g. github sha) associated with the `File`.",
+ "format": "byte",
+ "type": "string"
}
},
- "id": "File"
+ "id": "File",
+ "description": "`File` containing source content.",
+ "type": "object"
},
"FunctionCall": {
"description": "Represents a service-defined function call that was invoked during test\nexecution.",
@@ -43,23 +199,21 @@
"description": "The response for FirebaseRulesService.ListReleases.",
"type": "object",
"properties": {
+ "nextPageToken": {
+ "description": "The pagination token to retrieve the next page of results. If the value is\nempty, no further results remain.",
+ "type": "string"
+ },
"releases": {
"description": "List of `Release` instances.",
"type": "array",
"items": {
"$ref": "Release"
}
- },
- "nextPageToken": {
- "description": "The pagination token to retrieve the next page of results. If the value is\nempty, no further results remain.",
- "type": "string"
}
},
"id": "ListReleasesResponse"
},
"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.",
@@ -80,52 +234,45 @@
"type": "string"
}
},
- "id": "Release"
+ "id": "Release",
+ "description": "`Release` is a named reference to a `Ruleset`. Once a `Release` refers to a\n`Ruleset`, rules-enabled services will be able to enforce the `Ruleset`.",
+ "type": "object"
},
"TestRulesetResponse": {
- "description": "The response for FirebaseRulesService.TestRuleset.",
- "type": "object",
"properties": {
- "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"
- }
- },
"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": {
- "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`.",
+ },
+ "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": "FunctionCall"
+ "$ref": "TestResult"
}
- },
+ }
+ },
+ "id": "TestRulesetResponse",
+ "description": "The response for FirebaseRulesService.TestRuleset.",
+ "type": "object"
+ },
+ "TestResult": {
+ "properties": {
"state": {
+ "enum": [
+ "STATE_UNSPECIFIED",
+ "SUCCESS",
+ "FAILURE"
+ ],
"description": "State of the test.",
"type": "string",
"enumDescriptions": [
"Test state is not set.",
"Test is a success.",
"Test is a failure."
- ],
- "enum": [
- "STATE_UNSPECIFIED",
- "SUCCESS",
- "FAILURE"
]
},
"debugMessages": {
@@ -136,11 +283,20 @@
}
},
"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 }`"
+ "description": "Position in the `Source` or `Ruleset` where the principle runtime error\noccurs.\n\nEvaluation of an expression may result in an error. Rules are deny by\ndefault, so a `DENY` expectation when an error is generated is valid.\nWhen there is a `DENY` with an error, the `SourcePosition` is returned.\n\nE.g. `error_position { line: 19 column: 37 }`",
+ "$ref": "SourcePosition"
+ },
+ "functionCalls": {
+ "description": "The set of function calls made to service-defined methods.\n\nFunction calls are included in the order in which they are encountered\nduring evaluation, are provided for both mocked and unmocked functions,\nand included on the response regardless of the test `state`.",
+ "type": "array",
+ "items": {
+ "$ref": "FunctionCall"
+ }
}
},
- "id": "TestResult"
+ "id": "TestResult",
+ "description": "Test result message containing the state of the test as well as a\ndescription and source position for test failures.",
+ "type": "object"
},
"ListRulesetsResponse": {
"description": "The response for FirebaseRulesService.ListRulesets.",
@@ -169,29 +325,13 @@
"type": "any"
},
"anyValue": {
- "description": "Argument matches any value provided.",
- "$ref": "Empty"
+ "$ref": "Empty",
+ "description": "Argument matches any value provided."
}
},
"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": {
- "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": {
"updateMask": {
"description": "Specifies which fields to update.",
@@ -203,7 +343,23 @@
"$ref": "Release"
}
},
- "id": "UpdateReleaseRequest"
+ "id": "UpdateReleaseRequest",
+ "description": "The request for FirebaseRulesService.UpdateReleasePatch.",
+ "type": "object"
+ },
+ "TestSuite": {
+ "properties": {
+ "testCases": {
+ "description": "Collection of test cases associated with the `TestSuite`.",
+ "type": "array",
+ "items": {
+ "$ref": "TestCase"
+ }
+ }
+ },
+ "id": "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"
},
"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 `{}`.",
@@ -215,9 +371,13 @@
"description": "Mock function definition.\n\nMocks must refer to a function declared by the target service. The type of\nthe function args and result will be inferred at test time. If either the\narg or result values are not compatible with function type declaration, the\nrequest will be considered invalid.\n\nMore than one `FunctionMock` may be provided for a given function name so\nlong as the `Arg` matchers are distinct. There may be only one function\nfor a given overload where all `Arg` values are `Arg.any_value`.",
"type": "object",
"properties": {
+ "function": {
+ "description": "The name of the function.\n\nThe function name must match one provided by a service declaration.",
+ "type": "string"
+ },
"result": {
- "description": "The mock result of the function call.",
- "$ref": "Result"
+ "$ref": "Result",
+ "description": "The mock result of the function call."
},
"args": {
"description": "The list of `Arg` values to match. The order in which the arguments are\nprovided is the order in which they must appear in the function\ninvocation.",
@@ -225,17 +385,11 @@
"items": {
"$ref": "Arg"
}
- },
- "function": {
- "description": "The name of the function.\n\nThe function name must match one provided by a service declaration.",
- "type": "string"
}
},
"id": "FunctionMock"
},
"GetReleaseExecutableResponse": {
- "description": "The response for FirebaseRulesService.GetReleaseExecutable",
- "type": "object",
"properties": {
"executableVersion": {
"enumDescriptions": [
@@ -262,17 +416,17 @@
"type": "string"
},
"language": {
+ "enum": [
+ "LANGUAGE_UNSPECIFIED",
+ "FIREBASE_RULES",
+ "EVENT_FLOW_TRIGGERS"
+ ],
"description": "`Language` used to generate the executable bytes.",
"type": "string",
"enumDescriptions": [
"Language unspecified. Defaults to FIREBASE_RULES.",
"Firebase Rules language.",
"Event Flow triggers."
- ],
- "enum": [
- "LANGUAGE_UNSPECIFIED",
- "FIREBASE_RULES",
- "EVENT_FLOW_TRIGGERS"
]
},
"rulesetName": {
@@ -280,159 +434,9 @@
"type": "string"
}
},
- "id": "GetReleaseExecutableResponse"
- },
- "Source": {
- "description": "`Source` is one or more `File` messages comprising a logical set of rules.",
- "type": "object",
- "properties": {
- "files": {
- "description": "`File` set constituting the `Source` bundle.",
- "type": "array",
- "items": {
- "$ref": "File"
- }
- }
- },
- "id": "Source"
- },
- "Result": {
- "description": "Possible result values from the function mock invocation.",
- "type": "object",
- "properties": {
- "value": {
- "description": "The result is an actual value. The type of the value must match that\nof the type declared by the service.",
- "type": "any"
- },
- "undefined": {
- "description": "The result is undefined, meaning the result could not be computed.",
- "$ref": "Empty"
- }
- },
- "id": "Result"
- },
- "SourcePosition": {
- "description": "Position in the `Source` content including its line, column number, and an\nindex of the `File` in the `Source` message. Used for debug purposes.",
- "type": "object",
- "properties": {
- "fileName": {
- "description": "Name of the `File`.",
- "type": "string"
- },
- "line": {
- "description": "Line number of the source fragment. 1-based.",
- "format": "int32",
- "type": "integer"
- },
- "column": {
- "description": "First column on the source line associated with the source fragment.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "SourcePosition"
- },
- "TestCase": {
- "description": "`TestCase` messages provide the request context and an expectation as to\nwhether the given context will be allowed or denied. Test cases may specify\nthe `request`, `resource`, and `function_mocks` to mock a function call to\na service-provided function.\n\nThe `request` object represents context present at request-time.\n\nThe `resource` is the value of the target resource as it appears in\npersistent storage before the request is executed.",
- "type": "object",
- "properties": {
- "resource": {
- "description": "Optional resource value as it appears in persistent storage before the\nrequest is fulfilled.\n\nThe resource type depends on the `request.path` value.",
- "type": "any"
- },
- "functionMocks": {
- "description": "Optional function mocks for service-defined functions. If not set, any\nservice defined function is expected to return an error, which may or may\nnot influence the test outcome.",
- "type": "array",
- "items": {
- "$ref": "FunctionMock"
- }
- },
- "expectation": {
- "description": "Test expectation.",
- "type": "string",
- "enumDescriptions": [
- "Unspecified expectation.",
- "Expect an allowed result.",
- "Expect a denied result."
- ],
- "enum": [
- "EXPECTATION_UNSPECIFIED",
- "ALLOW",
- "DENY"
- ]
- },
- "request": {
- "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"
- },
- "Issue": {
- "description": "Issues include warnings, errors, and deprecation notices.",
- "type": "object",
- "properties": {
- "description": {
- "description": "Short error description.",
- "type": "string"
- },
- "sourcePosition": {
- "$ref": "SourcePosition",
- "description": "Position of the issue in the `Source`."
- },
- "severity": {
- "enumDescriptions": [
- "An unspecified severity.",
- "Deprecation issue for statements and method that may no longer be\nsupported or maintained.",
- "Warnings such as: unused variables.",
- "Errors such as: unmatched curly braces or variable redefinition."
- ],
- "enum": [
- "SEVERITY_UNSPECIFIED",
- "DEPRECATION",
- "WARNING",
- "ERROR"
- ],
- "description": "The severity of the issue.",
- "type": "string"
- }
- },
- "id": "Issue"
- },
- "TestRulesetRequest": {
- "description": "The request for FirebaseRulesService.TestRuleset.",
- "type": "object",
- "properties": {
- "source": {
- "description": "Optional `Source` to be checked for correctness.\n\nThis field must not be set when the resource name refers to a `Ruleset`.",
- "$ref": "Source"
- },
- "testSuite": {
- "$ref": "TestSuite",
- "description": "Inline `TestSuite` to run."
- }
- },
- "id": "TestRulesetRequest"
- },
- "Ruleset": {
- "description": "`Ruleset` is an immutable copy of `Source` with a globally unique identifier\nand a creation time.",
- "type": "object",
- "properties": {
- "createTime": {
- "description": "Time the `Ruleset` was created.\nOutput only.",
- "format": "google-datetime",
- "type": "string"
- },
- "name": {
- "description": "Name of the `Ruleset`. The ruleset_id is auto generated by the service.\nFormat: `projects/{project_id}/rulesets/{ruleset_id}`\nOutput only.",
- "type": "string"
- },
- "source": {
- "description": "`Source` for the `Ruleset`.",
- "$ref": "Source"
- }
- },
- "id": "Ruleset"
+ "id": "GetReleaseExecutableResponse",
+ "description": "The response for FirebaseRulesService.GetReleaseExecutable",
+ "type": "object"
}
},
"icons": {
@@ -464,42 +468,41 @@
"ownerName": "Google",
"resources": {
"projects": {
- "methods": {
- "test": {
- "request": {
- "$ref": "TestRulesetRequest"
- },
- "description": "Test `Source` for syntactic and semantic correctness. Issues present, if\nany, will be returned to the caller with a description, severity, and\nsource location.\n\nThe test method may be executed with `Source` or a `Ruleset` name.\nPassing `Source` is useful for unit testing new rules. Passing a `Ruleset`\nname is useful for regression testing an existing rule.\n\nThe following is an example of `Source` that permits users to upload images\nto a bucket bearing their user id and matching the correct metadata:\n\n_*Example*_\n\n // Users are allowed to subscribe and unsubscribe to the blog.\n service firebase.storage {\n match /users/{userId}/images/{imageName} {\n allow write: if userId == request.auth.uid\n && (imageName.matches('*.png$')\n || imageName.matches('*.jpg$'))\n && resource.mimeType.matches('^image/')\n }\n }",
- "response": {
- "$ref": "TestRulesetResponse"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "POST",
- "parameters": {
- "name": {
- "description": "Tests may either provide `source` or a `Ruleset` resource name.\n\nFor tests against `source`, the resource name must refer to the project:\nFormat: `projects/{project_id}`\n\nFor tests against a `Ruleset`, this must be the `Ruleset` resource name:\nFormat: `projects/{project_id}/rulesets/{ruleset_id}`",
- "required": true,
- "type": "string",
- "pattern": "^projects/.+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/firebase",
- "https://www.googleapis.com/auth/firebase.readonly"
- ],
- "flatPath": "v1/projects/{projectsId}:test",
- "path": "v1/{+name}:test",
- "id": "firebaserules.projects.test"
- }
- },
"resources": {
"rulesets": {
"methods": {
+ "create": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Ruleset"
+ },
+ "parameters": {
+ "name": {
+ "description": "Resource name for Project which owns this `Ruleset`.\n\nFormat: `projects/{project_id}`",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/firebase"
+ ],
+ "flatPath": "v1/projects/{projectsId}/rulesets",
+ "id": "firebaserules.projects.rulesets.create",
+ "path": "v1/{+name}/rulesets",
+ "request": {
+ "$ref": "Ruleset"
+ },
+ "description": "Create a `Ruleset` from `Source`.\n\nThe `Ruleset` is given a unique generated name which is returned to the\ncaller. `Source` containing syntactic or semantics errors will result in an\nerror response indicating the first error encountered. For a detailed view\nof `Source` issues, use TestRuleset."
+ },
"delete": {
+ "path": "v1/{+name}",
+ "id": "firebaserules.projects.rulesets.delete",
"description": "Delete a `Ruleset` by resource name.\n\nIf the `Ruleset` is referenced by a `Release` the operation will fail.",
"response": {
"$ref": "Empty"
@@ -508,6 +511,10 @@
"name"
],
"httpMethod": "DELETE",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/firebase"
+ ],
"parameters": {
"name": {
"description": "Resource name for the ruleset to delete.\n\nFormat: `projects/{project_id}/rulesets/{ruleset_id}`",
@@ -517,30 +524,26 @@
"location": "path"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/firebase"
- ],
- "flatPath": "v1/projects/{projectsId}/rulesets/{rulesetsId}",
- "path": "v1/{+name}",
- "id": "firebaserules.projects.rulesets.delete"
+ "flatPath": "v1/projects/{projectsId}/rulesets/{rulesetsId}"
},
"get": {
+ "id": "firebaserules.projects.rulesets.get",
+ "path": "v1/{+name}",
"description": "Get a `Ruleset` by name including the full `Source` contents.",
+ "httpMethod": "GET",
"response": {
"$ref": "Ruleset"
},
"parameterOrder": [
"name"
],
- "httpMethod": "GET",
"parameters": {
"name": {
+ "pattern": "^projects/[^/]+/rulesets/[^/]+$",
+ "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/[^/]+$",
- "location": "path"
+ "type": "string"
}
},
"scopes": [
@@ -548,15 +551,9 @@
"https://www.googleapis.com/auth/firebase",
"https://www.googleapis.com/auth/firebase.readonly"
],
- "flatPath": "v1/projects/{projectsId}/rulesets/{rulesetsId}",
- "path": "v1/{+name}",
- "id": "firebaserules.projects.rulesets.get"
+ "flatPath": "v1/projects/{projectsId}/rulesets/{rulesetsId}"
},
"list": {
- "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"
},
@@ -564,177 +561,48 @@
"name"
],
"httpMethod": "GET",
- "parameters": {
- "filter": {
- "location": "query",
- "description": "`Ruleset` filter. The list method supports filters with restrictions on\n`Ruleset.name`.\n\nFilters on `Ruleset.create_time` should use the `date` function which\nparses strings that conform to the RFC 3339 date/time specifications.\n\nExample: `create_time \u003e date(\"2017-01-01\") AND name=UUID-*`",
- "type": "string"
- },
- "name": {
- "description": "Resource name for the project.\n\nFormat: `projects/{project_id}`",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+$",
- "location": "path"
- },
- "pageToken": {
- "location": "query",
- "description": "Next page token for loading the next batch of `Ruleset` instances.",
- "type": "string"
- },
- "pageSize": {
- "description": "Page size to load. Maximum of 100. Defaults to 10.\nNote: `page_size` is just a hint and the service may choose to load less\nthan `page_size` due to the size of the output. To traverse all of the\nreleases, caller should iterate until the `page_token` is empty.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- }
- },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/firebase",
"https://www.googleapis.com/auth/firebase.readonly"
- ]
- },
- "create": {
- "flatPath": "v1/projects/{projectsId}/rulesets",
- "path": "v1/{+name}/rulesets",
- "id": "firebaserules.projects.rulesets.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.",
- "request": {
- "$ref": "Ruleset"
- },
- "response": {
- "$ref": "Ruleset"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/firebase"
],
"parameters": {
"name": {
+ "pattern": "^projects/[^/]+$",
"location": "path",
- "description": "Resource name for Project which owns this `Ruleset`.\n\nFormat: `projects/{project_id}`",
+ "description": "Resource name for the project.\n\nFormat: `projects/{project_id}`",
"required": true,
+ "type": "string"
+ },
+ "pageToken": {
+ "description": "Next page token for loading the next batch of `Ruleset` instances.",
"type": "string",
- "pattern": "^projects/[^/]+$"
+ "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": {
+ "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"
}
- }
+ },
+ "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."
}
}
},
"releases": {
"methods": {
- "delete": {
- "description": "Delete a `Release` by resource name.",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "DELETE",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/firebase"
- ],
- "parameters": {
- "name": {
- "location": "path",
- "description": "Resource name for the `Release` to delete.\n\nFormat: `projects/{project_id}/releases/{release_id}`",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/releases/.+$"
- }
- },
- "flatPath": "v1/projects/{projectsId}/releases/{releasesId}",
- "path": "v1/{+name}",
- "id": "firebaserules.projects.releases.delete"
- },
- "getExecutable": {
- "response": {
- "$ref": "GetReleaseExecutableResponse"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "parameters": {
- "name": {
- "description": "Resource name of the `Release`.\n\nFormat: `projects/{project_id}/releases/{release_id}`",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/releases/.+$",
- "location": "path"
- },
- "executableVersion": {
- "location": "query",
- "enum": [
- "RELEASE_EXECUTABLE_VERSION_UNSPECIFIED",
- "FIREBASE_RULES_EXECUTABLE_V1",
- "FIREBASE_RULES_EXECUTABLE_V2"
- ],
- "description": "The requested runtime executable version.\nDefaults to FIREBASE_RULES_EXECUTABLE_V1",
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/firebase",
- "https://www.googleapis.com/auth/firebase.readonly"
- ],
- "flatPath": "v1/projects/{projectsId}/releases/{releasesId}:getExecutable",
- "path": "v1/{+name}:getExecutable",
- "id": "firebaserules.projects.releases.getExecutable",
- "description": "Get the `Release` executable to use when enforcing rules."
- },
- "list": {
- "response": {
- "$ref": "ListReleasesResponse"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "parameters": {
- "filter": {
- "description": "`Release` filter. The list method supports filters with restrictions on the\n`Release.name`, `Release.ruleset_name`, and `Release.test_suite_name`.\n\nExample 1: A filter of 'name=prod*' might return `Release`s with names\nwithin 'projects/foo' prefixed with 'prod':\n\nName | Ruleset Name\n------------------------------|-------------\nprojects/foo/releases/prod | projects/foo/rulesets/uuid1234\nprojects/foo/releases/prod/v1 | projects/foo/rulesets/uuid1234\nprojects/foo/releases/prod/v2 | projects/foo/rulesets/uuid8888\n\nExample 2: A filter of `name=prod* ruleset_name=uuid1234` would return only\n`Release` instances for 'projects/foo' with names prefixed with 'prod'\nreferring to the same `Ruleset` name of 'uuid1234':\n\nName | Ruleset Name\n------------------------------|-------------\nprojects/foo/releases/prod | projects/foo/rulesets/1234\nprojects/foo/releases/prod/v1 | projects/foo/rulesets/1234\n\nIn the examples, the filter parameters refer to the search filters are\nrelative to the project. Fully qualified prefixed may also be used. e.g.\n`test_suite_name=projects/foo/testsuites/uuid1`",
- "type": "string",
- "location": "query"
- },
- "name": {
- "location": "path",
- "description": "Resource name for the project.\n\nFormat: `projects/{project_id}`",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+$"
- },
- "pageToken": {
- "location": "query",
- "description": "Next page token for the next batch of `Release` instances.",
- "type": "string"
- },
- "pageSize": {
- "location": "query",
- "description": "Page size to load. Maximum of 100. Defaults to 10.\nNote: `page_size` is just a hint and the service may choose to load fewer\nthan `page_size` results due to the size of the output. To traverse all of\nthe releases, the caller should iterate until the `page_token` on the\nresponse is empty.",
- "format": "int32",
- "type": "integer"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/firebase",
- "https://www.googleapis.com/auth/firebase.readonly"
- ],
- "flatPath": "v1/projects/{projectsId}/releases",
- "path": "v1/{+name}/releases",
- "id": "firebaserules.projects.releases.list",
- "description": "List the `Release` values for a project. This list may optionally be\nfiltered by `Release` name, `Ruleset` name, `TestSuite` name, or any\ncombination thereof."
- },
"create": {
+ "path": "v1/{+name}/releases",
+ "id": "firebaserules.projects.releases.create",
"request": {
"$ref": "Release"
},
@@ -748,20 +616,18 @@
"httpMethod": "POST",
"parameters": {
"name": {
+ "pattern": "^projects/[^/]+$",
+ "location": "path",
"description": "Resource name for the project which owns this `Release`.\n\nFormat: `projects/{project_id}`",
"required": true,
- "type": "string",
- "pattern": "^projects/[^/]+$",
- "location": "path"
+ "type": "string"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/firebase"
],
- "flatPath": "v1/projects/{projectsId}/releases",
- "path": "v1/{+name}/releases",
- "id": "firebaserules.projects.releases.create"
+ "flatPath": "v1/projects/{projectsId}/releases"
},
"patch": {
"request": {
@@ -777,11 +643,11 @@
},
"parameters": {
"name": {
+ "pattern": "^projects/[^/]+/releases/.+$",
+ "location": "path",
"description": "Resource name for the project which owns this `Release`.\n\nFormat: `projects/{project_id}`",
"required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/releases/.+$",
- "location": "path"
+ "type": "string"
}
},
"scopes": [
@@ -793,6 +659,8 @@
"path": "v1/{+name}"
},
"get": {
+ "path": "v1/{+name}",
+ "id": "firebaserules.projects.releases.get",
"description": "Get a `Release` by name.",
"response": {
"$ref": "Release"
@@ -808,77 +676,223 @@
],
"parameters": {
"name": {
+ "pattern": "^projects/[^/]+/releases/.+$",
"location": "path",
"description": "Resource name of the `Release`.\n\nFormat: `projects/{project_id}/releases/{release_id}`",
"required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/releases/.+$"
+ "type": "string"
}
},
- "flatPath": "v1/projects/{projectsId}/releases/{releasesId}",
- "path": "v1/{+name}",
- "id": "firebaserules.projects.releases.get"
+ "flatPath": "v1/projects/{projectsId}/releases/{releasesId}"
},
"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": {
- "description": "Resource name for the `Release`.\n\n`Release` names may be structured `app1/prod/v2` or flat `app1_prod_v2`\nwhich affords developers a great deal of flexibility in mapping the name\nto the style that best fits their existing development practices. For\nexample, a name could refer to an environment, an app, a version, or some\ncombination of three.\n\nIn the table below, for the project name `projects/foo`, the following\nrelative release paths show how flat and structured names might be chosen\nto match a desired development / deployment strategy.\n\nUse Case | Flat Name | Structured Name\n-------------|---------------------|----------------\nEnvironments | releases/qa | releases/qa\nApps | releases/app1_qa | releases/app1/qa\nVersions | releases/app1_v2_qa | releases/app1/v2/qa\n\nThe delimiter between the release name path elements can be almost anything\nand it should work equally well with the release name list filter, but in\nmany ways the structured paths provide a clearer picture of the\nrelationship between `Release` instances.\n\nFormat: `projects/{project_id}/releases/{release_id}`",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/releases/.+$",
- "location": "path"
- }
- },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "PUT",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/firebase"
],
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+/releases/.+$",
+ "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"
+ }
+ },
"flatPath": "v1/projects/{projectsId}/releases/{releasesId}",
+ "path": "v1/{+name}",
"id": "firebaserules.projects.releases.update",
- "path": "v1/{+name}"
+ "description": "Update a `Release`.\n\nOnly updates to the `ruleset_name` and `test_suite_name` fields will be\nhonored. `Release` rename is not supported. To create a `Release` use the\nCreateRelease method.",
+ "request": {
+ "$ref": "Release"
+ }
+ },
+ "getExecutable": {
+ "id": "firebaserules.projects.releases.getExecutable",
+ "path": "v1/{+name}:getExecutable",
+ "description": "Get the `Release` executable to use when enforcing rules.",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "GetReleaseExecutableResponse"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "description": "Resource name of the `Release`.\n\nFormat: `projects/{project_id}/releases/{release_id}`",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/releases/.+$",
+ "location": "path"
+ },
+ "executableVersion": {
+ "enum": [
+ "RELEASE_EXECUTABLE_VERSION_UNSPECIFIED",
+ "FIREBASE_RULES_EXECUTABLE_V1",
+ "FIREBASE_RULES_EXECUTABLE_V2"
+ ],
+ "description": "The requested runtime executable version.\nDefaults to FIREBASE_RULES_EXECUTABLE_V1",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/firebase",
+ "https://www.googleapis.com/auth/firebase.readonly"
+ ],
+ "flatPath": "v1/projects/{projectsId}/releases/{releasesId}:getExecutable"
+ },
+ "delete": {
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "DELETE",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/firebase"
+ ],
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+/releases/.+$",
+ "location": "path",
+ "description": "Resource name for the `Release` to delete.\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.delete",
+ "description": "Delete a `Release` by resource name."
+ },
+ "list": {
+ "response": {
+ "$ref": "ListReleasesResponse"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/firebase",
+ "https://www.googleapis.com/auth/firebase.readonly"
+ ],
+ "parameters": {
+ "name": {
+ "description": "Resource name for the project.\n\nFormat: `projects/{project_id}`",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+$",
+ "location": "path"
+ },
+ "pageToken": {
+ "description": "Next page token for the next batch of `Release` instances.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageSize": {
+ "location": "query",
+ "description": "Page size to load. Maximum of 100. Defaults to 10.\nNote: `page_size` is just a hint and the service may choose to load fewer\nthan `page_size` results due to the size of the output. To traverse all of\nthe releases, the caller should iterate until the `page_token` on the\nresponse is empty.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "filter": {
+ "description": "`Release` filter. The list method supports filters with restrictions on the\n`Release.name`, `Release.ruleset_name`, and `Release.test_suite_name`.\n\nExample 1: A filter of 'name=prod*' might return `Release`s with names\nwithin 'projects/foo' prefixed with 'prod':\n\nName | Ruleset Name\n------------------------------|-------------\nprojects/foo/releases/prod | projects/foo/rulesets/uuid1234\nprojects/foo/releases/prod/v1 | projects/foo/rulesets/uuid1234\nprojects/foo/releases/prod/v2 | projects/foo/rulesets/uuid8888\n\nExample 2: A filter of `name=prod* ruleset_name=uuid1234` would return only\n`Release` instances for 'projects/foo' with names prefixed with 'prod'\nreferring to the same `Ruleset` name of 'uuid1234':\n\nName | Ruleset Name\n------------------------------|-------------\nprojects/foo/releases/prod | projects/foo/rulesets/1234\nprojects/foo/releases/prod/v1 | projects/foo/rulesets/1234\n\nIn the examples, the filter parameters refer to the search filters are\nrelative to the project. Fully qualified prefixed may also be used. e.g.\n`test_suite_name=projects/foo/testsuites/uuid1`",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/releases",
+ "path": "v1/{+name}/releases",
+ "id": "firebaserules.projects.releases.list",
+ "description": "List the `Release` values for a project. This list may optionally be\nfiltered by `Release` name, `Ruleset` name, `TestSuite` name, or any\ncombination thereof."
}
}
}
+ },
+ "methods": {
+ "test": {
+ "request": {
+ "$ref": "TestRulesetRequest"
+ },
+ "description": "Test `Source` for syntactic and semantic correctness. Issues present, if\nany, will be returned to the caller with a description, severity, and\nsource location.\n\nThe test method may be executed with `Source` or a `Ruleset` name.\nPassing `Source` is useful for unit testing new rules. Passing a `Ruleset`\nname is useful for regression testing an existing rule.\n\nThe following is an example of `Source` that permits users to upload images\nto a bucket bearing their user id and matching the correct metadata:\n\n_*Example*_\n\n // Users are allowed to subscribe and unsubscribe to the blog.\n service firebase.storage {\n match /users/{userId}/images/{imageName} {\n allow write: if userId == request.auth.uid\n && (imageName.matches('*.png$')\n || imageName.matches('*.jpg$'))\n && resource.mimeType.matches('^image/')\n }\n }",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "TestRulesetResponse"
+ },
+ "parameters": {
+ "name": {
+ "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"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/firebase",
+ "https://www.googleapis.com/auth/firebase.readonly"
+ ],
+ "flatPath": "v1/projects/{projectsId}:test",
+ "id": "firebaserules.projects.test",
+ "path": "v1/{+name}:test"
+ }
}
}
},
"parameters": {
+ "access_token": {
+ "description": "OAuth access token.",
+ "type": "string",
+ "location": "query"
+ },
+ "key": {
+ "location": "query",
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "type": "string"
+ },
"quotaUser": {
"location": "query",
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
"type": "string"
},
"pp": {
+ "location": "query",
"description": "Pretty-print response.",
"type": "boolean",
- "default": "true",
- "location": "query"
- },
- "oauth_token": {
- "location": "query",
- "description": "OAuth 2.0 token for the current user.",
- "type": "string"
+ "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": {
- "location": "query",
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"prettyPrint": {
"description": "Returns response with indentations and line breaks.",
@@ -886,15 +900,20 @@
"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"
},
- "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": [
@@ -909,12 +928,12 @@
"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",
@@ -923,22 +942,7 @@
],
"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"
+ "default": "json"
}
},
"version": "v1",
@@ -946,9 +950,5 @@
"kind": "discovery#restDescription",
"description": "Creates and manages rules that determine when a Firebase Rules-enabled service should permit a request.\n",
"servicePath": "",
- "basePath": "",
- "id": "firebaserules:v1",
- "revision": "20171108",
- "documentationLink": "https://firebase.google.com/docs/storage/security",
- "discoveryVersion": "v1"
+ "basePath": ""
}
diff --git a/firestore/v1beta1/firestore-api.json b/firestore/v1beta1/firestore-api.json
index 4d8c877..a89f93b 100644
--- a/firestore/v1beta1/firestore-api.json
+++ b/firestore/v1beta1/firestore-api.json
@@ -1,17 +1,4 @@
{
- "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"
- }
- }
- }
- },
"rootUrl": "https://firestore.googleapis.com/",
"ownerDomain": "google.com",
"name": "firestore",
@@ -24,85 +11,25 @@
"resources": {
"databases": {
"resources": {
- "documents": {
+ "indexes": {
"methods": {
- "write": {
- "description": "Streams batches of document updates and deletes, in order.",
- "request": {
- "$ref": "WriteRequest"
- },
+ "delete": {
+ "flatPath": "v1beta1/projects/{projectsId}/databases/{databasesId}/indexes/{indexesId}",
+ "id": "firestore.projects.databases.indexes.delete",
+ "path": "v1beta1/{+name}",
+ "description": "Deletes an index.",
+ "httpMethod": "DELETE",
"response": {
- "$ref": "WriteResponse"
+ "$ref": "Empty"
},
"parameterOrder": [
- "database"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/datastore"
+ "name"
],
"parameters": {
- "database": {
- "description": "The database name. In the format:\n`projects/{project_id}/databases/{database_id}`.\nThis is only required in the first message.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/databases/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1beta1/projects/{projectsId}/databases/{databasesId}/documents:write",
- "path": "v1beta1/{+database}/documents:write",
- "id": "firestore.projects.databases.documents.write"
- },
- "beginTransaction": {
- "description": "Starts a new transaction.",
- "request": {
- "$ref": "BeginTransactionRequest"
- },
- "response": {
- "$ref": "BeginTransactionResponse"
- },
- "parameterOrder": [
- "database"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/datastore"
- ],
- "parameters": {
- "database": {
+ "name": {
+ "pattern": "^projects/[^/]+/databases/[^/]+/indexes/[^/]+$",
"location": "path",
- "description": "The database name. In the format:\n`projects/{project_id}/databases/{database_id}`.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/databases/[^/]+$"
- }
- },
- "flatPath": "v1beta1/projects/{projectsId}/databases/{databasesId}/documents:beginTransaction",
- "path": "v1beta1/{+database}/documents:beginTransaction",
- "id": "firestore.projects.databases.documents.beginTransaction"
- },
- "batchGet": {
- "path": "v1beta1/{+database}/documents:batchGet",
- "id": "firestore.projects.databases.documents.batchGet",
- "request": {
- "$ref": "BatchGetDocumentsRequest"
- },
- "description": "Gets multiple documents.\n\nDocuments returned by this method are not guaranteed to be returned in the\nsame order that they were requested.",
- "response": {
- "$ref": "BatchGetDocumentsResponse"
- },
- "parameterOrder": [
- "database"
- ],
- "httpMethod": "POST",
- "parameters": {
- "database": {
- "pattern": "^projects/[^/]+/databases/[^/]+$",
- "location": "path",
- "description": "The database name. In the format:\n`projects/{project_id}/databases/{database_id}`.",
+ "description": "The index name. For example:\n`projects/{project_id}/databases/{database_id}/indexes/{index_id}`",
"required": true,
"type": "string"
}
@@ -110,91 +37,78 @@
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/datastore"
- ],
- "flatPath": "v1beta1/projects/{projectsId}/databases/{databasesId}/documents:batchGet"
+ ]
},
"list": {
- "id": "firestore.projects.databases.documents.list",
- "path": "v1beta1/{+parent}/{collectionId}",
- "description": "Lists documents.",
- "httpMethod": "GET",
+ "path": "v1beta1/{+parent}/indexes",
+ "id": "firestore.projects.databases.indexes.list",
+ "description": "Lists the indexes that match the specified filters.",
"response": {
- "$ref": "ListDocumentsResponse"
+ "$ref": "ListIndexesResponse"
},
"parameterOrder": [
- "parent",
- "collectionId"
+ "parent"
],
+ "httpMethod": "GET",
"parameters": {
- "mask.fieldPaths": {
- "description": "The list of field paths in the mask. See Document.fields for a field\npath syntax reference.",
- "type": "string",
- "repeated": true,
- "location": "query"
- },
"pageToken": {
- "description": "The `next_page_token` value returned from a previous List request, if any.",
+ "description": "The standard List page token.",
"type": "string",
"location": "query"
},
"pageSize": {
- "location": "query",
- "description": "The maximum number of documents to return.",
+ "description": "The standard List page size.",
"format": "int32",
- "type": "integer"
- },
- "collectionId": {
- "location": "path",
- "description": "The collection ID, relative to `parent`, to list. For example: `chatrooms`\nor `messages`.",
- "required": true,
- "type": "string"
- },
- "transaction": {
- "location": "query",
- "description": "Reads documents in a transaction.",
- "format": "byte",
- "type": "string"
+ "type": "integer",
+ "location": "query"
},
"parent": {
- "description": "The parent resource name. In the format:\n`projects/{project_id}/databases/{database_id}/documents` or\n`projects/{project_id}/databases/{database_id}/documents/{document_path}`.\nFor example:\n`projects/my-project/databases/my-database/documents` or\n`projects/my-project/databases/my-database/documents/chatrooms/my-chatroom`",
+ "description": "The database name. For example:\n`projects/{project_id}/databases/{database_id}`",
"required": true,
"type": "string",
- "pattern": "^projects/[^/]+/databases/[^/]+/documents/[^/]+/.+$",
+ "pattern": "^projects/[^/]+/databases/[^/]+$",
"location": "path"
},
- "readTime": {
+ "filter": {
"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"
- },
- "orderBy": {
- "description": "The order to sort results by. For example: `priority desc, name`.",
- "type": "string",
- "location": "query"
- },
- "showMissing": {
- "description": "If the list should show missing documents. A missing document is a\ndocument that does not exist but has sub-documents. These documents will\nbe returned with a key but will not have fields, Document.create_time,\nor Document.update_time set.\n\nRequests with `show_missing` may not specify `where` or\n`order_by`.",
- "type": "boolean",
- "location": "query"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/datastore"
],
- "flatPath": "v1beta1/projects/{projectsId}/databases/{databasesId}/documents/{documentsId}/{documentsId1}/{collectionId}"
+ "flatPath": "v1beta1/projects/{projectsId}/databases/{databasesId}/indexes"
},
- "runQuery": {
- "flatPath": "v1beta1/projects/{projectsId}/databases/{databasesId}/documents/{documentsId}/{documentsId1}:runQuery",
- "path": "v1beta1/{+parent}:runQuery",
- "id": "firestore.projects.databases.documents.runQuery",
- "description": "Runs a query.",
- "request": {
- "$ref": "RunQueryRequest"
- },
+ "get": {
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "name"
+ ],
"response": {
- "$ref": "RunQueryResponse"
+ "$ref": "Index"
+ },
+ "parameters": {
+ "name": {
+ "description": "The name of the index. For example:\n`projects/{project_id}/databases/{database_id}/indexes/{index_id}`",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/databases/[^/]+/indexes/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/datastore"
+ ],
+ "flatPath": "v1beta1/projects/{projectsId}/databases/{databasesId}/indexes/{indexesId}",
+ "id": "firestore.projects.databases.indexes.get",
+ "path": "v1beta1/{+name}",
+ "description": "Gets an index."
+ },
+ "create": {
+ "response": {
+ "$ref": "Operation"
},
"parameterOrder": [
"parent"
@@ -206,188 +120,26 @@
],
"parameters": {
"parent": {
- "location": "path",
- "description": "The parent resource name. In the format:\n`projects/{project_id}/databases/{database_id}/documents` or\n`projects/{project_id}/databases/{database_id}/documents/{document_path}`.\nFor example:\n`projects/my-project/databases/my-database/documents` or\n`projects/my-project/databases/my-database/documents/chatrooms/my-chatroom`",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/databases/[^/]+/documents/[^/]+/.+$"
- }
- }
- },
- "createDocument": {
- "httpMethod": "POST",
- "parameterOrder": [
- "parent",
- "collectionId"
- ],
- "response": {
- "$ref": "Document"
- },
- "parameters": {
- "parent": {
- "location": "path",
- "description": "The parent resource. For example:\n`projects/{project_id}/databases/{database_id}/documents` or\n`projects/{project_id}/databases/{database_id}/documents/chatrooms/{chatroom_id}`",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/databases/[^/]+/documents/.+$"
- },
- "documentId": {
- "location": "query",
- "description": "The client-assigned document ID to use for this document.\n\nOptional. If not specified, an ID will be assigned by the service.",
- "type": "string"
- },
- "mask.fieldPaths": {
- "location": "query",
- "description": "The list of field paths in the mask. See Document.fields for a field\npath syntax reference.",
- "type": "string",
- "repeated": true
- },
- "collectionId": {
- "description": "The collection ID, relative to `parent`, to list. For example: `chatrooms`.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/datastore"
- ],
- "flatPath": "v1beta1/projects/{projectsId}/databases/{databasesId}/documents/{documentsId}/{collectionId}",
- "id": "firestore.projects.databases.documents.createDocument",
- "path": "v1beta1/{+parent}/{collectionId}",
- "request": {
- "$ref": "Document"
- },
- "description": "Creates a new document."
- },
- "listen": {
- "response": {
- "$ref": "ListenResponse"
- },
- "parameterOrder": [
- "database"
- ],
- "httpMethod": "POST",
- "parameters": {
- "database": {
- "description": "The database name. In the format:\n`projects/{project_id}/databases/{database_id}`.",
+ "description": "The name of the database this index will apply to. For example:\n`projects/{project_id}/databases/{database_id}`",
"required": true,
"type": "string",
"pattern": "^projects/[^/]+/databases/[^/]+$",
"location": "path"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/datastore"
- ],
- "flatPath": "v1beta1/projects/{projectsId}/databases/{databasesId}/documents:listen",
- "path": "v1beta1/{+database}/documents:listen",
- "id": "firestore.projects.databases.documents.listen",
+ "flatPath": "v1beta1/projects/{projectsId}/databases/{databasesId}/indexes",
+ "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": "ListenRequest"
- },
- "description": "Listens to changes."
- },
- "patch": {
- "request": {
- "$ref": "Document"
- },
- "description": "Updates or inserts a document.",
- "response": {
- "$ref": "Document"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "PATCH",
- "parameters": {
- "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": {
- "repeated": true,
- "location": "query",
- "description": "The list of field paths in the mask. See Document.fields for a field\npath syntax reference.",
- "type": "string"
- },
- "mask.fieldPaths": {
- "repeated": true,
- "location": "query",
- "description": "The list of field paths in the mask. See Document.fields for a field\npath syntax reference.",
- "type": "string"
- },
- "currentDocument.updateTime": {
- "description": "When set, the target document must exist and have been last updated at\nthat time.",
- "format": "google-datetime",
- "type": "string",
- "location": "query"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/datastore"
- ],
- "flatPath": "v1beta1/projects/{projectsId}/databases/{databasesId}/documents/{documentsId}/{documentsId1}",
- "path": "v1beta1/{+name}",
- "id": "firestore.projects.databases.documents.patch"
- },
- "get": {
- "flatPath": "v1beta1/projects/{projectsId}/databases/{databasesId}/documents/{documentsId}/{documentsId1}",
- "id": "firestore.projects.databases.documents.get",
- "path": "v1beta1/{+name}",
- "description": "Gets a single document.",
- "httpMethod": "GET",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Document"
- },
- "parameters": {
- "name": {
- "description": "The resource name of the Document to get. In the format:\n`projects/{project_id}/databases/{database_id}/documents/{document_path}`.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/databases/[^/]+/documents/[^/]+/.+$",
- "location": "path"
- },
- "mask.fieldPaths": {
- "description": "The list of field paths in the mask. See Document.fields for a field\npath syntax reference.",
- "type": "string",
- "repeated": true,
- "location": "query"
- },
- "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": {
- "description": "Reads the document in a transaction.",
- "format": "byte",
- "type": "string",
- "location": "query"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/datastore"
- ]
- },
+ "$ref": "Index"
+ }
+ }
+ }
+ },
+ "documents": {
+ "methods": {
"commit": {
- "flatPath": "v1beta1/projects/{projectsId}/databases/{databasesId}/documents:commit",
"id": "firestore.projects.databases.documents.commit",
"path": "v1beta1/{+database}/documents:commit",
"request": {
@@ -403,45 +155,45 @@
},
"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/[^/]+$",
- "location": "path"
+ "pattern": "^projects/[^/]+/databases/[^/]+$"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/datastore"
- ]
+ ],
+ "flatPath": "v1beta1/projects/{projectsId}/databases/{databasesId}/documents:commit"
},
"delete": {
- "description": "Deletes a document.",
+ "httpMethod": "DELETE",
"response": {
"$ref": "Empty"
},
"parameterOrder": [
"name"
],
- "httpMethod": "DELETE",
"parameters": {
- "currentDocument.exists": {
+ "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"
+ "type": "boolean",
+ "location": "query"
},
"name": {
- "pattern": "^projects/[^/]+/databases/[^/]+/documents/[^/]+/.+$",
"location": "path",
"description": "The resource name of the Document to delete. In the format:\n`projects/{project_id}/databases/{database_id}/documents/{document_path}`.",
"required": true,
- "type": "string"
- },
- "currentDocument.updateTime": {
- "description": "When set, the target document must exist and have been last updated at\nthat time.",
- "format": "google-datetime",
"type": "string",
- "location": "query"
+ "pattern": "^projects/[^/]+/databases/[^/]+/documents/[^/]+/.+$"
}
},
"scopes": [
@@ -449,8 +201,9 @@
"https://www.googleapis.com/auth/datastore"
],
"flatPath": "v1beta1/projects/{projectsId}/databases/{databasesId}/documents/{documentsId}/{documentsId1}",
+ "id": "firestore.projects.databases.documents.delete",
"path": "v1beta1/{+name}",
- "id": "firestore.projects.databases.documents.delete"
+ "description": "Deletes a document."
},
"listCollectionIds": {
"response": {
@@ -462,11 +215,11 @@
"httpMethod": "POST",
"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/[^/]+/.+$",
- "location": "path"
+ "pattern": "^projects/[^/]+/databases/[^/]+/documents/[^/]+/.+$"
}
},
"scopes": [
@@ -482,6 +235,10 @@
"description": "Lists all the collection IDs underneath a document."
},
"rollback": {
+ "description": "Rolls back a transaction.",
+ "request": {
+ "$ref": "RollbackRequest"
+ },
"response": {
"$ref": "Empty"
},
@@ -504,44 +261,154 @@
},
"flatPath": "v1beta1/projects/{projectsId}/databases/{databasesId}/documents:rollback",
"path": "v1beta1/{+database}/documents:rollback",
- "id": "firestore.projects.databases.documents.rollback",
- "description": "Rolls back a transaction.",
- "request": {
- "$ref": "RollbackRequest"
- }
- }
- }
- },
- "indexes": {
- "methods": {
- "list": {
- "description": "Lists the indexes that match the specified filters.",
+ "id": "firestore.projects.databases.documents.rollback"
+ },
+ "write": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "database"
+ ],
"response": {
- "$ref": "ListIndexesResponse"
+ "$ref": "WriteResponse"
+ },
+ "parameters": {
+ "database": {
+ "location": "path",
+ "description": "The database name. In the format:\n`projects/{project_id}/databases/{database_id}`.\nThis is only required in the first message.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/databases/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/datastore"
+ ],
+ "flatPath": "v1beta1/projects/{projectsId}/databases/{databasesId}/documents:write",
+ "id": "firestore.projects.databases.documents.write",
+ "path": "v1beta1/{+database}/documents:write",
+ "request": {
+ "$ref": "WriteRequest"
+ },
+ "description": "Streams batches of document updates and deletes, in order."
+ },
+ "batchGet": {
+ "flatPath": "v1beta1/projects/{projectsId}/databases/{databasesId}/documents:batchGet",
+ "id": "firestore.projects.databases.documents.batchGet",
+ "path": "v1beta1/{+database}/documents:batchGet",
+ "request": {
+ "$ref": "BatchGetDocumentsRequest"
+ },
+ "description": "Gets multiple documents.\n\nDocuments returned by this method are not guaranteed to be returned in the\nsame order that they were requested.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "database"
+ ],
+ "response": {
+ "$ref": "BatchGetDocumentsResponse"
+ },
+ "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"
+ ]
+ },
+ "beginTransaction": {
+ "response": {
+ "$ref": "BeginTransactionResponse"
},
"parameterOrder": [
- "parent"
+ "database"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "database": {
+ "description": "The database name. In the format:\n`projects/{project_id}/databases/{database_id}`.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/databases/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/datastore"
+ ],
+ "flatPath": "v1beta1/projects/{projectsId}/databases/{databasesId}/documents:beginTransaction",
+ "path": "v1beta1/{+database}/documents:beginTransaction",
+ "id": "firestore.projects.databases.documents.beginTransaction",
+ "request": {
+ "$ref": "BeginTransactionRequest"
+ },
+ "description": "Starts a new transaction."
+ },
+ "list": {
+ "description": "Lists documents.",
+ "response": {
+ "$ref": "ListDocumentsResponse"
+ },
+ "parameterOrder": [
+ "parent",
+ "collectionId"
],
"httpMethod": "GET",
"parameters": {
- "parent": {
- "pattern": "^projects/[^/]+/databases/[^/]+$",
- "location": "path",
- "description": "The database name. For example:\n`projects/{project_id}/databases/{database_id}`",
- "required": true,
- "type": "string"
- },
- "filter": {
+ "transaction": {
+ "description": "Reads documents in a transaction.",
+ "format": "byte",
"type": "string",
"location": "query"
},
- "pageToken": {
+ "parent": {
+ "description": "The parent resource name. In the format:\n`projects/{project_id}/databases/{database_id}/documents` or\n`projects/{project_id}/databases/{database_id}/documents/{document_path}`.\nFor example:\n`projects/my-project/databases/my-database/documents` or\n`projects/my-project/databases/my-database/documents/chatrooms/my-chatroom`",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/databases/[^/]+/documents/[^/]+/.+$",
+ "location": "path"
+ },
+ "orderBy": {
"location": "query",
- "description": "The standard List page token.",
+ "description": "The order to sort results by. For example: `priority desc, name`.",
+ "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"
+ },
+ "showMissing": {
+ "description": "If the list should show missing documents. A missing document is a\ndocument that does not exist but has sub-documents. These documents will\nbe returned with a key but will not have fields, Document.create_time,\nor Document.update_time set.\n\nRequests with `show_missing` may not specify `where` or\n`order_by`.",
+ "type": "boolean",
+ "location": "query"
+ },
+ "pageToken": {
+ "description": "The `next_page_token` value returned from a previous List request, if any.",
+ "type": "string",
+ "location": "query"
+ },
+ "mask.fieldPaths": {
+ "location": "query",
+ "description": "The list of field paths in the mask. See Document.fields for a field\npath syntax reference.",
+ "type": "string",
+ "repeated": true
+ },
+ "collectionId": {
+ "location": "path",
+ "description": "The collection ID, relative to `parent`, to list. For example: `chatrooms`\nor `messages`.",
+ "required": true,
"type": "string"
},
"pageSize": {
- "description": "The standard List page size.",
+ "description": "The maximum number of documents to return.",
"format": "int32",
"type": "integer",
"location": "query"
@@ -551,90 +418,210 @@
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/datastore"
],
- "flatPath": "v1beta1/projects/{projectsId}/databases/{databasesId}/indexes",
- "path": "v1beta1/{+parent}/indexes",
- "id": "firestore.projects.databases.indexes.list"
+ "flatPath": "v1beta1/projects/{projectsId}/databases/{databasesId}/documents/{documentsId}/{documentsId1}/{collectionId}",
+ "path": "v1beta1/{+parent}/{collectionId}",
+ "id": "firestore.projects.databases.documents.list"
},
- "get": {
- "id": "firestore.projects.databases.indexes.get",
- "path": "v1beta1/{+name}",
- "description": "Gets an index.",
- "httpMethod": "GET",
- "parameterOrder": [
- "name"
- ],
+ "runQuery": {
+ "description": "Runs a query.",
+ "request": {
+ "$ref": "RunQueryRequest"
+ },
"response": {
- "$ref": "Index"
+ "$ref": "RunQueryResponse"
},
- "parameters": {
- "name": {
- "description": "The name of the index. For example:\n`projects/{project_id}/databases/{database_id}/indexes/{index_id}`",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/databases/[^/]+/indexes/[^/]+$",
- "location": "path"
- }
- },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/datastore"
],
- "flatPath": "v1beta1/projects/{projectsId}/databases/{databasesId}/indexes/{indexesId}"
- },
- "create": {
- "request": {
- "$ref": "Index"
- },
- "description": "Creates the specified index.\nA newly created index's initial state is `CREATING`. On completion of the\nreturned google.longrunning.Operation, the state will be `READY`.\nIf the index already exists, the call will return an `ALREADY_EXISTS`\nstatus.\n\nDuring creation, the process could result in an error, in which case the\nindex will move to the `ERROR` state. The process can be recovered by\nfixing the data that caused the error, removing the index with\ndelete, then re-creating the index with\ncreate.\n\nIndexes with a single field cannot be created.",
- "httpMethod": "POST",
- "parameterOrder": [
- "parent"
- ],
- "response": {
- "$ref": "Operation"
- },
"parameters": {
"parent": {
- "pattern": "^projects/[^/]+/databases/[^/]+$",
+ "pattern": "^projects/[^/]+/databases/[^/]+/documents/[^/]+/.+$",
"location": "path",
- "description": "The name of the database this index will apply to. For example:\n`projects/{project_id}/databases/{database_id}`",
+ "description": "The parent resource name. In the format:\n`projects/{project_id}/databases/{database_id}/documents` or\n`projects/{project_id}/databases/{database_id}/documents/{document_path}`.\nFor example:\n`projects/my-project/databases/my-database/documents` or\n`projects/my-project/databases/my-database/documents/chatrooms/my-chatroom`",
"required": true,
"type": "string"
}
},
+ "flatPath": "v1beta1/projects/{projectsId}/databases/{databasesId}/documents/{documentsId}/{documentsId1}:runQuery",
+ "path": "v1beta1/{+parent}:runQuery",
+ "id": "firestore.projects.databases.documents.runQuery"
+ },
+ "createDocument": {
+ "request": {
+ "$ref": "Document"
+ },
+ "description": "Creates a new document.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "parent",
+ "collectionId"
+ ],
+ "response": {
+ "$ref": "Document"
+ },
+ "parameters": {
+ "collectionId": {
+ "description": "The collection ID, relative to `parent`, to list. For example: `chatrooms`.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "parent": {
+ "pattern": "^projects/[^/]+/databases/[^/]+/documents/.+$",
+ "location": "path",
+ "description": "The parent resource. For example:\n`projects/{project_id}/databases/{database_id}/documents` or\n`projects/{project_id}/databases/{database_id}/documents/chatrooms/{chatroom_id}`",
+ "required": true,
+ "type": "string"
+ },
+ "documentId": {
+ "location": "query",
+ "description": "The client-assigned document ID to use for this document.\n\nOptional. If not specified, an ID will be assigned by the service.",
+ "type": "string"
+ },
+ "mask.fieldPaths": {
+ "repeated": true,
+ "location": "query",
+ "description": "The list of field paths in the mask. See Document.fields for a field\npath syntax reference.",
+ "type": "string"
+ }
+ },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/datastore"
],
- "flatPath": "v1beta1/projects/{projectsId}/databases/{databasesId}/indexes",
- "id": "firestore.projects.databases.indexes.create",
- "path": "v1beta1/{+parent}/indexes"
+ "flatPath": "v1beta1/projects/{projectsId}/databases/{databasesId}/documents/{documentsId}/{collectionId}",
+ "id": "firestore.projects.databases.documents.createDocument",
+ "path": "v1beta1/{+parent}/{collectionId}"
},
- "delete": {
+ "get": {
+ "id": "firestore.projects.databases.documents.get",
+ "path": "v1beta1/{+name}",
+ "description": "Gets a single document.",
+ "httpMethod": "GET",
"response": {
- "$ref": "Empty"
+ "$ref": "Document"
},
"parameterOrder": [
"name"
],
- "httpMethod": "DELETE",
"parameters": {
+ "transaction": {
+ "description": "Reads the document in a transaction.",
+ "format": "byte",
+ "type": "string",
+ "location": "query"
+ },
"name": {
- "location": "path",
- "description": "The index name. For example:\n`projects/{project_id}/databases/{database_id}/indexes/{index_id}`",
+ "description": "The resource name of the Document to get. In the format:\n`projects/{project_id}/databases/{database_id}/documents/{document_path}`.",
"required": true,
"type": "string",
- "pattern": "^projects/[^/]+/databases/[^/]+/indexes/[^/]+$"
+ "pattern": "^projects/[^/]+/databases/[^/]+/documents/[^/]+/.+$",
+ "location": "path"
+ },
+ "mask.fieldPaths": {
+ "repeated": true,
+ "location": "query",
+ "description": "The list of field paths in the mask. See Document.fields for a field\npath syntax reference.",
+ "type": "string"
+ },
+ "readTime": {
+ "description": "Reads the version of the document at the given time.\nThis may not be older than 60 seconds.",
+ "format": "google-datetime",
+ "type": "string",
+ "location": "query"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/datastore"
],
- "flatPath": "v1beta1/projects/{projectsId}/databases/{databasesId}/indexes/{indexesId}",
+ "flatPath": "v1beta1/projects/{projectsId}/databases/{databasesId}/documents/{documentsId}/{documentsId1}"
+ },
+ "patch": {
+ "request": {
+ "$ref": "Document"
+ },
+ "description": "Updates or inserts a document.",
+ "response": {
+ "$ref": "Document"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "PATCH",
+ "parameters": {
+ "name": {
+ "location": "path",
+ "description": "The resource name of the document, for example\n`projects/{project_id}/databases/{database_id}/documents/{document_path}`.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/databases/[^/]+/documents/[^/]+/.+$"
+ },
+ "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"
+ }
+ },
+ "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.indexes.delete",
- "description": "Deletes an index."
+ "id": "firestore.projects.databases.documents.patch"
+ },
+ "listen": {
+ "request": {
+ "$ref": "ListenRequest"
+ },
+ "description": "Listens to changes.",
+ "response": {
+ "$ref": "ListenResponse"
+ },
+ "parameterOrder": [
+ "database"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "database": {
+ "description": "The database name. In the format:\n`projects/{project_id}/databases/{database_id}`.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/databases/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/datastore"
+ ],
+ "flatPath": "v1beta1/projects/{projectsId}/databases/{databasesId}/documents:listen",
+ "path": "v1beta1/{+database}/documents:listen",
+ "id": "firestore.projects.databases.documents.listen"
}
}
}
@@ -644,11 +631,42 @@
}
},
"parameters": {
- "upload_protocol": {
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "key": {
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
"type": "string",
"location": "query"
},
+ "access_token": {
+ "description": "OAuth access token.",
+ "type": "string",
+ "location": "query"
+ },
+ "quotaUser": {
+ "location": "query",
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "type": "string"
+ },
+ "pp": {
+ "description": "Pretty-print response.",
+ "type": "boolean",
+ "default": "true",
+ "location": "query"
+ },
+ "oauth_token": {
+ "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",
@@ -656,9 +674,9 @@
"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.",
@@ -666,8 +684,6 @@
"location": "query"
},
"$.xgafv": {
- "description": "V1 error format.",
- "type": "string",
"enumDescriptions": [
"v1 error format",
"v2 error format"
@@ -676,7 +692,9 @@
"enum": [
"1",
"2"
- ]
+ ],
+ "description": "V1 error format.",
+ "type": "string"
},
"callback": {
"description": "JSONP",
@@ -684,8 +702,6 @@
"location": "query"
},
"alt": {
- "description": "Data format for response.",
- "default": "json",
"enum": [
"json",
"media",
@@ -697,38 +713,9 @@
"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": {
- "description": "Available 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"
+ "description": "Data format for response.",
+ "default": "json"
}
},
"version": "v1beta1",
@@ -743,257 +730,6 @@
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
- "DocumentTransform": {
- "description": "A transformation of a document.",
- "type": "object",
- "properties": {
- "document": {
- "description": "The name of the document to transform.",
- "type": "string"
- },
- "fieldTransforms": {
- "description": "The list of transformations to apply to the fields of the document, in\norder.\nThis must not be empty.",
- "type": "array",
- "items": {
- "$ref": "FieldTransform"
- }
- }
- },
- "id": "DocumentTransform"
- },
- "FieldTransform": {
- "description": "A transformation of a field of the document.",
- "type": "object",
- "properties": {
- "fieldPath": {
- "description": "The path of the field. See Document.fields for the field path syntax\nreference.",
- "type": "string"
- },
- "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"
- }
- },
- "id": "FieldTransform"
- },
- "CommitResponse": {
- "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"
- }
- }
- },
- "id": "CommitResponse"
- },
- "ListCollectionIdsResponse": {
- "description": "The response from Firestore.ListCollectionIds.",
- "type": "object",
- "properties": {
- "collectionIds": {
- "description": "The collection ids.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "nextPageToken": {
- "description": "A page token that may be used to continue the list.",
- "type": "string"
- }
- },
- "id": "ListCollectionIdsResponse"
- },
- "Order": {
- "description": "An order on a field.",
- "type": "object",
- "properties": {
- "direction": {
- "enum": [
- "DIRECTION_UNSPECIFIED",
- "ASCENDING",
- "DESCENDING"
- ],
- "description": "The direction to order by. Defaults to `ASCENDING`.",
- "type": "string",
- "enumDescriptions": [
- "Unspecified.",
- "Ascending.",
- "Descending."
- ]
- },
- "field": {
- "$ref": "FieldReference",
- "description": "The field to order by."
- }
- },
- "id": "Order"
- },
- "WriteResponse": {
- "description": "The response for Firestore.Write.",
- "type": "object",
- "properties": {
- "streamToken": {
- "description": "A token that represents the position of this response in the stream.\nThis can be used by a client to resume the stream at this point.\n\nThis field is always set.",
- "format": "byte",
- "type": "string"
- },
- "writeResults": {
- "description": "The result of applying the writes.\n\nThis i-th write result corresponds to the i-th write in the\nrequest.",
- "type": "array",
- "items": {
- "$ref": "WriteResult"
- }
- },
- "streamId": {
- "description": "The ID of the stream.\nOnly set on the first message, when a new stream was created.",
- "type": "string"
- },
- "commitTime": {
- "description": "The time at which the commit occurred.",
- "format": "google-datetime",
- "type": "string"
- }
- },
- "id": "WriteResponse"
- },
- "FieldFilter": {
- "description": "A filter on a specific field.",
- "type": "object",
- "properties": {
- "field": {
- "$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",
- "LESS_THAN_OR_EQUAL",
- "GREATER_THAN",
- "GREATER_THAN_OR_EQUAL",
- "EQUAL"
- ],
- "description": "The operator to filter by.",
- "type": "string"
- }
- },
- "id": "FieldFilter"
- },
- "TargetChange": {
- "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",
- "items": {
- "format": "int32",
- "type": "integer"
- }
- },
- "cause": {
- "description": "The error that resulted in this change, if applicable.",
- "$ref": "Status"
- },
- "readTime": {
- "description": "The consistent `read_time` for the given `target_ids` (omitted when the\ntarget_ids are not at a consistent snapshot).\n\nThe stream is guaranteed to send a `read_time` with `target_ids` empty\nwhenever the entire stream reaches a new consistent snapshot. ADD,\nCURRENT, and RESET messages are guaranteed to (eventually) result in a\nnew consistent snapshot (while NO_CHANGE and REMOVE messages are not).\n\nFor a given stream, `read_time` is guaranteed to be monotonically\nincreasing.",
- "format": "google-datetime",
- "type": "string"
- },
- "targetChangeType": {
- "enum": [
- "NO_CHANGE",
- "ADD",
- "REMOVE",
- "CURRENT",
- "RESET"
- ],
- "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.",
- "The targets have been removed.",
- "The targets reflect all changes committed before the targets were added\nto the stream.\n\nThis will be sent after or with a `read_time` that is greater than or\nequal to the time at which the targets were added.\n\nListeners can wait for this change if read-after-write semantics\nare desired.",
- "The targets have been reset, and a new initial state for the targets\nwill be returned in subsequent changes.\n\nAfter the initial state is complete, `CURRENT` will be returned even\nif the target was previously indicated to be `CURRENT`."
- ]
- }
- },
- "id": "TargetChange",
- "description": "Targets being watched have changed.",
- "type": "object"
- },
- "MapValue": {
- "description": "A map value.",
- "type": "object",
- "properties": {
- "fields": {
- "additionalProperties": {
- "$ref": "Value"
- },
- "description": "The map's fields.\n\nThe map keys represent field names. Field names matching the regular\nexpression `__.*__` are reserved. Reserved field names are forbidden except\nin certain documented contexts. The map keys, represented as UTF-8, must\nnot exceed 1,500 bytes and cannot be empty.",
- "type": "object"
- }
- },
- "id": "MapValue"
- },
- "DocumentDelete": {
- "description": "A Document has been deleted.\n\nMay be the result of multiple writes, including updates, the\nlast of which deleted the Document.\n\nMultiple DocumentDelete messages may be returned for the same logical\ndelete, if multiple targets are affected.",
- "type": "object",
- "properties": {
- "readTime": {
- "description": "The read timestamp at which the delete was observed.\n\nGreater or equal to the `commit_time` of the delete.",
- "format": "google-datetime",
- "type": "string"
- },
- "removedTargetIds": {
- "description": "A set of target IDs for targets that previously matched this entity.",
- "type": "array",
- "items": {
- "format": "int32",
- "type": "integer"
- }
- },
- "document": {
- "description": "The resource name of the Document that was deleted.",
- "type": "string"
- }
- },
- "id": "DocumentDelete"
- },
"BeginTransactionResponse": {
"description": "The response for Firestore.BeginTransaction.",
"type": "object",
@@ -1035,6 +771,10 @@
"description": "The response for Firestore.RunQuery.",
"type": "object",
"properties": {
+ "document": {
+ "description": "A query result.\nNot set when reporting partial progress.",
+ "$ref": "Document"
+ },
"readTime": {
"description": "The time at which the document was read. This may be monotonically\nincreasing; in this case, the previous documents in the result stream are\nguaranteed not to have changed between their `read_time` and this one.\n\nIf the query returns no results, a response with `read_time` and no\n`document` will be sent, and this represents the time at which the query\nwas run.",
"format": "google-datetime",
@@ -1049,25 +789,10 @@
"description": "The transaction that was started as part of this request.\nCan only be set in the first response, and only if\nRunQueryRequest.new_transaction was set in the request.\nIf set, no other fields will be set in this response.",
"format": "byte",
"type": "string"
- },
- "document": {
- "$ref": "Document",
- "description": "A query result.\nNot set when reporting partial progress."
}
},
"id": "RunQueryResponse"
},
- "BeginTransactionRequest": {
- "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"
- },
"CommitRequest": {
"properties": {
"transaction": {
@@ -1087,12 +812,21 @@
"description": "The request for Firestore.Commit.",
"type": "object"
},
- "ListenRequest": {
+ "BeginTransactionRequest": {
"properties": {
- "addTarget": {
- "description": "A target to add to this stream.",
- "$ref": "Target"
- },
+ "options": {
+ "$ref": "TransactionOptions",
+ "description": "The options for the transaction.\nDefaults to a read-write transaction."
+ }
+ },
+ "id": "BeginTransactionRequest",
+ "description": "The request for Firestore.BeginTransaction.",
+ "type": "object"
+ },
+ "ListenRequest": {
+ "description": "A request for Firestore.Listen",
+ "type": "object",
+ "properties": {
"labels": {
"additionalProperties": {
"type": "string"
@@ -1104,11 +838,13 @@
"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.",
@@ -1157,6 +893,8 @@
"id": "ArrayValue"
},
"Index": {
+ "description": "An index definition.",
+ "type": "object",
"properties": {
"fields": {
"description": "The fields to index.",
@@ -1166,8 +904,6 @@
}
},
"state": {
- "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.",
@@ -1179,7 +915,9 @@
"CREATING",
"READY",
"ERROR"
- ]
+ ],
+ "description": "The state of the index.\nOutput only.",
+ "type": "string"
},
"name": {
"description": "The resource name of the index.\nOutput only.",
@@ -1190,22 +928,12 @@
"type": "string"
}
},
- "id": "Index",
- "description": "An index definition.",
- "type": "object"
+ "id": "Index"
},
"StructuredQuery": {
"description": "A Firestore query.",
"type": "object",
"properties": {
- "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."
@@ -1237,13 +965,19 @@
"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."
}
},
"id": "StructuredQuery"
},
"UnaryFilter": {
- "description": "A filter with a single operand.",
- "type": "object",
"properties": {
"field": {
"description": "The field to which to apply the operator.",
@@ -1264,53 +998,32 @@
"type": "string"
}
},
- "id": "UnaryFilter"
+ "id": "UnaryFilter",
+ "description": "A filter with a single operand.",
+ "type": "object"
},
"Filter": {
+ "description": "A filter.",
+ "type": "object",
"properties": {
"fieldFilter": {
- "description": "A filter on a document field.",
- "$ref": "FieldFilter"
+ "$ref": "FieldFilter",
+ "description": "A filter on a document field."
},
"unaryFilter": {
- "$ref": "UnaryFilter",
- "description": "A filter that takes exactly one argument."
+ "description": "A filter that takes exactly one argument.",
+ "$ref": "UnaryFilter"
},
"compositeFilter": {
- "$ref": "CompositeFilter",
- "description": "A composite filter."
+ "description": "A composite filter.",
+ "$ref": "CompositeFilter"
}
},
- "id": "Filter",
- "description": "A filter.",
- "type": "object"
- },
- "BatchGetDocumentsResponse": {
- "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",
- "description": "The streamed response for Firestore.BatchGetDocuments.",
- "type": "object"
+ "id": "Filter"
},
"WriteRequest": {
+ "description": "The request for Firestore.Write.\n\nThe first request creates a stream, or resumes an existing one from a token.\n\nWhen creating a new stream, the server replies with a response containing\nonly an ID and a token, to use in the next request.\n\nWhen resuming a stream, the server first streams any responses later than the\ngiven token, then a response containing only an up-to-date token, to use in\nthe next request.",
+ "type": "object",
"properties": {
"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.",
@@ -1336,23 +1049,37 @@
"type": "string"
}
},
- "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"
+ "id": "WriteRequest"
+ },
+ "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": {
- "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."
- },
"query": {
"description": "A target specified by a query.",
"$ref": "QueryTarget"
@@ -1370,31 +1097,40 @@
"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"
+ "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"
},
"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"
+ },
+ "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"
+ "id": "Precondition",
+ "description": "A precondition on a document, used for conditional operations.",
+ "type": "object"
},
"RunQueryRequest": {
"description": "The request for Firestore.RunQuery.",
@@ -1444,12 +1180,12 @@
"type": "object",
"properties": {
"readOnly": {
- "description": "The transaction can only be used for read operations.",
- "$ref": "ReadOnly"
+ "$ref": "ReadOnly",
+ "description": "The transaction can only be used for read operations."
},
"readWrite": {
- "description": "The transaction can be used for both read and write operations.",
- "$ref": "ReadWrite"
+ "$ref": "ReadWrite",
+ "description": "The transaction can be used for both read and write operations."
}
},
"id": "TransactionOptions"
@@ -1465,31 +1201,31 @@
"id": "FieldReference"
},
"ListenResponse": {
+ "description": "The response for Firestore.Listen.",
+ "type": "object",
"properties": {
"filter": {
- "$ref": "ExistenceFilter",
- "description": "A filter to apply to the set of documents previously returned for the\ngiven target.\n\nReturned when documents may have been removed from the given target, but\nthe exact documents are unknown."
+ "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"
},
"documentRemove": {
- "$ref": "DocumentRemove",
- "description": "A Document has been removed from a target (because it is no longer\nrelevant to that target)."
+ "description": "A Document has been removed from a target (because it is no longer\nrelevant to that target).",
+ "$ref": "DocumentRemove"
},
"documentDelete": {
"$ref": "DocumentDelete",
"description": "A Document has been deleted."
}
},
- "id": "ListenResponse",
- "description": "The response for Firestore.Listen.",
- "type": "object"
+ "id": "ListenResponse"
},
"ListCollectionIdsRequest": {
"description": "The request for Firestore.ListCollectionIds.",
@@ -1511,13 +1247,13 @@
"description": "A digest of all the documents that match a given target.",
"type": "object",
"properties": {
- "targetId": {
- "description": "The target ID to which this filter applies.",
+ "count": {
+ "description": "The total count of documents that match target_id.\n\nIf different from the count of documents in the client that match, the\nclient must manually determine which documents no longer match the target.",
"format": "int32",
"type": "integer"
},
- "count": {
- "description": "The total count of documents that match target_id.\n\nIf different from the count of documents in the client that match, the\nclient must manually determine which documents no longer match the target.",
+ "targetId": {
+ "description": "The target ID to which this filter applies.",
"format": "int32",
"type": "integer"
}
@@ -1525,8 +1261,6 @@
"id": "ExistenceFilter"
},
"ReadOnly": {
- "description": "Options for a transaction that can only be used to read documents.",
- "type": "object",
"properties": {
"readTime": {
"description": "Reads documents at the given time.\nThis may not be older than 60 seconds.",
@@ -1534,7 +1268,9 @@
"type": "string"
}
},
- "id": "ReadOnly"
+ "id": "ReadOnly",
+ "description": "Options for a transaction that can only be used to read documents.",
+ "type": "object"
},
"WriteResult": {
"description": "The result of applying a write.",
@@ -1556,37 +1292,9 @@
"id": "WriteResult"
},
"Value": {
+ "description": "A message that can hold any of the supported value types.",
+ "type": "object",
"properties": {
- "mapValue": {
- "$ref": "MapValue",
- "description": "A map value."
- },
- "geoPointValue": {
- "description": "A geo point value representing a point on the surface of Earth.",
- "$ref": "LatLng"
- },
- "bytesValue": {
- "description": "A bytes value.\n\nMust not exceed 1 MiB - 89 bytes.\nOnly the first 1,500 bytes are considered by queries.",
- "format": "byte",
- "type": "string"
- },
- "integerValue": {
- "description": "An integer value.",
- "format": "int64",
- "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"
- },
- "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",
@@ -1602,35 +1310,55 @@
"type": "boolean"
},
"nullValue": {
+ "description": "A null value.",
+ "type": "string",
"enumDescriptions": [
"Null value."
],
"enum": [
"NULL_VALUE"
- ],
- "description": "A null value.",
+ ]
+ },
+ "mapValue": {
+ "$ref": "MapValue",
+ "description": "A map value."
+ },
+ "bytesValue": {
+ "description": "A bytes value.\n\nMust not exceed 1 MiB - 89 bytes.\nOnly the first 1,500 bytes are considered by queries.",
+ "format": "byte",
+ "type": "string"
+ },
+ "geoPointValue": {
+ "$ref": "LatLng",
+ "description": "A geo point value representing a point on the surface of Earth."
+ },
+ "integerValue": {
+ "description": "An integer value.",
+ "format": "int64",
+ "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",
- "description": "A message that can hold any of the supported value types.",
- "type": "object"
+ "id": "Value"
},
"Write": {
"description": "A write on a document.",
"type": "object",
"properties": {
- "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."
- },
- "currentDocument": {
- "description": "An optional precondition on the document.\n\nThe write will fail if this is set and not met by the target document.",
- "$ref": "Precondition"
- },
"update": {
- "$ref": "Document",
- "description": "A document to write."
+ "description": "A document to write.",
+ "$ref": "Document"
},
"transform": {
"$ref": "DocumentTransform",
@@ -1639,6 +1367,14 @@
"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."
+ },
+ "currentDocument": {
+ "description": "An optional precondition on the document.\n\nThe write will fail if this is set and not met by the target document.",
+ "$ref": "Precondition"
}
},
"id": "Write"
@@ -1677,18 +1413,13 @@
"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."
+ "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"
},
"transaction": {
"description": "Reads documents in a transaction.",
@@ -1701,11 +1432,18 @@
"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"
}
},
"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": {
"description": "The new state of the Document.\n\nIf `mask` is set, contains only fields that were updated or added.",
@@ -1728,12 +1466,24 @@
}
}
},
- "id": "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"
+ "id": "DocumentChange"
},
"Operation": {
+ "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
+ "type": "object",
"properties": {
+ "error": {
+ "$ref": "Status",
+ "description": "The error result of the operation in case of failure or cancellation."
+ },
+ "metadata": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "description": "Service-specific metadata associated with the operation. It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata. Any method that returns a\nlong-running operation should document the metadata type, if any.",
+ "type": "object"
+ },
"done": {
"description": "If the value is `false`, it means the operation is still in progress.\nIf `true`, the operation is completed, and either `error` or `response` is\navailable.",
"type": "boolean"
@@ -1749,40 +1499,28 @@
"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"
+ "id": "Operation"
},
"QueryTarget": {
"description": "A target specified by a query.",
"type": "object",
"properties": {
- "structuredQuery": {
- "$ref": "StructuredQuery",
- "description": "A structured query."
- },
"parent": {
"description": "The parent resource name. In the format:\n`projects/{project_id}/databases/{database_id}/documents` or\n`projects/{project_id}/databases/{database_id}/documents/{document_path}`.\nFor example:\n`projects/my-project/databases/my-database/documents` or\n`projects/my-project/databases/my-database/documents/chatrooms/my-chatroom`",
"type": "string"
+ },
+ "structuredQuery": {
+ "$ref": "StructuredQuery",
+ "description": "A structured query."
}
},
"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.",
@@ -1797,27 +1535,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"
}
}
},
- "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.",
"type": "object",
"properties": {
- "createTime": {
- "description": "Output only. The time at which the document was created.\n\nThis value increases monotonically when a document is deleted then\nrecreated. It can also be compared to values from other documents and\nthe `read_time` of a query.",
- "format": "google-datetime",
- "type": "string"
- },
"fields": {
"additionalProperties": {
"$ref": "Value"
@@ -1833,6 +1564,11 @@
"name": {
"description": "The resource name of the document, for example\n`projects/{project_id}/databases/{database_id}/documents/{document_path}`.",
"type": "string"
+ },
+ "createTime": {
+ "description": "Output only. The time at which the document was created.\n\nThis value increases monotonically when a document is deleted then\nrecreated. It can also be compared to values from other documents and\nthe `read_time` of a query.",
+ "format": "google-datetime",
+ "type": "string"
}
},
"id": "Document"
@@ -1852,6 +1588,8 @@
"type": "object"
},
"DocumentRemove": {
+ "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": {
"document": {
"description": "The resource name of the Document that has gone out of view.",
@@ -1871,27 +1609,25 @@
}
}
},
- "id": "DocumentRemove",
- "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"
+ "id": "DocumentRemove"
},
"ListDocumentsResponse": {
- "description": "The response for Firestore.ListDocuments.",
- "type": "object",
"properties": {
+ "nextPageToken": {
+ "description": "The next page token.",
+ "type": "string"
+ },
"documents": {
"description": "The Documents found.",
"type": "array",
"items": {
"$ref": "Document"
}
- },
- "nextPageToken": {
- "description": "The next page token.",
- "type": "string"
}
},
- "id": "ListDocumentsResponse"
+ "id": "ListDocumentsResponse",
+ "description": "The response for Firestore.ListDocuments.",
+ "type": "object"
},
"RollbackRequest": {
"description": "The request for Firestore.Rollback.",
@@ -1917,6 +1653,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."
@@ -1924,9 +1662,7 @@
"enum": [
"OPERATOR_UNSPECIFIED",
"AND"
- ],
- "description": "The operator for combining multiple filters.",
- "type": "string"
+ ]
}
},
"id": "CompositeFilter"
@@ -1958,11 +1694,275 @@
"id": "DocumentMask",
"description": "A set of field paths on a document.\nUsed to restrict a get or update operation on a document to a subset of its\nfields.\nThis is different from standard field masks, as this is always scoped to a\nDocument, and takes in account the dynamic nature of Value.",
"type": "object"
+ },
+ "DocumentTransform": {
+ "properties": {
+ "document": {
+ "description": "The name of the document to transform.",
+ "type": "string"
+ },
+ "fieldTransforms": {
+ "description": "The list of transformations to apply to the fields of the document, in\norder.\nThis must not be empty.",
+ "type": "array",
+ "items": {
+ "$ref": "FieldTransform"
+ }
+ }
+ },
+ "id": "DocumentTransform",
+ "description": "A transformation of a document.",
+ "type": "object"
+ },
+ "FieldTransform": {
+ "description": "A transformation of a field of the document.",
+ "type": "object",
+ "properties": {
+ "fieldPath": {
+ "description": "The path of the field. See Document.fields for the field path syntax\nreference.",
+ "type": "string"
+ },
+ "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"
+ }
+ },
+ "id": "FieldTransform"
+ },
+ "CommitResponse": {
+ "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"
+ }
+ }
+ },
+ "id": "CommitResponse",
+ "description": "The response for Firestore.Commit.",
+ "type": "object"
+ },
+ "ListCollectionIdsResponse": {
+ "description": "The response from Firestore.ListCollectionIds.",
+ "type": "object",
+ "properties": {
+ "collectionIds": {
+ "description": "The collection ids.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "nextPageToken": {
+ "description": "A page token that may be used to continue the list.",
+ "type": "string"
+ }
+ },
+ "id": "ListCollectionIdsResponse"
+ },
+ "WriteResponse": {
+ "properties": {
+ "streamId": {
+ "description": "The ID of the stream.\nOnly set on the first message, when a new stream was created.",
+ "type": "string"
+ },
+ "commitTime": {
+ "description": "The time at which the commit occurred.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "streamToken": {
+ "description": "A token that represents the position of this response in the stream.\nThis can be used by a client to resume the stream at this point.\n\nThis field is always set.",
+ "format": "byte",
+ "type": "string"
+ },
+ "writeResults": {
+ "description": "The result of applying the writes.\n\nThis i-th write result corresponds to the i-th write in the\nrequest.",
+ "type": "array",
+ "items": {
+ "$ref": "WriteResult"
+ }
+ }
+ },
+ "id": "WriteResponse",
+ "description": "The response for Firestore.Write.",
+ "type": "object"
+ },
+ "Order": {
+ "properties": {
+ "field": {
+ "$ref": "FieldReference",
+ "description": "The field to order by."
+ },
+ "direction": {
+ "enumDescriptions": [
+ "Unspecified.",
+ "Ascending.",
+ "Descending."
+ ],
+ "enum": [
+ "DIRECTION_UNSPECIFIED",
+ "ASCENDING",
+ "DESCENDING"
+ ],
+ "description": "The direction to order by. Defaults to `ASCENDING`.",
+ "type": "string"
+ }
+ },
+ "id": "Order",
+ "description": "An order on a field.",
+ "type": "object"
+ },
+ "FieldFilter": {
+ "description": "A filter on a specific field.",
+ "type": "object",
+ "properties": {
+ "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",
+ "LESS_THAN_OR_EQUAL",
+ "GREATER_THAN",
+ "GREATER_THAN_OR_EQUAL",
+ "EQUAL"
+ ],
+ "description": "The operator to filter by.",
+ "type": "string"
+ },
+ "field": {
+ "$ref": "FieldReference",
+ "description": "The field to filter by."
+ },
+ "value": {
+ "$ref": "Value",
+ "description": "The value to compare to."
+ }
+ },
+ "id": "FieldFilter"
+ },
+ "TargetChange": {
+ "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",
+ "items": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "cause": {
+ "description": "The error that resulted in this change, if applicable.",
+ "$ref": "Status"
+ },
+ "readTime": {
+ "description": "The consistent `read_time` for the given `target_ids` (omitted when the\ntarget_ids are not at a consistent snapshot).\n\nThe stream is guaranteed to send a `read_time` with `target_ids` empty\nwhenever the entire stream reaches a new consistent snapshot. ADD,\nCURRENT, and RESET messages are guaranteed to (eventually) result in a\nnew consistent snapshot (while NO_CHANGE and REMOVE messages are not).\n\nFor a given stream, `read_time` is guaranteed to be monotonically\nincreasing.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "targetChangeType": {
+ "enumDescriptions": [
+ "No change has occurred. Used only to send an updated `resume_token`.",
+ "The targets have been added.",
+ "The targets have been removed.",
+ "The targets reflect all changes committed before the targets were added\nto the stream.\n\nThis will be sent after or with a `read_time` that is greater than or\nequal to the time at which the targets were added.\n\nListeners can wait for this change if read-after-write semantics\nare desired.",
+ "The targets have been reset, and a new initial state for the targets\nwill be returned in subsequent changes.\n\nAfter the initial state is complete, `CURRENT` will be returned even\nif the target was previously indicated to be `CURRENT`."
+ ],
+ "enum": [
+ "NO_CHANGE",
+ "ADD",
+ "REMOVE",
+ "CURRENT",
+ "RESET"
+ ],
+ "description": "The type of change that occurred.",
+ "type": "string"
+ }
+ },
+ "id": "TargetChange",
+ "description": "Targets being watched have changed.",
+ "type": "object"
+ },
+ "MapValue": {
+ "properties": {
+ "fields": {
+ "additionalProperties": {
+ "$ref": "Value"
+ },
+ "description": "The map's fields.\n\nThe map keys represent field names. Field names matching the regular\nexpression `__.*__` are reserved. Reserved field names are forbidden except\nin certain documented contexts. The map keys, represented as UTF-8, must\nnot exceed 1,500 bytes and cannot be empty.",
+ "type": "object"
+ }
+ },
+ "id": "MapValue",
+ "description": "A map value.",
+ "type": "object"
+ },
+ "DocumentDelete": {
+ "properties": {
+ "document": {
+ "description": "The resource name of the Document that was deleted.",
+ "type": "string"
+ },
+ "readTime": {
+ "description": "The read timestamp at which the delete was observed.\n\nGreater or equal to the `commit_time` of the delete.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "removedTargetIds": {
+ "description": "A set of target IDs for targets that previously matched this entity.",
+ "type": "array",
+ "items": {
+ "format": "int32",
+ "type": "integer"
+ }
+ }
+ },
+ "id": "DocumentDelete",
+ "description": "A Document has been deleted.\n\nMay be the result of multiple writes, including updates, the\nlast of which deleted the Document.\n\nMultiple DocumentDelete messages may be returned for the same logical\ndelete, if multiple targets are affected.",
+ "type": "object"
}
},
+ "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": "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"
+ }
+ }
+ }
+ }
}
diff --git a/genomics/v1/genomics-api.json b/genomics/v1/genomics-api.json
index 30bc1ad..2d9ade7 100644
--- a/genomics/v1/genomics-api.json
+++ b/genomics/v1/genomics-api.json
@@ -1,287 +1,481 @@
{
- "ownerDomain": "google.com",
- "name": "genomics",
- "batchPath": "batch",
- "revision": "20171221",
- "documentationLink": "https://cloud.google.com/genomics",
- "id": "genomics:v1",
- "title": "Genomics API",
- "discoveryVersion": "v1",
- "ownerName": "Google",
"resources": {
- "callsets": {
+ "annotations": {
"methods": {
"delete": {
+ "id": "genomics.annotations.delete",
+ "path": "v1/annotations/{annotationId}",
+ "description": "Deletes an annotation. Caller must have WRITE permission for\nthe associated annotation set.",
+ "httpMethod": "DELETE",
+ "parameterOrder": [
+ "annotationId"
+ ],
+ "response": {
+ "$ref": "Empty"
+ },
+ "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}"
+ },
+ "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.",
+ "response": {
+ "$ref": "Annotation"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "parameters": {},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics"
+ ],
+ "flatPath": "v1/annotations",
+ "path": "v1/annotations",
+ "id": "genomics.annotations.create"
+ },
+ "batchCreate": {
+ "description": "Creates one or more new annotations atomically. All annotations must\nbelong to the same annotation set. Caller must have WRITE\npermission for this annotation set. For optimal performance, batch\npositionally adjacent annotations together.\n\nIf the request has a systemic issue, such as an attempt to write to\nan inaccessible annotation set, the entire RPC will fail accordingly. For\nlesser data issues, when possible an error will be isolated to the\ncorresponding batch entry in the response; the remaining well formed\nannotations will be created normally.\n\nFor details on the requirements for each individual annotation resource,\nsee\nCreateAnnotation.",
+ "request": {
+ "$ref": "BatchCreateAnnotationsRequest"
+ },
+ "response": {
+ "$ref": "BatchCreateAnnotationsResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics"
+ ],
+ "parameters": {},
+ "flatPath": "v1/annotations:batchCreate",
+ "path": "v1/annotations:batchCreate",
+ "id": "genomics.annotations.batchCreate"
+ },
+ "search": {
+ "path": "v1/annotations/search",
+ "id": "genomics.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.",
+ "response": {
+ "$ref": "SearchAnnotationsResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "parameters": {},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics",
+ "https://www.googleapis.com/auth/genomics.readonly"
+ ],
+ "flatPath": "v1/annotations/search"
+ },
+ "get": {
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "Annotation"
+ },
+ "parameterOrder": [
+ "annotationId"
+ ],
+ "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}",
+ "id": "genomics.annotations.get",
+ "path": "v1/annotations/{annotationId}",
+ "description": "Gets an annotation. Caller must have READ permission\nfor the associated annotation set."
+ },
+ "update": {
+ "response": {
+ "$ref": "Annotation"
+ },
+ "parameterOrder": [
+ "annotationId"
+ ],
+ "httpMethod": "PUT",
+ "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": {
+ "location": "path",
+ "description": "The ID of the annotation to be updated.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics"
+ ],
+ "flatPath": "v1/annotations/{annotationId}",
+ "path": "v1/annotations/{annotationId}",
+ "id": "genomics.annotations.update",
+ "request": {
+ "$ref": "Annotation"
+ },
+ "description": "Updates an annotation. Caller must have\nWRITE permission for the associated dataset."
+ }
+ }
+ },
+ "variantsets": {
+ "methods": {
+ "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"
+ },
+ "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",
+ "parameters": {
+ "variantSetId": {
+ "location": "path",
+ "description": "Required. The ID of the variant set.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics",
+ "https://www.googleapis.com/auth/genomics.readonly"
+ ],
+ "flatPath": "v1/variantsets/{variantSetId}",
+ "path": "v1/variantsets/{variantSetId}",
+ "id": "genomics.variantsets.get"
+ },
+ "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}",
+ "id": "genomics.variantsets.patch",
+ "path": "v1/variantsets/{variantSetId}",
+ "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)",
+ "httpMethod": "PATCH",
+ "parameterOrder": [
+ "variantSetId"
+ ],
+ "response": {
+ "$ref": "VariantSet"
+ }
+ },
+ "delete": {
+ "parameters": {
+ "variantSetId": {
+ "location": "path",
+ "description": "The ID of the variant set to be deleted.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics"
+ ],
+ "flatPath": "v1/variantsets/{variantSetId}",
+ "id": "genomics.variantsets.delete",
+ "path": "v1/variantsets/{variantSetId}",
+ "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)",
+ "httpMethod": "DELETE",
"response": {
"$ref": "Empty"
},
"parameterOrder": [
- "callSetId"
- ],
- "httpMethod": "DELETE",
- "parameters": {
- "callSetId": {
- "description": "The ID of the call set to be deleted.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics"
- ],
- "flatPath": "v1/callsets/{callSetId}",
- "path": "v1/callsets/{callSetId}",
- "id": "genomics.callsets.delete",
- "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": {
- "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).",
- "request": {
- "$ref": "SearchCallSetsRequest"
- },
- "response": {
- "$ref": "SearchCallSetsResponse"
- },
- "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/callsets/search",
- "path": "v1/callsets/search",
- "id": "genomics.callsets.search"
- },
- "patch": {
- "description": "Updates 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)\n\nThis method supports patch semantics.",
- "request": {
- "$ref": "CallSet"
- },
- "response": {
- "$ref": "CallSet"
- },
- "parameterOrder": [
- "callSetId"
- ],
- "httpMethod": "PATCH",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics"
- ],
- "parameters": {
- "callSetId": {
- "location": "path",
- "description": "The ID of the call set to be updated.",
- "required": true,
- "type": "string"
- },
- "updateMask": {
- "location": "query",
- "description": "An optional mask specifying which fields to update. At this time, the only\nmutable field is name. The only\nacceptable value is \"name\". If unspecified, all mutable fields will be\nupdated.",
- "format": "google-fieldmask",
- "type": "string"
- }
- },
- "flatPath": "v1/callsets/{callSetId}",
- "path": "v1/callsets/{callSetId}",
- "id": "genomics.callsets.patch"
- },
- "get": {
- "description": "Gets a call set by ID.\n\nFor the definitions of call sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)",
- "response": {
- "$ref": "CallSet"
- },
- "parameterOrder": [
- "callSetId"
- ],
- "httpMethod": "GET",
- "parameters": {
- "callSetId": {
- "description": "The ID of the call 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/callsets/{callSetId}",
- "path": "v1/callsets/{callSetId}",
- "id": "genomics.callsets.get"
+ "variantSetId"
+ ]
},
"create": {
- "httpMethod": "POST",
- "parameterOrder": [],
- "response": {
- "$ref": "CallSet"
- },
- "parameters": {},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/genomics"
],
- "flatPath": "v1/callsets",
- "id": "genomics.callsets.create",
- "path": "v1/callsets",
+ "parameters": {},
+ "flatPath": "v1/variantsets",
+ "path": "v1/variantsets",
+ "id": "genomics.variantsets.create",
+ "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.",
"request": {
- "$ref": "CallSet"
+ "$ref": "VariantSet"
},
- "description": "Creates a new call set.\n\nFor the definitions of call sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)"
+ "response": {
+ "$ref": "VariantSet"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST"
+ },
+ "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": {
+ "location": "path",
+ "description": "Required. The ID of the variant set that contains variant data which\nshould be exported. The caller must have READ access to this variant set.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "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"
}
}
},
- "reads": {
+ "operations": {
+ "methods": {
+ "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": {
+ "location": "query",
+ "description": "The standard list page token.",
+ "type": "string"
+ },
+ "pageSize": {
+ "location": "query",
+ "description": "The maximum number of results to return. If unspecified, defaults to\n256. The maximum value is 2048.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "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": {
+ "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/genomics"
+ ],
+ "flatPath": "v1/operations/{operationsId}",
+ "id": "genomics.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",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "name"
+ ]
+ },
+ "cancel": {
+ "path": "v1/{+name}:cancel",
+ "id": "genomics.operations.cancel",
+ "request": {
+ "$ref": "CancelOperationRequest"
+ },
+ "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. Clients may use Operations.GetOperation or Operations.ListOperations to check whether the cancellation succeeded or the operation completed despite cancellation.",
+ "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/genomics"
+ ],
+ "flatPath": "v1/operations/{operationsId}:cancel"
+ }
+ }
+ },
+ "referencesets": {
"methods": {
"search": {
- "id": "genomics.reads.search",
- "path": "v1/reads/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": "SearchReadsRequest"
+ "$ref": "SearchReferenceSetsRequest"
},
- "description": "Gets a list of reads for one or more read group sets.\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\nReads search operates over a genomic coordinate space of reference sequence\n& position defined over the reference sequences to which the requested\nread group sets are aligned.\n\nIf a target positional range is specified, search returns all reads whose\nalignment to the reference genome overlap the range. A query which\nspecifies only read group set IDs yields all reads in those read group\nsets, including unmapped reads.\n\nAll reads returned (including reads on subsequent pages) are ordered by\ngenomic coordinate (by reference sequence, then position). Reads with\nequivalent genomic coordinates are returned in an unspecified order. This\norder is consistent, such that two queries for the same content (regardless\nof page size) yield reads in the same order across their respective streams\nof paginated responses.\n\nImplements\n[GlobalAllianceApi.searchReads](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/readmethods.avdl#L85).",
- "httpMethod": "POST",
- "parameterOrder": [],
"response": {
- "$ref": "SearchReadsResponse"
+ "$ref": "SearchReferenceSetsResponse"
},
- "parameters": {},
+ "parameterOrder": [],
+ "httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/genomics",
"https://www.googleapis.com/auth/genomics.readonly"
],
- "flatPath": "v1/reads/search"
+ "parameters": {},
+ "flatPath": "v1/referencesets/search"
+ },
+ "get": {
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "ReferenceSet"
+ },
+ "parameterOrder": [
+ "referenceSetId"
+ ],
+ "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}",
+ "id": "genomics.referencesets.get",
+ "path": "v1/referencesets/{referenceSetId}",
+ "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)."
}
}
},
"readgroupsets": {
"methods": {
- "delete": {
- "httpMethod": "DELETE",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "readGroupSetId"
- ],
- "parameters": {
- "readGroupSetId": {
- "description": "The ID of the read group set to be deleted. The caller must have WRITE\npermissions to the dataset associated with this read group set.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics"
- ],
- "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)"
- },
- "import": {
- "httpMethod": "POST",
- "parameterOrder": [],
- "response": {
- "$ref": "Operation"
- },
- "parameters": {},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/devstorage.read_write",
- "https://www.googleapis.com/auth/genomics"
- ],
- "flatPath": "v1/readgroupsets:import",
- "id": "genomics.readgroupsets.import",
- "path": "v1/readgroupsets:import",
- "request": {
- "$ref": "ImportReadGroupSetsRequest"
- },
- "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)"
- },
- "export": {
- "request": {
- "$ref": "ExportReadGroupSetRequest"
- },
- "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.",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "readGroupSetId"
- ],
- "httpMethod": "POST",
- "parameters": {
- "readGroupSetId": {
- "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"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/devstorage.read_write",
- "https://www.googleapis.com/auth/genomics"
- ],
- "flatPath": "v1/readgroupsets/{readGroupSetId}:export",
- "path": "v1/readgroupsets/{readGroupSetId}:export",
- "id": "genomics.readgroupsets.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"
},
"parameterOrder": [],
"httpMethod": "POST",
- "parameters": {},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/genomics",
"https://www.googleapis.com/auth/genomics.readonly"
],
+ "parameters": {},
"flatPath": "v1/readgroupsets/search",
"path": "v1/readgroupsets/search",
- "id": "genomics.readgroupsets.search",
- "request": {
- "$ref": "SearchReadGroupSetsRequest"
- },
- "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)."
- },
- "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)",
- "response": {
- "$ref": "ReadGroupSet"
- },
- "parameterOrder": [
- "readGroupSetId"
- ],
- "httpMethod": "GET",
- "parameters": {
- "readGroupSetId": {
- "description": "The ID of the read group 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/readgroupsets/{readGroupSetId}",
- "path": "v1/readgroupsets/{readGroupSetId}",
- "id": "genomics.readgroupsets.get"
+ "id": "genomics.readgroupsets.search"
},
"patch": {
"response": {
@@ -297,16 +491,16 @@
],
"parameters": {
"readGroupSetId": {
- "location": "path",
"description": "The ID of the read group set to be updated. The caller must have WRITE\npermissions to the dataset associated with this read group set.",
"required": true,
- "type": "string"
+ "type": "string",
+ "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}",
@@ -316,15 +510,112 @@
"request": {
"$ref": "ReadGroupSet"
}
+ },
+ "get": {
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "readGroupSetId"
+ ],
+ "response": {
+ "$ref": "ReadGroupSet"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics",
+ "https://www.googleapis.com/auth/genomics.readonly"
+ ],
+ "parameters": {
+ "readGroupSetId": {
+ "location": "path",
+ "description": "The ID of the read group set.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1/readgroupsets/{readGroupSetId}",
+ "id": "genomics.readgroupsets.get",
+ "path": "v1/readgroupsets/{readGroupSetId}",
+ "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)"
+ },
+ "import": {
+ "description": "Creates read group sets by asynchronously importing the provided\ninformation.\n\nFor the definitions of read group sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nThe caller must have WRITE permissions to the dataset.\n\n## Notes on [BAM](https://samtools.github.io/hts-specs/SAMv1.pdf) import\n\n- Tags will be converted to strings - tag types are not preserved\n- Comments (`@CO`) in the input file header will not be preserved\n- Original header order of references (`@SQ`) will not be preserved\n- Any reverse stranded unmapped reads will be reverse complemented, and\ntheir qualities (also the \"BQ\" and \"OQ\" tags, if any) will be reversed\n- Unmapped reads will be stripped of positional information (reference name\nand position)",
+ "request": {
+ "$ref": "ImportReadGroupSetsRequest"
+ },
+ "httpMethod": "POST",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/devstorage.read_write",
+ "https://www.googleapis.com/auth/genomics"
+ ],
+ "parameters": {},
+ "flatPath": "v1/readgroupsets:import",
+ "id": "genomics.readgroupsets.import",
+ "path": "v1/readgroupsets:import"
+ },
+ "delete": {
+ "path": "v1/readgroupsets/{readGroupSetId}",
+ "id": "genomics.readgroupsets.delete",
+ "description": "Deletes a read group set.\n\nFor the definitions of read group sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "readGroupSetId"
+ ],
+ "httpMethod": "DELETE",
+ "parameters": {
+ "readGroupSetId": {
+ "location": "path",
+ "description": "The ID of the read group set to be deleted. The caller must have WRITE\npermissions to the dataset associated with this read group set.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics"
+ ],
+ "flatPath": "v1/readgroupsets/{readGroupSetId}"
+ },
+ "export": {
+ "id": "genomics.readgroupsets.export",
+ "path": "v1/readgroupsets/{readGroupSetId}:export",
+ "request": {
+ "$ref": "ExportReadGroupSetRequest"
+ },
+ "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.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "readGroupSetId"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "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"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/devstorage.read_write",
+ "https://www.googleapis.com/auth/genomics"
+ ],
+ "flatPath": "v1/readgroupsets/{readGroupSetId}:export"
}
},
"resources": {
"coveragebuckets": {
"methods": {
"list": {
- "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"
},
@@ -350,14 +641,8 @@
"location": "query"
},
"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"
- },
- "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"
},
@@ -367,6 +652,12 @@
"required": true,
"type": "string"
},
+ "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": {
"description": "The name of the reference to query, within the reference set associated\nwith this query. Optional.",
"type": "string",
@@ -379,20 +670,67 @@
"type": "string"
}
},
- "flatPath": "v1/readgroupsets/{readGroupSetId}/coveragebuckets"
+ "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."
}
}
}
}
},
- "annotationsets": {
+ "reads": {
"methods": {
+ "search": {
+ "request": {
+ "$ref": "SearchReadsRequest"
+ },
+ "description": "Gets a list of reads for one or more read group sets.\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\nReads search operates over a genomic coordinate space of reference sequence\n& position defined over the reference sequences to which the requested\nread group sets are aligned.\n\nIf a target positional range is specified, search returns all reads whose\nalignment to the reference genome overlap the range. A query which\nspecifies only read group set IDs yields all reads in those read group\nsets, including unmapped reads.\n\nAll reads returned (including reads on subsequent pages) are ordered by\ngenomic coordinate (by reference sequence, then position). Reads with\nequivalent genomic coordinates are returned in an unspecified order. This\norder is consistent, such that two queries for the same content (regardless\nof page size) yield reads in the same order across their respective streams\nof paginated responses.\n\nImplements\n[GlobalAllianceApi.searchReads](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/readmethods.avdl#L85).",
+ "httpMethod": "POST",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "SearchReadsResponse"
+ },
+ "parameters": {},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics",
+ "https://www.googleapis.com/auth/genomics.readonly"
+ ],
+ "flatPath": "v1/reads/search",
+ "id": "genomics.reads.search",
+ "path": "v1/reads/search"
+ }
+ }
+ },
+ "callsets": {
+ "methods": {
+ "create": {
+ "path": "v1/callsets",
+ "id": "genomics.callsets.create",
+ "request": {
+ "$ref": "CallSet"
+ },
+ "description": "Creates a new call set.\n\nFor the definitions of call sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)",
+ "response": {
+ "$ref": "CallSet"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "parameters": {},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics"
+ ],
+ "flatPath": "v1/callsets"
+ },
"delete": {
+ "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)",
"response": {
"$ref": "Empty"
},
"parameterOrder": [
- "annotationSetId"
+ "callSetId"
],
"httpMethod": "DELETE",
"scopes": [
@@ -400,24 +738,294 @@
"https://www.googleapis.com/auth/genomics"
],
"parameters": {
- "annotationSetId": {
+ "callSetId": {
+ "description": "The ID of the call set to be deleted.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/callsets/{callSetId}",
+ "path": "v1/callsets/{callSetId}",
+ "id": "genomics.callsets.delete"
+ },
+ "search": {
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics",
+ "https://www.googleapis.com/auth/genomics.readonly"
+ ],
+ "parameters": {},
+ "flatPath": "v1/callsets/search",
+ "path": "v1/callsets/search",
+ "id": "genomics.callsets.search",
+ "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).",
+ "request": {
+ "$ref": "SearchCallSetsRequest"
+ },
+ "response": {
+ "$ref": "SearchCallSetsResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST"
+ },
+ "patch": {
+ "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. At this time, the only\nmutable field is name. The only\nacceptable value is \"name\". If unspecified, all mutable fields will be\nupdated.",
+ "format": "google-fieldmask",
+ "type": "string"
+ },
+ "callSetId": {
+ "description": "The ID of the call set to be updated.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/callsets/{callSetId}",
+ "path": "v1/callsets/{callSetId}",
+ "id": "genomics.callsets.patch",
+ "description": "Updates 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)\n\nThis method supports patch semantics.",
+ "request": {
+ "$ref": "CallSet"
+ },
+ "response": {
+ "$ref": "CallSet"
+ },
+ "parameterOrder": [
+ "callSetId"
+ ],
+ "httpMethod": "PATCH"
+ },
+ "get": {
+ "parameters": {
+ "callSetId": {
"location": "path",
- "description": "The ID of the annotation set to be deleted.",
+ "description": "The ID of the call set.",
"required": true,
"type": "string"
}
},
- "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."
- },
- "search": {
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics",
+ "https://www.googleapis.com/auth/genomics.readonly"
+ ],
+ "flatPath": "v1/callsets/{callSetId}",
+ "id": "genomics.callsets.get",
+ "path": "v1/callsets/{callSetId}",
+ "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)",
+ "httpMethod": "GET",
"response": {
- "$ref": "SearchAnnotationSetsResponse"
+ "$ref": "CallSet"
+ },
+ "parameterOrder": [
+ "callSetId"
+ ]
+ }
+ }
+ },
+ "variants": {
+ "methods": {
+ "create": {
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics"
+ ],
+ "parameters": {},
+ "flatPath": "v1/variants",
+ "path": "v1/variants",
+ "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"
+ },
+ "response": {
+ "$ref": "Variant"
},
"parameterOrder": [],
+ "httpMethod": "POST"
+ },
+ "search": {
"httpMethod": "POST",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "SearchVariantsResponse"
+ },
+ "parameters": {},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics",
+ "https://www.googleapis.com/auth/genomics.readonly"
+ ],
+ "flatPath": "v1/variants/search",
+ "id": "genomics.variants.search",
+ "path": "v1/variants/search",
+ "request": {
+ "$ref": "SearchVariantsRequest"
+ },
+ "description": "Gets a list of variants matching the criteria.\n\nFor the definitions of variants and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nImplements\n[GlobalAllianceApi.searchVariants](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/variantmethods.avdl#L126)."
+ },
+ "patch": {
+ "parameters": {
+ "variantId": {
+ "description": "The ID of the variant to be updated.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "updateMask": {
+ "location": "query",
+ "description": "An optional mask specifying which fields to update. At this time, mutable\nfields are names and\ninfo. Acceptable values are \"names\" and\n\"info\". If unspecified, all mutable fields will be updated.",
+ "format": "google-fieldmask",
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics"
+ ],
+ "flatPath": "v1/variants/{variantId}",
+ "id": "genomics.variants.patch",
+ "path": "v1/variants/{variantId}",
+ "request": {
+ "$ref": "Variant"
+ },
+ "description": "Updates a variant.\n\nFor the definitions of variants and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nThis method supports patch semantics. Returns the modified variant without\nits calls.",
+ "httpMethod": "PATCH",
+ "parameterOrder": [
+ "variantId"
+ ],
+ "response": {
+ "$ref": "Variant"
+ }
+ },
+ "get": {
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "variantId"
+ ],
+ "response": {
+ "$ref": "Variant"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics",
+ "https://www.googleapis.com/auth/genomics.readonly"
+ ],
+ "parameters": {
+ "variantId": {
+ "description": "The ID of the variant.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/variants/{variantId}",
+ "id": "genomics.variants.get",
+ "path": "v1/variants/{variantId}",
+ "description": "Gets a variant by ID.\n\nFor the definitions of variants and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)"
+ },
+ "merge": {
+ "id": "genomics.variants.merge",
+ "path": "v1/variants:merge",
+ "request": {
+ "$ref": "MergeVariantsRequest"
+ },
+ "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.",
+ "httpMethod": "POST",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameters": {},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics"
+ ],
+ "flatPath": "v1/variants:merge"
+ },
+ "import": {
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/devstorage.read_write",
+ "https://www.googleapis.com/auth/genomics"
+ ],
+ "parameters": {},
+ "flatPath": "v1/variants:import",
+ "id": "genomics.variants.import",
+ "path": "v1/variants:import",
+ "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.",
+ "request": {
+ "$ref": "ImportVariantsRequest"
+ },
+ "httpMethod": "POST",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "Operation"
+ }
+ },
+ "delete": {
+ "parameters": {
+ "variantId": {
+ "description": "The ID of the variant to be deleted.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics"
+ ],
+ "flatPath": "v1/variants/{variantId}",
+ "path": "v1/variants/{variantId}",
+ "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)",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "variantId"
+ ],
+ "httpMethod": "DELETE"
+ }
+ }
+ },
+ "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",
+ "parameters": {
+ "annotationSetId": {
+ "description": "The ID of the annotation set to be deleted.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics"
+ ],
+ "flatPath": "v1/annotationsets/{annotationSetId}",
+ "path": "v1/annotationsets/{annotationSetId}",
+ "id": "genomics.annotationsets.delete"
+ },
+ "search": {
"parameters": {},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
@@ -425,21 +1033,26 @@
"https://www.googleapis.com/auth/genomics.readonly"
],
"flatPath": "v1/annotationsets/search",
- "path": "v1/annotationsets/search",
"id": "genomics.annotationsets.search",
+ "path": "v1/annotationsets/search",
"request": {
"$ref": "SearchAnnotationSetsRequest"
},
- "description": "Searches for annotation sets that match the given criteria. Annotation sets\nare returned in an unspecified order. This order is consistent, such that\ntwo queries for the same content (regardless of page size) yield annotation\nsets in the same order across their respective streams of paginated\nresponses. Caller must have READ permission for the queried datasets."
+ "description": "Searches for annotation sets that match the given criteria. Annotation sets\nare returned in an unspecified order. This order is consistent, such that\ntwo queries for the same content (regardless of page size) yield annotation\nsets in the same order across their respective streams of paginated\nresponses. Caller must have READ permission for the queried datasets.",
+ "httpMethod": "POST",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "SearchAnnotationSetsResponse"
+ }
},
"get": {
- "response": {
- "$ref": "AnnotationSet"
- },
+ "httpMethod": "GET",
"parameterOrder": [
"annotationSetId"
],
- "httpMethod": "GET",
+ "response": {
+ "$ref": "AnnotationSet"
+ },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/genomics",
@@ -454,18 +1067,11 @@
}
},
"flatPath": "v1/annotationsets/{annotationSetId}",
- "path": "v1/annotationsets/{annotationSetId}",
"id": "genomics.annotationsets.get",
+ "path": "v1/annotationsets/{annotationSetId}",
"description": "Gets an annotation set. Caller must have READ permission for\nthe associated dataset."
},
"update": {
- "response": {
- "$ref": "AnnotationSet"
- },
- "parameterOrder": [
- "annotationSetId"
- ],
- "httpMethod": "PUT",
"parameters": {
"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.",
@@ -490,9 +1096,20 @@
"request": {
"$ref": "AnnotationSet"
},
- "description": "Updates an annotation set. The update must respect all mutability\nrestrictions and other invariants described on the annotation set resource.\nCaller must have WRITE permission for the associated dataset."
+ "description": "Updates an annotation set. The update must respect all mutability\nrestrictions and other invariants described on the annotation set resource.\nCaller must have WRITE permission for the associated dataset.",
+ "response": {
+ "$ref": "AnnotationSet"
+ },
+ "parameterOrder": [
+ "annotationSetId"
+ ],
+ "httpMethod": "PUT"
},
"create": {
+ "request": {
+ "$ref": "AnnotationSet"
+ },
+ "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).",
"response": {
"$ref": "AnnotationSet"
},
@@ -505,186 +1122,66 @@
],
"flatPath": "v1/annotationsets",
"path": "v1/annotationsets",
- "id": "genomics.annotationsets.create",
- "request": {
- "$ref": "AnnotationSet"
- },
- "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)."
- }
- }
- },
- "variants": {
- "methods": {
- "create": {
- "response": {
- "$ref": "Variant"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics"
- ],
- "parameters": {},
- "flatPath": "v1/variants",
- "path": "v1/variants",
- "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": {
- "response": {
- "$ref": "SearchVariantsResponse"
- },
- "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/variants/search",
- "path": "v1/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"
- },
- "parameterOrder": [
- "variantId"
- ],
- "httpMethod": "GET",
- "parameters": {
- "variantId": {
- "description": "The ID of the variant.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics",
- "https://www.googleapis.com/auth/genomics.readonly"
- ],
- "flatPath": "v1/variants/{variantId}"
- },
- "patch": {
- "path": "v1/variants/{variantId}",
- "id": "genomics.variants.patch",
- "request": {
- "$ref": "Variant"
- },
- "description": "Updates a variant.\n\nFor the definitions of variants and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nThis method supports patch semantics. Returns the modified variant without\nits calls.",
- "response": {
- "$ref": "Variant"
- },
- "parameterOrder": [
- "variantId"
- ],
- "httpMethod": "PATCH",
- "parameters": {
- "variantId": {
- "description": "The ID of the variant to be updated.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "updateMask": {
- "description": "An optional mask specifying which fields to update. At this time, mutable\nfields are names and\ninfo. Acceptable values are \"names\" and\n\"info\". If unspecified, all mutable fields will be updated.",
- "format": "google-fieldmask",
- "type": "string",
- "location": "query"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics"
- ],
- "flatPath": "v1/variants/{variantId}"
- },
- "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"
- },
- "parameterOrder": [
- "variantId"
- ],
- "httpMethod": "DELETE",
- "parameters": {
- "variantId": {
- "description": "The ID of the variant to be deleted.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics"
- ],
- "flatPath": "v1/variants/{variantId}",
- "path": "v1/variants/{variantId}",
- "id": "genomics.variants.delete"
- },
- "import": {
- "httpMethod": "POST",
- "parameterOrder": [],
- "response": {
- "$ref": "Operation"
- },
- "parameters": {},
- "scopes": [
- "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": {
- "request": {
- "$ref": "MergeVariantsRequest"
- },
- "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.",
- "httpMethod": "POST",
- "parameterOrder": [],
- "response": {
- "$ref": "Empty"
- },
- "parameters": {},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics"
- ],
- "flatPath": "v1/variants:merge",
- "id": "genomics.variants.merge",
- "path": "v1/variants:merge"
+ "id": "genomics.annotationsets.create"
}
}
},
"references": {
+ "methods": {
+ "search": {
+ "path": "v1/references/search",
+ "id": "genomics.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).",
+ "response": {
+ "$ref": "SearchReferencesResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "parameters": {},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics",
+ "https://www.googleapis.com/auth/genomics.readonly"
+ ],
+ "flatPath": "v1/references/search"
+ },
+ "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).",
+ "response": {
+ "$ref": "Reference"
+ },
+ "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": {
+ "referenceId": {
+ "description": "The ID of the reference.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/references/{referenceId}",
+ "path": "v1/references/{referenceId}",
+ "id": "genomics.references.get"
+ }
+ },
"resources": {
"bases": {
"methods": {
"list": {
+ "path": "v1/references/{referenceId}/bases",
+ "id": "genomics.references.bases.list",
+ "description": "Lists the bases in a reference, optionally restricted to a range.\n\nFor the definitions of references and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nImplements\n[GlobalAllianceApi.getReferenceBases](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/referencemethods.avdl#L221).",
"response": {
"$ref": "ListBasesResponse"
},
@@ -698,23 +1195,6 @@
"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": {
- "location": "query",
- "description": "The start position (0-based) of this query. Defaults to 0.",
- "format": "int64",
- "type": "string"
- },
"referenceId": {
"location": "path",
"description": "The ID of the reference.",
@@ -726,49 +1206,108 @@
"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": {
+ "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"
}
},
- "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)."
+ "flatPath": "v1/references/{referenceId}/bases"
}
}
}
- },
+ }
+ },
+ "datasets": {
"methods": {
- "search": {
- "description": "Searches for references which match the given criteria.\n\nFor the definitions of references and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nImplements\n[GlobalAllianceApi.searchReferences](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/referencemethods.avdl#L146).",
- "request": {
- "$ref": "SearchReferencesRequest"
- },
- "response": {
- "$ref": "SearchReferencesResponse"
- },
- "parameterOrder": [],
+ "getIamPolicy": {
"httpMethod": "POST",
+ "parameterOrder": [
+ "resource"
+ ],
+ "response": {
+ "$ref": "Policy"
+ },
+ "parameters": {
+ "resource": {
+ "pattern": "^datasets/[^/]+$",
+ "location": "path",
+ "description": "REQUIRED: The resource for which policy is being specified. Format is\n`datasets/\u003cdataset ID\u003e`.",
+ "required": true,
+ "type": "string"
+ }
+ },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics",
- "https://www.googleapis.com/auth/genomics.readonly"
+ "https://www.googleapis.com/auth/genomics"
],
- "parameters": {},
- "flatPath": "v1/references/search",
- "path": "v1/references/search",
- "id": "genomics.references.search"
+ "flatPath": "v1/datasets/{datasetsId}:getIamPolicy",
+ "id": "genomics.datasets.getIamPolicy",
+ "path": "v1/{+resource}:getIamPolicy",
+ "request": {
+ "$ref": "GetIamPolicyRequest"
+ },
+ "description": "Gets the access control policy for the dataset. This is empty if the\npolicy or resource does not exist.\n\nSee \u003ca href=\"/iam/docs/managing-policies#getting_a_policy\"\u003eGetting a\nPolicy\u003c/a\u003e for more information.\n\nFor the definitions of datasets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)"
},
- "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).",
- "httpMethod": "GET",
+ "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": "Reference"
+ "$ref": "Dataset"
},
"parameterOrder": [
- "referenceId"
+ "datasetId"
+ ],
+ "httpMethod": "PATCH",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics"
],
"parameters": {
- "referenceId": {
- "description": "The ID of the reference.",
+ "datasetId": {
+ "location": "path",
+ "description": "The ID of the dataset to be updated.",
+ "required": true,
+ "type": "string"
+ },
+ "updateMask": {
+ "location": "query",
+ "description": "An optional mask specifying which fields to update. At this time, the only\nmutable field is name. The only\nacceptable value is \"name\". If unspecified, all mutable fields will be\nupdated.",
+ "format": "google-fieldmask",
+ "type": "string"
+ }
+ },
+ "flatPath": "v1/datasets/{datasetId}",
+ "path": "v1/datasets/{datasetId}",
+ "id": "genomics.datasets.patch"
+ },
+ "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)",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "Dataset"
+ },
+ "parameterOrder": [
+ "datasetId"
+ ],
+ "parameters": {
+ "datasetId": {
+ "description": "The ID of the dataset.",
"required": true,
"type": "string",
"location": "path"
@@ -779,15 +1318,129 @@
"https://www.googleapis.com/auth/genomics",
"https://www.googleapis.com/auth/genomics.readonly"
],
- "flatPath": "v1/references/{referenceId}",
- "id": "genomics.references.get",
- "path": "v1/references/{referenceId}"
- }
- }
- },
- "datasets": {
- "methods": {
+ "flatPath": "v1/datasets/{datasetId}",
+ "id": "genomics.datasets.get",
+ "path": "v1/datasets/{datasetId}"
+ },
+ "undelete": {
+ "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 undeleted.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1/datasets/{datasetId}:undelete",
+ "id": "genomics.datasets.undelete",
+ "path": "v1/datasets/{datasetId}:undelete",
+ "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.",
+ "request": {
+ "$ref": "UndeleteDatasetRequest"
+ },
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "datasetId"
+ ],
+ "response": {
+ "$ref": "Dataset"
+ }
+ },
+ "testIamPermissions": {
+ "request": {
+ "$ref": "TestIamPermissionsRequest"
+ },
+ "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)",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "resource"
+ ],
+ "response": {
+ "$ref": "TestIamPermissionsResponse"
+ },
+ "parameters": {
+ "resource": {
+ "pattern": "^datasets/[^/]+$",
+ "location": "path",
+ "description": "REQUIRED: The resource for which policy is being specified. Format is\n`datasets/\u003cdataset ID\u003e`.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics"
+ ],
+ "flatPath": "v1/datasets/{datasetsId}:testIamPermissions",
+ "id": "genomics.datasets.testIamPermissions",
+ "path": "v1/{+resource}:testIamPermissions"
+ },
+ "delete": {
+ "httpMethod": "DELETE",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "datasetId"
+ ],
+ "parameters": {
+ "datasetId": {
+ "location": "path",
+ "description": "The ID of the dataset to be deleted.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics"
+ ],
+ "flatPath": "v1/datasets/{datasetId}",
+ "id": "genomics.datasets.delete",
+ "path": "v1/datasets/{datasetId}",
+ "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": {
+ "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": {
+ "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",
+ "path": "v1/datasets",
+ "id": "genomics.datasets.list",
+ "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)",
+ "response": {
+ "$ref": "ListDatasetsResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "GET"
+ },
"setIamPolicy": {
+ "path": "v1/{+resource}:setIamPolicy",
+ "id": "genomics.datasets.setIamPolicy",
"description": "Sets the access control policy on the specified dataset. Replaces any\nexisting policy.\n\nFor the definitions of datasets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nSee \u003ca href=\"/iam/docs/managing-policies#setting_a_policy\"\u003eSetting a\nPolicy\u003c/a\u003e for more information.",
"request": {
"$ref": "SetIamPolicyRequest"
@@ -805,746 +1458,78 @@
],
"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",
- "pattern": "^datasets/[^/]+$",
- "location": "path"
+ "type": "string"
}
},
- "flatPath": "v1/datasets/{datasetsId}:setIamPolicy",
- "path": "v1/{+resource}:setIamPolicy",
- "id": "genomics.datasets.setIamPolicy"
+ "flatPath": "v1/datasets/{datasetsId}:setIamPolicy"
},
"create": {
- "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"
},
+ "httpMethod": "POST",
+ "parameterOrder": [],
"response": {
"$ref": "Dataset"
},
- "parameterOrder": [],
- "httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/genomics"
],
"parameters": {},
- "flatPath": "v1/datasets"
- },
- "getIamPolicy": {
- "path": "v1/{+resource}:getIamPolicy",
- "id": "genomics.datasets.getIamPolicy",
- "request": {
- "$ref": "GetIamPolicyRequest"
- },
- "description": "Gets the access control policy for the dataset. This is empty if the\npolicy or resource does not exist.\n\nSee \u003ca href=\"/iam/docs/managing-policies#getting_a_policy\"\u003eGetting a\nPolicy\u003c/a\u003e for more information.\n\nFor the definitions of datasets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)",
- "response": {
- "$ref": "Policy"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
- "parameters": {
- "resource": {
- "description": "REQUIRED: The resource for which policy is being specified. Format is\n`datasets/\u003cdataset ID\u003e`.",
- "required": true,
- "type": "string",
- "pattern": "^datasets/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics"
- ],
- "flatPath": "v1/datasets/{datasetsId}:getIamPolicy"
- },
- "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"
- }
- },
- "get": {
- "response": {
- "$ref": "Dataset"
- },
- "parameterOrder": [
- "datasetId"
- ],
- "httpMethod": "GET",
- "parameters": {
- "datasetId": {
- "location": "path",
- "description": "The ID of the dataset.",
- "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/datasets/{datasetId}",
- "path": "v1/datasets/{datasetId}",
- "id": "genomics.datasets.get",
- "description": "Gets a dataset by ID.\n\nFor the definitions of datasets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)"
- },
- "undelete": {
- "response": {
- "$ref": "Dataset"
- },
- "parameterOrder": [
- "datasetId"
- ],
- "httpMethod": "POST",
- "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 undeleted.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1/datasets/{datasetId}:undelete",
- "path": "v1/datasets/{datasetId}:undelete",
- "id": "genomics.datasets.undelete",
- "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.",
- "request": {
- "$ref": "UndeleteDatasetRequest"
- }
- },
- "testIamPermissions": {
- "response": {
- "$ref": "TestIamPermissionsResponse"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
- "parameters": {
- "resource": {
- "pattern": "^datasets/[^/]+$",
- "location": "path",
- "description": "REQUIRED: The resource for which policy is being specified. Format is\n`datasets/\u003cdataset ID\u003e`.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics"
- ],
- "flatPath": "v1/datasets/{datasetsId}:testIamPermissions",
- "path": "v1/{+resource}:testIamPermissions",
- "id": "genomics.datasets.testIamPermissions",
- "request": {
- "$ref": "TestIamPermissionsRequest"
- },
- "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)"
- },
- "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": {
- "response": {
- "$ref": "ListDatasetsResponse"
- },
- "parameterOrder": [],
- "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": {
- "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"
- }
- },
"flatPath": "v1/datasets",
- "path": "v1/datasets",
- "id": "genomics.datasets.list",
- "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)"
- }
- }
- },
- "annotations": {
- "methods": {
- "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": {
- "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"
- },
- "create": {
- "response": {
- "$ref": "Annotation"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics"
- ],
- "parameters": {},
- "flatPath": "v1/annotations",
- "path": "v1/annotations",
- "id": "genomics.annotations.create",
- "description": "Creates a new annotation. Caller must have WRITE permission\nfor the associated annotation set.\n\nThe following fields are required:\n\n* annotationSetId\n* referenceName or\n referenceId\n\n### Transcripts\n\nFor annotations of type TRANSCRIPT, the following fields of\ntranscript must be provided:\n\n* exons.start\n* exons.end\n\nAll other fields may be optionally specified, unless documented as being\nserver-generated (for example, the `id` field). The annotated\nrange must be no longer than 100Mbp (mega base pairs). See the\nAnnotation resource\nfor additional restrictions on each field.",
- "request": {
- "$ref": "Annotation"
- }
- },
- "batchCreate": {
- "request": {
- "$ref": "BatchCreateAnnotationsRequest"
- },
- "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.",
- "response": {
- "$ref": "BatchCreateAnnotationsResponse"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "parameters": {},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics"
- ],
- "flatPath": "v1/annotations:batchCreate",
- "path": "v1/annotations:batchCreate",
- "id": "genomics.annotations.batchCreate"
- },
- "search": {
- "response": {
- "$ref": "SearchAnnotationsResponse"
- },
- "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/annotations/search",
- "path": "v1/annotations/search",
- "id": "genomics.annotations.search",
- "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.",
- "request": {
- "$ref": "SearchAnnotationsRequest"
- }
- },
- "get": {
- "httpMethod": "GET",
- "response": {
- "$ref": "Annotation"
- },
- "parameterOrder": [
- "annotationId"
- ],
- "parameters": {
- "annotationId": {
- "description": "The ID of the annotation to be retrieved.",
- "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/annotations/{annotationId}",
- "id": "genomics.annotations.get",
- "path": "v1/annotations/{annotationId}",
- "description": "Gets an annotation. Caller must have READ permission\nfor the associated annotation set."
- },
- "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": {
- "annotationId": {
- "description": "The ID of the annotation to be updated.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "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"
- }
- },
- "flatPath": "v1/annotations/{annotationId}",
- "path": "v1/annotations/{annotationId}",
- "id": "genomics.annotations.update"
- }
- }
- },
- "variantsets": {
- "methods": {
- "create": {
- "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.",
- "request": {
- "$ref": "VariantSet"
- },
- "response": {
- "$ref": "VariantSet"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics"
- ],
- "parameters": {},
- "flatPath": "v1/variantsets",
- "path": "v1/variantsets",
- "id": "genomics.variantsets.create"
- },
- "export": {
- "httpMethod": "POST",
- "parameterOrder": [
- "variantSetId"
- ],
- "response": {
- "$ref": "Operation"
- },
- "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",
- "id": "genomics.variantsets.export",
- "path": "v1/variantsets/{variantSetId}: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": {
- "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",
- "path": "v1/variantsets/search",
- "id": "genomics.variantsets.search"
- },
- "get": {
- "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",
- "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)"
- },
- "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": {
- "description": "An optional mask specifying which fields to update. Supported fields:\n\n* metadata.\n* name.\n* description.\n\nLeaving `updateMask` unset is equivalent to specifying all mutable\nfields.",
- "format": "google-fieldmask",
- "type": "string",
- "location": "query"
- },
- "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"
- },
- "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": {
- "description": "The ID of the variant set to be deleted.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "flatPath": "v1/variantsets/{variantSetId}",
- "path": "v1/variantsets/{variantSetId}",
- "id": "genomics.variantsets.delete"
- }
- }
- },
- "operations": {
- "methods": {
- "cancel": {
- "httpMethod": "POST",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Empty"
- },
- "parameters": {
- "name": {
- "pattern": "^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/genomics"
- ],
- "flatPath": "v1/operations/{operationsId}:cancel",
- "id": "genomics.operations.cancel",
- "path": "v1/{+name}:cancel",
- "request": {
- "$ref": "CancelOperationRequest"
- },
- "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. Clients may use Operations.GetOperation or Operations.ListOperations to check whether the cancellation succeeded or the operation completed despite cancellation."
- },
- "list": {
- "httpMethod": "GET",
- "response": {
- "$ref": "ListOperationsResponse"
- },
- "parameterOrder": [
- "name"
- ],
- "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",
- "id": "genomics.operations.list",
- "path": "v1/{+name}",
- "description": "Lists operations that match the specified filter in the request."
- },
- "get": {
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "parameters": {
- "name": {
- "description": "The name of the operation resource.",
- "required": true,
- "type": "string",
- "pattern": "^operations/.+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics"
- ],
- "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": {
- "id": "genomics.referencesets.get",
- "path": "v1/referencesets/{referenceSetId}",
- "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).",
- "httpMethod": "GET",
- "response": {
- "$ref": "ReferenceSet"
- },
- "parameterOrder": [
- "referenceSetId"
- ],
- "parameters": {
- "referenceSetId": {
- "location": "path",
- "description": "The ID of the reference set.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics",
- "https://www.googleapis.com/auth/genomics.readonly"
- ],
- "flatPath": "v1/referencesets/{referenceSetId}"
+ "id": "genomics.datasets.create",
+ "path": "v1/datasets"
}
}
}
},
"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"
},
+ "prettyPrint": {
+ "location": "query",
+ "description": "Returns response with indentations and line breaks.",
+ "type": "boolean",
+ "default": "true"
+ },
+ "uploadType": {
+ "location": "query",
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string"
+ },
"fields": {
"location": "query",
"description": "Selector specifying which fields to include in a partial response.",
"type": "string"
},
"callback": {
+ "location": "query",
"description": "JSONP",
- "type": "string",
- "location": "query"
+ "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"
- ],
- "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",
@@ -1552,12 +1537,18 @@
],
"location": "query",
"description": "Data format for response.",
- "default": "json"
+ "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"
+ "type": "string",
+ "location": "query"
},
"access_token": {
"location": "query",
@@ -1576,35 +1567,203 @@
"location": "query"
},
"bearer_token": {
+ "location": "query",
"description": "OAuth bearer token.",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"oauth_token": {
- "location": "query",
"description": "OAuth 2.0 token for the current user.",
- "type": "string"
+ "type": "string",
+ "location": "query"
}
},
"schemas": {
+ "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": {
+ "name": {
+ "description": "The dataset name.",
+ "type": "string"
+ },
+ "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"
+ },
+ "createTime": {
+ "description": "The time this dataset was created, in seconds from the epoch.",
+ "format": "google-datetime",
+ "type": "string"
+ }
+ },
+ "id": "Dataset"
+ },
+ "ImportVariantsResponse": {
+ "description": "The variant data import response.",
+ "type": "object",
+ "properties": {
+ "callSetIds": {
+ "description": "IDs of the call sets created during the import.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "id": "ImportVariantsResponse"
+ },
+ "ReadGroup": {
+ "description": "A read group is all the data that's processed the same way by the sequencer.",
+ "type": "object",
+ "properties": {
+ "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"
+ }
+ },
+ "description": {
+ "description": "A free-form text description of this read group.",
+ "type": "string"
+ },
+ "sampleId": {
+ "description": "A client-supplied sample identifier for the reads in this read group.",
+ "type": "string"
+ },
+ "datasetId": {
+ "description": "The dataset to which this read group belongs.",
+ "type": "string"
+ },
+ "experiment": {
+ "$ref": "Experiment",
+ "description": "The experiment used to generate this read group."
+ },
+ "name": {
+ "description": "The read group name. This corresponds to the @RG ID field in the SAM spec.",
+ "type": "string"
+ },
+ "referenceSetId": {
+ "description": "The reference set the reads in this read group are aligned to.",
+ "type": "string"
+ },
+ "info": {
+ "additionalProperties": {
+ "type": "array",
+ "items": {
+ "type": "any"
+ }
+ },
+ "description": "A map of additional read group information. This must be of the form\nmap\u003cstring, string[]\u003e (string key mapping to a list of string values).",
+ "type": "object"
+ }
+ },
+ "id": "ReadGroup"
+ },
+ "ReadGroupSet": {
+ "id": "ReadGroupSet",
+ "description": "A read group set is a logical collection of read groups, which are\ncollections of reads produced by a sequencer. A read group set typically\nmodels reads corresponding to one sample, sequenced one way, and aligned one\nway.\n\n* A read group set belongs to one dataset.\n* A read group belongs to one read group set.\n* A read belongs to one read group.\n\nFor more genomics resource definitions, see [Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "The read group set name. By default this will be initialized to the sample\nname of the sequenced data contained in this set.",
+ "type": "string"
+ },
+ "referenceSetId": {
+ "description": "The reference set to which the reads in this read group set are aligned.",
+ "type": "string"
+ },
+ "info": {
+ "description": "A map of additional read group set information.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "array",
+ "items": {
+ "type": "any"
+ }
+ }
+ },
+ "id": {
+ "description": "The server-generated read group set ID, unique for all read group sets.",
+ "type": "string"
+ },
+ "datasetId": {
+ "description": "The dataset to which this read group set belongs.",
+ "type": "string"
+ },
+ "readGroups": {
+ "description": "The read groups in this set. There are typically 1-10 read groups in a read\ngroup set.",
+ "type": "array",
+ "items": {
+ "$ref": "ReadGroup"
+ }
+ },
+ "filename": {
+ "description": "The filename of the original source file for this read group set, if any.",
+ "type": "string"
+ }
+ }
+ },
+ "SearchVariantSetsResponse": {
+ "id": "SearchVariantSetsResponse",
+ "description": "The search variant sets response.",
+ "type": "object",
+ "properties": {
+ "variantSets": {
+ "description": "The variant sets belonging to the requested dataset.",
+ "type": "array",
+ "items": {
+ "$ref": "VariantSet"
+ }
+ },
+ "nextPageToken": {
+ "description": "The continuation token, which is used to page through large result sets.\nProvide this value in a subsequent request to return the next page of\nresults. This field will be empty if there aren't any additional results.",
+ "type": "string"
+ }
+ }
+ },
+ "Empty": {
+ "id": "Empty",
+ "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
+ "type": "object",
+ "properties": {}
+ },
"Entry": {
+ "type": "object",
"properties": {
"status": {
"description": "The creation status.",
"$ref": "Status"
},
"annotation": {
- "description": "The created annotation, if creation was successful.",
- "$ref": "Annotation"
+ "$ref": "Annotation",
+ "description": "The created annotation, if creation was successful."
}
},
- "id": "Entry",
- "type": "object"
+ "id": "Entry"
},
"Position": {
"description": "An abstraction for referring to a genomic position, in relation to some\nalready known reference. For now, represents a genomic position as a\nreference name, a base number on that reference (0-based), and a\ndetermination of forward or reverse strand.",
"type": "object",
"properties": {
+ "position": {
+ "description": "The 0-based offset from the start of the forward strand for that reference.",
+ "format": "int64",
+ "type": "string"
+ },
"referenceName": {
"description": "The name of the reference in whatever reference set is being used.",
"type": "string"
@@ -1612,16 +1771,12 @@
"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": {
+ "id": "SearchReferenceSetsResponse",
"type": "object",
"properties": {
"referenceSets": {
@@ -1635,10 +1790,10 @@
"description": "The continuation token, which is used to page through large result sets.\nProvide this value in a subsequent request to return the next page of\nresults. This field will be empty if there aren't any additional results.",
"type": "string"
}
- },
- "id": "SearchReferenceSetsResponse"
+ }
},
"SearchCallSetsRequest": {
+ "id": "SearchCallSetsRequest",
"description": "The call set search request.",
"type": "object",
"properties": {
@@ -1662,27 +1817,13 @@
"type": "string"
}
}
- },
- "id": "SearchCallSetsRequest"
+ }
},
"ImportReadGroupSetsRequest": {
+ "id": "ImportReadGroupSetsRequest",
"description": "The read group set import request.",
"type": "object",
"properties": {
- "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"
@@ -1697,9 +1838,22 @@
"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"
+ ]
}
- },
- "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).",
@@ -1726,63 +1880,10 @@
"id": "Policy"
},
"Annotation": {
+ "id": "Annotation",
"description": "An annotation describes a region of reference genome. The value of an\nannotation may be one of several canonical types, supplemented by arbitrary\ninfo tags. An annotation is not inherently associated with a specific\nsample or individual (though a client could choose to use annotations in\nthis way). Example canonical annotation types are `GENE` and\n`VARIANT`.",
"type": "object",
"properties": {
- "reverseStrand": {
- "description": "Whether this range refers to the reverse strand, as opposed to the forward\nstrand. Note that regardless of this field, the start/end position of the\nrange always refer to the forward strand.",
- "type": "boolean"
- },
- "referenceName": {
- "description": "The display name corresponding to the reference specified by\n`referenceId`, for example `chr1`, `1`, or `chrX`.",
- "type": "string"
- },
- "type": {
- "enum": [
- "ANNOTATION_TYPE_UNSPECIFIED",
- "GENERIC",
- "VARIANT",
- "GENE",
- "TRANSCRIPT"
- ],
- "description": "The data type for this annotation. Must match the containing annotation\nset's type.",
- "type": "string",
- "enumDescriptions": [
- "",
- "A `GENERIC` annotation type should be used when no other annotation\ntype will suffice. This represents an untyped annotation of the reference\ngenome.",
- "A `VARIANT` annotation type.",
- "A `GENE` annotation type represents the existence of a gene at the\nassociated reference coordinates. The start coordinate is typically the\ngene's transcription start site and the end is typically the end of the\ngene's last exon.",
- "A `TRANSCRIPT` annotation type represents the assertion that a\nparticular region of the reference genome may be transcribed as RNA."
- ]
- },
- "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"
- },
- "end": {
- "description": "The end position of the range on the reference, 0-based exclusive.",
- "format": "int64",
- "type": "string"
- },
- "transcript": {
- "$ref": "Transcript",
- "description": "A transcript value represents the assertion that a particular region of\nthe reference genome may be transcribed as RNA. An alternative splicing\npattern would be represented as a separate transcript object. This field\nis only set for annotations of type `TRANSCRIPT`."
- },
- "start": {
- "description": "The start position of the range on the reference, 0-based inclusive.",
- "format": "int64",
- "type": "string"
- },
- "annotationSetId": {
- "description": "The annotation set to which this annotation belongs.",
- "type": "string"
- },
"name": {
"description": "The display name of this annotation.",
"type": "string"
@@ -1798,32 +1899,74 @@
"referenceId": {
"description": "The ID of the Google Genomics reference associated with this range.",
"type": "string"
- }
- },
- "id": "Annotation"
- },
- "CancelOperationRequest": {
- "properties": {},
- "id": "CancelOperationRequest",
- "description": "The request message for Operations.CancelOperation.",
- "type": "object"
- },
- "SearchReadsRequest": {
- "description": "The read search request.",
- "type": "object",
- "properties": {
- "readGroupIds": {
- "description": "The IDs of the read groups within which to search for reads. All specified\nread groups must belong to the same read group sets. Must specify one of\n`readGroupSetIds` or `readGroupIds`.",
- "type": "array",
- "items": {
- "type": "string"
+ },
+ "reverseStrand": {
+ "description": "Whether this range refers to the reverse strand, as opposed to the forward\nstrand. Note that regardless of this field, the start/end position of the\nrange always refer to the forward strand.",
+ "type": "boolean"
+ },
+ "referenceName": {
+ "description": "The display name corresponding to the reference specified by\n`referenceId`, for example `chr1`, `1`, or `chrX`.",
+ "type": "string"
+ },
+ "info": {
+ "description": "A map of additional read alignment information. This must be of the form\nmap\u003cstring, string[]\u003e (string key mapping to a list of string values).",
+ "type": "object",
+ "additionalProperties": {
+ "type": "array",
+ "items": {
+ "type": "any"
+ }
}
},
+ "type": {
+ "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 data type for this annotation. Must match the containing annotation\nset's type.",
+ "type": "string"
+ },
"end": {
- "description": "The end position of the range on the reference, 0-based exclusive. If\nspecified, `referenceName` must also be specified.",
+ "description": "The end position of the range on the reference, 0-based exclusive.",
"format": "int64",
"type": "string"
},
+ "transcript": {
+ "description": "A transcript value represents the assertion that a particular region of\nthe reference genome may be transcribed as RNA. An alternative splicing\npattern would be represented as a separate transcript object. This field\nis only set for annotations of type `TRANSCRIPT`.",
+ "$ref": "Transcript"
+ },
+ "start": {
+ "description": "The start position of the range on the reference, 0-based inclusive.",
+ "format": "int64",
+ "type": "string"
+ },
+ "annotationSetId": {
+ "description": "The annotation set to which this annotation belongs.",
+ "type": "string"
+ }
+ }
+ },
+ "CancelOperationRequest": {
+ "id": "CancelOperationRequest",
+ "description": "The request message for Operations.CancelOperation.",
+ "type": "object",
+ "properties": {}
+ },
+ "SearchReadsRequest": {
+ "id": "SearchReadsRequest",
+ "description": "The read search request.",
+ "type": "object",
+ "properties": {
"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"
@@ -1848,22 +1991,35 @@
"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"
}
- },
- "id": "SearchReadsRequest"
+ }
},
"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",
- "description": "Runtime metadata that will be populated in the\nruntimeMetadata\nfield of the Operation associated with a RunPipeline execution.",
- "type": "object"
+ "id": "RuntimeMetadata"
},
"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.",
@@ -1882,8 +2038,8 @@
"type": "string"
},
"error": {
- "description": "The error result of the operation in case of failure or cancellation.",
- "$ref": "Status"
+ "$ref": "Status",
+ "description": "The error result of the operation in case of failure or cancellation."
},
"metadata": {
"additionalProperties": {
@@ -1894,9 +2050,7 @@
"type": "object"
}
},
- "id": "Operation",
- "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
- "type": "object"
+ "id": "Operation"
},
"ImportReadGroupSetsResponse": {
"description": "The read group set import response.",
@@ -1913,7 +2067,17 @@
"id": "ImportReadGroupSetsResponse"
},
"VariantCall": {
+ "description": "A call represents the determination of genotype with respect to a particular\nvariant. It may include associated information such as quality and phasing.\nFor example, a call might assign a probability of 0.32 to the occurrence of\na SNP named rs1234 in a call set with the name NA12345.",
+ "type": "object",
"properties": {
+ "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",
+ "items": {
+ "format": "double",
+ "type": "number"
+ }
+ },
"callSetId": {
"description": "The ID of the call set this variant call belongs to.",
"type": "string"
@@ -1943,34 +2107,24 @@
"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",
- "items": {
- "format": "double",
- "type": "number"
- }
}
},
- "id": "VariantCall",
- "description": "A call represents the determination of genotype with respect to a particular\nvariant. It may include associated information such as quality and phasing.\nFor example, a call might assign a probability of 0.32 to the occurrence of\na SNP named rs1234 in a call set with the name NA12345.",
- "type": "object"
+ "id": "VariantCall"
},
"SearchVariantsResponse": {
"description": "The variant 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"
- },
"variants": {
"description": "The list of matching Variants.",
"type": "array",
"items": {
"$ref": "Variant"
}
+ },
+ "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": "SearchVariantsResponse"
@@ -1978,6 +2132,11 @@
"ListBasesResponse": {
"type": "object",
"properties": {
+ "offset": {
+ "description": "The offset position (0-based) of the given `sequence` from the\nstart of this `Reference`. This value will differ for each page\nin a paginated request.",
+ "format": "int64",
+ "type": "string"
+ },
"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"
@@ -1985,11 +2144,6 @@
"sequence": {
"description": "A substring of the bases that make up this reference.",
"type": "string"
- },
- "offset": {
- "description": "The offset position (0-based) of the given `sequence` from the\nstart of this `Reference`. This value will differ for each page\nin a paginated request.",
- "format": "int64",
- "type": "string"
}
},
"id": "ListBasesResponse"
@@ -1998,17 +2152,6 @@
"description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
"type": "object",
"properties": {
- "details": {
- "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.",
- "type": "array",
- "items": {
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- },
- "type": "object"
- }
- },
"code": {
"description": "The status code, which should be an enum value of google.rpc.Code.",
"format": "int32",
@@ -2017,11 +2160,24 @@
"message": {
"description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
"type": "string"
+ },
+ "details": {
+ "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ }
+ }
}
},
"id": "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",
@@ -2035,16 +2191,17 @@
"type": "string"
}
},
- "id": "Binding",
- "description": "Associates `members` with a `role`.",
- "type": "object"
+ "id": "Binding"
},
"UndeleteDatasetRequest": {
- "properties": {},
"id": "UndeleteDatasetRequest",
- "type": "object"
+ "type": "object",
+ "properties": {}
},
"Range": {
+ "id": "Range",
+ "description": "A 0-based half-open genomic coordinate range for search requests.",
+ "type": "object",
"properties": {
"start": {
"description": "The start position of the range on the reference, 0-based inclusive.",
@@ -2060,10 +2217,7 @@
"description": "The reference sequence name, for example `chr1`,\n`1`, or `chrX`.",
"type": "string"
}
- },
- "id": "Range",
- "description": "A 0-based half-open genomic coordinate range for search requests.",
- "type": "object"
+ }
},
"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)",
@@ -2107,6 +2261,7 @@
"id": "VariantSet"
},
"ReferenceBound": {
+ "id": "ReferenceBound",
"description": "ReferenceBound records an upper bound for the starting coordinate of\nvariants in a particular reference.",
"type": "object",
"properties": {
@@ -2119,8 +2274,7 @@
"description": "The name of the reference associated with this reference bound.",
"type": "string"
}
- },
- "id": "ReferenceBound"
+ }
},
"BatchCreateAnnotationsResponse": {
"type": "object",
@@ -2136,49 +2290,28 @@
"id": "BatchCreateAnnotationsResponse"
},
"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"
},
"Variant": {
+ "id": "Variant",
"description": "A variant represents a change in DNA sequence relative to a reference\nsequence. For example, a variant could represent a SNP or an insertion.\nVariants belong to a variant set.\n\nFor more genomics resource definitions, see [Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nEach of the calls on a variant represent a determination of genotype with\nrespect to that variant. For example, a call might assign probability of 0.32\nto the occurrence of a SNP named rs1234 in a sample named NA12345. A call\nbelongs to a call set, which contains related calls typically from one\nsample.",
"type": "object",
"properties": {
- "variantSetId": {
- "description": "The ID of the variant set this variant belongs to.",
- "type": "string"
- },
- "referenceName": {
- "description": "The reference on which this variant occurs.\n(such as `chr20` or `X`)",
- "type": "string"
- },
- "info": {
- "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.",
- "type": "string"
- },
"names": {
"description": "Names for the variant, for example a RefSNP ID.",
"type": "array",
@@ -2230,11 +2363,35 @@
"id": {
"description": "The server-generated variant ID, unique across all variants.",
"type": "string"
+ },
+ "variantSetId": {
+ "description": "The ID of the variant set this variant belongs to.",
+ "type": "string"
+ },
+ "referenceName": {
+ "description": "The reference on which this variant occurs.\n(such as `chr20` or `X`)",
+ "type": "string"
+ },
+ "info": {
+ "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.",
+ "type": "string"
}
- },
- "id": "Variant"
+ }
},
"SearchCallSetsResponse": {
+ "id": "SearchCallSetsResponse",
+ "description": "The call set search response.",
+ "type": "object",
"properties": {
"nextPageToken": {
"description": "The continuation token, which is used to page through large result sets.\nProvide this value in a subsequent request to return the next page of\nresults. This field will be empty if there aren't any additional results.",
@@ -2247,28 +2404,12 @@
"$ref": "CallSet"
}
}
- },
- "id": "SearchCallSetsResponse",
- "description": "The call set search response.",
- "type": "object"
+ }
},
"SearchVariantsRequest": {
"description": "The variant search request.",
"type": "object",
"properties": {
- "start": {
- "description": "The beginning of the window (0-based, inclusive) for which\noverlapping variants should be returned. If unspecified, defaults to 0.",
- "format": "int64",
- "type": "string"
- },
- "variantName": {
- "description": "Only return variants which have exactly this name.",
- "type": "string"
- },
- "referenceName": {
- "description": "Required. Only return variants in this reference sequence.",
- "type": "string"
- },
"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",
@@ -2301,27 +2442,32 @@
"items": {
"type": "string"
}
+ },
+ "start": {
+ "description": "The beginning of the window (0-based, inclusive) for which\noverlapping variants should be returned. If unspecified, defaults to 0.",
+ "format": "int64",
+ "type": "string"
+ },
+ "variantName": {
+ "description": "Only return variants which have exactly this name.",
+ "type": "string"
+ },
+ "referenceName": {
+ "description": "Required. Only return variants in this reference sequence.",
+ "type": "string"
}
},
"id": "SearchVariantsRequest"
},
"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",
@@ -2329,26 +2475,36 @@
"$ref": "OperationEvent"
}
},
+ "endTime": {
+ "description": "The time at which the job stopped running.",
+ "format": "google-datetime",
+ "type": "string"
+ },
"startTime": {
"description": "The time at which the job began to run.",
"format": "google-datetime",
"type": "string"
},
"request": {
+ "description": "The original request that started the operation. Note that this will be in\ncurrent version of the API. If the operation was started with v1beta2 API\nand a GetOperation is performed on v1 API, a v1 request will be returned.",
+ "type": "object",
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
- },
- "description": "The original request that started the operation. Note that this will be in\ncurrent version of the API. If the operation was started with v1beta2 API\nand a GetOperation is performed on v1 API, a v1 request will be returned.",
- "type": "object"
+ }
},
"runtimeMetadata": {
+ "description": "Runtime metadata on this Operation.",
+ "type": "object",
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
- },
- "description": "Runtime metadata on this Operation.",
- "type": "object"
+ }
+ },
+ "createTime": {
+ "description": "The time at which the job was submitted to the Genomics service.",
+ "format": "google-datetime",
+ "type": "string"
},
"labels": {
"additionalProperties": {
@@ -2357,15 +2513,16 @@
"description": "Optionally provided by the caller when submitting the request that creates\nthe operation.",
"type": "object"
},
- "createTime": {
- "description": "The time at which the job was submitted to the Genomics service.",
- "format": "google-datetime",
+ "projectId": {
+ "description": "The Google Cloud Project in which the job is scoped.",
"type": "string"
}
- },
- "id": "OperationMetadata"
+ }
},
"SearchReadGroupSetsRequest": {
+ "id": "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.",
@@ -2387,12 +2544,10 @@
"format": "int32",
"type": "integer"
}
- },
- "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.",
@@ -2406,29 +2561,36 @@
}
}
},
- "id": "SearchAnnotationsResponse",
- "type": "object"
+ "id": "SearchAnnotationsResponse"
},
"SearchReadsResponse": {
+ "description": "The read search response.",
+ "type": "object",
"properties": {
- "nextPageToken": {
- "description": "The continuation token, which is used to page through large result sets.\nProvide this value in a subsequent request to return the next page of\nresults. This field will be empty if there aren't any additional results.",
- "type": "string"
- },
"alignments": {
"description": "The list of matching alignments sorted by mapped genomic coordinate,\nif any, ascending in position within the same reference. Unmapped reads,\nwhich have no position, are returned contiguously and are sorted in\nascending lexicographic order by fragment name.",
"type": "array",
"items": {
"$ref": "Read"
}
+ },
+ "nextPageToken": {
+ "description": "The continuation token, which is used to page through large result sets.\nProvide this value in a subsequent request to return the next page of\nresults. This field will be empty if there aren't any additional results.",
+ "type": "string"
}
},
- "id": "SearchReadsResponse",
- "description": "The read search response.",
- "type": "object"
+ "id": "SearchReadsResponse"
},
"ClinicalCondition": {
+ "type": "object",
"properties": {
+ "names": {
+ "description": "A set of names for the condition.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
"omimId": {
"description": "The OMIM id for this condition.\nSearch for these IDs at http://omim.org/",
"type": "string"
@@ -2443,19 +2605,12 @@
"conceptId": {
"description": "The MedGen concept id associated with this gene.\nSearch for these IDs at http://www.ncbi.nlm.nih.gov/medgen/",
"type": "string"
- },
- "names": {
- "description": "A set of names for the condition.",
- "type": "array",
- "items": {
- "type": "string"
- }
}
},
- "id": "ClinicalCondition",
- "type": "object"
+ "id": "ClinicalCondition"
},
"Program": {
+ "id": "Program",
"type": "object",
"properties": {
"name": {
@@ -2478,8 +2633,7 @@
"description": "The version of the program run.",
"type": "string"
}
- },
- "id": "Program"
+ }
},
"CoverageBucket": {
"description": "A bucket over which read coverage has been precomputed. A bucket corresponds\nto a specific range of the reference sequence.",
@@ -2491,14 +2645,21 @@
"type": "number"
},
"range": {
- "$ref": "Range",
- "description": "The genomic coordinate range spanned by this bucket."
+ "description": "The genomic coordinate range spanned by this bucket.",
+ "$ref": "Range"
}
},
"id": "CoverageBucket"
},
"ComputeEngine": {
+ "id": "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"
@@ -2513,31 +2674,27 @@
"items": {
"type": "string"
}
- },
- "instanceName": {
- "description": "The instance on which the operation is running.",
- "type": "string"
}
- },
- "id": "ComputeEngine",
- "description": "Describes a Compute Engine resource that is being managed by a running\npipeline.",
- "type": "object"
+ }
},
"ExternalId": {
+ "id": "ExternalId",
"type": "object",
"properties": {
- "sourceName": {
- "description": "The name of the source of this data.",
- "type": "string"
- },
"id": {
"description": "The id used by the source of this data.",
"type": "string"
+ },
+ "sourceName": {
+ "description": "The name of the source of this data.",
+ "type": "string"
}
- },
- "id": "ExternalId"
+ }
},
"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",
"properties": {
"name": {
"description": "The name of this reference, for example `22`.",
@@ -2572,32 +2729,19 @@
"description": "The URI from which the sequence was obtained. Typically specifies a FASTA\nformat file.",
"type": "string"
}
- },
- "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"
+ }
},
"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": {
- "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": [
- "",
- "",
- "",
- "",
- "",
- ""
- ]
+ "key": {
+ "description": "The top-level key.",
+ "type": "string"
+ },
+ "description": {
+ "description": "A textual description of this metadata.",
+ "type": "string"
},
"info": {
"additionalProperties": {
@@ -2609,35 +2753,52 @@
"description": "Remaining structured metadata key-value pairs. This must be of the form\nmap\u003cstring, string[]\u003e (string key mapping to a list of string values).",
"type": "object"
},
- "value": {
- "description": "The value field for simple metadata",
- "type": "string"
- },
- "id": {
- "description": "User-provided ID field, not enforced by this API.\nTwo or more pieces of structured metadata with identical\nid and key fields are considered equivalent.",
+ "type": {
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "enum": [
+ "TYPE_UNSPECIFIED",
+ "INTEGER",
+ "FLOAT",
+ "FLAG",
+ "CHARACTER",
+ "STRING"
+ ],
+ "description": "The type of data. Possible types include: Integer, Float,\nFlag, Character, and String.",
"type": "string"
},
"number": {
"description": "The number of values that can be included in a field described by this\nmetadata.",
"type": "string"
},
- "key": {
- "description": "The top-level key.",
+ "id": {
+ "description": "User-provided ID field, not enforced by this API.\nTwo or more pieces of structured metadata with identical\nid and key fields are considered equivalent.",
"type": "string"
},
- "description": {
- "description": "A textual description of this metadata.",
+ "value": {
+ "description": "The value field for simple metadata",
"type": "string"
}
},
- "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"
+ "id": "VariantSetMetadata"
},
"SearchVariantSetsRequest": {
"description": "The search variant sets request.",
"type": "object",
"properties": {
+ "datasetIds": {
+ "description": "Exactly one dataset ID must be provided here. Only variant sets which\nbelong to this dataset will be returned.",
+ "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"
@@ -2646,18 +2807,13 @@
"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",
- "items": {
- "type": "string"
- }
}
},
"id": "SearchVariantSetsRequest"
},
"SearchReferenceSetsRequest": {
+ "id": "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`.",
@@ -2686,20 +2842,18 @@
"type": "string"
}
}
- },
- "id": "SearchReferenceSetsRequest",
- "type": "object"
+ }
},
"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",
- "description": "Request message for `SetIamPolicy` method.",
- "type": "object"
+ "id": "SetIamPolicyRequest"
},
"MergeVariantsRequest": {
"type": "object",
@@ -2731,7 +2885,23 @@
"id": "MergeVariantsRequest"
},
"Read": {
+ "id": "Read",
+ "description": "A read alignment describes a linear alignment of a string of DNA to a\nreference sequence, in addition to metadata\nabout the fragment (the molecule of DNA sequenced) and the read (the bases\nwhich were read by the sequencer). A read is equivalent to a line in a SAM\nfile. A read belongs to exactly one read group and exactly one\nread group set.\n\nFor more genomics resource definitions, see [Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\n### Reverse-stranded reads\n\nMapped reads (reads having a non-null `alignment`) can be aligned to either\nthe forward or the reverse strand of their associated reference. Strandedness\nof a mapped read is encoded by `alignment.position.reverseStrand`.\n\nIf we consider the reference to be a forward-stranded coordinate space of\n`[0, reference.length)` with `0` as the left-most position and\n`reference.length` as the right-most position, reads are always aligned left\nto right. That is, `alignment.position.position` always refers to the\nleft-most reference coordinate and `alignment.cigar` describes the alignment\nof this read to the reference from left to right. All per-base fields such as\n`alignedSequence` and `alignedQuality` share this same left-to-right\norientation; this is true of reads which are aligned to either strand. For\nreverse-stranded reads, this means that `alignedSequence` is the reverse\ncomplement of the bases that were originally reported by the sequencing\nmachine.\n\n### Generating a reference-aligned sequence string\n\nWhen interacting with mapped reads, it's often useful to produce a string\nrepresenting the local alignment of the read to reference. The following\npseudocode demonstrates one way of doing this:\n\n out = \"\"\n offset = 0\n for c in read.alignment.cigar {\n switch c.operation {\n case \"ALIGNMENT_MATCH\", \"SEQUENCE_MATCH\", \"SEQUENCE_MISMATCH\":\n out += read.alignedSequence[offset:offset+c.operationLength]\n offset += c.operationLength\n break\n case \"CLIP_SOFT\", \"INSERT\":\n offset += c.operationLength\n break\n case \"PAD\":\n out += repeat(\"*\", c.operationLength)\n break\n case \"DELETE\":\n out += repeat(\"-\", c.operationLength)\n break\n case \"SKIP\":\n out += repeat(\" \", c.operationLength)\n break\n case \"CLIP_HARD\":\n break\n }\n }\n return out\n\n### Converting to SAM's CIGAR string\n\nThe following pseudocode generates a SAM CIGAR string from the\n`cigar` field. Note that this is a lossy conversion\n(`cigar.referenceSequence` is lost).\n\n cigarMap = {\n \"ALIGNMENT_MATCH\": \"M\",\n \"INSERT\": \"I\",\n \"DELETE\": \"D\",\n \"SKIP\": \"N\",\n \"CLIP_SOFT\": \"S\",\n \"CLIP_HARD\": \"H\",\n \"PAD\": \"P\",\n \"SEQUENCE_MATCH\": \"=\",\n \"SEQUENCE_MISMATCH\": \"X\",\n }\n cigarStr = \"\"\n for c in read.alignment.cigar {\n cigarStr += c.operationLength + cigarMap[c.operation]\n }\n return cigarStr",
+ "type": "object",
"properties": {
+ "properPlacement": {
+ "description": "The orientation and the distance between reads from the fragment are\nconsistent with the sequencing protocol (SAM flag 0x2).",
+ "type": "boolean"
+ },
+ "supplementaryAlignment": {
+ "description": "Whether this alignment is supplementary. Equivalent to SAM flag 0x800.\nSupplementary alignments are used in the representation of a chimeric\nalignment. In a chimeric alignment, a read is split into multiple\nlinear alignments that map to different reference contigs. The first\nlinear alignment in the read will be designated as the representative\nalignment; the remaining linear alignments will be designated as\nsupplementary alignments. These alignments may have different mapping\nquality scores. In each linear alignment in a chimeric alignment, the read\nwill be hard clipped. The `alignedSequence` and\n`alignedQuality` fields in the alignment record will only\nrepresent the bases for its respective linear alignment.",
+ "type": "boolean"
+ },
+ "fragmentLength": {
+ "description": "The observed length of the fragment, equivalent to TLEN in SAM.",
+ "format": "int32",
+ "type": "integer"
+ },
"failedVendorQualityChecks": {
"description": "Whether this read did not pass filters, such as platform or vendor quality\ncontrols (SAM flag 0x200).",
"type": "boolean"
@@ -2745,8 +2915,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).",
@@ -2786,10 +2956,6 @@
"description": "The ID of the read group this read belongs to. A read belongs to exactly\none read group. This is a server-generated ID which is distinct from SAM's\nRG tag (for that value, see\nReadGroup.name).",
"type": "string"
},
- "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"
- },
"info": {
"additionalProperties": {
"type": "array",
@@ -2800,40 +2966,28 @@
"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"
},
- "properPlacement": {
- "description": "The orientation and the distance between reads from the fragment are\nconsistent with the sequencing protocol (SAM flag 0x2).",
- "type": "boolean"
- },
- "supplementaryAlignment": {
- "description": "Whether this alignment is supplementary. Equivalent to SAM flag 0x800.\nSupplementary alignments are used in the representation of a chimeric\nalignment. In a chimeric alignment, a read is split into multiple\nlinear alignments that map to different reference contigs. The first\nlinear alignment in the read will be designated as the representative\nalignment; the remaining linear alignments will be designated as\nsupplementary alignments. These alignments may have different mapping\nquality scores. In each linear alignment in a chimeric alignment, the read\nwill be hard clipped. The `alignedSequence` and\n`alignedQuality` fields in the alignment record will only\nrepresent the bases for its respective linear alignment.",
- "type": "boolean"
- },
- "fragmentLength": {
- "description": "The observed length of the fragment, equivalent to TLEN in SAM.",
- "format": "int32",
- "type": "integer"
+ "nextMatePosition": {
+ "$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."
}
- },
- "id": "Read",
- "description": "A read alignment describes a linear alignment of a string of DNA to a\nreference sequence, in addition to metadata\nabout the fragment (the molecule of DNA sequenced) and the read (the bases\nwhich were read by the sequencer). A read is equivalent to a line in a SAM\nfile. A read belongs to exactly one read group and exactly one\nread group set.\n\nFor more genomics resource definitions, see [Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\n### Reverse-stranded reads\n\nMapped reads (reads having a non-null `alignment`) can be aligned to either\nthe forward or the reverse strand of their associated reference. Strandedness\nof a mapped read is encoded by `alignment.position.reverseStrand`.\n\nIf we consider the reference to be a forward-stranded coordinate space of\n`[0, reference.length)` with `0` as the left-most position and\n`reference.length` as the right-most position, reads are always aligned left\nto right. That is, `alignment.position.position` always refers to the\nleft-most reference coordinate and `alignment.cigar` describes the alignment\nof this read to the reference from left to right. All per-base fields such as\n`alignedSequence` and `alignedQuality` share this same left-to-right\norientation; this is true of reads which are aligned to either strand. For\nreverse-stranded reads, this means that `alignedSequence` is the reverse\ncomplement of the bases that were originally reported by the sequencing\nmachine.\n\n### Generating a reference-aligned sequence string\n\nWhen interacting with mapped reads, it's often useful to produce a string\nrepresenting the local alignment of the read to reference. The following\npseudocode demonstrates one way of doing this:\n\n out = \"\"\n offset = 0\n for c in read.alignment.cigar {\n switch c.operation {\n case \"ALIGNMENT_MATCH\", \"SEQUENCE_MATCH\", \"SEQUENCE_MISMATCH\":\n out += read.alignedSequence[offset:offset+c.operationLength]\n offset += c.operationLength\n break\n case \"CLIP_SOFT\", \"INSERT\":\n offset += c.operationLength\n break\n case \"PAD\":\n out += repeat(\"*\", c.operationLength)\n break\n case \"DELETE\":\n out += repeat(\"-\", c.operationLength)\n break\n case \"SKIP\":\n out += repeat(\" \", c.operationLength)\n break\n case \"CLIP_HARD\":\n break\n }\n }\n return out\n\n### Converting to SAM's CIGAR string\n\nThe following pseudocode generates a SAM CIGAR string from the\n`cigar` field. Note that this is a lossy conversion\n(`cigar.referenceSequence` is lost).\n\n cigarMap = {\n \"ALIGNMENT_MATCH\": \"M\",\n \"INSERT\": \"I\",\n \"DELETE\": \"D\",\n \"SKIP\": \"N\",\n \"CLIP_SOFT\": \"S\",\n \"CLIP_HARD\": \"H\",\n \"PAD\": \"P\",\n \"SEQUENCE_MATCH\": \"=\",\n \"SEQUENCE_MISMATCH\": \"X\",\n }\n cigarStr = \"\"\n for c in read.alignment.cigar {\n cigarStr += c.operationLength + cigarMap[c.operation]\n }\n return cigarStr",
- "type": "object"
+ }
},
"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",
- "type": "object"
+ "id": "BatchCreateAnnotationsRequest"
},
"CigarUnit": {
"description": "A single CIGAR operation.",
@@ -2845,6 +2999,7 @@
"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`.",
@@ -2868,8 +3023,7 @@
"PAD",
"SEQUENCE_MATCH",
"SEQUENCE_MISMATCH"
- ],
- "type": "string"
+ ]
},
"referenceSequence": {
"description": "`referenceSequence` is only used at mismatches\n(`SEQUENCE_MISMATCH`) and deletions (`DELETE`).\nFilling this field replaces SAM's MD tag. If the relevant information is\nnot available, this field is unset.",
@@ -2882,15 +3036,6 @@
"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": {
- "sourceUri": {
- "description": "The URI from which the references were obtained.",
- "type": "string"
- },
- "ncbiTaxonId": {
- "description": "ID from http://www.ncbi.nlm.nih.gov/taxonomy (for example, 9606 for human)\nindicating the species which this reference set is intended to model. Note\nthat contained references may specify a different `ncbiTaxonId`, as\nassemblies may contain reference sequences which do not belong to the\nmodeled species, for example EBV in a human reference genome.",
- "format": "int32",
- "type": "integer"
- },
"referenceIds": {
"description": "The IDs of the reference objects that are part of this set.\n`Reference.md5checksum` must be unique within this set.",
"type": "array",
@@ -2898,18 +3043,22 @@
"type": "string"
}
},
- "md5checksum": {
- "description": "Order-independent MD5 checksum which identifies this reference set. The\nchecksum is computed by sorting all lower case hexidecimal string\n`reference.md5checksum` (for all reference in this set) in\nascending lexicographic order, concatenating, and taking the MD5 of that\nvalue. The resulting value is represented in lower case hexadecimal format.",
- "type": "string"
- },
"assemblyId": {
"description": "Public id of this reference set, such as `GRCh37`.",
"type": "string"
},
+ "md5checksum": {
+ "description": "Order-independent MD5 checksum which identifies this reference set. The\nchecksum is computed by sorting all lower case hexidecimal string\n`reference.md5checksum` (for all reference in this set) in\nascending lexicographic order, concatenating, and taking the MD5 of that\nvalue. The resulting value is represented in lower case hexadecimal format.",
+ "type": "string"
+ },
"id": {
"description": "The server-generated reference set ID, unique across all reference sets.",
"type": "string"
},
+ "description": {
+ "description": "Free text description of this reference set.",
+ "type": "string"
+ },
"sourceAccessions": {
"description": "All known corresponding accession IDs in INSDC (GenBank/ENA/DDBJ) ideally\nwith a version number, for example `NC_000001.11`.",
"type": "array",
@@ -2917,14 +3066,21 @@
"type": "string"
}
},
- "description": {
- "description": "Free text description of this reference set.",
+ "ncbiTaxonId": {
+ "description": "ID from http://www.ncbi.nlm.nih.gov/taxonomy (for example, 9606 for human)\nindicating the species which this reference set is intended to model. Note\nthat contained references may specify a different `ncbiTaxonId`, as\nassemblies may contain reference sequences which do not belong to the\nmodeled species, for example EBV in a human reference genome.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "sourceUri": {
+ "description": "The URI from which the references were obtained.",
"type": "string"
}
},
"id": "ReferenceSet"
},
"Transcript": {
+ "description": "A transcript represents the assertion that a particular region of the\nreference genome may be transcribed as RNA.",
+ "type": "object",
"properties": {
"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.",
@@ -2942,9 +3098,7 @@
"type": "string"
}
},
- "id": "Transcript",
- "description": "A transcript represents the assertion that a particular region of the\nreference genome may be transcribed as RNA.",
- "type": "object"
+ "id": "Transcript"
},
"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'.",
@@ -2967,6 +3121,13 @@
"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",
@@ -2975,24 +3136,17 @@
"TRANSCRIPT"
],
"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."
- ]
+ "type": "string"
},
"info": {
+ "description": "A map of additional read alignment information. This must be of the form\nmap\u003cstring, string[]\u003e (string key mapping to a list of string values).",
+ "type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "any"
}
- },
- "description": "A map of additional read alignment information. This must be of the form\nmap\u003cstring, string[]\u003e (string key mapping to a list of string values).",
- "type": "object"
+ }
},
"id": {
"description": "The server-generated annotation set ID, unique across all annotation sets.",
@@ -3002,15 +3156,9 @@
"id": "AnnotationSet"
},
"Experiment": {
+ "id": "Experiment",
+ "type": "object",
"properties": {
- "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"
- },
- "instrumentModel": {
- "description": "The instrument model used as part of this experiment. This maps to\nsequencing technology in the SAM spec.",
- "type": "string"
- },
"sequencingCenter": {
"description": "The sequencing center used as part of this experiment.",
"type": "string"
@@ -3018,12 +3166,21 @@
"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"
+ },
+ "instrumentModel": {
+ "description": "The instrument model used as part of this experiment. This maps to\nsequencing technology in the SAM spec.",
+ "type": "string"
}
- },
- "id": "Experiment",
- "type": "object"
+ }
},
"ListDatasetsResponse": {
+ "id": "ListDatasetsResponse",
+ "description": "The dataset list response.",
+ "type": "object",
"properties": {
"datasets": {
"description": "The list of matching Datasets.",
@@ -3036,12 +3193,12 @@
"description": "The continuation token, which is used to page through large result sets.\nProvide this value in a subsequent request to return the next page of\nresults. This field will be empty if there aren't any additional results.",
"type": "string"
}
- },
- "id": "ListDatasetsResponse",
- "description": "The dataset list response.",
- "type": "object"
+ }
},
"TestIamPermissionsRequest": {
+ "id": "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`",
@@ -3050,12 +3207,12 @@
"type": "string"
}
}
- },
- "id": "TestIamPermissionsRequest",
- "description": "Request message for `TestIamPermissions` method.",
- "type": "object"
+ }
},
"ExportReadGroupSetRequest": {
+ "id": "ExportReadGroupSetRequest",
+ "description": "The read group set export request.",
+ "type": "object",
"properties": {
"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.",
@@ -3072,19 +3229,11 @@
"description": "Required. The Google Cloud project ID that owns this\nexport. The caller must have WRITE access to this project.",
"type": "string"
}
- },
- "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",
@@ -3094,11 +3243,18 @@
"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"
},
"CallSet": {
+ "description": "A call set is a collection of variant calls, typically for one sample. It\nbelongs to a variant set.\n\nFor more genomics resource definitions, see [Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)",
+ "type": "object",
"properties": {
"created": {
"description": "The date this call set was created in milliseconds from the epoch.",
@@ -3114,14 +3270,14 @@
"type": "string"
},
"info": {
+ "description": "A map of additional call set 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 call set information. This must be of the form\nmap\u003cstring, string[]\u003e (string key mapping to a list of string values).",
- "type": "object"
+ }
},
"variantSetIds": {
"description": "The IDs of the variant sets this call set belongs to. This field must\nhave exactly length one, as a call set belongs to a single variant set.\nThis field is repeated for compatibility with the\n[GA4GH 0.5.1\nAPI](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/variants.avdl#L76).",
@@ -3135,30 +3291,46 @@
"type": "string"
}
},
- "id": "CallSet",
- "description": "A call set is a collection of variant calls, typically for one sample. It\nbelongs to a variant set.\n\nFor more genomics resource definitions, see [Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)",
- "type": "object"
+ "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.",
- "type": "string"
- },
"annotationSets": {
"description": "The matching annotation sets.",
"type": "array",
"items": {
"$ref": "AnnotationSet"
}
+ },
+ "nextPageToken": {
+ "description": "The continuation token, which is used to page through large result sets.\nProvide this value in a subsequent request to return the next page of\nresults. This field will be empty if there aren't any additional results.",
+ "type": "string"
}
},
"id": "SearchAnnotationSetsResponse"
},
"ImportVariantsRequest": {
+ "description": "The variant data import request.",
+ "type": "object",
"properties": {
+ "format": {
+ "description": "The format of the variant data being imported. If unspecified, defaults to\nto `VCF`.",
+ "type": "string",
+ "enumDescriptions": [
+ "",
+ "VCF (Variant Call Format). The VCF files may be gzip compressed. gVCF is\nalso supported. Disclaimer: gzip VCF imports are currently much slower\nthan equivalent uncompressed VCF imports. For this reason, uncompressed\nVCF is currently recommended for imports with more than 1GB combined\nuncompressed size, or for time sensitive imports.",
+ "Complete Genomics masterVarBeta format. The masterVarBeta files may\nbe bzip2 compressed."
+ ],
+ "enum": [
+ "FORMAT_UNSPECIFIED",
+ "FORMAT_VCF",
+ "FORMAT_COMPLETE_GENOMICS"
+ ]
+ },
"infoMergeConfig": {
+ "description": "A mapping between info field keys and the InfoMergeOperations to\nbe performed on them. This is plumbed down to the MergeVariantRequests\ngenerated by the resulting import job.",
+ "type": "object",
"additionalProperties": {
"enum": [
"INFO_MERGE_OPERATION_UNSPECIFIED",
@@ -3166,9 +3338,7 @@
"MOVE_TO_CALLS"
],
"type": "string"
- },
- "description": "A mapping between info field keys and the InfoMergeOperations to\nbe performed on them. This is plumbed down to the MergeVariantRequests\ngenerated by the resulting import job.",
- "type": "object"
+ }
},
"variantSetId": {
"description": "Required. The variant set to which variant data should be imported.",
@@ -3184,64 +3354,14 @@
"normalizeReferenceNames": {
"description": "Convert reference names to the canonical representation.\nhg19 haploytypes (those reference names containing \"_hap\")\nare not modified in any way.\nAll other reference names are modified according to the following rules:\nThe reference name is capitalized.\nThe \"chr\" prefix is dropped for all autosomes and sex chromsomes.\nFor example \"chr17\" becomes \"17\" and \"chrX\" becomes \"X\".\nAll mitochondrial chromosomes (\"chrM\", \"chrMT\", etc) become \"MT\".",
"type": "boolean"
- },
- "format": {
- "enum": [
- "FORMAT_UNSPECIFIED",
- "FORMAT_VCF",
- "FORMAT_COMPLETE_GENOMICS"
- ],
- "description": "The format of the variant data being imported. If unspecified, defaults to\nto `VCF`.",
- "type": "string",
- "enumDescriptions": [
- "",
- "VCF (Variant Call Format). The VCF files may be gzip compressed. gVCF is\nalso supported. Disclaimer: gzip VCF imports are currently much slower\nthan equivalent uncompressed VCF imports. For this reason, uncompressed\nVCF is currently recommended for imports with more than 1GB combined\nuncompressed size, or for time sensitive imports.",
- "Complete Genomics masterVarBeta format. The masterVarBeta files may\nbe bzip2 compressed."
- ]
}
},
- "id": "ImportVariantsRequest",
- "description": "The variant data import request.",
- "type": "object"
+ "id": "ImportVariantsRequest"
},
"VariantAnnotation": {
+ "id": "VariantAnnotation",
+ "type": "object",
"properties": {
- "clinicalSignificance": {
- "enum": [
- "CLINICAL_SIGNIFICANCE_UNSPECIFIED",
- "CLINICAL_SIGNIFICANCE_OTHER",
- "UNCERTAIN",
- "BENIGN",
- "LIKELY_BENIGN",
- "LIKELY_PATHOGENIC",
- "PATHOGENIC",
- "DRUG_RESPONSE",
- "HISTOCOMPATIBILITY",
- "CONFERS_SENSITIVITY",
- "RISK_FACTOR",
- "ASSOCIATION",
- "PROTECTIVE",
- "MULTIPLE_REPORTED"
- ],
- "description": "Describes the clinical significance of a variant.\nIt is adapted from the ClinVar controlled vocabulary for clinical\nsignificance described at:\nhttp://www.ncbi.nlm.nih.gov/clinvar/docs/clinsig/",
- "type": "string",
- "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.",
"type": "array",
@@ -3283,6 +3403,16 @@
}
},
"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",
@@ -3294,17 +3424,7 @@
"CNV"
],
"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."
- ]
+ "type": "string"
},
"alternateBases": {
"description": "The alternate allele for this variant. If multiple alternate alleles\nexist at this location, create a separate variant for each one, as they\nmay represent distinct conditions.",
@@ -3313,17 +3433,48 @@
"geneId": {
"description": "Google annotation ID of the gene affected by this variant. This should\nbe provided when the variant is created.",
"type": "string"
+ },
+ "clinicalSignificance": {
+ "enumDescriptions": [
+ "",
+ "`OTHER` should be used when no other clinical significance\nvalue will suffice.",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ "`MULTIPLE_REPORTED` should be used when multiple clinical\nsignficances are reported for a variant. The original clinical\nsignificance values may be provided in the `info` field."
+ ],
+ "enum": [
+ "CLINICAL_SIGNIFICANCE_UNSPECIFIED",
+ "CLINICAL_SIGNIFICANCE_OTHER",
+ "UNCERTAIN",
+ "BENIGN",
+ "LIKELY_BENIGN",
+ "LIKELY_PATHOGENIC",
+ "PATHOGENIC",
+ "DRUG_RESPONSE",
+ "HISTOCOMPATIBILITY",
+ "CONFERS_SENSITIVITY",
+ "RISK_FACTOR",
+ "ASSOCIATION",
+ "PROTECTIVE",
+ "MULTIPLE_REPORTED"
+ ],
+ "description": "Describes the clinical significance of a variant.\nIt is adapted from the ClinVar controlled vocabulary for clinical\nsignificance described at:\nhttp://www.ncbi.nlm.nih.gov/clinvar/docs/clinsig/",
+ "type": "string"
}
- },
- "id": "VariantAnnotation",
- "type": "object"
+ }
},
"ListCoverageBucketsResponse": {
+ "type": "object",
"properties": {
- "nextPageToken": {
- "description": "The continuation token, which is used to page through large result sets.\nProvide this value in a subsequent request to return the next page of\nresults. This field will be empty if there aren't any additional results.",
- "type": "string"
- },
"bucketWidth": {
"description": "The length of each coverage bucket in base pairs. Note that buckets at the\nend of a reference sequence may be shorter. This value is omitted if the\nbucket width is infinity (the default behaviour, with no range or\n`targetBucketWidth`).",
"format": "int64",
@@ -3335,23 +3486,28 @@
"items": {
"$ref": "CoverageBucket"
}
+ },
+ "nextPageToken": {
+ "description": "The continuation token, which is used to page through large result sets.\nProvide this value in a subsequent request to return the next page of\nresults. This field will be empty if there aren't any additional results.",
+ "type": "string"
}
},
- "id": "ListCoverageBucketsResponse",
- "type": "object"
+ "id": "ListCoverageBucketsResponse"
},
"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": {
@@ -3374,12 +3530,19 @@
"type": "string"
}
},
- "id": "ExportVariantSetRequest",
- "description": "The variant data export request.",
- "type": "object"
+ "id": "ExportVariantSetRequest"
},
"SearchAnnotationsRequest": {
+ "id": "SearchAnnotationsRequest",
+ "type": "object",
"properties": {
+ "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"
@@ -3406,27 +3569,14 @@
"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",
- "type": "object"
+ }
},
"OperationEvent": {
+ "id": "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",
@@ -3435,11 +3585,16 @@
"description": {
"description": "Required description of event.",
"type": "string"
+ },
+ "endTime": {
+ "description": "Optional time of when event finished. An event can have a start time and no\nfinish time. If an event has a finish time, there must be a start time.",
+ "format": "google-datetime",
+ "type": "string"
}
- },
- "id": "OperationEvent"
+ }
},
"CodingSequence": {
+ "id": "CodingSequence",
"type": "object",
"properties": {
"start": {
@@ -3452,10 +3607,10 @@
"format": "int64",
"type": "string"
}
- },
- "id": "CodingSequence"
+ }
},
"TestIamPermissionsResponse": {
+ "id": "TestIamPermissionsResponse",
"description": "Response message for `TestIamPermissions` method.",
"type": "object",
"properties": {
@@ -3466,16 +3621,16 @@
"type": "string"
}
}
- },
- "id": "TestIamPermissionsResponse"
+ }
},
"GetIamPolicyRequest": {
- "properties": {},
- "id": "GetIamPolicyRequest",
"description": "Request message for `GetIamPolicy` method.",
- "type": "object"
+ "type": "object",
+ "properties": {},
+ "id": "GetIamPolicyRequest"
},
"SearchReferencesResponse": {
+ "id": "SearchReferencesResponse",
"type": "object",
"properties": {
"references": {
@@ -3489,19 +3644,12 @@
"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": "SearchReferencesResponse"
+ }
},
"SearchAnnotationSetsRequest": {
+ "id": "SearchAnnotationSetsRequest",
+ "type": "object",
"properties": {
- "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"
- },
"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"
@@ -3519,13 +3667,6 @@
}
},
"types": {
- "enumDescriptions": [
- "",
- "A `GENERIC` annotation type should be used when no other annotation\ntype will suffice. This represents an untyped annotation of the reference\ngenome.",
- "A `VARIANT` annotation type.",
- "A `GENE` annotation type represents the existence of a gene at the\nassociated reference coordinates. The start coordinate is typically the\ngene's transcription start site and the end is typically the end of the\ngene's last exon.",
- "A `TRANSCRIPT` annotation type represents the assertion that a\nparticular region of the reference genome may be transcribed as RNA."
- ],
"description": "If specified, only annotation sets that have any of these types are\nreturned.",
"type": "array",
"items": {
@@ -3537,31 +3678,47 @@
"TRANSCRIPT"
],
"type": "string"
- }
+ },
+ "enumDescriptions": [
+ "",
+ "A `GENERIC` annotation type should be used when no other annotation\ntype will suffice. This represents an untyped annotation of the reference\ngenome.",
+ "A `VARIANT` annotation type.",
+ "A `GENE` annotation type represents the existence of a gene at the\nassociated reference coordinates. The start coordinate is typically the\ngene's transcription start site and the end is typically the end of the\ngene's last exon.",
+ "A `TRANSCRIPT` annotation type represents the assertion that a\nparticular region of the reference genome may be transcribed as RNA."
+ ]
+ },
+ "name": {
+ "description": "Only return annotations sets for which a substring of the name matches this\nstring (case insensitive).",
+ "type": "string"
+ },
+ "referenceSetId": {
+ "description": "If specified, only annotation sets associated with the given reference set\nare returned.",
+ "type": "string"
}
- },
- "id": "SearchAnnotationSetsRequest",
- "type": "object"
+ }
},
"SearchReadGroupSetsResponse": {
+ "id": "SearchReadGroupSetsResponse",
"description": "The read group 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"
- },
"readGroupSets": {
"description": "The list of matching read group sets.",
"type": "array",
"items": {
"$ref": "ReadGroupSet"
}
+ },
+ "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": "SearchReadGroupSetsResponse"
+ }
},
"LinearAlignment": {
+ "id": "LinearAlignment",
+ "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.",
@@ -3579,12 +3736,11 @@
"$ref": "CigarUnit"
}
}
- },
- "id": "LinearAlignment",
- "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"
+ }
},
"SearchReferencesRequest": {
+ "id": "SearchReferencesRequest",
+ "type": "object",
"properties": {
"md5checksums": {
"description": "If present, return references for which the\nmd5checksum matches exactly.",
@@ -3613,184 +3769,22 @@
"format": "int32",
"type": "integer"
}
- },
- "id": "SearchReferencesRequest",
- "type": "object"
- },
- "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",
- "type": "string"
- },
- "name": {
- "description": "The dataset name.",
- "type": "string"
- },
- "projectId": {
- "description": "The Google Cloud project ID that this dataset belongs to.",
- "type": "string"
- }
- },
- "id": "Dataset"
- },
- "ImportVariantsResponse": {
- "description": "The variant data import response.",
- "type": "object",
- "properties": {
- "callSetIds": {
- "description": "IDs of the call sets created during the import.",
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "id": "ImportVariantsResponse"
- },
- "ReadGroup": {
- "description": "A read group is all the data that's processed the same way by the sequencer.",
- "type": "object",
- "properties": {
- "datasetId": {
- "description": "The dataset to which this read group belongs.",
- "type": "string"
- },
- "experiment": {
- "description": "The experiment used to generate this read group.",
- "$ref": "Experiment"
- },
- "name": {
- "description": "The read group name. This corresponds to the @RG ID field in the SAM spec.",
- "type": "string"
- },
- "referenceSetId": {
- "description": "The reference set the reads in this read group are aligned to.",
- "type": "string"
- },
- "info": {
- "additionalProperties": {
- "type": "array",
- "items": {
- "type": "any"
- }
- },
- "description": "A map of additional read group information. This must be of the form\nmap\u003cstring, string[]\u003e (string key mapping to a list of string values).",
- "type": "object"
- },
- "id": {
- "description": "The server-generated read group ID, unique for all read groups.\nNote: This is different than the @RG ID field in the SAM spec. For that\nvalue, see name.",
- "type": "string"
- },
- "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"
- },
- "sampleId": {
- "description": "A client-supplied sample identifier for the reads in this read group.",
- "type": "string"
- }
- },
- "id": "ReadGroup"
- },
- "ReadGroupSet": {
- "properties": {
- "datasetId": {
- "description": "The dataset to which this read group set belongs.",
- "type": "string"
- },
- "readGroups": {
- "description": "The read groups in this set. There are typically 1-10 read groups in a read\ngroup set.",
- "type": "array",
- "items": {
- "$ref": "ReadGroup"
- }
- },
- "filename": {
- "description": "The filename of the original source file for this read group set, if any.",
- "type": "string"
- },
- "name": {
- "description": "The read group set name. By default this will be initialized to the sample\nname of the sequenced data contained in this set.",
- "type": "string"
- },
- "referenceSetId": {
- "description": "The reference set to which the reads in this read group set are aligned.",
- "type": "string"
- },
- "info": {
- "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",
- "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"
- }
- }
- },
- "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"
+ }
}
},
- "protocol": "rest",
"icons": {
"x16": "http://www.google.com/images/icons/product/search-16.gif",
"x32": "http://www.google.com/images/icons/product/search-32.gif"
},
+ "protocol": "rest",
"version": "v1",
"baseUrl": "https://genomics.googleapis.com/",
"auth": {
"oauth2": {
"scopes": {
+ "https://www.googleapis.com/auth/genomics": {
+ "description": "View and manage Genomics data"
+ },
"https://www.googleapis.com/auth/bigquery": {
"description": "View and manage your data in Google BigQuery"
},
@@ -3802,9 +3796,6 @@
},
"https://www.googleapis.com/auth/genomics.readonly": {
"description": "View Genomics data"
- },
- "https://www.googleapis.com/auth/genomics": {
- "description": "View and manage Genomics data"
}
}
}
@@ -3813,5 +3804,14 @@
"description": "Upload, process, query, and search Genomics data in the cloud.",
"servicePath": "",
"rootUrl": "https://genomics.googleapis.com/",
- "basePath": ""
+ "basePath": "",
+ "ownerDomain": "google.com",
+ "name": "genomics",
+ "batchPath": "batch",
+ "revision": "20171221",
+ "documentationLink": "https://cloud.google.com/genomics",
+ "id": "genomics:v1",
+ "title": "Genomics API",
+ "ownerName": "Google",
+ "discoveryVersion": "v1"
}
diff --git a/genomics/v1alpha2/genomics-api.json b/genomics/v1alpha2/genomics-api.json
index 51bd22e..828177b 100644
--- a/genomics/v1alpha2/genomics-api.json
+++ b/genomics/v1alpha2/genomics-api.json
@@ -1,119 +1,22 @@
{
+ "basePath": "",
+ "ownerDomain": "google.com",
+ "name": "genomics",
+ "batchPath": "batch",
+ "revision": "20171221",
+ "id": "genomics:v1alpha2",
+ "documentationLink": "https://cloud.google.com/genomics",
+ "title": "Genomics API",
"discoveryVersion": "v1",
"ownerName": "Google",
"resources": {
"pipelines": {
"methods": {
- "getControllerConfig": {
- "response": {
- "$ref": "ControllerConfig"
- },
- "parameterOrder": [],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics"
- ],
- "parameters": {
- "operationId": {
- "description": "The operation to retrieve controller configuration for.",
- "type": "string",
- "location": "query"
- },
- "validationToken": {
- "location": "query",
- "format": "uint64",
- "type": "string"
- }
- },
- "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": {
- "path": "v1alpha2/pipelines/{pipelineId}",
- "id": "genomics.pipelines.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",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics"
- ],
- "flatPath": "v1alpha2/pipelines/{pipelineId}"
- },
- "list": {
- "description": "Lists pipelines.\n\nCaller must have READ permission to the project.",
- "response": {
- "$ref": "ListPipelinesResponse"
- },
- "parameterOrder": [],
- "httpMethod": "GET",
- "parameters": {
- "namePrefix": {
- "location": "query",
- "description": "Pipelines with names that match this prefix should be\nreturned. If unspecified, all pipelines in the project, up to\n`pageSize`, will be returned.",
- "type": "string"
- },
- "pageToken": {
- "description": "Token to use to indicate where to start getting results.\nIf unspecified, returns the first page of results.",
- "type": "string",
- "location": "query"
- },
- "pageSize": {
- "description": "Number of pipelines to return at once. Defaults to 256, and max\nis 2048.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- },
- "projectId": {
- "location": "query",
- "description": "Required. The name of the project to search for pipelines. Caller\nmust have READ access to this project.",
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics"
- ],
- "flatPath": "v1alpha2/pipelines",
- "path": "v1alpha2/pipelines",
- "id": "genomics.pipelines.list"
- },
- "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": {
+ "description": "Runs a pipeline. If `pipelineId` is specified in the request, then\nrun a saved pipeline. If `ephemeralPipeline` is specified, then run\nthat pipeline once without saving a copy.\n\nThe caller must have READ permission to the project where the pipeline\nis stored and WRITE permission to the project where the pipeline will be\nrun, as VMs will be created and storage will be used.\n\nIf a pipeline operation is still running after 6 days, it will be canceled.",
+ "request": {
+ "$ref": "RunPipelineRequest"
+ },
"response": {
"$ref": "Operation"
},
@@ -127,13 +30,13 @@
"parameters": {},
"flatPath": "v1alpha2/pipelines:run",
"path": "v1alpha2/pipelines:run",
- "id": "genomics.pipelines.run",
- "description": "Runs a pipeline. If `pipelineId` is specified in the request, then\nrun a saved pipeline. If `ephemeralPipeline` is specified, then run\nthat pipeline once without saving a copy.\n\nThe caller must have READ permission to the project where the pipeline\nis stored and WRITE permission to the project where the pipeline will be\nrun, as VMs will be created and storage will be used.\n\nIf a pipeline operation is still running after 6 days, it will be canceled.",
- "request": {
- "$ref": "RunPipelineRequest"
- }
+ "id": "genomics.pipelines.run"
},
"get": {
+ "flatPath": "v1alpha2/pipelines/{pipelineId}",
+ "id": "genomics.pipelines.get",
+ "path": "v1alpha2/pipelines/{pipelineId}",
+ "description": "Retrieves a pipeline based on ID.\n\nCaller must have READ permission to the project.",
"httpMethod": "GET",
"response": {
"$ref": "Pipeline"
@@ -152,42 +55,145 @@
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/genomics"
- ],
- "flatPath": "v1alpha2/pipelines/{pipelineId}",
- "id": "genomics.pipelines.get",
- "path": "v1alpha2/pipelines/{pipelineId}",
- "description": "Retrieves a pipeline based on ID.\n\nCaller must have READ permission to the project."
+ ]
},
"setOperationStatus": {
+ "httpMethod": "PUT",
+ "parameterOrder": [],
"response": {
"$ref": "Empty"
},
- "parameterOrder": [],
- "httpMethod": "PUT",
"parameters": {},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/genomics"
],
"flatPath": "v1alpha2/pipelines:setOperationStatus",
- "path": "v1alpha2/pipelines:setOperationStatus",
"id": "genomics.pipelines.setOperationStatus",
+ "path": "v1alpha2/pipelines: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."
+ },
+ "getControllerConfig": {
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "ControllerConfig"
+ },
+ "parameterOrder": [],
+ "parameters": {
+ "operationId": {
+ "location": "query",
+ "description": "The operation to retrieve controller configuration for.",
+ "type": "string"
+ },
+ "validationToken": {
+ "location": "query",
+ "format": "uint64",
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics"
+ ],
+ "flatPath": "v1alpha2/pipelines:getControllerConfig",
+ "id": "genomics.pipelines.getControllerConfig",
+ "path": "v1alpha2/pipelines:getControllerConfig",
+ "description": "Gets controller configuration information. Should only be called\nby VMs created by the Pipelines Service and not by end users."
+ },
+ "delete": {
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "pipelineId"
+ ],
+ "httpMethod": "DELETE",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics"
+ ],
+ "parameters": {
+ "pipelineId": {
+ "description": "Caller must have WRITE access to the project in which this pipeline\nis defined.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1alpha2/pipelines/{pipelineId}",
+ "path": "v1alpha2/pipelines/{pipelineId}",
+ "id": "genomics.pipelines.delete",
+ "description": "Deletes a pipeline based on ID.\n\nCaller must have WRITE permission to the project."
+ },
+ "list": {
+ "response": {
+ "$ref": "ListPipelinesResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics"
+ ],
+ "parameters": {
+ "namePrefix": {
+ "location": "query",
+ "description": "Pipelines with names that match this prefix should be\nreturned. If unspecified, all pipelines in the project, up to\n`pageSize`, will be returned.",
+ "type": "string"
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "Token to use to indicate where to start getting results.\nIf unspecified, returns the first page of results.",
+ "type": "string"
+ },
+ "pageSize": {
+ "location": "query",
+ "description": "Number of pipelines to return at once. Defaults to 256, and max\nis 2048.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "projectId": {
+ "location": "query",
+ "description": "Required. The name of the project to search for pipelines. Caller\nmust have READ access to this project.",
+ "type": "string"
+ }
+ },
+ "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"
}
}
},
"operations": {
"methods": {
"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"
},
+ "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.",
"response": {
"$ref": "Empty"
},
@@ -195,23 +201,24 @@
"name"
],
"httpMethod": "POST",
+ "parameters": {
+ "name": {
+ "location": "path",
+ "description": "The name of the operation resource to be cancelled.",
+ "required": true,
+ "type": "string",
+ "pattern": "^operations/.+$"
+ }
+ },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"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": "v1alpha2/operations/{operationsId}:cancel"
+ "flatPath": "v1alpha2/operations/{operationsId}:cancel",
+ "path": "v1alpha2/{+name}:cancel",
+ "id": "genomics.operations.cancel"
},
"list": {
- "description": "Lists operations that match the specified filter in the request.",
"response": {
"$ref": "ListOperationsResponse"
},
@@ -219,23 +226,7 @@
"name"
],
"httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics"
- ],
"parameters": {
- "name": {
- "pattern": "^operations$",
- "location": "path",
- "description": "The name of the operation's parent resource.",
- "required": true,
- "type": "string"
- },
- "pageToken": {
- "description": "The standard list page token.",
- "type": "string",
- "location": "query"
- },
"pageSize": {
"location": "query",
"description": "The maximum number of results to return. If unspecified, defaults to\n256. The maximum value is 2048.",
@@ -246,20 +237,42 @@
"description": "A string for filtering Operations.\nThe following filter fields are supported:\n\n* projectId: Required. Corresponds to\n OperationMetadata.projectId.\n* createTime: The time this job was created, in seconds from the\n [epoch](http://en.wikipedia.org/wiki/Unix_time). Can use `\u003e=` and/or `\u003c=`\n operators.\n* status: Can be `RUNNING`, `SUCCESS`, `FAILURE`, or `CANCELED`. Only\n one status may be specified.\n* labels.key where key is a label key.\n\nExamples:\n\n* `projectId = my-project AND createTime \u003e= 1432140000`\n* `projectId = my-project AND createTime \u003e= 1432140000 AND createTime \u003c= 1432150000 AND status = RUNNING`\n* `projectId = my-project AND labels.color = *`\n* `projectId = my-project AND labels.color = red`",
"type": "string",
"location": "query"
+ },
+ "name": {
+ "location": "path",
+ "description": "The name of the operation's parent resource.",
+ "required": true,
+ "type": "string",
+ "pattern": "^operations$"
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "The standard list page token.",
+ "type": "string"
}
},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics"
+ ],
"flatPath": "v1alpha2/operations",
"path": "v1alpha2/{+name}",
- "id": "genomics.operations.list"
+ "id": "genomics.operations.list",
+ "description": "Lists operations that match the specified filter in the request."
},
"get": {
- "httpMethod": "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": {
"description": "The name of the operation resource.",
@@ -269,14 +282,9 @@
"location": "path"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics"
- ],
"flatPath": "v1alpha2/operations/{operationsId}",
- "id": "genomics.operations.get",
"path": "v1alpha2/{+name}",
- "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": "genomics.operations.get"
}
}
}
@@ -303,6 +311,11 @@
"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",
@@ -316,17 +329,7 @@
"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",
@@ -335,7 +338,12 @@
],
"location": "query",
"description": "Data format for response.",
- "default": "json"
+ "default": "json",
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ]
},
"key": {
"location": "query",
@@ -358,29 +366,69 @@
"type": "boolean",
"default": "true"
},
- "oauth_token": {
- "description": "OAuth 2.0 token for the current user.",
- "type": "string",
- "location": "query"
- },
"bearer_token": {
"location": "query",
"description": "OAuth bearer token.",
"type": "string"
+ },
+ "oauth_token": {
+ "location": "query",
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string"
}
},
"schemas": {
+ "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": {
+ "pipelineId": {
+ "description": "The already created pipeline to run.",
+ "type": "string"
+ },
+ "ephemeralPipeline": {
+ "$ref": "Pipeline",
+ "description": "A new pipeline object to run once and then delete."
+ },
+ "pipelineArgs": {
+ "$ref": "RunPipelineArgs",
+ "description": "The arguments to use when running this pipeline."
+ }
+ },
+ "id": "RunPipelineRequest"
+ },
+ "CancelOperationRequest": {
+ "description": "The request message for Operations.CancelOperation.",
+ "type": "object",
+ "properties": {},
+ "id": "CancelOperationRequest"
+ },
+ "RuntimeMetadata": {
+ "description": "Runtime metadata that will be populated in the\nruntimeMetadata\nfield of the Operation associated with a RunPipeline execution.",
+ "type": "object",
+ "properties": {
+ "computeEngine": {
+ "description": "Execution information specific to Google Compute Engine.",
+ "$ref": "ComputeEngine"
+ }
+ },
+ "id": "RuntimeMetadata"
+ },
"Operation": {
"description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
"type": "object",
"properties": {
+ "done": {
+ "description": "If the value is `false`, it means the operation is still in progress.\nIf `true`, the operation is completed, and either `error` or `response` is\navailable.",
+ "type": "boolean"
+ },
"response": {
+ "description": "If importing ReadGroupSets, an ImportReadGroupSetsResponse is returned. If importing Variants, an ImportVariantsResponse is returned. For pipelines and exports, an Empty response is returned.",
+ "type": "object",
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
- },
- "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`",
@@ -397,25 +445,10 @@
},
"description": "An OperationMetadata object. This will always be returned with the Operation.",
"type": "object"
- },
- "done": {
- "description": "If the value is `false`, it means the operation is still in progress.\nIf `true`, the operation is completed, and either `error` or `response` is\navailable.",
- "type": "boolean"
}
},
"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": {
- "$ref": "ComputeEngine",
- "description": "Execution information specific to Google Compute Engine."
- }
- },
- "id": "RuntimeMetadata"
- },
"ImportReadGroupSetsResponse": {
"description": "The read group set import response.",
"type": "object",
@@ -431,11 +464,9 @@
"id": "ImportReadGroupSetsResponse"
},
"Status": {
+ "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
+ "type": "object",
"properties": {
- "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",
@@ -451,11 +482,13 @@
"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"
},
"ServiceAccount": {
"description": "A Google Cloud Service Account.",
@@ -476,14 +509,9 @@
"id": "ServiceAccount"
},
"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": {
- "outputParameters": {
- "description": "Output parameters of the pipeline.",
- "type": "array",
- "items": {
- "$ref": "PipelineParameter"
- }
- },
"docker": {
"description": "Specifies the docker run information.",
"$ref": "DockerExecutor"
@@ -514,44 +542,21 @@
"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"
- }
- },
- "id": "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"
- },
- "PipelineResources": {
- "properties": {
- "minimumRamGb": {
- "description": "The minimum amount of RAM to use. Defaults to 3.75 (GB)",
- "format": "double",
- "type": "number"
},
- "preemptible": {
- "description": "Whether to use preemptible VMs. Defaults to `false`. In order to use this,\nmust be true for both create time and run time. Cannot be true at run time\nif false at create time.",
- "type": "boolean"
- },
- "zones": {
- "description": "List of Google Compute Engine availability zones to which resource\ncreation will restricted. If empty, any zone may be chosen.",
+ "outputParameters": {
+ "description": "Output parameters of the pipeline.",
"type": "array",
"items": {
- "type": "string"
+ "$ref": "PipelineParameter"
}
- },
- "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": "Pipeline"
+ },
+ "PipelineResources": {
+ "description": "The system resources for the pipeline run.",
+ "type": "object",
+ "properties": {
"noAddress": {
"description": "Whether to assign an external IP to the instance. This is an experimental\nfeature that may go away. Defaults to false.\nCorresponds to `--no_address` flag for [gcloud compute instances create]\n(https://cloud.google.com/sdk/gcloud/reference/compute/instances/create).\nIn order to use this, must be true for both create time and run time.\nCannot be true at run time if false at create time. If you need to ssh into\na private IP VM for debugging, you can ssh to a public VM and then ssh into\nthe private VM's Internal IP. If noAddress is set, this pipeline run may\nonly load docker images from Google Container Registry and not Docker Hub.\nBefore using this, you must\n[configure access to Google services from internal IPs](https://cloud.google.com/compute/docs/configure-private-google-access#configuring_access_to_google_services_from_internal_ips).",
"type": "boolean"
@@ -567,51 +572,67 @@
"description": "The size of the boot disk. Defaults to 10 (GB).",
"format": "int32",
"type": "integer"
- }
- },
- "id": "PipelineResources",
- "description": "The system resources for the pipeline run.",
- "type": "object"
- },
- "OperationEvent": {
- "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",
+ },
+ "preemptible": {
+ "description": "Whether to use preemptible VMs. Defaults to `false`. In order to use this,\nmust be true for both create time and run time. Cannot be true at run time\nif false at create time.",
+ "type": "boolean"
+ },
+ "minimumRamGb": {
+ "description": "The minimum amount of RAM to use. Defaults to 3.75 (GB)",
+ "format": "double",
+ "type": "number"
+ },
+ "zones": {
+ "description": "List of Google Compute Engine availability zones to which resource\ncreation will restricted. If empty, any zone may be chosen.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "minimumCpuCores": {
+ "description": "The minimum number of cores to use. Defaults to 1.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "acceleratorType": {
+ "description": "Optional. The Compute Engine defined accelerator type.\nBy specifying this parameter, you will download and install the following\nthird-party software onto your managed Compute Engine instances: NVIDIA®\nTesla® drivers and NVIDIA® CUDA toolkit.\nPlease see https://cloud.google.com/compute/docs/gpus/ for a list of\navailable accelerator types.",
"type": "string"
},
- "startTime": {
- "description": "Optional time of when event started.",
- "format": "google-datetime",
- "type": "string"
- },
- "description": {
- "description": "Required description of event.",
+ "acceleratorCount": {
+ "description": "Optional. The number of accelerators of the specified type to attach.\nBy specifying this parameter, you will download and install the following\nthird-party software onto your managed Compute Engine instances:\nNVIDIA® Tesla® drivers and NVIDIA® CUDA toolkit.",
+ "format": "int64",
"type": "string"
}
},
- "id": "OperationEvent",
- "description": "An event that occurred during an Operation.",
- "type": "object"
+ "id": "PipelineResources"
},
"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": {
+ "vars": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "image": {
+ "type": "string"
+ },
"gcsLogPath": {
"type": "string"
},
"gcsSources": {
+ "type": "object",
"additionalProperties": {
"$ref": "RepeatedString"
- },
- "type": "object"
+ }
},
"gcsSinks": {
+ "type": "object",
"additionalProperties": {
"$ref": "RepeatedString"
- },
- "type": "object"
+ }
},
"disks": {
"additionalProperties": {
@@ -624,19 +645,31 @@
},
"cmd": {
"type": "string"
- },
- "vars": {
- "additionalProperties": {
- "type": "string"
- },
- "type": "object"
- },
- "image": {
- "type": "string"
}
},
"id": "ControllerConfig"
},
+ "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"
+ },
"ListOperationsResponse": {
"description": "The response message for Operations.ListOperations.",
"type": "object",
@@ -656,6 +689,7 @@
"id": "ListOperationsResponse"
},
"RepeatedString": {
+ "type": "object",
"properties": {
"values": {
"type": "array",
@@ -664,10 +698,11 @@
}
}
},
- "id": "RepeatedString",
- "type": "object"
+ "id": "RepeatedString"
},
"OperationMetadata": {
+ "description": "Metadata describing an Operation.",
+ "type": "object",
"properties": {
"projectId": {
"description": "The Google Cloud Project in which the job is scoped.",
@@ -677,6 +712,11 @@
"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",
@@ -684,23 +724,18 @@
"$ref": "OperationEvent"
}
},
- "endTime": {
- "description": "The time at which the job stopped running.",
- "format": "google-datetime",
- "type": "string"
- },
"startTime": {
"description": "The time at which the job began to run.",
"format": "google-datetime",
"type": "string"
},
"request": {
+ "description": "The original request that started the operation. Note that this will be in\ncurrent version of the API. If the operation was started with v1beta2 API\nand a GetOperation is performed on v1 API, a v1 request will be returned.",
+ "type": "object",
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
- },
- "description": "The original request that started the operation. Note that this will be in\ncurrent version of the API. If the operation was started with v1beta2 API\nand a GetOperation is performed on v1 API, a v1 request will be returned.",
- "type": "object"
+ }
},
"runtimeMetadata": {
"additionalProperties": {
@@ -710,33 +745,35 @@
"description": "Runtime metadata on this Operation.",
"type": "object"
},
+ "labels": {
+ "description": "Optionally provided by the caller when submitting the request that creates\nthe operation.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
"createTime": {
"description": "The time at which the job was submitted to the Genomics service.",
"format": "google-datetime",
"type": "string"
- },
+ }
+ },
+ "id": "OperationMetadata"
+ },
+ "RunPipelineArgs": {
+ "description": "The pipeline run arguments.",
+ "type": "object",
+ "properties": {
"labels": {
"additionalProperties": {
"type": "string"
},
- "description": "Optionally provided by the caller when submitting the request that creates\nthe operation.",
+ "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"
- }
- },
- "id": "OperationMetadata",
- "description": "Metadata describing an Operation.",
- "type": "object"
- },
- "RunPipelineArgs": {
- "properties": {
- "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"
+ "logging": {
+ "description": "Required. Logging options. Used by the service to communicate results\nto the user.",
+ "$ref": "LoggingOptions"
},
"outputs": {
"additionalProperties": {
@@ -745,6 +782,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": {
+ "$ref": "PipelineResources",
+ "description": "Specifies resource requirements/overrides for the pipeline run."
+ },
+ "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"
@@ -753,10 +799,6 @@
"description": "This field is deprecated. Use `labels` instead. Client-specified pipeline\noperation identifier.",
"type": "string"
},
- "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"
- },
"inputs": {
"additionalProperties": {
"type": "string"
@@ -764,21 +806,12 @@
"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"
},
- "logging": {
- "description": "Required. Logging options. Used by the service to communicate results\nto the user.",
- "$ref": "LoggingOptions"
- },
- "labels": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "Labels to apply to this pipeline run. Labels will also be applied to\ncompute resources (VM, disks) created by this pipeline run. When listing\noperations, operations can filtered by labels.\nLabel keys may not be empty; label values may be empty. Non-empty labels\nmust be 1-63 characters long, and comply with [RFC1035]\n(https://www.ietf.org/rfc/rfc1035.txt).\nSpecifically, the name must be 1-63 characters long and match the regular\nexpression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first\ncharacter must be a lowercase letter, and all following characters must be\na dash, lowercase letter, or digit, except the last character, which cannot\nbe a dash.",
- "type": "object"
+ "serviceAccount": {
+ "description": "The Google Cloud Service Account that will be used to access data and\nservices. By default, the compute service account associated with\n`projectId` is used.",
+ "$ref": "ServiceAccount"
}
},
- "id": "RunPipelineArgs",
- "description": "The pipeline run arguments.",
- "type": "object"
+ "id": "RunPipelineArgs"
},
"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.",
@@ -799,6 +832,8 @@
"id": "ListPipelinesResponse"
},
"SetOperationStatusRequest": {
+ "description": "Request to set operation status. Should only be used by VMs\ncreated by the Pipelines Service and not by end users.",
+ "type": "object",
"properties": {
"operationId": {
"type": "string"
@@ -811,6 +846,25 @@
"type": "string"
},
"errorCode": {
+ "enumDescriptions": [
+ "Not an error; returned on success\n\nHTTP Mapping: 200 OK",
+ "The operation was cancelled, typically by the caller.\n\nHTTP Mapping: 499 Client Closed Request",
+ "Unknown error. For example, this error may be returned when\na `Status` value received from another address space belongs to\nan error space that is not known in this address space. Also\nerrors raised by APIs that do not return enough error information\nmay be converted to this error.\n\nHTTP Mapping: 500 Internal Server Error",
+ "The client specified an invalid argument. Note that this differs\nfrom `FAILED_PRECONDITION`. `INVALID_ARGUMENT` indicates arguments\nthat are problematic regardless of the state of the system\n(e.g., a malformed file name).\n\nHTTP Mapping: 400 Bad Request",
+ "The deadline expired before the operation could complete. For operations\nthat change the state of the system, this error may be returned\neven if the operation has completed successfully. For example, a\nsuccessful response from a server could have been delayed long\nenough for the deadline to expire.\n\nHTTP Mapping: 504 Gateway Timeout",
+ "Some requested entity (e.g., file or directory) was not found.\n\nNote to server developers: if a request is denied for an entire class\nof users, such as gradual feature rollout or undocumented whitelist,\n`NOT_FOUND` may be used. If a request is denied for some users within\na class of users, such as user-based access control, `PERMISSION_DENIED`\nmust be used.\n\nHTTP Mapping: 404 Not Found",
+ "The entity that a client attempted to create (e.g., file or directory)\nalready exists.\n\nHTTP Mapping: 409 Conflict",
+ "The caller does not have permission to execute the specified\noperation. `PERMISSION_DENIED` must not be used for rejections\ncaused by exhausting some resource (use `RESOURCE_EXHAUSTED`\ninstead for those errors). `PERMISSION_DENIED` must not be\nused if the caller can not be identified (use `UNAUTHENTICATED`\ninstead for those errors). This error code does not imply the\nrequest is valid or the requested entity exists or satisfies\nother pre-conditions.\n\nHTTP Mapping: 403 Forbidden",
+ "The request does not have valid authentication credentials for the\noperation.\n\nHTTP Mapping: 401 Unauthorized",
+ "Some resource has been exhausted, perhaps a per-user quota, or\nperhaps the entire file system is out of space.\n\nHTTP Mapping: 429 Too Many Requests",
+ "The operation was rejected because the system is not in a state\nrequired for the operation's execution. For example, the directory\nto be deleted is non-empty, an rmdir operation is applied to\na non-directory, etc.\n\nService implementors can use the following guidelines to decide\nbetween `FAILED_PRECONDITION`, `ABORTED`, and `UNAVAILABLE`:\n (a) Use `UNAVAILABLE` if the client can retry just the failing call.\n (b) Use `ABORTED` if the client should retry at a higher level\n (e.g., when a client-specified test-and-set fails, indicating the\n client should restart a read-modify-write sequence).\n (c) Use `FAILED_PRECONDITION` if the client should not retry until\n the system state has been explicitly fixed. E.g., if an \"rmdir\"\n fails because the directory is non-empty, `FAILED_PRECONDITION`\n should be returned since the client should not retry unless\n the files are deleted from the directory.\n\nHTTP Mapping: 400 Bad Request",
+ "The operation was aborted, typically due to a concurrency issue such as\na sequencer check failure or transaction abort.\n\nSee the guidelines above for deciding between `FAILED_PRECONDITION`,\n`ABORTED`, and `UNAVAILABLE`.\n\nHTTP Mapping: 409 Conflict",
+ "The operation was attempted past the valid range. E.g., seeking or\nreading past end-of-file.\n\nUnlike `INVALID_ARGUMENT`, this error indicates a problem that may\nbe fixed if the system state changes. For example, a 32-bit file\nsystem will generate `INVALID_ARGUMENT` if asked to read at an\noffset that is not in the range [0,2^32-1], but it will generate\n`OUT_OF_RANGE` if asked to read from an offset past the current\nfile size.\n\nThere is a fair bit of overlap between `FAILED_PRECONDITION` and\n`OUT_OF_RANGE`. We recommend using `OUT_OF_RANGE` (the more specific\nerror) when it applies so that callers who are iterating through\na space can easily look for an `OUT_OF_RANGE` error to detect when\nthey are done.\n\nHTTP Mapping: 400 Bad Request",
+ "The operation is not implemented or is not supported/enabled in this\nservice.\n\nHTTP Mapping: 501 Not Implemented",
+ "Internal errors. This means that some invariants expected by the\nunderlying system have been broken. This error code is reserved\nfor serious errors.\n\nHTTP Mapping: 500 Internal Server Error",
+ "The service is currently unavailable. This is most likely a\ntransient condition, which can be corrected by retrying with\na backoff.\n\nSee the guidelines above for deciding between `FAILED_PRECONDITION`,\n`ABORTED`, and `UNAVAILABLE`.\n\nHTTP Mapping: 503 Service Unavailable",
+ "Unrecoverable data loss or corruption.\n\nHTTP Mapping: 500 Internal Server Error"
+ ],
"enum": [
"OK",
"CANCELLED",
@@ -830,26 +884,7 @@
"UNAVAILABLE",
"DATA_LOSS"
],
- "type": "string",
- "enumDescriptions": [
- "Not an error; returned on success\n\nHTTP Mapping: 200 OK",
- "The operation was cancelled, typically by the caller.\n\nHTTP Mapping: 499 Client Closed Request",
- "Unknown error. For example, this error may be returned when\na `Status` value received from another address space belongs to\nan error space that is not known in this address space. Also\nerrors raised by APIs that do not return enough error information\nmay be converted to this error.\n\nHTTP Mapping: 500 Internal Server Error",
- "The client specified an invalid argument. Note that this differs\nfrom `FAILED_PRECONDITION`. `INVALID_ARGUMENT` indicates arguments\nthat are problematic regardless of the state of the system\n(e.g., a malformed file name).\n\nHTTP Mapping: 400 Bad Request",
- "The deadline expired before the operation could complete. For operations\nthat change the state of the system, this error may be returned\neven if the operation has completed successfully. For example, a\nsuccessful response from a server could have been delayed long\nenough for the deadline to expire.\n\nHTTP Mapping: 504 Gateway Timeout",
- "Some requested entity (e.g., file or directory) was not found.\n\nNote to server developers: if a request is denied for an entire class\nof users, such as gradual feature rollout or undocumented whitelist,\n`NOT_FOUND` may be used. If a request is denied for some users within\na class of users, such as user-based access control, `PERMISSION_DENIED`\nmust be used.\n\nHTTP Mapping: 404 Not Found",
- "The entity that a client attempted to create (e.g., file or directory)\nalready exists.\n\nHTTP Mapping: 409 Conflict",
- "The caller does not have permission to execute the specified\noperation. `PERMISSION_DENIED` must not be used for rejections\ncaused by exhausting some resource (use `RESOURCE_EXHAUSTED`\ninstead for those errors). `PERMISSION_DENIED` must not be\nused if the caller can not be identified (use `UNAUTHENTICATED`\ninstead for those errors). This error code does not imply the\nrequest is valid or the requested entity exists or satisfies\nother pre-conditions.\n\nHTTP Mapping: 403 Forbidden",
- "The request does not have valid authentication credentials for the\noperation.\n\nHTTP Mapping: 401 Unauthorized",
- "Some resource has been exhausted, perhaps a per-user quota, or\nperhaps the entire file system is out of space.\n\nHTTP Mapping: 429 Too Many Requests",
- "The operation was rejected because the system is not in a state\nrequired for the operation's execution. For example, the directory\nto be deleted is non-empty, an rmdir operation is applied to\na non-directory, etc.\n\nService implementors can use the following guidelines to decide\nbetween `FAILED_PRECONDITION`, `ABORTED`, and `UNAVAILABLE`:\n (a) Use `UNAVAILABLE` if the client can retry just the failing call.\n (b) Use `ABORTED` if the client should retry at a higher level\n (e.g., when a client-specified test-and-set fails, indicating the\n client should restart a read-modify-write sequence).\n (c) Use `FAILED_PRECONDITION` if the client should not retry until\n the system state has been explicitly fixed. E.g., if an \"rmdir\"\n fails because the directory is non-empty, `FAILED_PRECONDITION`\n should be returned since the client should not retry unless\n the files are deleted from the directory.\n\nHTTP Mapping: 400 Bad Request",
- "The operation was aborted, typically due to a concurrency issue such as\na sequencer check failure or transaction abort.\n\nSee the guidelines above for deciding between `FAILED_PRECONDITION`,\n`ABORTED`, and `UNAVAILABLE`.\n\nHTTP Mapping: 409 Conflict",
- "The operation was attempted past the valid range. E.g., seeking or\nreading past end-of-file.\n\nUnlike `INVALID_ARGUMENT`, this error indicates a problem that may\nbe fixed if the system state changes. For example, a 32-bit file\nsystem will generate `INVALID_ARGUMENT` if asked to read at an\noffset that is not in the range [0,2^32-1], but it will generate\n`OUT_OF_RANGE` if asked to read from an offset past the current\nfile size.\n\nThere is a fair bit of overlap between `FAILED_PRECONDITION` and\n`OUT_OF_RANGE`. We recommend using `OUT_OF_RANGE` (the more specific\nerror) when it applies so that callers who are iterating through\na space can easily look for an `OUT_OF_RANGE` error to detect when\nthey are done.\n\nHTTP Mapping: 400 Bad Request",
- "The operation is not implemented or is not supported/enabled in this\nservice.\n\nHTTP Mapping: 501 Not Implemented",
- "Internal errors. This means that some invariants expected by the\nunderlying system have been broken. This error code is reserved\nfor serious errors.\n\nHTTP Mapping: 500 Internal Server Error",
- "The service is currently unavailable. This is most likely a\ntransient condition, which can be corrected by retrying with\na backoff.\n\nSee the guidelines above for deciding between `FAILED_PRECONDITION`,\n`ABORTED`, and `UNAVAILABLE`.\n\nHTTP Mapping: 503 Service Unavailable",
- "Unrecoverable data loss or corruption.\n\nHTTP Mapping: 500 Internal Server Error"
- ]
+ "type": "string"
},
"timestampEvents": {
"type": "array",
@@ -858,16 +893,12 @@
}
}
},
- "id": "SetOperationStatusRequest",
- "description": "Request to set operation status. Should only be used by VMs\ncreated by the Pipelines Service and not by end users.",
- "type": "object"
+ "id": "SetOperationStatusRequest"
},
"ComputeEngine": {
+ "description": "Describes a Compute Engine resource that is being managed by a running\npipeline.",
+ "type": "object",
"properties": {
- "zone": {
- "description": "The availability zone in which the instance resides.",
- "type": "string"
- },
"machineType": {
"description": "The machine type of the instance.",
"type": "string"
@@ -882,11 +913,13 @@
"instanceName": {
"description": "The instance on which the operation is running.",
"type": "string"
+ },
+ "zone": {
+ "description": "The availability zone in which the instance resides.",
+ "type": "string"
}
},
- "id": "ComputeEngine",
- "description": "Describes a Compute Engine resource that is being managed by a running\npipeline.",
- "type": "object"
+ "id": "ComputeEngine"
},
"ImportVariantsResponse": {
"description": "The variant data import response.",
@@ -906,19 +939,21 @@
"description": "Stores the list of events and times they occured for major events in job\nexecution.",
"type": "object",
"properties": {
+ "description": {
+ "description": "String indicating the type of event",
+ "type": "string"
+ },
"timestamp": {
"description": "The time this event occured.",
"format": "google-datetime",
"type": "string"
- },
- "description": {
- "description": "String indicating the type of event",
- "type": "string"
}
},
"id": "TimestampEvent"
},
"LocalCopy": {
+ "description": "LocalCopy defines how a remote file should be copied to and from the VM.",
+ "type": "object",
"properties": {
"disk": {
"description": "Required. The name of the disk where this parameter is\nlocated. Can be the name of one of the disks specified in the\nResources field, or \"boot\", which represents the Docker\ninstance's boot disk and has a mount point of `/`.",
@@ -929,55 +964,33 @@
"type": "string"
}
},
- "id": "LocalCopy",
- "description": "LocalCopy defines how a remote file should be copied to and from the VM.",
- "type": "object"
+ "id": "LocalCopy"
},
"DockerExecutor": {
+ "description": "The Docker execuctor specification.",
+ "type": "object",
"properties": {
- "cmd": {
- "description": "Required. The command or newline delimited script to run. The command\nstring will be executed within a bash shell.\n\nIf the command exits with a non-zero exit code, output parameter\nde-localization will be skipped and the pipeline operation's\n`error` field will be populated.\n\nMaximum command string length is 16384.",
- "type": "string"
- },
"imageName": {
"description": "Required. Image name from either Docker Hub or Google Container Registry.\nUsers that run pipelines must have READ access to the image.",
"type": "string"
+ },
+ "cmd": {
+ "description": "Required. The command or newline delimited script to run. The command\nstring will be executed within a bash shell.\n\nIf the command exits with a non-zero exit code, output parameter\nde-localization will be skipped and the pipeline operation's\n`error` field will be populated.\n\nMaximum command string length is 16384.",
+ "type": "string"
}
},
- "id": "DockerExecutor",
- "description": "The Docker execuctor specification.",
- "type": "object"
+ "id": "DockerExecutor"
},
"Empty": {
- "properties": {},
- "id": "Empty",
"description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
- "type": "object"
+ "type": "object",
+ "properties": {},
+ "id": "Empty"
},
"Disk": {
"description": "A Google Compute Engine disk resource specification.",
"type": "object",
"properties": {
- "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": {
- "enum": [
- "TYPE_UNSPECIFIED",
- "PERSISTENT_HDD",
- "PERSISTENT_SSD",
- "LOCAL_SSD"
- ],
- "description": "Required. The type of the disk to create.",
- "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.",
- "Specifies a Google Compute Engine persistent solid-state disk. See\nhttps://cloud.google.com/compute/docs/disks/#pdspecs for details.",
- "Specifies a Google Compute Engine local SSD.\nSee https://cloud.google.com/compute/docs/disks/local-ssd for details."
- ]
- },
"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"
@@ -998,12 +1011,42 @@
"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"
+ },
+ "type": {
+ "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.",
+ "Specifies a Google Compute Engine persistent solid-state disk. See\nhttps://cloud.google.com/compute/docs/disks/#pdspecs for details.",
+ "Specifies a Google Compute Engine local SSD.\nSee https://cloud.google.com/compute/docs/disks/local-ssd for details."
+ ],
+ "enum": [
+ "TYPE_UNSPECIFIED",
+ "PERSISTENT_HDD",
+ "PERSISTENT_SSD",
+ "LOCAL_SSD"
+ ],
+ "description": "Required. The type of the disk to create.",
+ "type": "string"
}
},
"id": "Disk"
},
"PipelineParameter": {
+ "description": "Parameters facilitate setting and delivering data into the\npipeline's execution environment. They are defined at create time,\nwith optional defaults, and can be overridden at run time.\n\nIf `localCopy` is unset, then the parameter specifies a string that\nis passed as-is into the pipeline, as the value of the environment\nvariable with the given name. A default value can be optionally\nspecified at create time. The default can be overridden at run time\nusing the inputs map. If no default is given, a value must be\nsupplied at runtime.\n\nIf `localCopy` is defined, then the parameter specifies a data\nsource or sink, both in Google Cloud Storage and on the Docker container\nwhere the pipeline computation is run. The service account associated with\nthe Pipeline (by\ndefault the project's Compute Engine service account) must have access to the\nGoogle Cloud Storage paths.\n\nAt run time, the Google Cloud Storage paths can be overridden if a default\nwas provided at create time, or must be set otherwise. The pipeline runner\nshould add a key/value pair to either the inputs or outputs map. The\nindicated data copies will be carried out before/after pipeline execution,\njust as if the corresponding arguments were provided to `gsutil cp`.\n\nFor example: Given the following `PipelineParameter`, specified\nin the `inputParameters` list:\n\n```\n{name: \"input_file\", localCopy: {path: \"file.txt\", disk: \"pd1\"}}\n```\n\nwhere `disk` is defined in the `PipelineResources` object as:\n\n```\n{name: \"pd1\", mountPoint: \"/mnt/disk/\"}\n```\n\nWe create a disk named `pd1`, mount it on the host VM, and map\n`/mnt/pd1` to `/mnt/disk` in the docker container. At\nruntime, an entry for `input_file` would be required in the inputs\nmap, such as:\n\n```\n inputs[\"input_file\"] = \"gs://my-bucket/bar.txt\"\n```\n\nThis would generate the following gsutil call:\n\n```\n gsutil cp gs://my-bucket/bar.txt /mnt/pd1/file.txt\n```\n\nThe file `/mnt/pd1/file.txt` maps to `/mnt/disk/file.txt` in the\nDocker container. Acceptable paths are:\n\n\u003ctable\u003e\n \u003cthead\u003e\n \u003ctr\u003e\u003cth\u003eGoogle Cloud storage path\u003c/th\u003e\u003cth\u003eLocal path\u003c/th\u003e\u003c/tr\u003e\n \u003c/thead\u003e\n \u003ctbody\u003e\n \u003ctr\u003e\u003ctd\u003efile\u003c/td\u003e\u003ctd\u003efile\u003c/td\u003e\u003c/tr\u003e\n \u003ctr\u003e\u003ctd\u003eglob\u003c/td\u003e\u003ctd\u003edirectory\u003c/td\u003e\u003c/tr\u003e\n \u003c/tbody\u003e\n\u003c/table\u003e\n\nFor outputs, the direction of the copy is reversed:\n\n```\n gsutil cp /mnt/disk/file.txt gs://my-bucket/bar.txt\n```\n\nAcceptable paths are:\n\n\u003ctable\u003e\n \u003cthead\u003e\n \u003ctr\u003e\u003cth\u003eLocal path\u003c/th\u003e\u003cth\u003eGoogle Cloud Storage path\u003c/th\u003e\u003c/tr\u003e\n \u003c/thead\u003e\n \u003ctbody\u003e\n \u003ctr\u003e\u003ctd\u003efile\u003c/td\u003e\u003ctd\u003efile\u003c/td\u003e\u003c/tr\u003e\n \u003ctr\u003e\n \u003ctd\u003efile\u003c/td\u003e\n \u003ctd\u003edirectory - directory must already exist\u003c/td\u003e\n \u003c/tr\u003e\n \u003ctr\u003e\n \u003ctd\u003eglob\u003c/td\u003e\n \u003ctd\u003edirectory - directory will be created if it doesn't exist\u003c/td\u003e\u003c/tr\u003e\n \u003c/tbody\u003e\n\u003c/table\u003e\n\nOne restriction due to docker limitations, is that for outputs that are found\non the boot disk, the local path cannot be a glob and must be a file.",
+ "type": "object",
"properties": {
+ "description": {
+ "description": "Human-readable description.",
+ "type": "string"
+ },
+ "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"
@@ -1011,19 +1054,9 @@
"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",
- "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"
+ "id": "PipelineParameter"
},
"LoggingOptions": {
"description": "The logging options for the pipeline run.",
@@ -1035,51 +1068,26 @@
}
},
"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": {
- "description": "The arguments to use when running this pipeline.",
- "$ref": "RunPipelineArgs"
- },
- "pipelineId": {
- "description": "The already created pipeline to run.",
- "type": "string"
- },
- "ephemeralPipeline": {
- "$ref": "Pipeline",
- "description": "A new pipeline object to run once and then delete."
- }
- },
- "id": "RunPipelineRequest"
- },
- "CancelOperationRequest": {
- "properties": {},
- "id": "CancelOperationRequest",
- "description": "The request message for Operations.CancelOperation.",
- "type": "object"
}
},
- "protocol": "rest",
"icons": {
"x16": "http://www.google.com/images/icons/product/search-16.gif",
"x32": "http://www.google.com/images/icons/product/search-32.gif"
},
+ "protocol": "rest",
"version": "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"
}
}
}
@@ -1087,13 +1095,5 @@
"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": "20171221",
- "documentationLink": "https://cloud.google.com/genomics",
- "id": "genomics:v1alpha2",
- "title": "Genomics API"
+ "rootUrl": "https://genomics.googleapis.com/"
}
diff --git a/iam/v1/iam-api.json b/iam/v1/iam-api.json
index 48d2975..ce529c3 100644
--- a/iam/v1/iam-api.json
+++ b/iam/v1/iam-api.json
@@ -1,1054 +1,197 @@
{
- "rootUrl": "https://iam.googleapis.com/",
- "ownerDomain": "google.com",
- "name": "iam",
- "batchPath": "batch",
- "fullyEncodeReservedExpansion": true,
- "title": "Google Identity and Access Management (IAM) API",
- "ownerName": "Google",
- "resources": {
- "organizations": {
- "resources": {
- "roles": {
- "methods": {
- "list": {
- "flatPath": "v1/organizations/{organizationsId}/roles",
- "path": "v1/{+parent}/roles",
- "id": "iam.organizations.roles.list",
- "description": "Lists the Roles defined on a resource.",
- "response": {
- "$ref": "ListRolesResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "showDeleted": {
- "location": "query",
- "description": "Include Roles that have been deleted.",
- "type": "boolean"
- },
- "pageToken": {
- "description": "Optional pagination token returned in an earlier ListRolesResponse.",
- "type": "string",
- "location": "query"
- },
- "pageSize": {
- "description": "Optional limit on the number of roles to include in the response.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- },
- "view": {
- "location": "query",
- "enum": [
- "BASIC",
- "FULL"
- ],
- "description": "Optional view for the returned Role objects.",
- "type": "string"
- },
- "parent": {
- "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"
- }
- }
- },
- "create": {
- "id": "iam.organizations.roles.create",
- "path": "v1/{+parent}/roles",
- "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}`",
- "required": true,
- "type": "string",
- "pattern": "^organizations/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/organizations/{organizationsId}/roles"
- },
- "undelete": {
- "id": "iam.organizations.roles.undelete",
- "path": "v1/{+name}:undelete",
- "request": {
- "$ref": "UndeleteRoleRequest"
- },
- "description": "Undelete a Role, bringing it back in its previous state.",
- "httpMethod": "POST",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Role"
- },
- "parameters": {
- "name": {
- "description": "The resource name of the role in one of the following formats:\n`organizations/{ORGANIZATION_ID}/roles/{ROLE_NAME}`\n`projects/{PROJECT_ID}/roles/{ROLE_NAME}`",
- "required": true,
- "type": "string",
- "pattern": "^organizations/[^/]+/roles/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/organizations/{organizationsId}/roles/{rolesId}:undelete"
- },
- "get": {
- "httpMethod": "GET",
- "response": {
- "$ref": "Role"
- },
- "parameterOrder": [
- "name"
- ],
- "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"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/organizations/{organizationsId}/roles/{rolesId}",
- "id": "iam.organizations.roles.get",
- "path": "v1/{+name}",
- "description": "Gets a Role definition."
- },
- "patch": {
- "response": {
- "$ref": "Role"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "PATCH",
- "parameters": {
- "updateMask": {
- "location": "query",
- "description": "A mask describing which fields in the Role have changed.",
- "format": "google-fieldmask",
- "type": "string"
- },
- "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.patch",
- "request": {
- "$ref": "Role"
- },
- "description": "Updates a Role definition."
- },
- "delete": {
- "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.",
- "response": {
- "$ref": "Role"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "DELETE",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "etag": {
- "location": "query",
- "description": "Used to perform a consistent read-modify-write.",
- "format": "byte",
- "type": "string"
- },
- "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}"
- }
- }
- }
- }
- },
- "projects": {
- "resources": {
- "serviceAccounts": {
- "methods": {
- "list": {
- "response": {
- "$ref": "ListServiceAccountsResponse"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "location": "path",
- "description": "Required. The resource name of the project associated with the service\naccounts, such as `projects/my-project-123`.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+$"
- },
- "pageToken": {
- "description": "Optional pagination token returned in an earlier\nListServiceAccountsResponse.next_page_token.",
- "type": "string",
- "location": "query"
- },
- "pageSize": {
- "description": "Optional limit on the number of service accounts to include in the\nresponse. Further accounts can subsequently be obtained by including the\nListServiceAccountsResponse.next_page_token\nin a subsequent request.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- }
- },
- "flatPath": "v1/projects/{projectsId}/serviceAccounts",
- "path": "v1/{+name}/serviceAccounts",
- "id": "iam.projects.serviceAccounts.list",
- "description": "Lists ServiceAccounts for a project."
- },
- "signBlob": {
- "description": "Signs a blob using a service account's system-managed private key.",
- "request": {
- "$ref": "SignBlobRequest"
- },
- "response": {
- "$ref": "SignBlobResponse"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "POST",
- "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}:signBlob",
- "path": "v1/{+name}:signBlob",
- "id": "iam.projects.serviceAccounts.signBlob"
- },
- "setIamPolicy": {
- "request": {
- "$ref": "SetIamPolicyRequest"
- },
- "description": "Sets the IAM access control policy for a\nServiceAccount.",
- "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}/serviceAccounts/{serviceAccountsId}:setIamPolicy",
- "path": "v1/{+resource}:setIamPolicy",
- "id": "iam.projects.serviceAccounts.setIamPolicy"
- },
- "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.",
- "response": {
- "$ref": "SignJwtResponse"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "POST",
- "parameters": {
- "name": {
- "location": "path",
- "description": "The resource name of the service account in the following format:\n`projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`.\nUsing `-` as a wildcard for the `PROJECT_ID` will infer the project from\nthe account. The `ACCOUNT` value can be the `email` address or the\n`unique_id` of the service account.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/serviceAccounts/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}:signJwt",
- "path": "v1/{+name}:signJwt",
- "id": "iam.projects.serviceAccounts.signJwt"
- },
- "create": {
- "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",
- "path": "v1/{+name}/serviceAccounts",
- "id": "iam.projects.serviceAccounts.create",
- "request": {
- "$ref": "CreateServiceAccountRequest"
- },
- "description": "Creates a ServiceAccount\nand returns it."
- },
- "getIamPolicy": {
- "description": "Returns the IAM access control policy for a\nServiceAccount.",
- "response": {
- "$ref": "Policy"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
- "parameters": {
- "resource": {
- "location": "path",
- "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/serviceAccounts/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}:getIamPolicy",
- "path": "v1/{+resource}:getIamPolicy",
- "id": "iam.projects.serviceAccounts.getIamPolicy"
- },
- "get": {
- "response": {
- "$ref": "ServiceAccount"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "location": "path",
- "description": "The resource name of the service account in the following format:\n`projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`.\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/[^/]+$"
- }
- },
- "flatPath": "v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}",
- "path": "v1/{+name}",
- "id": "iam.projects.serviceAccounts.get",
- "description": "Gets a ServiceAccount."
- },
- "update": {
- "path": "v1/{+name}",
- "id": "iam.projects.serviceAccounts.update",
- "request": {
- "$ref": "ServiceAccount"
- },
- "description": "Updates a ServiceAccount.\n\nCurrently, only the following fields are updatable:\n`display_name` .\nThe `etag` is mandatory.",
- "response": {
- "$ref": "ServiceAccount"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "PUT",
- "parameters": {
- "name": {
- "location": "path",
- "description": "The resource name of the service account in the following format:\n`projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`.\n\nRequests using `-` as a wildcard for the `PROJECT_ID` will infer the\nproject from the `account` and the `ACCOUNT` value can be the `email`\naddress or the `unique_id` of the service account.\n\nIn responses the resource name will always be in the format\n`projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/serviceAccounts/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}"
- },
- "testIamPermissions": {
- "flatPath": "v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}:testIamPermissions",
- "path": "v1/{+resource}:testIamPermissions",
- "id": "iam.projects.serviceAccounts.testIamPermissions",
- "request": {
- "$ref": "TestIamPermissionsRequest"
- },
- "description": "Tests the specified permissions against the IAM access control policy\nfor a ServiceAccount.",
- "response": {
- "$ref": "TestIamPermissionsResponse"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
- "parameters": {
- "resource": {
- "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/serviceAccounts/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- },
- "delete": {
- "description": "Deletes a ServiceAccount.",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "DELETE",
- "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}",
- "path": "v1/{+name}",
- "id": "iam.projects.serviceAccounts.delete"
- }
- },
- "resources": {
- "keys": {
- "methods": {
- "create": {
- "flatPath": "v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}/keys",
- "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": {
- "location": "path",
- "description": "The resource name of the service account in the following format:\n`projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`.\nUsing `-` as a wildcard for the `PROJECT_ID` will infer the project from\nthe account. The `ACCOUNT` value can be the `email` address or the\n`unique_id` of the service account.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/serviceAccounts/[^/]+$"
- }
- }
- },
- "delete": {
- "description": "Deletes a ServiceAccountKey.",
- "httpMethod": "DELETE",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "name"
- ],
- "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}",
- "id": "iam.projects.serviceAccounts.keys.delete",
- "path": "v1/{+name}"
- },
- "list": {
- "description": "Lists ServiceAccountKeys.",
- "response": {
- "$ref": "ListServiceAccountKeysResponse"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "location": "path",
- "description": "The resource name of the service account in the following format:\n`projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`.\n\nUsing `-` as a wildcard for the `PROJECT_ID`, will infer the project from\nthe account. The `ACCOUNT` value can be the `email` address or the\n`unique_id` of the service account.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/serviceAccounts/[^/]+$"
- },
- "keyTypes": {
- "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"
- ]
- }
- },
- "flatPath": "v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}/keys",
- "path": "v1/{+name}/keys",
- "id": "iam.projects.serviceAccounts.keys.list"
- },
- "get": {
- "description": "Gets the ServiceAccountKey\nby key id.",
- "httpMethod": "GET",
- "response": {
- "$ref": "ServiceAccountKey"
- },
- "parameterOrder": [
- "name"
- ],
- "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": {
- "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"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}/keys/{keysId}",
- "id": "iam.projects.serviceAccounts.keys.get",
- "path": "v1/{+name}"
- }
- }
- }
- }
- },
- "roles": {
- "methods": {
- "undelete": {
- "id": "iam.projects.roles.undelete",
- "path": "v1/{+name}:undelete",
- "request": {
- "$ref": "UndeleteRoleRequest"
- },
- "description": "Undelete a Role, bringing it back in its previous state.",
- "httpMethod": "POST",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Role"
- },
- "parameters": {
- "name": {
- "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"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/roles/{rolesId}:undelete"
- },
- "get": {
- "httpMethod": "GET",
- "response": {
- "$ref": "Role"
- },
- "parameterOrder": [
- "name"
- ],
- "parameters": {
- "name": {
- "location": "path",
- "description": "The resource name of the role in one of the following formats:\n`roles/{ROLE_NAME}`\n`organizations/{ORGANIZATION_ID}/roles/{ROLE_NAME}`\n`projects/{PROJECT_ID}/roles/{ROLE_NAME}`",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/roles/[^/]+$"
- }
- },
- "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."
- },
- "patch": {
- "response": {
- "$ref": "Role"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "PATCH",
- "parameters": {
- "name": {
- "location": "path",
- "description": "The resource name of the role in one of the following formats:\n`roles/{ROLE_NAME}`\n`organizations/{ORGANIZATION_ID}/roles/{ROLE_NAME}`\n`projects/{PROJECT_ID}/roles/{ROLE_NAME}`",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/roles/[^/]+$"
- },
- "updateMask": {
- "description": "A mask describing which fields in the Role have changed.",
- "format": "google-fieldmask",
- "type": "string",
- "location": "query"
- }
- },
- "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": {
- "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": {
- "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/projects/{projectsId}/roles/{rolesId}",
- "path": "v1/{+name}",
- "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"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "GET",
- "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": {
- "enum": [
- "BASIC",
- "FULL"
- ],
- "description": "Optional view for the returned Role objects.",
- "type": "string",
- "location": "query"
- },
- "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": "^projects/[^/]+$",
- "location": "path"
- },
- "showDeleted": {
- "location": "query",
- "description": "Include Roles that have been deleted.",
- "type": "boolean"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/roles",
- "path": "v1/{+parent}/roles",
- "id": "iam.projects.roles.list"
- },
- "create": {
- "description": "Creates a new Role.",
- "request": {
- "$ref": "CreateRoleRequest"
- },
- "response": {
- "$ref": "Role"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "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"
- }
- },
- "flatPath": "v1/projects/{projectsId}/roles",
- "path": "v1/{+parent}/roles",
- "id": "iam.projects.roles.create"
- }
- }
- }
- }
- },
- "roles": {
- "methods": {
- "queryGrantableRoles": {
- "request": {
- "$ref": "QueryGrantableRolesRequest"
- },
- "description": "Queries roles that can be granted on a particular resource.\nA role is grantable if it can be used as the role in a binding for a policy\nfor that resource.",
- "response": {
- "$ref": "QueryGrantableRolesResponse"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "parameters": {},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/roles:queryGrantableRoles",
- "path": "v1/roles:queryGrantableRoles",
- "id": "iam.roles.queryGrantableRoles"
- },
- "list": {
- "response": {
- "$ref": "ListRolesResponse"
- },
- "parameterOrder": [],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "pageSize": {
- "location": "query",
- "description": "Optional limit on the number of roles to include in the response.",
- "format": "int32",
- "type": "integer"
- },
- "view": {
- "location": "query",
- "enum": [
- "BASIC",
- "FULL"
- ],
- "description": "Optional view for the returned Role objects.",
- "type": "string"
- },
- "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"
- },
- "pageToken": {
- "description": "Optional pagination token returned in an earlier ListRolesResponse.",
- "type": "string",
- "location": "query"
- }
- },
- "flatPath": "v1/roles",
- "path": "v1/roles",
- "id": "iam.roles.list",
- "description": "Lists the Roles defined on a resource."
- },
- "get": {
- "response": {
- "$ref": "Role"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "description": "The resource name of the role in one of the following formats:\n`roles/{ROLE_NAME}`\n`organizations/{ORGANIZATION_ID}/roles/{ROLE_NAME}`\n`projects/{PROJECT_ID}/roles/{ROLE_NAME}`",
- "required": true,
- "type": "string",
- "pattern": "^roles/[^/]+$",
- "location": "path"
- }
- },
- "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"
- }
- }
- }
- },
- "parameters": {
- "upload_protocol": {
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string",
- "location": "query"
- },
- "prettyPrint": {
- "description": "Returns response with indentations and line breaks.",
- "type": "boolean",
- "default": "true",
- "location": "query"
- },
- "fields": {
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string",
- "location": "query"
- },
- "uploadType": {
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string",
- "location": "query"
- },
- "$.xgafv": {
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query",
- "enum": [
- "1",
- "2"
- ],
- "description": "V1 error format.",
- "type": "string"
- },
- "callback": {
- "location": "query",
- "description": "JSONP",
- "type": "string"
- },
- "alt": {
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query",
- "description": "Data format for response.",
- "default": "json",
- "enum": [
- "json",
- "media",
- "proto"
- ],
- "type": "string"
- },
- "access_token": {
- "description": "OAuth access token.",
- "type": "string",
- "location": "query"
- },
- "key": {
- "location": "query",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string"
- },
- "quotaUser": {
- "location": "query",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string"
- },
- "pp": {
- "location": "query",
- "description": "Pretty-print response.",
- "type": "boolean",
- "default": "true"
- },
- "oauth_token": {
- "description": "OAuth 2.0 token for the current user.",
- "type": "string",
- "location": "query"
- },
- "bearer_token": {
- "description": "OAuth bearer token.",
- "type": "string",
- "location": "query"
- }
- },
- "version": "v1",
- "baseUrl": "https://iam.googleapis.com/",
- "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",
"documentationLink": "https://cloud.google.com/iam/",
- "revision": "20171214",
+ "revision": "20171228",
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
+ "CreateServiceAccountKeyRequest": {
+ "description": "The service account key create request.",
+ "type": "object",
+ "properties": {
+ "keyAlgorithm": {
+ "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",
+ "enumDescriptions": [
+ "An unspecified key algorithm.",
+ "1k RSA Key.",
+ "2k RSA Key."
+ ],
+ "enum": [
+ "KEY_ALG_UNSPECIFIED",
+ "KEY_ALG_RSA_1024",
+ "KEY_ALG_RSA_2048"
+ ]
+ },
+ "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"
+ }
+ },
+ "id": "CreateServiceAccountKeyRequest"
+ },
+ "SignJwtResponse": {
+ "description": "The service account sign JWT response.",
+ "type": "object",
+ "properties": {
+ "keyId": {
+ "description": "The id of the key used to sign the JWT.",
+ "type": "string"
+ },
+ "signedJwt": {
+ "description": "The signed JWT.",
+ "type": "string"
+ }
+ },
+ "id": "SignJwtResponse"
+ },
+ "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"
+ }
+ }
+ }
+ },
+ "Policy": {
+ "description": "Defines an Identity and Access Management (IAM) policy. It is used to\nspecify access control policies for Cloud Platform resources.\n\n\nA `Policy` consists of a list of `bindings`. A `Binding` binds a list of\n`members` to a `role`, where the members can be user accounts, Google groups,\nGoogle domains, and service accounts. A `role` is a named list of permissions\ndefined by IAM.\n\n**Example**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/owner\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-other-app@appspot.gserviceaccount.com\",\n ]\n },\n {\n \"role\": \"roles/viewer\",\n \"members\": [\"user:sean@example.com\"]\n }\n ]\n }\n\nFor a description of IAM and its features, see the\n[IAM developer's guide](https://cloud.google.com/iam/docs).",
+ "type": "object",
+ "properties": {
+ "version": {
+ "description": "Deprecated.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "bindings": {
+ "description": "Associates a list of `members` to a `role`.\n`bindings` with no members will result in an error.",
+ "type": "array",
+ "items": {
+ "$ref": "Binding"
+ }
+ },
+ "etag": {
+ "description": "`etag` is used for optimistic concurrency control as a way to help\nprevent simultaneous updates of a policy from overwriting each other.\nIt is strongly suggested that systems make use of the `etag` in the\nread-modify-write cycle to perform policy updates in order to avoid race\nconditions: An `etag` is returned in the response to `getIamPolicy`, and\nsystems are expected to put that etag in the request to `setIamPolicy` to\nensure that their change will be applied to the same version of the policy.\n\nIf no `etag` is provided in the call to `setIamPolicy`, then the existing\npolicy is overwritten blindly.",
+ "format": "byte",
+ "type": "string"
+ }
+ },
+ "id": "Policy"
+ },
+ "ListRolesResponse": {
+ "description": "The response containing the roles defined under a resource.",
+ "type": "object",
+ "properties": {
+ "roles": {
+ "description": "The Roles defined on this resource.",
+ "type": "array",
+ "items": {
+ "$ref": "Role"
+ }
+ },
+ "nextPageToken": {
+ "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."
+ }
+ }
+ },
+ "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": {
+ "role": {
+ "description": "Role that is assigned to `members`.\nFor example, `roles/viewer`, `roles/editor`, or `roles/owner`.\nRequired",
+ "type": "string"
+ },
+ "action": {
+ "description": "The action that was performed on a Binding.\nRequired",
+ "type": "string",
+ "enumDescriptions": [
+ "Unspecified.",
+ "Addition of a Binding.",
+ "Removal of a Binding."
+ ],
+ "enum": [
+ "ACTION_UNSPECIFIED",
+ "ADD",
+ "REMOVE"
+ ]
+ },
+ "member": {
+ "description": "A single identity requesting access for a Cloud Platform resource.\nFollows the same format of Binding.members.\nRequired",
+ "type": "string"
+ }
+ }
+ },
+ "UndeleteRoleRequest": {
+ "description": "The request to undelete an existing role.",
+ "type": "object",
+ "properties": {
+ "etag": {
+ "description": "Used to perform a consistent read-modify-write.",
+ "format": "byte",
+ "type": "string"
+ }
+ },
+ "id": "UndeleteRoleRequest"
+ },
+ "CreateServiceAccountRequest": {
+ "id": "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": {
+ "$ref": "ServiceAccount",
+ "description": "The ServiceAccount resource to create.\nCurrently, only the following values are user assignable:\n`display_name` ."
+ }
+ }
+ },
"Role": {
"description": "A role in the Identity and Access Management API.",
"type": "object",
"properties": {
"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",
@@ -1058,15 +201,7 @@
"EAP"
],
"description": "The current launch stage of the role.",
- "type": "string",
- "enumDescriptions": [
- "The user has indicated this role is currently in an alpha phase.",
- "The user has indicated this role is currently in a beta phase.",
- "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."
- ]
+ "type": "string"
},
"name": {
"description": "The name of the role.\n\nWhen Role is used in CreateRole, the role name must not be set.\n\nWhen Role is used in output and other input such as UpdateRole, the role\nname is the complete path, e.g., roles/logging.viewer for curated roles\nand organizations/{ORGANIZATION_ID}/roles/logging.viewer for custom roles.",
@@ -1100,6 +235,7 @@
"id": "Role"
},
"Binding": {
+ "id": "Binding",
"description": "Associates `members` with a `role`.",
"type": "object",
"properties": {
@@ -1114,46 +250,11 @@
"description": "Role that is assigned to `members`.\nFor example, `roles/viewer`, `roles/editor`, or `roles/owner`.\nRequired",
"type": "string"
}
- },
- "id": "Binding"
- },
- "ServiceAccount": {
- "description": "A service account in the Identity and Access Management API.\n\nTo create a service account, specify the `project_id` and the `account_id`\nfor the account. The `account_id` is unique within the project, and is used\nto generate the service account email address and a stable\n`unique_id`.\n\nIf the account already exists, the account's resource name is returned\nin the format of projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}. The caller\ncan use the name in other methods to access the account.\n\nAll other methods can identify the service account using the format\n`projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`.\nUsing `-` as a wildcard for the `PROJECT_ID` will infer the project from\nthe account. The `ACCOUNT` value can be the `email` address or the\n`unique_id` of the service account.",
- "type": "object",
- "properties": {
- "displayName": {
- "description": "Optional. A user-specified description of the service account. Must be\nfewer than 100 UTF-8 bytes.",
- "type": "string"
- },
- "etag": {
- "description": "Used to perform a consistent read-modify-write.",
- "format": "byte",
- "type": "string"
- },
- "email": {
- "description": "@OutputOnly The email address of the service account.",
- "type": "string"
- },
- "name": {
- "description": "The resource name of the service account in the following format:\n`projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`.\n\nRequests using `-` as a wildcard for the `PROJECT_ID` will infer the\nproject from the `account` and the `ACCOUNT` value can be the `email`\naddress or the `unique_id` of the service account.\n\nIn responses the resource name will always be in the format\n`projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`.",
- "type": "string"
- },
- "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": {
+ "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`.",
@@ -1180,9 +281,43 @@
]
}
},
- "id": "QueryGrantableRolesRequest",
- "description": "The grantable role query request.",
- "type": "object"
+ "id": "QueryGrantableRolesRequest"
+ },
+ "ServiceAccount": {
+ "description": "A service account in the Identity and Access Management API.\n\nTo create a service account, specify the `project_id` and the `account_id`\nfor the account. The `account_id` is unique within the project, and is used\nto generate the service account email address and a stable\n`unique_id`.\n\nIf the account already exists, the account's resource name is returned\nin the format of projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}. The caller\ncan use the name in other methods to access the account.\n\nAll other methods can identify the service account using the format\n`projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`.\nUsing `-` as a wildcard for the `PROJECT_ID` will infer the project from\nthe account. The `ACCOUNT` value can be the `email` address or the\n`unique_id` of the service account.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "The resource name of the service account in the following format:\n`projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`.\n\nRequests using `-` as a wildcard for the `PROJECT_ID` will infer the\nproject from the `account` and the `ACCOUNT` value can be the `email`\naddress or the `unique_id` of the service account.\n\nIn responses the resource name will always be in the format\n`projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`.",
+ "type": "string"
+ },
+ "email": {
+ "description": "@OutputOnly The email address of the service account.",
+ "type": "string"
+ },
+ "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"
+ },
+ "displayName": {
+ "description": "Optional. A user-specified description of the service account. Must be\nfewer than 100 UTF-8 bytes.",
+ "type": "string"
+ },
+ "etag": {
+ "description": "Used to perform a consistent read-modify-write.",
+ "format": "byte",
+ "type": "string"
+ }
+ },
+ "id": "ServiceAccount"
},
"CreateRoleRequest": {
"description": "The request to create a new role.",
@@ -1199,27 +334,10 @@
},
"id": "CreateRoleRequest"
},
- "QueryTestablePermissionsRequest": {
- "description": "A request to get permissions which can be tested on a resource.",
- "type": "object",
- "properties": {
- "pageSize": {
- "description": "Optional limit on the number of permissions to include in the response.",
- "format": "int32",
- "type": "integer"
- },
- "fullResourceName": {
- "description": "Required. The full resource name to query from the list of testable\npermissions.\n\nThe name follows the Google Cloud Platform resource format.\nFor example, a Cloud Platform project with id `my-project` will be named\n`//cloudresourcemanager.googleapis.com/projects/my-project`.",
- "type": "string"
- },
- "pageToken": {
- "description": "Optional pagination token returned in an earlier\nQueryTestablePermissionsRequest.",
- "type": "string"
- }
- },
- "id": "QueryTestablePermissionsRequest"
- },
"ListServiceAccountKeysResponse": {
+ "id": "ListServiceAccountKeysResponse",
+ "description": "The service account keys list response.",
+ "type": "object",
"properties": {
"keys": {
"description": "The public keys for the service account.",
@@ -1228,12 +346,12 @@
"$ref": "ServiceAccountKey"
}
}
- },
- "id": "ListServiceAccountKeysResponse",
- "description": "The service account keys list response.",
- "type": "object"
+ }
},
"TestIamPermissionsResponse": {
+ "id": "TestIamPermissionsResponse",
+ "description": "Response message for `TestIamPermissions` method.",
+ "type": "object",
"properties": {
"permissions": {
"description": "A subset of `TestPermissionsRequest.permissions` that the caller is\nallowed.",
@@ -1242,13 +360,55 @@
"type": "string"
}
}
+ }
+ },
+ "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"
+ }
},
- "id": "TestIamPermissionsResponse",
- "description": "Response message for `TestIamPermissions` method.",
- "type": "object"
+ "id": "QueryTestablePermissionsRequest"
},
"ServiceAccountKey": {
+ "description": "Represents a service account key.\n\nA service account has two sets of key-pairs: user-managed, and\nsystem-managed.\n\nUser-managed key-pairs can be created and deleted by users. Users are\nresponsible for rotating these keys periodically to ensure security of\ntheir service accounts. Users retain the private key of these key-pairs,\nand Google retains ONLY the public key.\n\nSystem-managed key-pairs are managed automatically by Google, and rotated\ndaily without user intervention. The private key never leaves Google's\nservers to maximize security.\n\nPublic keys for all service accounts are also published at the OAuth2\nService Account API.",
+ "type": "object",
"properties": {
+ "name": {
+ "description": "The resource name of the service account key in the following format\n`projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}/keys/{key}`.",
+ "type": "string"
+ },
+ "validBeforeTime": {
+ "description": "The key can be used before this timestamp.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "keyAlgorithm": {
+ "description": "Specifies the algorithm (and possibly key size) for the key.",
+ "type": "string",
+ "enumDescriptions": [
+ "An unspecified key algorithm.",
+ "1k RSA Key.",
+ "2k RSA Key."
+ ],
+ "enum": [
+ "KEY_ALG_UNSPECIFIED",
+ "KEY_ALG_RSA_1024",
+ "KEY_ALG_RSA_2048"
+ ]
+ },
"validAfterTime": {
"description": "The key can be used after this timestamp.",
"format": "google-datetime",
@@ -1277,36 +437,12 @@
"description": "The public key data. Only provided in `GetServiceAccountKey` responses.",
"format": "byte",
"type": "string"
- },
- "name": {
- "description": "The resource name of the service account key in the following format\n`projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}/keys/{key}`.",
- "type": "string"
- },
- "validBeforeTime": {
- "description": "The key can be used before this timestamp.",
- "format": "google-datetime",
- "type": "string"
- },
- "keyAlgorithm": {
- "enumDescriptions": [
- "An unspecified key algorithm.",
- "1k RSA Key.",
- "2k RSA Key."
- ],
- "enum": [
- "KEY_ALG_UNSPECIFIED",
- "KEY_ALG_RSA_1024",
- "KEY_ALG_RSA_2048"
- ],
- "description": "Specifies the algorithm (and possibly key size) for the key.",
- "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"
+ "id": "ServiceAccountKey"
},
"SignBlobResponse": {
+ "id": "SignBlobResponse",
"description": "The service account sign blob response.",
"type": "object",
"properties": {
@@ -1319,21 +455,21 @@
"description": "The id of the key used to sign the blob.",
"type": "string"
}
- },
- "id": "SignBlobResponse"
+ }
},
"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"
+ }
},
"Permission": {
+ "id": "Permission",
"description": "A permission which can be included by a role.",
"type": "object",
"properties": {
@@ -1383,8 +519,7 @@
"description": "The title of this Permission.",
"type": "string"
}
- },
- "id": "Permission"
+ }
},
"PolicyDelta": {
"description": "The difference delta between two policies.",
@@ -1401,6 +536,8 @@
"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.",
@@ -1414,9 +551,7 @@
}
}
},
- "id": "ListServiceAccountsResponse",
- "description": "The service account list response.",
- "type": "object"
+ "id": "ListServiceAccountsResponse"
},
"QueryGrantableRolesResponse": {
"description": "The grantable role query response.",
@@ -1437,6 +572,7 @@
"id": "QueryGrantableRolesResponse"
},
"SignBlobRequest": {
+ "id": "SignBlobRequest",
"description": "The service account sign blob request.",
"type": "object",
"properties": {
@@ -1445,19 +581,18 @@
"format": "byte",
"type": "string"
}
- },
- "id": "SignBlobRequest"
+ }
},
"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"
+ }
},
"QueryTestablePermissionsResponse": {
"description": "The response containing permissions which can be tested on a resource.",
@@ -1482,186 +617,13 @@
"type": "object",
"properties": {},
"id": "Empty"
- },
- "CreateServiceAccountKeyRequest": {
- "description": "The service account key create request.",
- "type": "object",
- "properties": {
- "privateKeyType": {
- "description": "The output format of the private key. `GOOGLE_CREDENTIALS_FILE` is the\ndefault output format.",
- "type": "string",
- "enumDescriptions": [
- "Unspecified. Equivalent to `TYPE_GOOGLE_CREDENTIALS_FILE`.",
- "PKCS12 format.\nThe password for the PKCS12 file is `notasecret`.\nFor more information, see https://tools.ietf.org/html/rfc7292.",
- "Google Credentials File format."
- ],
- "enum": [
- "TYPE_UNSPECIFIED",
- "TYPE_PKCS12_FILE",
- "TYPE_GOOGLE_CREDENTIALS_FILE"
- ]
- },
- "keyAlgorithm": {
- "enum": [
- "KEY_ALG_UNSPECIFIED",
- "KEY_ALG_RSA_1024",
- "KEY_ALG_RSA_2048"
- ],
- "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",
- "enumDescriptions": [
- "An unspecified key algorithm.",
- "1k RSA Key.",
- "2k RSA Key."
- ]
- }
- },
- "id": "CreateServiceAccountKeyRequest"
- },
- "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"
- },
- "SignJwtResponse": {
- "description": "The service account sign JWT response.",
- "type": "object",
- "properties": {
- "keyId": {
- "description": "The id of the key used to sign the JWT.",
- "type": "string"
- },
- "signedJwt": {
- "description": "The signed JWT.",
- "type": "string"
- }
- },
- "id": "SignJwtResponse"
- },
- "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",
- "type": "string"
- },
- "version": {
- "description": "Version of the `Policy`. The default version is 0.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "Policy"
- },
- "ListRolesResponse": {
- "description": "The response containing the roles defined under a resource.",
- "type": "object",
- "properties": {
- "roles": {
- "description": "The Roles defined on this resource.",
- "type": "array",
- "items": {
- "$ref": "Role"
- }
- },
- "nextPageToken": {
- "description": "To retrieve the next page of results, set\n`ListRolesRequest.page_token` to this value.",
- "type": "string"
- }
- },
- "id": "ListRolesResponse"
- },
- "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."
- }
- },
- "id": "AuditData"
- },
- "BindingDelta": {
- "properties": {
- "member": {
- "description": "A single identity requesting access for a Cloud Platform resource.\nFollows the same format of Binding.members.\nRequired",
- "type": "string"
- },
- "role": {
- "description": "Role that is assigned to `members`.\nFor example, `roles/viewer`, `roles/editor`, or `roles/owner`.\nRequired",
- "type": "string"
- },
- "action": {
- "enum": [
- "ACTION_UNSPECIFIED",
- "ADD",
- "REMOVE"
- ],
- "description": "The action that was performed on a Binding.\nRequired",
- "type": "string",
- "enumDescriptions": [
- "Unspecified.",
- "Addition of a Binding.",
- "Removal of a Binding."
- ]
- }
- },
- "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.",
- "format": "byte",
- "type": "string"
- }
- },
- "id": "UndeleteRoleRequest"
- },
- "CreateServiceAccountRequest": {
- "description": "The service account create request.",
- "type": "object",
- "properties": {
- "serviceAccount": {
- "$ref": "ServiceAccount",
- "description": "The ServiceAccount resource to create.\nCurrently, only the following values are user assignable:\n`display_name` ."
- },
- "accountId": {
- "description": "Required. The account id that is used to generate the service account\nemail address and a stable unique id. It is unique within a project,\nmust be 6-30 characters long, and match the regular expression\n`[a-z]([-a-z0-9]*[a-z0-9])` to comply with RFC1035.",
- "type": "string"
- }
- },
- "id": "CreateServiceAccountRequest"
}
},
- "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": "iam",
"auth": {
"oauth2": {
@@ -1671,5 +633,1043 @@
}
}
}
- }
+ },
+ "rootUrl": "https://iam.googleapis.com/",
+ "ownerDomain": "google.com",
+ "name": "iam",
+ "batchPath": "batch",
+ "fullyEncodeReservedExpansion": true,
+ "title": "Google Identity and Access Management (IAM) API",
+ "ownerName": "Google",
+ "resources": {
+ "organizations": {
+ "resources": {
+ "roles": {
+ "methods": {
+ "delete": {
+ "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.",
+ "response": {
+ "$ref": "Role"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "DELETE",
+ "parameters": {
+ "name": {
+ "description": "The resource name of the role in one of the following formats:\n`organizations/{ORGANIZATION_ID}/roles/{ROLE_NAME}`\n`projects/{PROJECT_ID}/roles/{ROLE_NAME}`",
+ "required": true,
+ "type": "string",
+ "pattern": "^organizations/[^/]+/roles/[^/]+$",
+ "location": "path"
+ },
+ "etag": {
+ "description": "Used to perform a consistent read-modify-write.",
+ "format": "byte",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/organizations/{organizationsId}/roles/{rolesId}"
+ },
+ "list": {
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "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": {
+ "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"
+ }
+ },
+ "flatPath": "v1/organizations/{organizationsId}/roles",
+ "id": "iam.organizations.roles.list",
+ "path": "v1/{+parent}/roles",
+ "description": "Lists the Roles defined on a resource.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "parent"
+ ],
+ "response": {
+ "$ref": "ListRolesResponse"
+ }
+ },
+ "create": {
+ "parameters": {
+ "parent": {
+ "pattern": "^organizations/[^/]+$",
+ "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/organizations/{organizationsId}/roles",
+ "path": "v1/{+parent}/roles",
+ "id": "iam.organizations.roles.create",
+ "request": {
+ "$ref": "CreateRoleRequest"
+ },
+ "description": "Creates a new Role.",
+ "response": {
+ "$ref": "Role"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "POST"
+ },
+ "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": {
+ "path": "v1/{+name}",
+ "id": "iam.organizations.roles.get",
+ "description": "Gets a Role definition.",
+ "response": {
+ "$ref": "Role"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "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`roles/{ROLE_NAME}`\n`organizations/{ORGANIZATION_ID}/roles/{ROLE_NAME}`\n`projects/{PROJECT_ID}/roles/{ROLE_NAME}`",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1/organizations/{organizationsId}/roles/{rolesId}"
+ },
+ "patch": {
+ "httpMethod": "PATCH",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Role"
+ },
+ "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"
+ },
+ "updateMask": {
+ "description": "A mask describing which fields in the Role have changed.",
+ "format": "google-fieldmask",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/organizations/{organizationsId}/roles/{rolesId}",
+ "id": "iam.organizations.roles.patch",
+ "path": "v1/{+name}",
+ "request": {
+ "$ref": "Role"
+ },
+ "description": "Updates a Role definition."
+ }
+ }
+ }
+ }
+ },
+ "projects": {
+ "resources": {
+ "serviceAccounts": {
+ "methods": {
+ "testIamPermissions": {
+ "description": "Tests the specified permissions against the IAM access control policy\nfor a ServiceAccount.",
+ "request": {
+ "$ref": "TestIamPermissionsRequest"
+ },
+ "response": {
+ "$ref": "TestIamPermissionsResponse"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "resource": {
+ "pattern": "^projects/[^/]+/serviceAccounts/[^/]+$",
+ "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}/serviceAccounts/{serviceAccountsId}:testIamPermissions",
+ "path": "v1/{+resource}:testIamPermissions",
+ "id": "iam.projects.serviceAccounts.testIamPermissions"
+ },
+ "delete": {
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "DELETE",
+ "parameters": {
+ "name": {
+ "description": "The resource name of the service account in the following format:\n`projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`.\nUsing `-` as a wildcard for the `PROJECT_ID` will infer the project from\nthe account. The `ACCOUNT` value can be the `email` address or the\n`unique_id` of the service account.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/serviceAccounts/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}",
+ "path": "v1/{+name}",
+ "id": "iam.projects.serviceAccounts.delete",
+ "description": "Deletes a ServiceAccount."
+ },
+ "signBlob": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "SignBlobResponse"
+ },
+ "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}:signBlob",
+ "id": "iam.projects.serviceAccounts.signBlob",
+ "path": "v1/{+name}:signBlob",
+ "request": {
+ "$ref": "SignBlobRequest"
+ },
+ "description": "Signs a blob using a service account's system-managed private key."
+ },
+ "list": {
+ "response": {
+ "$ref": "ListServiceAccountsResponse"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "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"
+ },
+ "pageToken": {
+ "description": "Optional pagination token returned in an earlier\nListServiceAccountsResponse.next_page_token.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageSize": {
+ "description": "Optional limit on the number of service accounts to include in the\nresponse. Further accounts can subsequently be obtained by including the\nListServiceAccountsResponse.next_page_token\nin a subsequent request.",
+ "format": "int32",
+ "type": "integer",
+ "location": "query"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectsId}/serviceAccounts",
+ "path": "v1/{+name}/serviceAccounts",
+ "id": "iam.projects.serviceAccounts.list",
+ "description": "Lists ServiceAccounts for a project."
+ },
+ "create": {
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "description": "Required. The resource name of the project associated with the service\naccounts, such as `projects/my-project-123`.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/serviceAccounts",
+ "path": "v1/{+name}/serviceAccounts",
+ "id": "iam.projects.serviceAccounts.create",
+ "description": "Creates a ServiceAccount\nand returns it.",
+ "request": {
+ "$ref": "CreateServiceAccountRequest"
+ },
+ "response": {
+ "$ref": "ServiceAccount"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "POST"
+ },
+ "setIamPolicy": {
+ "response": {
+ "$ref": "Policy"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "resource": {
+ "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/serviceAccounts/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "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",
+ "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",
+ "path": "v1/{+name}:signJwt",
+ "id": "iam.projects.serviceAccounts.signJwt",
+ "request": {
+ "$ref": "SignJwtRequest"
+ },
+ "description": "Signs a JWT using a service account's system-managed private key.\n\nIf no expiry time (`exp`) is provided in the `SignJwtRequest`, IAM sets an\nan expiry time of one hour by default. If you request an expiry time of\nmore than one hour, the request will fail."
+ },
+ "getIamPolicy": {
+ "httpMethod": "POST",
+ "response": {
+ "$ref": "Policy"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "parameters": {
+ "resource": {
+ "pattern": "^projects/[^/]+/serviceAccounts/[^/]+$",
+ "location": "path",
+ "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}:getIamPolicy",
+ "id": "iam.projects.serviceAccounts.getIamPolicy",
+ "path": "v1/{+resource}:getIamPolicy",
+ "description": "Returns the IAM access control policy for a\nServiceAccount."
+ },
+ "get": {
+ "response": {
+ "$ref": "ServiceAccount"
+ },
+ "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"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}",
+ "path": "v1/{+name}",
+ "id": "iam.projects.serviceAccounts.get",
+ "description": "Gets a ServiceAccount."
+ },
+ "update": {
+ "response": {
+ "$ref": "ServiceAccount"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "PUT",
+ "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}`.\n\nRequests using `-` as a wildcard for the `PROJECT_ID` will infer the\nproject from the `account` and the `ACCOUNT` value can be the `email`\naddress or the `unique_id` of the service account.\n\nIn responses the resource name will always be in the format\n`projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/serviceAccounts/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}",
+ "path": "v1/{+name}",
+ "id": "iam.projects.serviceAccounts.update",
+ "description": "Updates a ServiceAccount.\n\nCurrently, only the following fields are updatable:\n`display_name` .\nThe `etag` is mandatory.",
+ "request": {
+ "$ref": "ServiceAccount"
+ }
+ }
+ },
+ "resources": {
+ "keys": {
+ "methods": {
+ "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": {
+ "path": "v1/{+name}/keys",
+ "id": "iam.projects.serviceAccounts.keys.list",
+ "description": "Lists ServiceAccountKeys.",
+ "response": {
+ "$ref": "ListServiceAccountKeysResponse"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "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}`.\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"
+ },
+ "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"
+ ]
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}/keys"
+ },
+ "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."
+ },
+ "create": {
+ "request": {
+ "$ref": "CreateServiceAccountKeyRequest"
+ },
+ "description": "Creates a ServiceAccountKey\nand returns it.",
+ "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"
+ }
+ }
+ }
+ }
+ },
+ "roles": {
+ "methods": {
+ "patch": {
+ "request": {
+ "$ref": "Role"
+ },
+ "description": "Updates a Role definition.",
+ "httpMethod": "PATCH",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Role"
+ },
+ "parameters": {
+ "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"
+ },
+ "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/projects/{projectsId}/roles/{rolesId}",
+ "id": "iam.projects.roles.patch",
+ "path": "v1/{+name}"
+ },
+ "undelete": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Role"
+ },
+ "parameters": {
+ "name": {
+ "description": "The resource name of the role in one of the following formats:\n`organizations/{ORGANIZATION_ID}/roles/{ROLE_NAME}`\n`projects/{PROJECT_ID}/roles/{ROLE_NAME}`",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/roles/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectsId}/roles/{rolesId}:undelete",
+ "id": "iam.projects.roles.undelete",
+ "path": "v1/{+name}:undelete",
+ "request": {
+ "$ref": "UndeleteRoleRequest"
+ },
+ "description": "Undelete a Role, bringing it back in its previous state."
+ },
+ "get": {
+ "id": "iam.projects.roles.get",
+ "path": "v1/{+name}",
+ "description": "Gets a Role definition.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Role"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "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"
+ }
+ },
+ "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"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "DELETE",
+ "parameters": {
+ "name": {
+ "description": "The resource name of the role in one of the following formats:\n`organizations/{ORGANIZATION_ID}/roles/{ROLE_NAME}`\n`projects/{PROJECT_ID}/roles/{ROLE_NAME}`",
+ "required": true,
+ "type": "string",
+ "pattern": "^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}",
+ "path": "v1/{+name}",
+ "id": "iam.projects.roles.delete"
+ },
+ "list": {
+ "response": {
+ "$ref": "ListRolesResponse"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "parent": {
+ "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"
+ },
+ "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"
+ ]
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectsId}/roles",
+ "path": "v1/{+parent}/roles",
+ "id": "iam.projects.roles.list",
+ "description": "Lists the Roles defined on a resource."
+ },
+ "create": {
+ "response": {
+ "$ref": "Role"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "parent": {
+ "description": "The resource name of the parent resource in one of the following formats:\n`organizations/{ORGANIZATION_ID}`\n`projects/{PROJECT_ID}`",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/roles",
+ "path": "v1/{+parent}/roles",
+ "id": "iam.projects.roles.create",
+ "description": "Creates a new Role.",
+ "request": {
+ "$ref": "CreateRoleRequest"
+ }
+ }
+ }
+ }
+ }
+ },
+ "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": {
+ "id": "iam.roles.list",
+ "path": "v1/roles",
+ "description": "Lists the Roles defined on a resource.",
+ "httpMethod": "GET",
+ "parameterOrder": [],
+ "response": {
+ "$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}`",
+ "type": "string",
+ "location": "query"
+ },
+ "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": {
+ "location": "query",
+ "enum": [
+ "BASIC",
+ "FULL"
+ ],
+ "description": "Optional view for the returned Role objects.",
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/roles"
+ },
+ "get": {
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The resource name of the role in one of the following formats:\n`roles/{ROLE_NAME}`\n`organizations/{ORGANIZATION_ID}/roles/{ROLE_NAME}`\n`projects/{PROJECT_ID}/roles/{ROLE_NAME}`",
+ "required": true,
+ "type": "string",
+ "pattern": "^roles/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/roles/{rolesId}",
+ "path": "v1/{+name}",
+ "id": "iam.roles.get",
+ "description": "Gets a Role definition.",
+ "response": {
+ "$ref": "Role"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET"
+ }
+ }
+ },
+ "permissions": {
+ "methods": {
+ "queryTestablePermissions": {
+ "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",
+ "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"
+ }
+ }
+ }
+ }
+ },
+ "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": {
+ "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"
+ },
+ "upload_protocol": {
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "type": "string",
+ "location": "query"
+ },
+ "prettyPrint": {
+ "location": "query",
+ "description": "Returns response with indentations and line breaks.",
+ "type": "boolean",
+ "default": "true"
+ },
+ "fields": {
+ "location": "query",
+ "description": "Selector specifying which fields to include in a partial response.",
+ "type": "string"
+ },
+ "uploadType": {
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "version": "v1",
+ "baseUrl": "https://iam.googleapis.com/",
+ "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": ""
}
diff --git a/iam/v1/iam-gen.go b/iam/v1/iam-gen.go
index 23f6264..e4b0a33 100644
--- a/iam/v1/iam-gen.go
+++ b/iam/v1/iam-gen.go
@@ -655,7 +655,7 @@
// }
//
// For a description of IAM and its features, see the
-// [IAM developer's guide](https://cloud.google.com/iam).
+// [IAM developer's guide](https://cloud.google.com/iam/docs).
type Policy struct {
// Bindings: Associates a list of `members` to a `role`.
// `bindings` with no members will result in an error.
@@ -681,7 +681,7 @@
// policy is overwritten blindly.
Etag string `json:"etag,omitempty"`
- // Version: Version of the `Policy`. The default version is 0.
+ // Version: Deprecated.
Version int64 `json:"version,omitempty"`
// ServerResponse contains the HTTP response code and headers from the
diff --git a/kgsearch/v1/kgsearch-api.json b/kgsearch/v1/kgsearch-api.json
index 6dc113b..5b7a4156 100644
--- a/kgsearch/v1/kgsearch-api.json
+++ b/kgsearch/v1/kgsearch-api.json
@@ -1,21 +1,40 @@
{
- "id": "kgsearch:v1",
- "documentationLink": "https://developers.google.com/knowledge-graph/",
- "revision": "20171103",
- "title": "Knowledge Graph Search API",
- "ownerName": "Google",
"discoveryVersion": "v1",
+ "ownerName": "Google",
"version_module": true,
"resources": {
"entities": {
"methods": {
"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",
"response": {
"$ref": "SearchResponse"
},
"parameterOrder": [],
"httpMethod": "GET",
"parameters": {
+ "query": {
+ "location": "query",
+ "description": "The literal query string for search.",
+ "type": "string"
+ },
+ "types": {
+ "repeated": true,
+ "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"
+ },
+ "indent": {
+ "location": "query",
+ "description": "Enables indenting of json results.",
+ "type": "boolean"
+ },
+ "languages": {
+ "description": "The list of language codes (defined in ISO 693) to run the query with,\ne.g. 'en'.",
+ "type": "string",
+ "repeated": true,
+ "location": "query"
+ },
"ids": {
"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",
@@ -32,64 +51,41 @@
"description": "Enables prefix match against names and aliases of entities",
"type": "boolean",
"location": "query"
- },
- "query": {
- "description": "The literal query string for search.",
- "type": "string",
- "location": "query"
- },
- "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": {
- "description": "Enables indenting of json results.",
- "type": "boolean",
- "location": "query"
- },
- "languages": {
- "type": "string",
- "repeated": true,
- "location": "query",
- "description": "The list of language codes (defined in ISO 693) to run the query with,\ne.g. 'en'."
}
},
"flatPath": "v1/entities:search",
"path": "v1/entities:search",
- "id": "kgsearch.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"
+ "id": "kgsearch.entities.search"
}
}
}
},
"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": {
- "location": "query",
- "description": "Pretty-print response.",
"type": "boolean",
- "default": "true"
+ "default": "true",
+ "location": "query",
+ "description": "Pretty-print response."
+ },
+ "bearer_token": {
+ "description": "OAuth bearer token.",
+ "type": "string",
+ "location": "query"
},
"oauth_token": {
"description": "OAuth 2.0 token for the current user.",
"type": "string",
"location": "query"
},
- "bearer_token": {
- "location": "query",
- "description": "OAuth bearer token.",
- "type": "string"
- },
"upload_protocol": {
- "location": "query",
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"prettyPrint": {
"location": "query",
@@ -103,9 +99,14 @@
"type": "string"
},
"fields": {
+ "location": "query",
"description": "Selector specifying which fields to include in a partial response.",
+ "type": "string"
+ },
+ "callback": {
"type": "string",
- "location": "query"
+ "location": "query",
+ "description": "JSONP"
},
"$.xgafv": {
"enum": [
@@ -120,17 +121,7 @@
],
"location": "query"
},
- "callback": {
- "description": "JSONP",
- "type": "string",
- "location": "query"
- },
"alt": {
- "enum": [
- "json",
- "media",
- "proto"
- ],
"type": "string",
"enumDescriptions": [
"Responses with Content-Type of application/json",
@@ -139,25 +130,33 @@
],
"location": "query",
"description": "Data format for response.",
- "default": "json"
+ "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"
+ "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"
+ "description": "OAuth access token."
}
},
"schemas": {
"SearchResponse": {
- "id": "SearchResponse",
"description": "Response message includes the context and a list of matching results\nwhich contain the detail of associated entities.",
"type": "object",
"properties": {
+ "@type": {
+ "description": "The schema type of top-level JSON-LD object, e.g. ItemList.",
+ "type": "any"
+ },
"@context": {
"description": "The local context applicable for the response. See more details at\nhttp://www.w3.org/TR/json-ld/#context-definitions.",
"type": "any"
@@ -168,18 +167,15 @@
"items": {
"type": "any"
}
- },
- "@type": {
- "description": "The schema type of top-level JSON-LD object, e.g. ItemList.",
- "type": "any"
}
- }
+ },
+ "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"
},
"version": "v1",
"baseUrl": "https://kgsearch.googleapis.com/",
@@ -190,5 +186,9 @@
"basePath": "",
"ownerDomain": "google.com",
"name": "kgsearch",
- "batchPath": "batch"
+ "batchPath": "batch",
+ "id": "kgsearch:v1",
+ "documentationLink": "https://developers.google.com/knowledge-graph/",
+ "revision": "20171103",
+ "title": "Knowledge Graph Search API"
}
diff --git a/language/v1/language-api.json b/language/v1/language-api.json
index 542c9cb..63da3b9 100644
--- a/language/v1/language-api.json
+++ b/language/v1/language-api.json
@@ -1,31 +1,577 @@
{
+ "batchPath": "batch",
+ "title": "Google Cloud Natural Language API",
+ "ownerName": "Google",
+ "resources": {
+ "documents": {
+ "methods": {
+ "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"
+ },
+ "httpMethod": "POST",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "AnalyzeSyntaxResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-language",
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {},
+ "flatPath": "v1/documents:analyzeSyntax",
+ "id": "language.documents.analyzeSyntax",
+ "path": "v1/documents:analyzeSyntax"
+ },
+ "annotateText": {
+ "response": {
+ "$ref": "AnnotateTextResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-language",
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {},
+ "flatPath": "v1/documents:annotateText",
+ "path": "v1/documents:annotateText",
+ "id": "language.documents.annotateText",
+ "description": "A convenience method that provides all the features that analyzeSentiment,\nanalyzeEntities, and analyzeSyntax provide in one call.",
+ "request": {
+ "$ref": "AnnotateTextRequest"
+ }
+ },
+ "classifyText": {
+ "request": {
+ "$ref": "ClassifyTextRequest"
+ },
+ "description": "Classifies a document into categories.",
+ "httpMethod": "POST",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "ClassifyTextResponse"
+ },
+ "parameters": {},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-language",
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/documents:classifyText",
+ "id": "language.documents.classifyText",
+ "path": "v1/documents:classifyText"
+ },
+ "analyzeSentiment": {
+ "request": {
+ "$ref": "AnalyzeSentimentRequest"
+ },
+ "description": "Analyzes the sentiment of the provided text.",
+ "httpMethod": "POST",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "AnalyzeSentimentResponse"
+ },
+ "parameters": {},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-language",
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/documents:analyzeSentiment",
+ "id": "language.documents.analyzeSentiment",
+ "path": "v1/documents:analyzeSentiment"
+ },
+ "analyzeEntitySentiment": {
+ "description": "Finds entities, similar to AnalyzeEntities in the text and analyzes\nsentiment associated with each entity and its mentions.",
+ "request": {
+ "$ref": "AnalyzeEntitySentimentRequest"
+ },
+ "response": {
+ "$ref": "AnalyzeEntitySentimentResponse"
+ },
+ "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"
+ },
+ "analyzeEntities": {
+ "httpMethod": "POST",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "AnalyzeEntitiesResponse"
+ },
+ "parameters": {},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-language",
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/documents:analyzeEntities",
+ "id": "language.documents.analyzeEntities",
+ "path": "v1/documents:analyzeEntities",
+ "request": {
+ "$ref": "AnalyzeEntitiesRequest"
+ },
+ "description": "Finds named entities (currently proper names and common nouns) in the text\nalong with entity types, salience, mentions for each entity, and\nother properties."
+ }
+ }
+ }
+ },
+ "parameters": {
+ "bearer_token": {
+ "location": "query",
+ "description": "OAuth bearer token.",
+ "type": "string"
+ },
+ "oauth_token": {
+ "location": "query",
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string"
+ },
+ "upload_protocol": {
+ "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"
+ },
+ "callback": {
+ "description": "JSONP",
+ "type": "string",
+ "location": "query"
+ },
+ "$.xgafv": {
+ "type": "string",
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query",
+ "enum": [
+ "1",
+ "2"
+ ],
+ "description": "V1 error format."
+ },
+ "alt": {
+ "type": "string",
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query",
+ "description": "Data format for response.",
+ "default": "json",
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ]
+ },
+ "key": {
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "type": "string",
+ "location": "query"
+ },
+ "access_token": {
+ "location": "query",
+ "description": "OAuth access token.",
+ "type": "string"
+ },
+ "quotaUser": {
+ "location": "query",
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "type": "string"
+ },
+ "pp": {
+ "description": "Pretty-print response.",
+ "type": "boolean",
+ "default": "true",
+ "location": "query"
+ }
+ },
+ "version": "v1",
+ "baseUrl": "https://language.googleapis.com/",
+ "description": "Provides natural language understanding technologies to developers. Examples include sentiment analysis, entity recognition, entity sentiment analysis, and text annotations.",
+ "kind": "discovery#restDescription",
+ "servicePath": "",
+ "basePath": "",
+ "revision": "20171231",
+ "documentationLink": "https://cloud.google.com/natural-language/",
+ "id": "language:v1",
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
- "AnalyzeSyntaxResponse": {
+ "AnalyzeSyntaxRequest": {
+ "type": "object",
+ "properties": {
+ "encodingType": {
+ "enum": [
+ "NONE",
+ "UTF8",
+ "UTF16",
+ "UTF32"
+ ],
+ "description": "The encoding type used by the API to calculate offsets.",
+ "type": "string",
+ "enumDescriptions": [
+ "If `EncodingType` is not specified, encoding-dependent information (such as\n`begin_offset`) will be set at `-1`.",
+ "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-8 encoding of the input. C++ and Go are examples of languages\nthat use this encoding natively.",
+ "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-16 encoding of the input. Java and Javascript are examples of\nlanguages that use this encoding natively.",
+ "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-32 encoding of the input. Python is an example of a language\nthat uses this encoding natively."
+ ]
+ },
+ "document": {
+ "description": "Input document.",
+ "$ref": "Document"
+ }
+ },
+ "id": "AnalyzeSyntaxRequest",
+ "description": "The syntax analysis request message."
+ },
+ "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": {
+ "name": {
+ "description": "The representative name for the entity.",
+ "type": "string"
+ },
+ "type": {
+ "description": "The entity type.",
"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."
+ "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."
+ },
+ "mentions": {
+ "description": "The mentions of this entity in the input document. The API currently\nsupports proper noun mentions.",
+ "type": "array",
+ "items": {
+ "$ref": "EntityMention"
+ }
+ }
+ }
+ },
+ "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": {
+ "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"
+ },
+ "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": {
+ "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": {
+ "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"
+ }
+ }
+ }
+ },
+ "Features": {
+ "type": "object",
+ "properties": {
+ "extractEntities": {
+ "description": "Extract entities.",
+ "type": "boolean"
+ },
+ "classifyText": {
+ "description": "Classify the full document into categories.",
+ "type": "boolean"
+ },
+ "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"
+ }
+ },
+ "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."
+ },
+ "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": {
+ "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"
+ }
+ },
+ "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": {
+ "description": "Input document.",
+ "$ref": "Document"
+ }
+ },
+ "id": "AnalyzeEntitiesRequest"
+ },
+ "ClassifyTextRequest": {
+ "type": "object",
+ "properties": {
+ "document": {
+ "description": "Input document.",
+ "$ref": "Document"
+ }
+ },
+ "id": "ClassifyTextRequest",
+ "description": "The document classification request message."
+ },
+ "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": {
+ "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"
- },
- "description": "Sentences in the input document."
+ }
+ }
+ },
+ "id": "AnalyzeSentimentResponse"
+ },
+ "AnalyzeSyntaxResponse": {
+ "description": "The syntax analysis response message.",
+ "type": "object",
+ "properties": {
+ "language": {
+ "description": "The language of the text, which will be the same as the language specified\nin the request or, if not specified, the automatically-detected language.\nSee Document.language field for more details.",
+ "type": "string"
+ },
+ "sentences": {
+ "description": "Sentences in the input document.",
+ "type": "array",
+ "items": {
+ "$ref": "Sentence"
+ }
},
"tokens": {
+ "description": "Tokens, along with their syntactic information, in the input document.",
"type": "array",
"items": {
"$ref": "Token"
- },
- "description": "Tokens, along with their syntactic information, in the input document."
+ }
}
},
- "id": "AnalyzeSyntaxResponse",
- "description": "The syntax analysis response message."
+ "id": "AnalyzeSyntaxResponse"
},
"AnnotateTextResponse": {
"type": "object",
@@ -59,12 +605,12 @@
}
},
"documentSentiment": {
- "$ref": "Sentiment",
- "description": "The overall sentiment for the document. Populated if the user enables\nAnnotateTextRequest.Features.extract_document_sentiment."
+ "description": "The overall sentiment for the document. Populated if the user enables\nAnnotateTextRequest.Features.extract_document_sentiment.",
+ "$ref": "Sentiment"
},
"language": {
- "type": "string",
- "description": "The language of the text, which will be the same as the language specified\nin the request or, if not specified, the automatically-detected language.\nSee Document.language field for more details."
+ "description": "The language of the text, which will be the same as the language specified\nin the request or, if not specified, the automatically-detected language.\nSee Document.language field for more details.",
+ "type": "string"
}
},
"id": "AnnotateTextResponse",
@@ -75,7 +621,6 @@
"type": "object",
"properties": {
"label": {
- "type": "string",
"enumDescriptions": [
"Unknown",
"Abbreviation modifier",
@@ -246,18 +791,18 @@
"MES",
"NCOMP"
],
- "description": "The parse label for the token."
+ "description": "The parse label for the token.",
+ "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": {
- "type": "object",
"properties": {
"text": {
"$ref": "TextSpan",
@@ -268,8 +813,8 @@
"description": "Dependency tree parse for this token."
},
"lemma": {
- "type": "string",
- "description": "[Lemma](https://en.wikipedia.org/wiki/Lemma_%28morphology%29) of the token."
+ "description": "[Lemma](https://en.wikipedia.org/wiki/Lemma_%28morphology%29) of the token.",
+ "type": "string"
},
"partOfSpeech": {
"$ref": "PartOfSpeech",
@@ -277,25 +822,28 @@
}
},
"id": "Token",
- "description": "Represents the smallest syntactic building block of the text."
+ "description": "Represents the smallest syntactic building block of the text.",
+ "type": "object"
},
"TextSpan": {
+ "id": "TextSpan",
+ "description": "Represents an output piece of text.",
"type": "object",
"properties": {
+ "beginOffset": {
+ "description": "The API calculates the beginning offset of the content in the original\ndocument according to the EncodingType specified in the API request.",
+ "format": "int32",
+ "type": "integer"
+ },
"content": {
"description": "The content of the output text.",
"type": "string"
- },
- "beginOffset": {
- "type": "integer",
- "description": "The API calculates the beginning offset of the content in the original\ndocument according to the EncodingType specified in the API request.",
- "format": "int32"
}
- },
- "id": "TextSpan",
- "description": "Represents an output piece of text."
+ }
},
"ClassifyTextResponse": {
+ "id": "ClassifyTextResponse",
+ "description": "The document classification response message.",
"type": "object",
"properties": {
"categories": {
@@ -305,19 +853,18 @@
"$ref": "ClassificationCategory"
}
}
- },
- "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."
+ "description": "The mention text.",
+ "$ref": "TextSpan"
},
"type": {
+ "description": "The type of the entity mention.",
"type": "string",
"enumDescriptions": [
"Unknown",
@@ -328,8 +875,7 @@
"TYPE_UNKNOWN",
"PROPER",
"COMMON"
- ],
- "description": "The type of the entity mention."
+ ]
},
"sentiment": {
"$ref": "Sentiment",
@@ -339,21 +885,23 @@
"id": "EntityMention"
},
"Sentence": {
+ "description": "Represents a sentence in the input document.",
"type": "object",
"properties": {
+ "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"
+ },
"text": {
"$ref": "TextSpan",
"description": "The sentence text."
- },
- "sentiment": {
- "$ref": "Sentiment",
- "description": "For calls to AnalyzeSentiment or if\nAnnotateTextRequest.Features.extract_document_sentiment is set to\ntrue, this field will contain the sentiment for the sentence."
}
},
- "id": "Sentence",
- "description": "Represents a sentence in the input document."
+ "id": "Sentence"
},
"Sentiment": {
+ "id": "Sentiment",
+ "description": "Represents the feeling associated with the entire text or entities in\nthe text.",
"type": "object",
"properties": {
"score": {
@@ -366,14 +914,23 @@
"format": "float",
"type": "number"
}
- },
- "id": "Sentiment",
- "description": "Represents the feeling associated with the entire text or entities in\nthe text."
+ }
},
"AnalyzeEntitySentimentRequest": {
+ "description": "The entity-level sentiment analysis request message.",
"type": "object",
"properties": {
+ "document": {
+ "$ref": "Document",
+ "description": "Input document."
+ },
"encodingType": {
+ "enumDescriptions": [
+ "If `EncodingType` is not specified, encoding-dependent information (such as\n`begin_offset`) will be set at `-1`.",
+ "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-8 encoding of the input. C++ and Go are examples of languages\nthat use this encoding natively.",
+ "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-16 encoding of the input. Java and Javascript are examples of\nlanguages that use this encoding natively.",
+ "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-32 encoding of the input. Python is an example of a language\nthat uses this encoding natively."
+ ],
"enum": [
"NONE",
"UTF8",
@@ -381,27 +938,15 @@
"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."
+ "type": "string"
}
},
- "id": "AnalyzeEntitySentimentRequest",
- "description": "The entity-level sentiment analysis request message."
+ "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": {
+ "description": "The grammatical form.",
"type": "string",
"enumDescriptions": [
"Form is not applicable in the analyzed language or is not predicted.",
@@ -430,10 +975,15 @@
"LONG",
"ORDER",
"SPECIFIC"
- ],
- "description": "The grammatical form."
+ ]
},
"number": {
+ "enumDescriptions": [
+ "Number is not applicable in the analyzed language or is not predicted.",
+ "Singular",
+ "Plural",
+ "Dual"
+ ],
"enum": [
"NUMBER_UNKNOWN",
"SINGULAR",
@@ -441,15 +991,15 @@
"DUAL"
],
"description": "The grammatical number.",
- "type": "string",
- "enumDescriptions": [
- "Number is not applicable in the analyzed language or is not predicted.",
- "Singular",
- "Plural",
- "Dual"
- ]
+ "type": "string"
},
"voice": {
+ "enumDescriptions": [
+ "Voice is not applicable in the analyzed language or is not predicted.",
+ "Active",
+ "Causative",
+ "Passive"
+ ],
"enum": [
"VOICE_UNKNOWN",
"ACTIVE",
@@ -457,13 +1007,7 @@
"PASSIVE"
],
"description": "The grammatical voice.",
- "type": "string",
- "enumDescriptions": [
- "Voice is not applicable in the analyzed language or is not predicted.",
- "Active",
- "Causative",
- "Passive"
- ]
+ "type": "string"
},
"aspect": {
"enum": [
@@ -482,15 +1026,6 @@
]
},
"mood": {
- "enum": [
- "MOOD_UNKNOWN",
- "CONDITIONAL_MOOD",
- "IMPERATIVE",
- "INDICATIVE",
- "INTERROGATIVE",
- "JUSSIVE",
- "SUBJUNCTIVE"
- ],
"description": "The grammatical mood.",
"type": "string",
"enumDescriptions": [
@@ -501,6 +1036,15 @@
"Interrogative",
"Jussive",
"Subjunctive"
+ ],
+ "enum": [
+ "MOOD_UNKNOWN",
+ "CONDITIONAL_MOOD",
+ "IMPERATIVE",
+ "INDICATIVE",
+ "INTERROGATIVE",
+ "JUSSIVE",
+ "SUBJUNCTIVE"
]
},
"tag": {
@@ -540,7 +1084,6 @@
]
},
"gender": {
- "type": "string",
"enumDescriptions": [
"Gender is not applicable in the analyzed language or is not predicted.",
"Feminine",
@@ -553,9 +1096,17 @@
"MASCULINE",
"NEUTER"
],
- "description": "The grammatical gender."
+ "description": "The grammatical gender.",
+ "type": "string"
},
"person": {
+ "enumDescriptions": [
+ "Person is not applicable in the analyzed language or is not predicted.",
+ "First",
+ "Second",
+ "Third",
+ "Reflexive"
+ ],
"enum": [
"PERSON_UNKNOWN",
"FIRST",
@@ -564,14 +1115,7 @@
"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": {
"type": "string",
@@ -588,23 +1132,6 @@
"description": "The grammatical properness."
},
"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": [
@@ -623,10 +1150,26 @@
"Reflexive",
"Relative",
"Vocative"
+ ],
+ "enum": [
+ "CASE_UNKNOWN",
+ "ACCUSATIVE",
+ "ADVERBIAL",
+ "COMPLEMENTIVE",
+ "DATIVE",
+ "GENITIVE",
+ "INSTRUMENTAL",
+ "LOCATIVE",
+ "NOMINATIVE",
+ "OBLIQUE",
+ "PARTITIVE",
+ "PREPOSITIONAL",
+ "REFLEXIVE_CASE",
+ "RELATIVE_CASE",
+ "VOCATIVE"
]
},
"tense": {
- "type": "string",
"enumDescriptions": [
"Tense is not applicable in the analyzed language or is not predicted.",
"Conditional",
@@ -645,10 +1188,10 @@
"IMPERFECT",
"PLUPERFECT"
],
- "description": "The grammatical tense."
+ "description": "The grammatical tense.",
+ "type": "string"
},
"reciprocity": {
- "type": "string",
"enumDescriptions": [
"Reciprocity is not applicable in the analyzed language or is not\npredicted.",
"Reciprocal",
@@ -659,593 +1202,50 @@
"RECIPROCAL",
"NON_RECIPROCAL"
],
- "description": "The grammatical reciprocity."
+ "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": {
- "type": "object",
"properties": {
"confidence": {
- "type": "number",
"description": "The classifier's confidence of the category. Number represents how certain\nthe classifier is that this category represents the given text.",
- "format": "float"
+ "format": "float",
+ "type": "number"
},
"name": {
- "type": "string",
- "description": "The name of the category representing the document."
+ "description": "The name of the category representing the document.",
+ "type": "string"
}
},
"id": "ClassificationCategory",
- "description": "Represents a category returned from the text classifier."
- },
- "AnalyzeSyntaxRequest": {
- "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": "AnalyzeSyntaxRequest",
- "description": "The syntax analysis request message."
- },
- "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": {
- "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": "AnalyzeEntitiesResponse"
- },
- "Entity": {
- "type": "object",
- "properties": {
- "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": [
- "Unknown",
- "Person",
- "Location",
- "Organization",
- "Event",
- "Work of art",
- "Consumer goods",
- "Other types"
- ]
- },
- "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": {
- "type": "number",
- "description": "The salience score associated with the entity in the [0, 1.0] range.\n\nThe salience score for an entity provides information about the\nimportance or centrality of that entity to the entire document text.\nScores closer to 0 are less salient, while scores closer to 1.0 are highly\nsalient.",
- "format": "float"
- },
- "sentiment": {
- "$ref": "Sentiment",
- "description": "For calls to AnalyzeEntitySentiment or if\nAnnotateTextRequest.Features.extract_entity_sentiment is set to\ntrue, this field will contain the aggregate sentiment expressed for this\nentity in the provided document."
- },
- "mentions": {
- "description": "The mentions of this entity in the input document. The API currently\nsupports proper noun mentions.",
- "type": "array",
- "items": {
- "$ref": "EntityMention"
- }
- }
- },
- "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."
- },
- "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": {
- "enum": [
- "NONE",
- "UTF8",
- "UTF16",
- "UTF32"
- ],
- "description": "The encoding type used by the API to calculate sentence 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": "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": {
- "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": {
- "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."
- }
- },
- "id": "Status"
- },
- "Features": {
- "type": "object",
- "properties": {
- "extractSyntax": {
- "type": "boolean",
- "description": "Extract syntax information."
- },
- "extractDocumentSentiment": {
- "type": "boolean",
- "description": "Extract document-level sentiment."
- },
- "extractEntitySentiment": {
- "type": "boolean",
- "description": "Extract entities and their associated sentiment."
- },
- "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."
- },
- "Document": {
- "type": "object",
- "properties": {
- "language": {
- "description": "The language of the document (if not specified, the language is\nautomatically detected). Both ISO and BCP-47 language codes are\naccepted.\u003cbr\u003e\n[Language Support](/natural-language/docs/languages)\nlists currently supported languages for each API method.\nIf the language (either specified by the caller or automatically detected)\nis not supported by the called API method, an `INVALID_ARGUMENT` error\nis returned.",
- "type": "string"
- },
- "type": {
- "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"
- }
- },
- "id": "Document",
- "description": "################################################################ #\n\nRepresents the input to API methods."
- },
- "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"
- },
- "ClassifyTextRequest": {
- "description": "The document classification request message.",
- "type": "object",
- "properties": {
- "document": {
- "$ref": "Document",
- "description": "Input document."
- }
- },
- "id": "ClassifyTextRequest"
- },
- "AnalyzeEntitySentimentResponse": {
- "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",
- "description": "The entity-level sentiment analysis response message."
- },
- "AnalyzeSentimentResponse": {
- "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": {
- "type": "array",
- "items": {
- "$ref": "Sentence"
- },
- "description": "The sentiment for all the sentences in the document."
- }
- },
- "id": "AnalyzeSentimentResponse",
- "description": "The sentiment analysis response message."
+ "description": "Represents a category returned from the text classifier.",
+ "type": "object"
}
},
"icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
+ "x32": "http://www.google.com/images/icons/product/search-32.gif",
+ "x16": "http://www.google.com/images/icons/product/search-16.gif"
},
"protocol": "rest",
"canonicalName": "Cloud Natural Language",
"auth": {
"oauth2": {
"scopes": {
- "https://www.googleapis.com/auth/cloud-platform": {
- "description": "View and manage your data across Google Cloud Platform services"
- },
"https://www.googleapis.com/auth/cloud-language": {
"description": "Apply machine learning models to reveal the structure and meaning of text"
+ },
+ "https://www.googleapis.com/auth/cloud-platform": {
+ "description": "View and manage your data across Google Cloud Platform services"
}
}
}
},
"rootUrl": "https://language.googleapis.com/",
"ownerDomain": "google.com",
- "name": "language",
- "batchPath": "batch",
- "title": "Google Cloud Natural Language API",
- "ownerName": "Google",
- "resources": {
- "documents": {
- "methods": {
- "analyzeEntitySentiment": {
- "httpMethod": "POST",
- "parameterOrder": [],
- "response": {
- "$ref": "AnalyzeEntitySentimentResponse"
- },
- "parameters": {},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-language",
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/documents:analyzeEntitySentiment",
- "id": "language.documents.analyzeEntitySentiment",
- "path": "v1/documents:analyzeEntitySentiment",
- "request": {
- "$ref": "AnalyzeEntitySentimentRequest"
- },
- "description": "Finds entities, similar to AnalyzeEntities in the text and analyzes\nsentiment associated with each entity and its mentions."
- },
- "analyzeEntities": {
- "flatPath": "v1/documents:analyzeEntities",
- "id": "language.documents.analyzeEntities",
- "path": "v1/documents:analyzeEntities",
- "request": {
- "$ref": "AnalyzeEntitiesRequest"
- },
- "description": "Finds named entities (currently proper names and common nouns) in the text\nalong with entity types, salience, mentions for each entity, and\nother properties.",
- "httpMethod": "POST",
- "parameterOrder": [],
- "response": {
- "$ref": "AnalyzeEntitiesResponse"
- },
- "parameters": {},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-language",
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- },
- "analyzeSyntax": {
- "flatPath": "v1/documents: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"
- ]
- },
- "annotateText": {
- "flatPath": "v1/documents:annotateText",
- "path": "v1/documents:annotateText",
- "id": "language.documents.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"
- ]
- },
- "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"
- }
- }
- }
- }
- },
- "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": {
- "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": {
- "location": "query",
- "enum": [
- "1",
- "2"
- ],
- "description": "V1 error format.",
- "type": "string",
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ]
- },
- "alt": {
- "enum": [
- "json",
- "media",
- "proto"
- ],
- "type": "string",
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query",
- "description": "Data format for response.",
- "default": "json"
- },
- "access_token": {
- "type": "string",
- "location": "query",
- "description": "OAuth access token."
- },
- "key": {
- "location": "query",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string"
- },
- "quotaUser": {
- "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": "v1",
- "baseUrl": "https://language.googleapis.com/",
- "description": "Provides natural language understanding technologies to developers. Examples include sentiment analysis, entity recognition, entity sentiment analysis, and text annotations.",
- "kind": "discovery#restDescription",
- "servicePath": "",
- "basePath": "",
- "revision": "20171231",
- "documentationLink": "https://cloud.google.com/natural-language/",
- "id": "language:v1"
+ "name": "language"
}
diff --git a/language/v1beta1/language-api.json b/language/v1beta1/language-api.json
index d856a0e..192ba7a 100644
--- a/language/v1beta1/language-api.json
+++ b/language/v1beta1/language-api.json
@@ -1,242 +1,9 @@
{
- "name": "language",
- "batchPath": "batch",
- "title": "Google Cloud Natural Language API",
- "ownerName": "Google",
- "resources": {
- "documents": {
- "methods": {
- "analyzeSentiment": {
- "request": {
- "$ref": "AnalyzeSentimentRequest"
- },
- "description": "Analyzes the sentiment of the provided text.",
- "httpMethod": "POST",
- "parameterOrder": [],
- "response": {
- "$ref": "AnalyzeSentimentResponse"
- },
- "parameters": {},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-language",
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta1/documents:analyzeSentiment",
- "id": "language.documents.analyzeSentiment",
- "path": "v1beta1/documents:analyzeSentiment"
- },
- "annotateText": {
- "request": {
- "$ref": "AnnotateTextRequest"
- },
- "description": "A convenience method that provides all the features that analyzeSentiment,\nanalyzeEntities, and analyzeSyntax provide in one call.",
- "httpMethod": "POST",
- "parameterOrder": [],
- "response": {
- "$ref": "AnnotateTextResponse"
- },
- "parameters": {},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-language",
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta1/documents:annotateText",
- "id": "language.documents.annotateText",
- "path": "v1beta1/documents:annotateText"
- },
- "analyzeEntities": {
- "request": {
- "$ref": "AnalyzeEntitiesRequest"
- },
- "description": "Finds named entities (currently proper names and common nouns) in the text\nalong with entity types, salience, mentions for each entity, and\nother properties.",
- "response": {
- "$ref": "AnalyzeEntitiesResponse"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "parameters": {},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-language",
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta1/documents:analyzeEntities",
- "path": "v1beta1/documents:analyzeEntities",
- "id": "language.documents.analyzeEntities"
- },
- "analyzeSyntax": {
- "request": {
- "$ref": "AnalyzeSyntaxRequest"
- },
- "description": "Analyzes the syntax of the text and provides sentence boundaries and\ntokenization along with part of speech tags, dependency trees, and other\nproperties.",
- "response": {
- "$ref": "AnalyzeSyntaxResponse"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "parameters": {},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-language",
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta1/documents:analyzeSyntax",
- "path": "v1beta1/documents:analyzeSyntax",
- "id": "language.documents.analyzeSyntax"
- }
- }
- }
- },
- "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": {
- "description": "OAuth access token.",
- "type": "string",
- "location": "query"
- },
- "key": {
- "location": "query",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string"
- },
- "quotaUser": {
- "location": "query",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string"
- },
- "pp": {
- "description": "Pretty-print response.",
- "type": "boolean",
- "default": "true",
- "location": "query"
- },
- "oauth_token": {
- "location": "query",
- "description": "OAuth 2.0 token for the current user.",
- "type": "string"
- },
- "bearer_token": {
- "description": "OAuth bearer token.",
- "type": "string",
- "location": "query"
- },
- "upload_protocol": {
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string",
- "location": "query"
- },
- "prettyPrint": {
- "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"
- }
- },
- "version": "v1beta1",
- "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": "",
- "id": "language:v1beta1",
- "documentationLink": "https://cloud.google.com/natural-language/",
- "revision": "20171231",
- "discoveryVersion": "v1",
- "version_module": true,
"schemas": {
- "AnalyzeSentimentResponse": {
- "description": "The sentiment analysis response message.",
- "type": "object",
- "properties": {
- "language": {
- "description": "The language of the text, which will be the same as the language specified\nin the request or, if not specified, the automatically-detected language.\nSee Document.language field for more details.",
- "type": "string"
- },
- "sentences": {
- "description": "The sentiment for all the sentences in the document.",
- "type": "array",
- "items": {
- "$ref": "Sentence"
- }
- },
- "documentSentiment": {
- "description": "The overall sentiment of the input document.",
- "$ref": "Sentiment"
- }
- },
- "id": "AnalyzeSentimentResponse"
- },
- "AnalyzeEntitiesResponse": {
- "id": "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"
- }
- }
- }
- },
"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"
@@ -276,8 +43,16 @@
"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"
+ }
}
- }
+ },
+ "id": "Entity"
},
"AnalyzeSyntaxResponse": {
"description": "The syntax analysis response message.",
@@ -305,8 +80,6 @@
"id": "AnalyzeSyntaxResponse"
},
"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",
"properties": {
"encodingType": {
@@ -326,18 +99,18 @@
"type": "string"
},
"document": {
- "description": "Input document.",
- "$ref": "Document"
+ "$ref": "Document",
+ "description": "Input document."
},
"features": {
- "description": "The enabled features.",
- "$ref": "Features"
+ "$ref": "Features",
+ "description": "The enabled features."
}
- }
+ },
+ "id": "AnnotateTextRequest",
+ "description": "The request message for the text annotation API, which can perform multiple\nanalysis types (sentiment, entities, and syntax) in one call."
},
"AnalyzeSentimentRequest": {
- "id": "AnalyzeSentimentRequest",
- "description": "The sentiment analysis request message.",
"type": "object",
"properties": {
"encodingType": {
@@ -357,12 +130,15 @@
"type": "string"
},
"document": {
- "$ref": "Document",
- "description": "Input document."
+ "description": "Input document.",
+ "$ref": "Document"
}
- }
+ },
+ "id": "AnalyzeSentimentRequest",
+ "description": "The sentiment analysis request message."
},
"AnnotateTextResponse": {
+ "id": "AnnotateTextResponse",
"description": "The text annotations response message.",
"type": "object",
"properties": {
@@ -385,25 +161,25 @@
}
},
"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."
},
"documentSentiment": {
- "description": "The overall sentiment for the document. Populated if the user enables\nAnnotateTextRequest.Features.extract_document_sentiment.",
- "$ref": "Sentiment"
+ "$ref": "Sentiment",
+ "description": "The overall sentiment for the document. Populated if the user enables\nAnnotateTextRequest.Features.extract_document_sentiment."
}
- },
- "id": "AnnotateTextResponse"
+ }
},
"DependencyEdge": {
- "id": "DependencyEdge",
"description": "Represents dependency parse tree information for a token.",
"type": "object",
"properties": {
"label": {
+ "description": "The parse label for the token.",
+ "type": "string",
"enumDescriptions": [
"Unknown",
"Abbreviation modifier",
@@ -573,28 +349,25 @@
"INFMOD",
"MES",
"NCOMP"
- ],
- "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"
},
"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"
+ "$ref": "TextSpan",
+ "description": "The token text."
},
"dependencyEdge": {
"description": "Dependency tree parse for this token.",
@@ -605,20 +378,22 @@
"type": "string"
}
},
- "id": "Token"
+ "id": "Token",
+ "description": "Represents the smallest syntactic building block of the text.",
+ "type": "object"
},
"TextSpan": {
"description": "Represents an output piece of text.",
"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"
- },
- "content": {
- "description": "The content of the output text.",
- "type": "string"
}
},
"id": "TextSpan"
@@ -627,6 +402,11 @@
"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"
@@ -635,23 +415,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"
},
"Features": {
- "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",
"properties": {
@@ -667,47 +441,41 @@
"description": "Extract document-level sentiment.",
"type": "boolean"
}
- }
+ },
+ "id": "Features"
},
"EntityMention": {
+ "id": "EntityMention",
"description": "Represents a mention for an entity in the text. Currently, proper noun\nmentions are supported.",
"type": "object",
"properties": {
"text": {
- "description": "The mention text.",
- "$ref": "TextSpan"
+ "$ref": "TextSpan",
+ "description": "The mention text."
},
"type": {
+ "enum": [
+ "TYPE_UNKNOWN",
+ "PROPER",
+ "COMMON"
+ ],
"description": "The type of the entity mention.",
"type": "string",
"enumDescriptions": [
"Unknown",
"Proper name",
"Common noun (or noun compound)"
- ],
- "enum": [
- "TYPE_UNKNOWN",
- "PROPER",
- "COMMON"
]
}
- },
- "id": "EntityMention"
+ }
},
"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": "string",
+ "description": "The language of the document (if not specified, the language is\nautomatically detected). Both ISO and BCP-47 language codes are\naccepted.\u003cbr\u003e\n[Language Support](/natural-language/docs/languages)\nlists currently supported languages for each API method.\nIf the language (either specified by the caller or automatically detected)\nis not supported by the called API method, an `INVALID_ARGUMENT` error\nis returned."
},
"type": {
- "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.",
@@ -718,17 +486,23 @@
"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"
+ },
+ "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"
+ "id": "Document",
+ "description": "################################################################ #\n\nRepresents the input to API methods.",
+ "type": "object"
},
"Sentence": {
- "id": "Sentence",
"description": "Represents a sentence in the input document.",
"type": "object",
"properties": {
@@ -737,17 +511,19 @@
"$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"
},
"AnalyzeEntitiesRequest": {
- "id": "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.",
@@ -759,18 +535,16 @@
"UTF8",
"UTF16",
"UTF32"
- ],
- "description": "The encoding type used by the API to calculate offsets.",
- "type": "string"
+ ]
},
"document": {
- "$ref": "Document",
- "description": "Input document."
+ "description": "Input document.",
+ "$ref": "Document"
}
- }
+ },
+ "id": "AnalyzeEntitiesRequest"
},
"Sentiment": {
- "id": "Sentiment",
"description": "Represents the feeling associated with the entire text or entities in\nthe text.",
"type": "object",
"properties": {
@@ -789,30 +563,13 @@
"format": "float",
"type": "number"
}
- }
+ },
+ "id": "Sentiment"
},
"PartOfSpeech": {
"description": "Represents part of speech information for a token.",
"type": "object",
"properties": {
- "person": {
- "enumDescriptions": [
- "Person is not applicable in the analyzed language or is not predicted.",
- "First",
- "Second",
- "Third",
- "Reflexive"
- ],
- "enum": [
- "PERSON_UNKNOWN",
- "FIRST",
- "SECOND",
- "THIRD",
- "REFLEXIVE_PERSON"
- ],
- "description": "The grammatical person.",
- "type": "string"
- },
"proper": {
"enumDescriptions": [
"Proper is not applicable in the analyzed language or is not predicted.",
@@ -828,6 +585,8 @@
"type": "string"
},
"case": {
+ "description": "The grammatical case.",
+ "type": "string",
"enumDescriptions": [
"Case is not applicable in the analyzed language or is not predicted.",
"Accusative",
@@ -861,20 +620,9 @@
"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",
@@ -885,7 +633,16 @@
"PLUPERFECT"
],
"description": "The grammatical tense.",
- "type": "string"
+ "type": "string",
+ "enumDescriptions": [
+ "Tense is not applicable in the analyzed language or is not predicted.",
+ "Conditional",
+ "Future",
+ "Past",
+ "Present",
+ "Imperfect",
+ "Pluperfect"
+ ]
},
"reciprocity": {
"description": "The grammatical reciprocity.",
@@ -902,6 +659,20 @@
]
},
"form": {
+ "enum": [
+ "FORM_UNKNOWN",
+ "ADNOMIAL",
+ "AUXILIARY",
+ "COMPLEMENTIZER",
+ "FINAL_ENDING",
+ "GERUND",
+ "REALIS",
+ "IRREALIS",
+ "SHORT",
+ "LONG",
+ "ORDER",
+ "SPECIFIC"
+ ],
"description": "The grammatical form.",
"type": "string",
"enumDescriptions": [
@@ -917,20 +688,6 @@
"Long form",
"Order form",
"Specific form"
- ],
- "enum": [
- "FORM_UNKNOWN",
- "ADNOMIAL",
- "AUXILIARY",
- "COMPLEMENTIZER",
- "FINAL_ENDING",
- "GERUND",
- "REALIS",
- "IRREALIS",
- "SHORT",
- "LONG",
- "ORDER",
- "SPECIFIC"
]
},
"number": {
@@ -950,8 +707,6 @@
]
},
"voice": {
- "description": "The grammatical voice.",
- "type": "string",
"enumDescriptions": [
"Voice is not applicable in the analyzed language or is not predicted.",
"Active",
@@ -963,9 +718,17 @@
"ACTIVE",
"CAUSATIVE",
"PASSIVE"
- ]
+ ],
+ "description": "The grammatical voice.",
+ "type": "string"
},
"aspect": {
+ "enum": [
+ "ASPECT_UNKNOWN",
+ "PERFECTIVE",
+ "IMPERFECTIVE",
+ "PROGRESSIVE"
+ ],
"description": "The grammatical aspect.",
"type": "string",
"enumDescriptions": [
@@ -973,16 +736,9 @@
"Perfective",
"Imperfective",
"Progressive"
- ],
- "enum": [
- "ASPECT_UNKNOWN",
- "PERFECTIVE",
- "IMPERFECTIVE",
- "PROGRESSIVE"
]
},
"mood": {
- "description": "The grammatical mood.",
"type": "string",
"enumDescriptions": [
"Mood is not applicable in the analyzed language or is not predicted.",
@@ -1001,7 +757,8 @@
"INTERROGATIVE",
"JUSSIVE",
"SUBJUNCTIVE"
- ]
+ ],
+ "description": "The grammatical mood."
},
"tag": {
"enumDescriptions": [
@@ -1054,6 +811,24 @@
],
"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"
+ ]
}
},
"id": "PartOfSpeech"
@@ -1084,6 +859,46 @@
}
},
"id": "AnalyzeSyntaxRequest"
+ },
+ "AnalyzeSentimentResponse": {
+ "type": "object",
+ "properties": {
+ "documentSentiment": {
+ "$ref": "Sentiment",
+ "description": "The overall sentiment of the input document."
+ },
+ "language": {
+ "type": "string",
+ "description": "The language of the text, which will be the same as the language specified\nin the request or, if not specified, the automatically-detected language.\nSee Document.language field for more details."
+ },
+ "sentences": {
+ "description": "The sentiment for all the sentences in the document.",
+ "type": "array",
+ "items": {
+ "$ref": "Sentence"
+ }
+ }
+ },
+ "id": "AnalyzeSentimentResponse",
+ "description": "The sentiment analysis response message."
+ },
+ "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"
}
},
"icons": {
@@ -1095,15 +910,200 @@
"auth": {
"oauth2": {
"scopes": {
- "https://www.googleapis.com/auth/cloud-language": {
- "description": "Apply machine learning models to reveal the structure and meaning of text"
- },
"https://www.googleapis.com/auth/cloud-platform": {
"description": "View and manage your data across Google Cloud Platform services"
+ },
+ "https://www.googleapis.com/auth/cloud-language": {
+ "description": "Apply machine learning models to reveal the structure and meaning of text"
}
}
}
},
"rootUrl": "https://language.googleapis.com/",
- "ownerDomain": "google.com"
+ "ownerDomain": "google.com",
+ "name": "language",
+ "batchPath": "batch",
+ "title": "Google Cloud Natural Language API",
+ "ownerName": "Google",
+ "resources": {
+ "documents": {
+ "methods": {
+ "analyzeSentiment": {
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-language",
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {},
+ "flatPath": "v1beta1/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"
+ },
+ "annotateText": {
+ "request": {
+ "$ref": "AnnotateTextRequest"
+ },
+ "description": "A convenience method that provides all the features that analyzeSentiment,\nanalyzeEntities, and analyzeSyntax provide in one call.",
+ "httpMethod": "POST",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "AnnotateTextResponse"
+ },
+ "parameters": {},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-language",
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta1/documents:annotateText",
+ "id": "language.documents.annotateText",
+ "path": "v1beta1/documents:annotateText"
+ },
+ "analyzeEntities": {
+ "flatPath": "v1beta1/documents:analyzeEntities",
+ "id": "language.documents.analyzeEntities",
+ "path": "v1beta1/documents:analyzeEntities",
+ "request": {
+ "$ref": "AnalyzeEntitiesRequest"
+ },
+ "description": "Finds named entities (currently proper names and common nouns) in the text\nalong with entity types, salience, mentions for each entity, and\nother properties.",
+ "httpMethod": "POST",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "AnalyzeEntitiesResponse"
+ },
+ "parameters": {},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-language",
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "analyzeSyntax": {
+ "httpMethod": "POST",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "AnalyzeSyntaxResponse"
+ },
+ "parameters": {},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-language",
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta1/documents:analyzeSyntax",
+ "id": "language.documents.analyzeSyntax",
+ "path": "v1beta1/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."
+ }
+ }
+ }
+ },
+ "parameters": {
+ "access_token": {
+ "type": "string",
+ "location": "query",
+ "description": "OAuth access token."
+ },
+ "key": {
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "type": "string",
+ "location": "query"
+ },
+ "quotaUser": {
+ "location": "query",
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "type": "string"
+ },
+ "pp": {
+ "location": "query",
+ "description": "Pretty-print response.",
+ "type": "boolean",
+ "default": "true"
+ },
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string",
+ "location": "query"
+ },
+ "bearer_token": {
+ "location": "query",
+ "description": "OAuth bearer token.",
+ "type": "string"
+ },
+ "upload_protocol": {
+ "location": "query",
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "type": "string"
+ },
+ "prettyPrint": {
+ "location": "query",
+ "description": "Returns response with indentations and line breaks.",
+ "type": "boolean",
+ "default": "true"
+ },
+ "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",
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query",
+ "enum": [
+ "1",
+ "2"
+ ]
+ },
+ "callback": {
+ "description": "JSONP",
+ "type": "string",
+ "location": "query"
+ },
+ "alt": {
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query",
+ "description": "Data format for response.",
+ "default": "json",
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
+ "type": "string"
+ }
+ },
+ "version": "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",
+ "documentationLink": "https://cloud.google.com/natural-language/",
+ "revision": "20171231",
+ "discoveryVersion": "v1",
+ "version_module": true
}
diff --git a/language/v1beta2/language-api.json b/language/v1beta2/language-api.json
index c04f3e3..7e489b9 100644
--- a/language/v1beta2/language-api.json
+++ b/language/v1beta2/language-api.json
@@ -1,69 +1,64 @@
{
- "rootUrl": "https://language.googleapis.com/",
- "ownerDomain": "google.com",
- "name": "language",
- "batchPath": "batch",
- "title": "Google Cloud Natural Language API",
"ownerName": "Google",
"resources": {
"documents": {
"methods": {
"classifyText": {
- "path": "v1beta2/documents:classifyText",
- "id": "language.documents.classifyText",
- "description": "Classifies a document into categories.",
- "request": {
- "$ref": "ClassifyTextRequest"
- },
+ "httpMethod": "POST",
+ "parameterOrder": [],
"response": {
"$ref": "ClassifyTextResponse"
},
- "parameterOrder": [],
- "httpMethod": "POST",
+ "parameters": {},
"scopes": [
"https://www.googleapis.com/auth/cloud-language",
"https://www.googleapis.com/auth/cloud-platform"
],
- "parameters": {},
- "flatPath": "v1beta2/documents:classifyText"
+ "flatPath": "v1beta2/documents:classifyText",
+ "id": "language.documents.classifyText",
+ "path": "v1beta2/documents:classifyText",
+ "request": {
+ "$ref": "ClassifyTextRequest"
+ },
+ "description": "Classifies a document into categories."
},
"analyzeSentiment": {
+ "request": {
+ "$ref": "AnalyzeSentimentRequest"
+ },
+ "description": "Analyzes the sentiment of the provided text.",
+ "httpMethod": "POST",
+ "parameterOrder": [],
"response": {
"$ref": "AnalyzeSentimentResponse"
},
- "parameterOrder": [],
- "httpMethod": "POST",
+ "parameters": {},
"scopes": [
"https://www.googleapis.com/auth/cloud-language",
"https://www.googleapis.com/auth/cloud-platform"
],
- "parameters": {},
"flatPath": "v1beta2/documents:analyzeSentiment",
- "path": "v1beta2/documents:analyzeSentiment",
"id": "language.documents.analyzeSentiment",
- "description": "Analyzes the sentiment of the provided text.",
- "request": {
- "$ref": "AnalyzeSentimentRequest"
- }
+ "path": "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",
+ "id": "language.documents.analyzeEntitySentiment",
"request": {
"$ref": "AnalyzeEntitySentimentRequest"
},
- "description": "Finds entities, similar to AnalyzeEntities in the text and analyzes\nsentiment associated with each entity and its mentions."
+ "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"
},
"analyzeEntities": {
"httpMethod": "POST",
@@ -85,87 +80,61 @@
"description": "Finds named entities (currently proper names and common nouns) in the text\nalong with entity types, salience, mentions for each entity, and\nother properties."
},
"analyzeSyntax": {
- "id": "language.documents.analyzeSyntax",
- "path": "v1beta2/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": "v1beta2/documents:analyzeSyntax"
+ "parameters": {},
+ "flatPath": "v1beta2/documents:analyzeSyntax",
+ "id": "language.documents.analyzeSyntax",
+ "path": "v1beta2/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"
+ }
},
"annotateText": {
- "httpMethod": "POST",
- "parameterOrder": [],
- "response": {
- "$ref": "AnnotateTextResponse"
- },
- "parameters": {},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-language",
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta2/documents:annotateText",
- "id": "language.documents.annotateText",
"path": "v1beta2/documents:annotateText",
+ "id": "language.documents.annotateText",
"request": {
"$ref": "AnnotateTextRequest"
},
- "description": "A convenience method that provides all syntax, sentiment, entity, and\nclassification features in one call."
+ "description": "A convenience method that provides all syntax, sentiment, entity, and\nclassification features 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": "v1beta2/documents:annotateText"
}
}
}
},
"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": {
- "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",
+ "default": "true"
+ },
+ "uploadType": {
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string",
"location": "query"
},
"fields": {
@@ -173,36 +142,25 @@
"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": {
- "enum": [
- "json",
- "media",
- "proto"
+ "$.xgafv": {
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
],
- "type": "string",
+ "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",
@@ -210,7 +168,44 @@
],
"location": "query",
"description": "Data format for response.",
- "default": "json"
+ "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": {
+ "description": "Pretty-print response.",
+ "type": "boolean",
+ "default": "true",
+ "location": "query"
+ },
+ "bearer_token": {
+ "location": "query",
+ "description": "OAuth bearer token.",
+ "type": "string"
+ },
+ "oauth_token": {
+ "location": "query",
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string"
}
},
"version": "v1beta2",
@@ -219,13 +214,36 @@
"description": "Provides natural language understanding technologies to developers. Examples include sentiment analysis, entity recognition, entity sentiment analysis, and text annotations.",
"servicePath": "",
"basePath": "",
- "id": "language:v1beta2",
- "revision": "20171212",
+ "revision": "20171231",
"documentationLink": "https://cloud.google.com/natural-language/",
+ "id": "language:v1beta2",
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
+ "AnalyzeSentimentResponse": {
+ "description": "The sentiment analysis response message.",
+ "type": "object",
+ "properties": {
+ "language": {
+ "description": "The language of the text, which will be the same as the language specified\nin the request or, if not specified, the automatically-detected language.\nSee Document.language field for more details.",
+ "type": "string"
+ },
+ "sentences": {
+ "description": "The sentiment for all the sentences in the document.",
+ "type": "array",
+ "items": {
+ "$ref": "Sentence"
+ }
+ },
+ "documentSentiment": {
+ "$ref": "Sentiment",
+ "description": "The overall sentiment of the input document."
+ }
+ },
+ "id": "AnalyzeSentimentResponse"
+ },
"AnalyzeSyntaxResponse": {
+ "id": "AnalyzeSyntaxResponse",
"description": "The syntax analysis response message.",
"type": "object",
"properties": {
@@ -247,8 +265,7 @@
"$ref": "Token"
}
}
- },
- "id": "AnalyzeSyntaxResponse"
+ }
},
"AnnotateTextResponse": {
"description": "The text annotations response message.",
@@ -276,8 +293,8 @@
}
},
"documentSentiment": {
- "description": "The overall sentiment for the document. Populated if the user enables\nAnnotateTextRequest.Features.extract_document_sentiment.",
- "$ref": "Sentiment"
+ "$ref": "Sentiment",
+ "description": "The overall sentiment for the document. Populated if the user enables\nAnnotateTextRequest.Features.extract_document_sentiment."
},
"language": {
"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.",
@@ -294,6 +311,8 @@
"id": "AnnotateTextResponse"
},
"DependencyEdge": {
+ "description": "Represents dependency parse tree information for a token.",
+ "type": "object",
"properties": {
"label": {
"enumDescriptions": [
@@ -475,27 +494,10 @@
"type": "integer"
}
},
- "id": "DependencyEdge",
- "description": "Represents dependency parse tree information for a token.",
- "type": "object"
- },
- "TextSpan": {
- "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",
- "description": "Represents an output piece of text.",
- "type": "object"
+ "id": "DependencyEdge"
},
"Token": {
+ "id": "Token",
"description": "Represents the smallest syntactic building block of the text.",
"type": "object",
"properties": {
@@ -508,17 +510,33 @@
"$ref": "TextSpan"
},
"dependencyEdge": {
- "$ref": "DependencyEdge",
- "description": "Dependency tree parse for this token."
+ "description": "Dependency tree parse for this token.",
+ "$ref": "DependencyEdge"
},
"lemma": {
"description": "[Lemma](https://en.wikipedia.org/wiki/Lemma_%28morphology%29) of the token.",
"type": "string"
}
- },
- "id": "Token"
+ }
+ },
+ "TextSpan": {
+ "id": "TextSpan",
+ "description": "Represents an output piece of text.",
+ "type": "object",
+ "properties": {
+ "beginOffset": {
+ "description": "The API calculates the beginning offset of the content in the original\ndocument according to the EncodingType specified in the API request.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "content": {
+ "description": "The content of the output text.",
+ "type": "string"
+ }
+ }
},
"ClassifyTextResponse": {
+ "id": "ClassifyTextResponse",
"description": "The document classification response message.",
"type": "object",
"properties": {
@@ -529,39 +547,39 @@
"$ref": "ClassificationCategory"
}
}
- },
- "id": "ClassifyTextResponse"
+ }
},
"EntityMention": {
+ "id": "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."
+ "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",
- "enumDescriptions": [
- "Unknown",
- "Proper name",
- "Common noun (or noun compound)"
- ]
+ "type": "string"
},
"sentiment": {
- "$ref": "Sentiment",
- "description": "For calls to AnalyzeEntitySentiment or if\nAnnotateTextRequest.Features.extract_entity_sentiment is set to\ntrue, this field will contain the sentiment expressed for this mention of\nthe entity in the provided document."
+ "description": "For calls to AnalyzeEntitySentiment or if\nAnnotateTextRequest.Features.extract_entity_sentiment is set to\ntrue, this field will contain the sentiment expressed for this mention of\nthe entity in the provided document.",
+ "$ref": "Sentiment"
}
- },
- "id": "EntityMention"
+ }
},
"Sentence": {
+ "id": "Sentence",
"description": "Represents a sentence in the input document.",
"type": "object",
"properties": {
@@ -570,13 +588,13 @@
"$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"
+ "$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": {
+ "id": "Sentiment",
"description": "Represents the feeling associated with the entire text or entities in\nthe text.",
"type": "object",
"properties": {
@@ -590,20 +608,13 @@
"format": "float",
"type": "number"
}
- },
- "id": "Sentiment"
+ }
},
"AnalyzeEntitySentimentRequest": {
"description": "The entity-level sentiment 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": [
@@ -611,6 +622,12 @@
"Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-8 encoding of the input. C++ and Go are examples of languages\nthat use this encoding natively.",
"Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-16 encoding of the input. Java and Javascript are examples of\nlanguages that use this encoding natively.",
"Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-32 encoding of the input. Python is an example of a language\nthat uses this encoding natively."
+ ],
+ "enum": [
+ "NONE",
+ "UTF8",
+ "UTF16",
+ "UTF32"
]
},
"document": {
@@ -621,7 +638,149 @@
"id": "AnalyzeEntitySentimentRequest"
},
"PartOfSpeech": {
+ "description": "Represents part of speech information for a token.",
+ "type": "object",
"properties": {
+ "number": {
+ "description": "The grammatical number.",
+ "type": "string",
+ "enumDescriptions": [
+ "Number is not applicable in the analyzed language or is not predicted.",
+ "Singular",
+ "Plural",
+ "Dual"
+ ],
+ "enum": [
+ "NUMBER_UNKNOWN",
+ "SINGULAR",
+ "PLURAL",
+ "DUAL"
+ ]
+ },
+ "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": {
+ "enumDescriptions": [
+ "Aspect is not applicable in the analyzed language or is not predicted.",
+ "Perfective",
+ "Imperfective",
+ "Progressive"
+ ],
+ "enum": [
+ "ASPECT_UNKNOWN",
+ "PERFECTIVE",
+ "IMPERFECTIVE",
+ "PROGRESSIVE"
+ ],
+ "description": "The grammatical aspect.",
+ "type": "string"
+ },
+ "mood": {
+ "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"
+ ],
+ "enum": [
+ "MOOD_UNKNOWN",
+ "CONDITIONAL_MOOD",
+ "IMPERATIVE",
+ "INDICATIVE",
+ "INTERROGATIVE",
+ "JUSSIVE",
+ "SUBJUNCTIVE"
+ ]
+ },
+ "tag": {
+ "enumDescriptions": [
+ "Unknown",
+ "Adjective",
+ "Adposition (preposition and postposition)",
+ "Adverb",
+ "Conjunction",
+ "Determiner",
+ "Noun (common and proper)",
+ "Cardinal number",
+ "Pronoun",
+ "Particle or other function word",
+ "Punctuation",
+ "Verb (all tenses and modes)",
+ "Other: foreign words, typos, abbreviations",
+ "Affix"
+ ],
+ "enum": [
+ "UNKNOWN",
+ "ADJ",
+ "ADP",
+ "ADV",
+ "CONJ",
+ "DET",
+ "NOUN",
+ "NUM",
+ "PRON",
+ "PRT",
+ "PUNCT",
+ "VERB",
+ "X",
+ "AFFIX"
+ ],
+ "description": "The part of speech tag.",
+ "type": "string"
+ },
+ "gender": {
+ "description": "The grammatical 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"
+ ]
+ },
+ "person": {
+ "enumDescriptions": [
+ "Person is not applicable in the analyzed language or is not predicted.",
+ "First",
+ "Second",
+ "Third",
+ "Reflexive"
+ ],
+ "enum": [
+ "PERSON_UNKNOWN",
+ "FIRST",
+ "SECOND",
+ "THIRD",
+ "REFLEXIVE_PERSON"
+ ],
+ "description": "The grammatical person.",
+ "type": "string"
+ },
"proper": {
"enumDescriptions": [
"Proper is not applicable in the analyzed language or is not predicted.",
@@ -697,17 +856,17 @@
"type": "string"
},
"reciprocity": {
- "enum": [
- "RECIPROCITY_UNKNOWN",
- "RECIPROCAL",
- "NON_RECIPROCAL"
- ],
"description": "The grammatical reciprocity.",
"type": "string",
"enumDescriptions": [
"Reciprocity is not applicable in the analyzed language or is not\npredicted.",
"Reciprocal",
"Non-reciprocal"
+ ],
+ "enum": [
+ "RECIPROCITY_UNKNOWN",
+ "RECIPROCAL",
+ "NON_RECIPROCAL"
]
},
"form": {
@@ -741,153 +900,12 @@
],
"description": "The grammatical form.",
"type": "string"
- },
- "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": {
- "enumDescriptions": [
- "Aspect is not applicable in the analyzed language or is not predicted.",
- "Perfective",
- "Imperfective",
- "Progressive"
- ],
- "enum": [
- "ASPECT_UNKNOWN",
- "PERFECTIVE",
- "IMPERFECTIVE",
- "PROGRESSIVE"
- ],
- "description": "The grammatical aspect.",
- "type": "string"
- },
- "mood": {
- "enumDescriptions": [
- "Mood is not applicable in the analyzed language or is not predicted.",
- "Conditional",
- "Imperative",
- "Indicative",
- "Interrogative",
- "Jussive",
- "Subjunctive"
- ],
- "enum": [
- "MOOD_UNKNOWN",
- "CONDITIONAL_MOOD",
- "IMPERATIVE",
- "INDICATIVE",
- "INTERROGATIVE",
- "JUSSIVE",
- "SUBJUNCTIVE"
- ],
- "description": "The grammatical mood.",
- "type": "string"
- },
- "tag": {
- "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"
- ]
}
},
- "id": "PartOfSpeech",
- "description": "Represents part of speech information for a token.",
- "type": "object"
+ "id": "PartOfSpeech"
},
"ClassificationCategory": {
+ "id": "ClassificationCategory",
"description": "Represents a category returned from the text classifier.",
"type": "object",
"properties": {
@@ -900,18 +918,13 @@
"description": "The name of the category representing the document.",
"type": "string"
}
- },
- "id": "ClassificationCategory"
+ }
},
"AnalyzeSyntaxRequest": {
+ "description": "The syntax analysis request message.",
+ "type": "object",
"properties": {
"encodingType": {
- "enum": [
- "NONE",
- "UTF8",
- "UTF16",
- "UTF32"
- ],
"description": "The encoding type used by the API to calculate offsets.",
"type": "string",
"enumDescriptions": [
@@ -919,18 +932,25 @@
"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": "AnalyzeSyntaxRequest",
- "description": "The syntax analysis request message.",
- "type": "object"
+ "id": "AnalyzeSyntaxRequest"
},
"AnalyzeEntitiesResponse": {
+ "id": "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.",
@@ -943,12 +963,12 @@
"$ref": "Entity"
}
}
- },
- "id": "AnalyzeEntitiesResponse",
- "description": "The entity analysis response message.",
- "type": "object"
+ }
},
"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": {
"name": {
"description": "The representative name for the entity.",
@@ -1001,16 +1021,15 @@
"$ref": "EntityMention"
}
}
- },
- "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"
+ }
},
"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": {
+ "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.",
@@ -1022,17 +1041,15 @@
"UTF8",
"UTF16",
"UTF32"
- ],
- "description": "The encoding type used by the API to calculate offsets.",
- "type": "string"
+ ]
},
"document": {
- "description": "Input document.",
- "$ref": "Document"
+ "$ref": "Document",
+ "description": "Input document."
},
"features": {
- "description": "The enabled features.",
- "$ref": "Features"
+ "$ref": "Features",
+ "description": "The enabled features."
}
},
"id": "AnnotateTextRequest"
@@ -1065,34 +1082,41 @@
"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.",
+ "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"
+ }
},
"Features": {
+ "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",
"properties": {
+ "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"
@@ -1108,34 +1132,29 @@
"extractEntities": {
"description": "Extract entities.",
"type": "boolean"
- },
- "classifyText": {
- "description": "Classify the full document into categories. If this is true,\nthe API will use the default model which classifies into a\n[predefined taxonomy](/natural-language/docs/categories).",
- "type": "boolean"
}
- },
- "id": "Features",
- "description": "All available features for sentiment, syntax, and semantic analysis.\nSetting each one to true will enable that specific analysis for the input.",
- "type": "object"
+ }
},
"Document": {
+ "description": "################################################################ #\n\nRepresents the input to API methods.",
+ "type": "object",
"properties": {
"language": {
"description": "The language of the document (if not specified, the language is\nautomatically detected). Both ISO and BCP-47 language codes are\naccepted.\u003cbr\u003e\n[Language Support](/natural-language/docs/languages)\nlists currently supported languages for each API method.\nIf the language (either specified by the caller or automatically detected)\nis not supported by the called API method, an `INVALID_ARGUMENT` error\nis returned.",
"type": "string"
},
"type": {
- "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"
+ ],
+ "enum": [
+ "TYPE_UNSPECIFIED",
+ "PLAIN_TEXT",
+ "HTML"
]
},
"content": {
@@ -1147,11 +1166,12 @@
"type": "string"
}
},
- "id": "Document",
- "description": "################################################################ #\n\nRepresents the input to API methods.",
- "type": "object"
+ "id": "Document"
},
"AnalyzeEntitiesRequest": {
+ "id": "AnalyzeEntitiesRequest",
+ "description": "The entity analysis request message.",
+ "type": "object",
"properties": {
"encodingType": {
"enumDescriptions": [
@@ -1173,68 +1193,43 @@
"$ref": "Document",
"description": "Input document."
}
- },
- "id": "AnalyzeEntitiesRequest",
- "description": "The entity analysis request message.",
- "type": "object"
+ }
},
"ClassifyTextRequest": {
"description": "The document classification request message.",
"type": "object",
"properties": {
"document": {
- "$ref": "Document",
- "description": "Input document."
+ "description": "Input document.",
+ "$ref": "Document"
}
},
"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": {
- "description": "The language of the text, which will be the same as the language specified\nin the request or, if not specified, the automatically-detected language.\nSee Document.language field for more details.",
- "type": "string"
}
- },
- "id": "AnalyzeEntitySentimentResponse",
- "description": "The entity-level sentiment analysis response message.",
- "type": "object"
- },
- "AnalyzeSentimentResponse": {
- "properties": {
- "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"
- },
- "sentences": {
- "description": "The sentiment for all the sentences in the document.",
- "type": "array",
- "items": {
- "$ref": "Sentence"
- }
- }
- },
- "id": "AnalyzeSentimentResponse",
- "description": "The sentiment analysis response message.",
- "type": "object"
+ }
}
},
- "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 Natural Language",
"auth": {
"oauth2": {
@@ -1247,5 +1242,10 @@
}
}
}
- }
+ },
+ "rootUrl": "https://language.googleapis.com/",
+ "ownerDomain": "google.com",
+ "name": "language",
+ "batchPath": "batch",
+ "title": "Google Cloud Natural Language API"
}
diff --git a/logging/v2/logging-api.json b/logging/v2/logging-api.json
index e8293a5..f9a3472 100644
--- a/logging/v2/logging-api.json
+++ b/logging/v2/logging-api.json
@@ -1,2528 +1,11 @@
{
- "rootUrl": "https://logging.googleapis.com/",
- "ownerDomain": "google.com",
- "name": "logging",
- "batchPath": "batch",
- "fullyEncodeReservedExpansion": true,
- "title": "Stackdriver Logging API",
- "ownerName": "Google",
- "resources": {
- "projects": {
- "resources": {
- "logs": {
- "methods": {
- "list": {
- "description": "Lists the logs in projects, organizations, folders, or billing accounts. Only logs that have entries are listed.",
- "response": {
- "$ref": "ListLogsResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "GET",
- "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"
- },
- "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": "^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"
- }
- },
- "flatPath": "v2/projects/{projectsId}/logs",
- "path": "v2/{+parent}/logs",
- "id": "logging.projects.logs.list"
- },
- "delete": {
- "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.",
- "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": "^projects/[^/]+/logs/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/logging.admin"
- ]
- }
- }
- },
- "sinks": {
- "methods": {
- "patch": {
- "httpMethod": "PATCH",
- "parameterOrder": [
- "sinkName"
- ],
- "response": {
- "$ref": "LogSink"
- },
- "parameters": {
- "sinkName": {
- "description": "Required. The full resource name of the sink to update, including the parent resource and the sink identifier:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/sinks/[^/]+$",
- "location": "path"
- },
- "uniqueWriterIdentity": {
- "description": "Optional. See sinks.create for a description of this field. When updating a sink, the effect of this field on the value of writer_identity in the updated sink depends on both the old and new values of this field:\nIf the old and new values of this field are both false or both true, then there is no change to the sink's writer_identity.\nIf the old value is false and the new value is true, then writer_identity is changed to a unique service account.\nIt is an error if the old value is true and the new value is set to false or defaulted to false.",
- "type": "boolean",
- "location": "query"
- },
- "updateMask": {
- "description": "Optional. Field mask that specifies the fields in sink that need an update. A sink field will be overwritten if, and only if, it is in the update mask. name and output only fields cannot be updated.An empty updateMask is temporarily treated as using the following mask for backwards compatibility purposes: destination,filter,includeChildren At some point in the future, behavior will be removed and specifying an empty updateMask will be an error.For a detailed FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmaskExample: updateMask=filter.",
- "format": "google-fieldmask",
- "type": "string",
- "location": "query"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/logging.admin"
- ],
- "flatPath": "v2/projects/{projectsId}/sinks/{sinksId}",
- "id": "logging.projects.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."
- },
- "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": "^projects/[^/]+/sinks/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v2/projects/{projectsId}/sinks/{sinksId}",
- "path": "v2/{+sinkName}",
- "id": "logging.projects.sinks.get"
- },
- "update": {
- "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"
- },
- "response": {
- "$ref": "LogSink"
- },
- "parameterOrder": [
- "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\".",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/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"
- }
- }
- },
- "delete": {
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "sinkName"
- ],
- "httpMethod": "DELETE",
- "parameters": {
- "sinkName": {
- "description": "Required. The full resource name of the sink to delete, including the parent resource and the sink identifier:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/sinks/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/logging.admin"
- ],
- "flatPath": "v2/projects/{projectsId}/sinks/{sinksId}",
- "path": "v2/{+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": {
- "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": {
- "pageSize": {
- "location": "query",
- "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.",
- "format": "int32",
- "type": "integer"
- },
- "parent": {
- "location": "path",
- "description": "Required. The parent resource whose sinks are to be listed:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+$"
- },
- "pageToken": {
- "location": "query",
- "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.",
- "type": "string"
- }
- },
- "flatPath": "v2/projects/{projectsId}/sinks",
- "path": "v2/{+parent}/sinks",
- "id": "logging.projects.sinks.list",
- "description": "Lists sinks."
- },
- "create": {
- "flatPath": "v2/projects/{projectsId}/sinks",
- "path": "v2/{+parent}/sinks",
- "id": "logging.projects.sinks.create",
- "description": "Creates a sink that exports specified log entries to a destination. The export of newly-ingested log entries begins immediately, unless the sink's writer_identity is not permitted to write to the destination. A sink can export log entries only from the resource owning the sink.",
- "request": {
- "$ref": "LogSink"
- },
- "response": {
- "$ref": "LogSink"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/logging.admin"
- ],
- "parameters": {
- "uniqueWriterIdentity": {
- "description": "Optional. Determines the kind of IAM identity returned as writer_identity in the new sink. If this value is omitted or set to false, and if the sink's parent is a project, then the value returned as writer_identity is the same group or service account used by Stackdriver Logging before the addition of writer identities to this API. The sink's destination must be in the same project as the sink itself.If this field is set to true, or if the sink is owned by a non-project resource such as an organization, then the value of writer_identity will be a unique service account used only for exports from the new sink. For more information, see writer_identity in LogSink.",
- "type": "boolean",
- "location": "query"
- },
- "parent": {
- "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"
- }
- }
- }
- }
- },
- "exclusions": {
- "methods": {
- "list": {
- "description": "Lists all the exclusions in a parent resource.",
- "httpMethod": "GET",
- "response": {
- "$ref": "ListExclusionsResponse"
- },
- "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": {
- "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": "^projects/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/logging.admin",
- "https://www.googleapis.com/auth/logging.read"
- ],
- "flatPath": "v2/projects/{projectsId}/exclusions",
- "id": "logging.projects.exclusions.list",
- "path": "v2/{+parent}/exclusions"
- },
- "get": {
- "description": "Gets the description of an exclusion.",
- "httpMethod": "GET",
- "response": {
- "$ref": "LogExclusion"
- },
- "parameterOrder": [
- "name"
- ],
- "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"
- ],
- "flatPath": "v2/projects/{projectsId}/exclusions/{exclusionsId}",
- "id": "logging.projects.exclusions.get",
- "path": "v2/{+name}"
- },
- "patch": {
- "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": {
- "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/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/logging.admin"
- ],
- "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"
- },
- "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": "^projects/[^/]+$"
- }
- },
- "flatPath": "v2/projects/{projectsId}/exclusions",
- "path": "v2/{+parent}/exclusions",
- "id": "logging.projects.exclusions.create"
- },
- "delete": {
- "description": "Deletes an exclusion.",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "DELETE",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/logging.admin"
- ],
- "parameters": {
- "name": {
- "location": "path",
- "description": "Required. The resource name of an existing exclusion to delete:\n\"projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]\"\n\"organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]\"\n\"folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]\"\nExample: \"projects/my-project-id/exclusions/my-exclusion-id\".",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/exclusions/[^/]+$"
- }
- },
- "flatPath": "v2/projects/{projectsId}/exclusions/{exclusionsId}",
- "path": "v2/{+name}",
- "id": "logging.projects.exclusions.delete"
- }
- }
- },
- "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": {
- "flatPath": "v2/projects/{projectsId}/metrics",
- "path": "v2/{+parent}/metrics",
- "id": "logging.projects.metrics.list",
- "description": "Lists logs-based metrics.",
- "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": {
- "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 name of the project containing the metrics:\n\"projects/[PROJECT_ID]\"\n",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+$",
- "location": "path"
- }
- }
- },
- "get": {
- "response": {
- "$ref": "LogMetric"
- },
- "parameterOrder": [
- "metricName"
- ],
- "httpMethod": "GET",
- "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": "v2/projects/{projectsId}/metrics/{metricsId}",
- "path": "v2/{+metricName}",
- "id": "logging.projects.metrics.get",
- "description": "Gets a logs-based metric."
- },
- "update": {
- "description": "Creates or updates a logs-based metric.",
- "request": {
- "$ref": "LogMetric"
- },
- "response": {
- "$ref": "LogMetric"
- },
- "parameterOrder": [
- "metricName"
- ],
- "httpMethod": "PUT",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/logging.admin",
- "https://www.googleapis.com/auth/logging.write"
- ],
- "parameters": {
- "metricName": {
- "location": "path",
- "description": "The resource name of the metric to update:\n\"projects/[PROJECT_ID]/metrics/[METRIC_ID]\"\nThe updated metric must be provided in the request and it's name field must be the same as [METRIC_ID] If the metric does not exist in [PROJECT_ID], then a new metric is created.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/metrics/[^/]+$"
- }
- },
- "flatPath": "v2/projects/{projectsId}/metrics/{metricsId}",
- "path": "v2/{+metricName}",
- "id": "logging.projects.metrics.update"
- },
- "create": {
- "response": {
- "$ref": "LogMetric"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "POST",
- "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": "v2/projects/{projectsId}/metrics",
- "path": "v2/{+parent}/metrics",
- "id": "logging.projects.metrics.create",
- "request": {
- "$ref": "LogMetric"
- },
- "description": "Creates a logs-based metric."
- }
- }
- }
- }
- },
- "billingAccounts": {
- "resources": {
- "logs": {
- "methods": {
- "list": {
- "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.",
- "httpMethod": "GET",
- "response": {
- "$ref": "ListLogsResponse"
- },
- "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 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"
- ]
- },
- "delete": {
- "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,
- "type": "string",
- "pattern": "^billingAccounts/[^/]+/logs/[^/]+$"
- }
- },
- "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."
- }
- }
- },
- "sinks": {
- "methods": {
- "delete": {
- "description": "Deletes a sink. If the sink has a unique writer_identity, then that service account is also deleted.",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "sinkName"
- ],
- "httpMethod": "DELETE",
- "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"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/logging.admin"
- ],
- "flatPath": "v2/billingAccounts/{billingAccountsId}/sinks/{sinksId}",
- "path": "v2/{+sinkName}",
- "id": "logging.billingAccounts.sinks.delete"
- },
- "list": {
- "description": "Lists sinks.",
- "httpMethod": "GET",
- "response": {
- "$ref": "ListSinksResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "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": "^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}/sinks",
- "id": "logging.billingAccounts.sinks.list",
- "path": "v2/{+parent}/sinks"
- },
- "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"
- },
- "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 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": "^billingAccounts/[^/]+$"
- },
- "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"
- }
- }
- },
- "get": {
- "description": "Gets a sink.",
- "response": {
- "$ref": "LogSink"
- },
- "parameterOrder": [
- "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": "^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"
- ],
- "flatPath": "v2/billingAccounts/{billingAccountsId}/sinks/{sinksId}",
- "path": "v2/{+sinkName}",
- "id": "logging.billingAccounts.sinks.get"
- },
- "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": "^billingAccounts/[^/]+/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/billingAccounts/{billingAccountsId}/sinks/{sinksId}",
- "path": "v2/{+sinkName}",
- "id": "logging.billingAccounts.sinks.patch"
- },
- "update": {
- "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": {
- "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": {
- "location": "query",
- "description": "Optional. See sinks.create for a description of this field. When updating a sink, the effect of this field on the value of writer_identity in the updated sink depends on both the old and new values of this field:\nIf the old and new values of this field are both false or both true, then there is no change to the sink's writer_identity.\nIf the old value is false and the new value is true, then writer_identity is changed to a unique service account.\nIt is an error if the old value is true and the new value is set to false or defaulted to false.",
- "type": "boolean"
- },
- "updateMask": {
- "description": "Optional. Field mask that specifies the fields in sink that need an update. A sink field will be overwritten if, and only if, it is in the update mask. name and output only fields cannot be updated.An empty updateMask is temporarily treated as using the following mask for backwards compatibility purposes: destination,filter,includeChildren At some point in the future, behavior will be removed and specifying an empty updateMask will be an error.For a detailed FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmaskExample: updateMask=filter.",
- "format": "google-fieldmask",
- "type": "string",
- "location": "query"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/logging.admin"
- ]
- }
- }
- },
- "exclusions": {
- "methods": {
- "list": {
- "description": "Lists all the exclusions in a parent resource.",
- "response": {
- "$ref": "ListExclusionsResponse"
- },
- "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": {
- "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"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/logging.admin",
- "https://www.googleapis.com/auth/logging.read"
- ],
- "flatPath": "v2/billingAccounts/{billingAccountsId}/exclusions",
- "path": "v2/{+parent}/exclusions",
- "id": "logging.billingAccounts.exclusions.list"
- },
- "get": {
- "description": "Gets the description of an exclusion.",
- "httpMethod": "GET",
- "response": {
- "$ref": "LogExclusion"
- },
- "parameterOrder": [
- "name"
- ],
- "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": "^billingAccounts/[^/]+/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/billingAccounts/{billingAccountsId}/exclusions/{exclusionsId}",
- "id": "logging.billingAccounts.exclusions.get",
- "path": "v2/{+name}"
- },
- "patch": {
- "flatPath": "v2/billingAccounts/{billingAccountsId}/exclusions/{exclusionsId}",
- "id": "logging.billingAccounts.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": {
- "location": "query",
- "description": "Required. A nonempty list of fields to change in the existing exclusion. New values for the fields are taken from the corresponding fields in the LogExclusion included in this request. Fields not mentioned in update_mask are not changed and are ignored in the request.For example, to change the filter and description of an exclusion, specify an update_mask of \"filter,description\".",
- "format": "google-fieldmask",
- "type": "string"
- },
- "name": {
- "description": "Required. The resource name of the exclusion to update:\n\"projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]\"\n\"organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]\"\n\"folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]\"\nExample: \"projects/my-project-id/exclusions/my-exclusion-id\".",
- "required": true,
- "type": "string",
- "pattern": "^billingAccounts/[^/]+/exclusions/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/logging.admin"
- ]
- },
- "create": {
- "flatPath": "v2/billingAccounts/{billingAccountsId}/exclusions",
- "path": "v2/{+parent}/exclusions",
- "id": "logging.billingAccounts.exclusions.create",
- "request": {
- "$ref": "LogExclusion"
- },
- "description": "Creates a new exclusion in a specified parent resource. Only log entries belonging to that resource can be excluded. You can have up to 10 exclusions in a resource.",
- "response": {
- "$ref": "LogExclusion"
- },
- "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": "^billingAccounts/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/logging.admin"
- ]
- },
- "delete": {
- "description": "Deletes an exclusion.",
- "httpMethod": "DELETE",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "name"
- ],
- "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"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/logging.admin"
- ],
- "flatPath": "v2/billingAccounts/{billingAccountsId}/exclusions/{exclusionsId}",
- "id": "logging.billingAccounts.exclusions.delete",
- "path": "v2/{+name}"
- }
- }
- }
- }
- },
- "folders": {
- "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",
- "parameters": {
- "logName": {
- "description": "Required. The resource name of the log to delete:\n\"projects/[PROJECT_ID]/logs/[LOG_ID]\"\n\"organizations/[ORGANIZATION_ID]/logs/[LOG_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]\"\n\"folders/[FOLDER_ID]/logs/[LOG_ID]\"\n[LOG_ID] must be URL-encoded. For example, \"projects/my-project-id/logs/syslog\", \"organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity\". For more information about log names, see LogEntry.",
- "required": true,
- "type": "string",
- "pattern": "^folders/[^/]+/logs/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/logging.admin"
- ],
- "flatPath": "v2/folders/{foldersId}/logs/{logsId}",
- "path": "v2/{+logName}",
- "id": "logging.folders.logs.delete"
- },
- "list": {
- "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": {
- "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": "^folders/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/logging.admin",
- "https://www.googleapis.com/auth/logging.read"
- ],
- "flatPath": "v2/folders/{foldersId}/logs",
- "path": "v2/{+parent}/logs",
- "id": "logging.folders.logs.list",
- "description": "Lists the logs in projects, organizations, folders, or billing accounts. Only logs that have entries are listed."
- }
- }
- },
- "sinks": {
- "methods": {
- "get": {
- "description": "Gets a sink.",
- "httpMethod": "GET",
- "response": {
- "$ref": "LogSink"
- },
- "parameterOrder": [
- "sinkName"
- ],
- "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": "^folders/[^/]+/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"
- ],
- "flatPath": "v2/folders/{foldersId}/sinks/{sinksId}",
- "id": "logging.folders.sinks.get",
- "path": "v2/{+sinkName}"
- },
- "patch": {
- "request": {
- "$ref": "LogSink"
- },
- "description": "Updates a sink. This method replaces the following fields in the existing sink with values from the new sink: destination, and filter. The updated sink might also have a new writer_identity; see the unique_writer_identity field.",
- "response": {
- "$ref": "LogSink"
- },
- "parameterOrder": [
- "sinkName"
- ],
- "httpMethod": "PATCH",
- "parameters": {
- "sinkName": {
- "description": "Required. The full resource name of the sink to update, including the parent resource and the sink identifier:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".",
- "required": true,
- "type": "string",
- "pattern": "^folders/[^/]+/sinks/[^/]+$",
- "location": "path"
- },
- "uniqueWriterIdentity": {
- "location": "query",
- "description": "Optional. See sinks.create for a description of this field. When updating a sink, the effect of this field on the value of writer_identity in the updated sink depends on both the old and new values of this field:\nIf the old and new values of this field are both false or both true, then there is no change to the sink's writer_identity.\nIf the old value is false and the new value is true, then writer_identity is changed to a unique service account.\nIt is an error if the old value is true and the new value is set to false or defaulted to false.",
- "type": "boolean"
- },
- "updateMask": {
- "description": "Optional. Field mask that specifies the fields in sink that need an update. A sink field will be overwritten if, and only if, it is in the update mask. name and output only fields cannot be updated.An empty updateMask is temporarily treated as using the following mask for backwards compatibility purposes: destination,filter,includeChildren At some point in the future, behavior will be removed and specifying an empty updateMask will be an error.For a detailed FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmaskExample: updateMask=filter.",
- "format": "google-fieldmask",
- "type": "string",
- "location": "query"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/logging.admin"
- ],
- "flatPath": "v2/folders/{foldersId}/sinks/{sinksId}",
- "path": "v2/{+sinkName}",
- "id": "logging.folders.sinks.patch"
- },
- "update": {
- "flatPath": "v2/folders/{foldersId}/sinks/{sinksId}",
- "path": "v2/{+sinkName}",
- "id": "logging.folders.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"
- },
- "parameterOrder": [
- "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\".",
- "required": true,
- "type": "string",
- "pattern": "^folders/[^/]+/sinks/[^/]+$",
- "location": "path"
- },
- "uniqueWriterIdentity": {
- "location": "query",
- "description": "Optional. See sinks.create for a description of this field. When updating a sink, the effect of this field on the value of writer_identity in the updated sink depends on both the old and new values of this field:\nIf the old and new values of this field are both false or both true, then there is no change to the sink's writer_identity.\nIf the old value is false and the new value is true, then writer_identity is changed to a unique service account.\nIt is an error if the old value is true and the new value is set to false or defaulted to false.",
- "type": "boolean"
- },
- "updateMask": {
- "description": "Optional. Field mask that specifies the fields in sink that need an update. A sink field will be overwritten if, and only if, it is in the update mask. name and output only fields cannot be updated.An empty updateMask is temporarily treated as using the following mask for backwards compatibility purposes: destination,filter,includeChildren At some point in the future, behavior will be removed and specifying an empty updateMask will be an error.For a detailed FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmaskExample: updateMask=filter.",
- "format": "google-fieldmask",
- "type": "string",
- "location": "query"
- }
- }
- },
- "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": "^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"
- },
- "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": {
- "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": "^folders/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/logging.admin",
- "https://www.googleapis.com/auth/logging.read"
- ],
- "flatPath": "v2/folders/{foldersId}/sinks",
- "path": "v2/{+parent}/sinks",
- "id": "logging.folders.sinks.list"
- },
- "create": {
- "request": {
- "$ref": "LogSink"
- },
- "description": "Creates a sink that exports specified log entries to a destination. The export of newly-ingested log entries begins immediately, unless the sink's writer_identity is not permitted to write to the destination. A sink can export log entries only from the resource owning the sink.",
- "httpMethod": "POST",
- "parameterOrder": [
- "parent"
- ],
- "response": {
- "$ref": "LogSink"
- },
- "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": "^folders/[^/]+$"
- },
- "uniqueWriterIdentity": {
- "location": "query",
- "description": "Optional. Determines the kind of IAM identity returned as writer_identity in the new sink. If this value is omitted or set to false, and if the sink's parent is a project, then the value returned as writer_identity is the same group or service account used by Stackdriver Logging before the addition of writer identities to this API. The sink's destination must be in the same project as the sink itself.If this field is set to true, or if the sink is owned by a non-project resource such as an organization, then the value of writer_identity will be a unique service account used only for exports from the new sink. For more information, see writer_identity in LogSink.",
- "type": "boolean"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/logging.admin"
- ],
- "flatPath": "v2/folders/{foldersId}/sinks",
- "id": "logging.folders.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": {
- "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 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/[^/]+$"
- }
- },
- "flatPath": "v2/folders/{foldersId}/exclusions",
- "path": "v2/{+parent}/exclusions",
- "id": "logging.folders.exclusions.list",
- "description": "Lists all the exclusions in a parent resource."
- },
- "get": {
- "flatPath": "v2/folders/{foldersId}/exclusions/{exclusionsId}",
- "id": "logging.folders.exclusions.get",
- "path": "v2/{+name}",
- "description": "Gets the description of an exclusion.",
- "httpMethod": "GET",
- "response": {
- "$ref": "LogExclusion"
- },
- "parameterOrder": [
- "name"
- ],
- "parameters": {
- "name": {
- "description": "Required. The resource name of an existing exclusion:\n\"projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]\"\n\"organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]\"\n\"folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]\"\nExample: \"projects/my-project-id/exclusions/my-exclusion-id\".",
- "required": true,
- "type": "string",
- "pattern": "^folders/[^/]+/exclusions/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/logging.admin",
- "https://www.googleapis.com/auth/logging.read"
- ]
- },
- "patch": {
- "request": {
- "$ref": "LogExclusion"
- },
- "description": "Changes one or more properties of an existing exclusion.",
- "httpMethod": "PATCH",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "LogExclusion"
- },
- "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/[^/]+$"
- }
- },
- "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.patch",
- "path": "v2/{+name}"
- },
- "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": "^folders/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/logging.admin"
- ],
- "flatPath": "v2/folders/{foldersId}/exclusions",
- "path": "v2/{+parent}/exclusions",
- "id": "logging.folders.exclusions.create"
- },
- "delete": {
- "description": "Deletes an exclusion.",
- "httpMethod": "DELETE",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "name"
- ],
- "parameters": {
- "name": {
- "description": "Required. The resource name of an existing exclusion to delete:\n\"projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]\"\n\"organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]\"\n\"folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]\"\nExample: \"projects/my-project-id/exclusions/my-exclusion-id\".",
- "required": true,
- "type": "string",
- "pattern": "^folders/[^/]+/exclusions/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/logging.admin"
- ],
- "flatPath": "v2/folders/{foldersId}/exclusions/{exclusionsId}",
- "id": "logging.folders.exclusions.delete",
- "path": "v2/{+name}"
- }
- }
- }
- }
- },
- "exclusions": {
- "methods": {
- "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"
- },
- "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": {
- "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"
- }
- },
- "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": "^[^/]+/[^/]+/exclusions/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v2/{v2Id}/{v2Id1}/exclusions/{exclusionsId}",
- "path": "v2/{+name}",
- "id": "logging.exclusions.get"
- },
- "patch": {
- "flatPath": "v2/{v2Id}/{v2Id1}/exclusions/{exclusionsId}",
- "path": "v2/{+name}",
- "id": "logging.exclusions.patch",
- "description": "Changes one or more properties of an existing exclusion.",
- "request": {
- "$ref": "LogExclusion"
- },
- "response": {
- "$ref": "LogExclusion"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "PATCH",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/logging.admin"
- ],
- "parameters": {
- "updateMask": {
- "description": "Required. A nonempty list of fields to change in the existing exclusion. New values for the fields are taken from the corresponding fields in the LogExclusion included in this request. Fields not mentioned in update_mask are not changed and are ignored in the request.For example, to change the filter and description of an exclusion, specify an update_mask of \"filter,description\".",
- "format": "google-fieldmask",
- "type": "string",
- "location": "query"
- },
- "name": {
- "description": "Required. The resource name of the exclusion to update:\n\"projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]\"\n\"organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]\"\n\"folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]\"\nExample: \"projects/my-project-id/exclusions/my-exclusion-id\".",
- "required": true,
- "type": "string",
- "pattern": "^[^/]+/[^/]+/exclusions/[^/]+$",
- "location": "path"
- }
- }
- },
- "create": {
- "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": "^[^/]+/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/logging.admin"
- ],
- "flatPath": "v2/{v2Id}/{v2Id1}/exclusions",
- "path": "v2/{+parent}/exclusions",
- "id": "logging.exclusions.create",
- "request": {
- "$ref": "LogExclusion"
- },
- "description": "Creates a new exclusion in a specified parent resource. Only log entries belonging to that resource can be excluded. You can have up to 10 exclusions in a resource."
- },
- "delete": {
- "description": "Deletes an exclusion.",
- "httpMethod": "DELETE",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "name"
- ],
- "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": "^[^/]+/[^/]+/exclusions/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/logging.admin"
- ],
- "flatPath": "v2/{v2Id}/{v2Id1}/exclusions/{exclusionsId}",
- "id": "logging.exclusions.delete",
- "path": "v2/{+name}"
- }
- }
- },
- "monitoredResourceDescriptors": {
- "methods": {
- "list": {
- "description": "Lists the descriptors for monitored resource types used by Stackdriver Logging.",
- "response": {
- "$ref": "ListMonitoredResourceDescriptorsResponse"
- },
- "parameterOrder": [],
- "httpMethod": "GET",
- "parameters": {
- "pageToken": {
- "location": "query",
- "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.",
- "type": "string"
- },
- "pageSize": {
- "location": "query",
- "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.",
- "format": "int32",
- "type": "integer"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/logging.admin",
- "https://www.googleapis.com/auth/logging.read"
- ],
- "flatPath": "v2/monitoredResourceDescriptors",
- "path": "v2/monitoredResourceDescriptors",
- "id": "logging.monitoredResourceDescriptors.list"
- }
- }
- },
- "organizations": {
- "resources": {
- "logs": {
- "methods": {
- "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": {
- "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/[^/]+$"
- },
- "pageToken": {
- "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.",
- "type": "string",
- "location": "query"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/logging.admin",
- "https://www.googleapis.com/auth/logging.read"
- ],
- "flatPath": "v2/organizations/{organizationsId}/logs",
- "id": "logging.organizations.logs.list",
- "path": "v2/{+parent}/logs"
- },
- "delete": {
- "description": "Deletes all the log entries in a log. The log reappears if it receives new entries. Log entries written shortly before the delete operation might not be deleted.",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "logName"
- ],
- "httpMethod": "DELETE",
- "parameters": {
- "logName": {
- "description": "Required. The resource name of the log to delete:\n\"projects/[PROJECT_ID]/logs/[LOG_ID]\"\n\"organizations/[ORGANIZATION_ID]/logs/[LOG_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]\"\n\"folders/[FOLDER_ID]/logs/[LOG_ID]\"\n[LOG_ID] must be URL-encoded. For example, \"projects/my-project-id/logs/syslog\", \"organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity\". For more information about log names, see LogEntry.",
- "required": true,
- "type": "string",
- "pattern": "^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}",
- "path": "v2/{+logName}",
- "id": "logging.organizations.logs.delete"
- }
- }
- },
- "sinks": {
- "methods": {
- "get": {
- "description": "Gets a sink.",
- "httpMethod": "GET",
- "response": {
- "$ref": "LogSink"
- },
- "parameterOrder": [
- "sinkName"
- ],
- "parameters": {
- "sinkName": {
- "location": "path",
- "description": "Required. The resource name of the sink:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".",
- "required": true,
- "type": "string",
- "pattern": "^organizations/[^/]+/sinks/[^/]+$"
- }
- },
- "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/{sinksId}",
- "id": "logging.organizations.sinks.get",
- "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"
- },
- "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": {
- "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.patch"
- },
- "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": {
- "description": "Required. The full resource name of the sink to update, including the parent resource and the sink identifier:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".",
- "required": true,
- "type": "string",
- "pattern": "^organizations/[^/]+/sinks/[^/]+$",
- "location": "path"
- },
- "uniqueWriterIdentity": {
- "location": "query",
- "description": "Optional. See sinks.create for a description of this field. When updating a sink, the effect of this field on the value of writer_identity in the updated sink depends on both the old and new values of this field:\nIf the old and new values of this field are both false or both true, then there is no change to the sink's writer_identity.\nIf the old value is false and the new value is true, then writer_identity is changed to a unique service account.\nIt is an error if the old value is true and the new value is set to false or defaulted to false.",
- "type": "boolean"
- },
- "updateMask": {
- "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}",
- "path": "v2/{+sinkName}",
- "id": "logging.organizations.sinks.delete",
- "description": "Deletes a sink. If the sink has a unique writer_identity, then that service account is also deleted.",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "sinkName"
- ],
- "httpMethod": "DELETE",
- "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 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/[^/]+$"
- }
- }
- },
- "list": {
- "description": "Lists sinks.",
- "response": {
- "$ref": "ListSinksResponse"
- },
- "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": {
- "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": {
- "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": "^organizations/[^/]+$",
- "location": "path"
- },
- "uniqueWriterIdentity": {
- "description": "Optional. Determines the kind of IAM identity returned as writer_identity in the new sink. If this value is omitted or set to false, and if the sink's parent is a project, then the value returned as writer_identity is the same group or service account used by Stackdriver Logging before the addition of writer identities to this API. The sink's destination must be in the same project as the sink itself.If this field is set to true, or if the sink is owned by a non-project resource such as an organization, then the value of writer_identity will be a unique service account used only for exports from the new sink. For more information, see writer_identity in LogSink.",
- "type": "boolean",
- "location": "query"
- }
- },
- "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"
- }
- }
- },
- "exclusions": {
- "methods": {
- "list": {
- "description": "Lists all the exclusions in a parent resource.",
- "response": {
- "$ref": "ListExclusionsResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/logging.admin",
- "https://www.googleapis.com/auth/logging.read"
- ],
- "parameters": {
- "pageToken": {
- "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"
- }
- },
- "flatPath": "v2/organizations/{organizationsId}/exclusions",
- "path": "v2/{+parent}/exclusions",
- "id": "logging.organizations.exclusions.list"
- },
- "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": {
- "description": "Changes one or more properties of an existing exclusion.",
- "request": {
- "$ref": "LogExclusion"
- },
- "response": {
- "$ref": "LogExclusion"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "PATCH",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/logging.admin"
- ],
- "parameters": {
- "updateMask": {
- "description": "Required. A nonempty list of fields to change in the existing exclusion. New values for the fields are taken from the corresponding fields in the LogExclusion included in this request. Fields not mentioned in update_mask are not changed and are ignored in the request.For example, to change the filter and description of an exclusion, specify an update_mask of \"filter,description\".",
- "format": "google-fieldmask",
- "type": "string",
- "location": "query"
- },
- "name": {
- "location": "path",
- "description": "Required. The resource name of the exclusion to update:\n\"projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]\"\n\"organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]\"\n\"folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]\"\nExample: \"projects/my-project-id/exclusions/my-exclusion-id\".",
- "required": true,
- "type": "string",
- "pattern": "^organizations/[^/]+/exclusions/[^/]+$"
- }
- },
- "flatPath": "v2/organizations/{organizationsId}/exclusions/{exclusionsId}",
- "path": "v2/{+name}",
- "id": "logging.organizations.exclusions.patch"
- },
- "create": {
- "flatPath": "v2/organizations/{organizationsId}/exclusions",
- "id": "logging.organizations.exclusions.create",
- "path": "v2/{+parent}/exclusions",
- "request": {
- "$ref": "LogExclusion"
- },
- "description": "Creates a new exclusion in a specified parent resource. Only log entries belonging to that resource can be excluded. You can have up to 10 exclusions in a resource.",
- "httpMethod": "POST",
- "parameterOrder": [
- "parent"
- ],
- "response": {
- "$ref": "LogExclusion"
- },
- "parameters": {
- "parent": {
- "location": "path",
- "description": "Required. The parent resource in which to create the exclusion:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\nExamples: \"projects/my-logging-project\", \"organizations/123456789\".",
- "required": true,
- "type": "string",
- "pattern": "^organizations/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/logging.admin"
- ]
- },
- "delete": {
- "description": "Deletes an exclusion.",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "DELETE",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/logging.admin"
- ],
- "parameters": {
- "name": {
- "location": "path",
- "description": "Required. The resource name of an existing exclusion to delete:\n\"projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]\"\n\"organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]\"\n\"folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]\"\nExample: \"projects/my-project-id/exclusions/my-exclusion-id\".",
- "required": true,
- "type": "string",
- "pattern": "^organizations/[^/]+/exclusions/[^/]+$"
- }
- },
- "flatPath": "v2/organizations/{organizationsId}/exclusions/{exclusionsId}",
- "path": "v2/{+name}",
- "id": "logging.organizations.exclusions.delete"
- }
- }
- }
- }
- },
- "entries": {
- "methods": {
- "list": {
- "description": "Lists log entries. Use this method to retrieve log entries from Stackdriver Logging. For ways to export log entries, see Exporting Logs.",
- "request": {
- "$ref": "ListLogEntriesRequest"
- },
- "response": {
- "$ref": "ListLogEntriesResponse"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "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": {},
- "flatPath": "v2/entries:list",
- "path": "v2/entries:list",
- "id": "logging.entries.list"
- },
- "write": {
- "description": "Log entry resourcesWrites log entries to Stackdriver Logging. This API method is the only way to send log entries to Stackdriver Logging. This method is used, directly or indirectly, by the Stackdriver Logging agent (fluentd) and all logging libraries configured to use Stackdriver Logging.",
- "request": {
- "$ref": "WriteLogEntriesRequest"
- },
- "response": {
- "$ref": "WriteLogEntriesResponse"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/logging.admin",
- "https://www.googleapis.com/auth/logging.write"
- ],
- "parameters": {},
- "flatPath": "v2/entries:write",
- "path": "v2/entries:write",
- "id": "logging.entries.write"
- }
- }
- },
- "sinks": {
- "methods": {
- "delete": {
- "description": "Deletes a sink. If the sink has a unique writer_identity, then that service account is also deleted.",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "sinkName"
- ],
- "httpMethod": "DELETE",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/logging.admin"
- ],
- "parameters": {
- "sinkName": {
- "description": "Required. The full resource name of the sink to delete, including the parent resource and the sink identifier:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".",
- "required": true,
- "type": "string",
- "pattern": "^[^/]+/[^/]+/sinks/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v2/{v2Id}/{v2Id1}/sinks/{sinksId}",
- "path": "v2/{+sinkName}",
- "id": "logging.sinks.delete"
- },
- "list": {
- "flatPath": "v2/{v2Id}/{v2Id1}/sinks",
- "path": "v2/{+parent}/sinks",
- "id": "logging.sinks.list",
- "description": "Lists sinks.",
- "response": {
- "$ref": "ListSinksResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "GET",
- "parameters": {
- "pageSize": {
- "location": "query",
- "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.",
- "format": "int32",
- "type": "integer"
- },
- "parent": {
- "description": "Required. The parent resource whose sinks are to be listed:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n",
- "required": true,
- "type": "string",
- "pattern": "^[^/]+/[^/]+$",
- "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"
- ]
- },
- "get": {
- "description": "Gets a sink.",
- "response": {
- "$ref": "LogSink"
- },
- "parameterOrder": [
- "sinkName"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/logging.admin",
- "https://www.googleapis.com/auth/logging.read"
- ],
- "parameters": {
- "sinkName": {
- "location": "path",
- "description": "Required. The resource name of the sink:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".",
- "required": true,
- "type": "string",
- "pattern": "^[^/]+/[^/]+/sinks/[^/]+$"
- }
- },
- "flatPath": "v2/{v2Id}/{v2Id1}/sinks/{sinksId}",
- "path": "v2/{+sinkName}",
- "id": "logging.sinks.get"
- },
- "update": {
- "flatPath": "v2/{v2Id}/{v2Id1}/sinks/{sinksId}",
- "path": "v2/{+sinkName}",
- "id": "logging.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"
- },
- "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": {
- "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"
- }
- }
- },
- "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": {
- "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"
- }
- },
- "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",
- "response": {
- "$ref": "ListLogsResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "parameters": {
- "pageSize": {
- "location": "query",
- "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.",
- "format": "int32",
- "type": "integer"
- },
- "parent": {
- "location": "path",
- "description": "Required. The 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": "^[^/]+/[^/]+$"
- },
- "pageToken": {
- "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.",
- "type": "string",
- "location": "query"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/logging.admin",
- "https://www.googleapis.com/auth/logging.read"
- ],
- "flatPath": "v2/{v2Id}/{v2Id1}/logs",
- "id": "logging.logs.list",
- "path": "v2/{+parent}/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": "^[^/]+/[^/]+/logs/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v2/{v2Id}/{v2Id1}/logs/{logsId}",
- "path": "v2/{+logName}",
- "id": "logging.logs.delete"
- }
- }
- }
- },
- "parameters": {
- "quotaUser": {
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string",
- "location": "query"
- },
- "pp": {
- "description": "Pretty-print response.",
- "type": "boolean",
- "default": "true",
- "location": "query"
- },
- "bearer_token": {
- "description": "OAuth bearer token.",
- "type": "string",
- "location": "query"
- },
- "oauth_token": {
- "description": "OAuth 2.0 token for the current user.",
- "type": "string",
- "location": "query"
- },
- "upload_protocol": {
- "location": "query",
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string"
- },
- "prettyPrint": {
- "location": "query",
- "description": "Returns response with indentations and line breaks.",
- "type": "boolean",
- "default": "true"
- },
- "uploadType": {
- "location": "query",
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string"
- },
- "fields": {
- "location": "query",
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string"
- },
- "callback": {
- "description": "JSONP",
- "type": "string",
- "location": "query"
- },
- "$.xgafv": {
- "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"
- }
- },
- "version": "v2",
- "baseUrl": "https://logging.googleapis.com/",
- "servicePath": "",
"kind": "discovery#restDescription",
"description": "Writes log entries and manages your Stackdriver Logging configuration.",
+ "servicePath": "",
"basePath": "",
- "id": "logging:v2",
+ "revision": "20171229",
"documentationLink": "https://cloud.google.com/logging/docs/",
- "revision": "20171219",
+ "id": "logging:v2",
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
@@ -2566,14 +49,6 @@
"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"
@@ -2581,6 +56,14 @@
"id": {
"description": "Optional. An arbitrary operation identifier. Log entries with the same identifier are assumed to be part of the same operation.",
"type": "string"
+ },
+ "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"
}
},
"id": "LogEntryOperation"
@@ -2589,32 +72,16 @@
"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": {
- "filter": {
- "description": "Required. An advanced logs filter which is used to match log entries. Example:\n\"resource.type=gae_app AND severity\u003e=ERROR\"\nThe maximum length of the filter is 20000 characters.",
- "type": "string"
- },
- "description": {
- "description": "Optional. A description of this metric, which is used in documentation.",
- "type": "string"
- },
- "bucketOptions": {
- "description": "Optional. The bucket_options are required when the logs-based metric is using a DISTRIBUTION value type and it describes the bucket boundaries used to create a histogram of the extracted values.",
- "$ref": "BucketOptions"
- },
- "valueExtractor": {
- "description": "Optional. A value_extractor is required when using a distribution logs-based metric to extract the values to record from a log entry. Two functions are supported for value extraction: EXTRACT(field) or REGEXP_EXTRACT(field, regex). The argument are: 1. field: The name of the log entry field from which the value is to be extracted. 2. regex: A regular expression using the Google RE2 syntax (https://github.com/google/re2/wiki/Syntax) with a single capture group to extract data from the specified log entry field. The value of the field is converted to a string before applying the regex. It is an error to specify a regex that does not include exactly one capture group.The result of the extraction must be convertible to a double type, as the distribution always records double values. If either the extraction or the conversion to double fails, then those values are not recorded in the distribution.Example: REGEXP_EXTRACT(jsonPayload.request, \".*quantity=(\\d+).*\")",
- "type": "string"
- },
"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"
+ }
},
"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.",
@@ -2631,6 +98,22 @@
],
"description": "Deprecated. The API version that created or updated this metric. The v2 format is used by default and cannot be changed.",
"type": "string"
+ },
+ "filter": {
+ "description": "Required. An advanced logs filter which is used to match log entries. Example:\n\"resource.type=gae_app AND severity\u003e=ERROR\"\nThe maximum length of the filter is 20000 characters.",
+ "type": "string"
+ },
+ "description": {
+ "description": "Optional. A description of this metric, which is used in documentation.",
+ "type": "string"
+ },
+ "bucketOptions": {
+ "description": "Optional. The bucket_options are required when the logs-based metric is using a DISTRIBUTION value type and it describes the bucket boundaries used to create a histogram of the extracted values.",
+ "$ref": "BucketOptions"
+ },
+ "valueExtractor": {
+ "description": "Optional. A value_extractor is required when using a distribution logs-based metric to extract the values to record from a log entry. Two functions are supported for value extraction: EXTRACT(field) or REGEXP_EXTRACT(field, regex). The argument are: 1. field: The name of the log entry field from which the value is to be extracted. 2. regex: A regular expression using the Google RE2 syntax (https://github.com/google/re2/wiki/Syntax) with a single capture group to extract data from the specified log entry field. The value of the field is converted to a string before applying the regex. It is an error to specify a regex that does not include exactly one capture group.The result of the extraction must be convertible to a double type, as the distribution always records double values. If either the extraction or the conversion to double fails, then those values are not recorded in the distribution.Example: REGEXP_EXTRACT(jsonPayload.request, \".*quantity=(\\d+).*\")",
+ "type": "string"
}
},
"id": "LogMetric"
@@ -2639,16 +122,16 @@
"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": {
- "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"
+ },
+ "labels": {
+ "description": "Required. Values for all of the labels listed in the associated monitored resource descriptor. For example, Compute Engine VM instances use the labels \"project_id\", \"instance_id\", and \"zone\".",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
}
},
"id": "MonitoredResource"
@@ -2665,20 +148,15 @@
"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"
},
- "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": {
- "description": "Deprecated. This field is ignored when creating or updating sinks.",
- "format": "google-datetime",
+ "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"
},
- "startTime": {
+ "endTime": {
"description": "Deprecated. This field is ignored when creating or updating sinks.",
"format": "google-datetime",
"type": "string"
@@ -2687,7 +165,14 @@
"description": "Output only. An IAM identity—a service account or group—under which Stackdriver Logging writes the exported log entries to the sink's destination. This field is set by sinks.create and sinks.update, based on the setting of unique_writer_identity in those methods.Until you grant this identity write-access to the destination, log entry exports from this sink will fail. For more information, see Granting access for a resource. Consult the destination service's documentation to determine the appropriate IAM roles to assign to the identity.",
"type": "string"
},
+ "startTime": {
+ "description": "Deprecated. This field is ignored when creating or updating sinks.",
+ "format": "google-datetime",
+ "type": "string"
+ },
"outputVersionFormat": {
+ "description": "Deprecated. The log entry format to use for this sink's exported log entries. The v2 format is used by default and cannot be changed.",
+ "type": "string",
"enumDescriptions": [
"An unspecified format version that will default to V2.",
"LogEntry version 2 format.",
@@ -2697,9 +182,7 @@
"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"
+ ]
}
},
"id": "LogSink"
@@ -2708,42 +191,37 @@
"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"
},
- "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.",
- "type": "string"
- },
- "sinks": {
- "description": "A list of sinks.",
- "type": "array",
- "items": {
- "$ref": "LogSink"
- }
- }
- },
- "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": {
+ "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",
@@ -2753,8 +231,9 @@
"description": "The request method. Examples: \"GET\", \"HEAD\", \"PUT\", \"POST\".",
"type": "string"
},
- "protocol": {
- "description": "Protocol used for the request. Examples: \"HTTP/1.1\", \"HTTP/2\", \"websocket\"",
+ "requestSize": {
+ "description": "The size of the HTTP request message in bytes, including the request headers and the request body.",
+ "format": "int64",
"type": "string"
},
"responseSize": {
@@ -2762,9 +241,8 @@
"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",
+ "protocol": {
+ "description": "Protocol used for the request. Examples: \"HTTP/1.1\", \"HTTP/2\", \"websocket\"",
"type": "string"
},
"requestUrl": {
@@ -2795,27 +273,43 @@
"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"
- },
- "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"
}
},
"id": "HttpRequest"
},
+ "ListSinksResponse": {
+ "description": "Result returned from ListSinks.",
+ "type": "object",
+ "properties": {
+ "sinks": {
+ "description": "A list of sinks.",
+ "type": "array",
+ "items": {
+ "$ref": "LogSink"
+ }
+ },
+ "nextPageToken": {
+ "description": "If there might be more results than appear in this response, then nextPageToken is included. To get the next set of results, call the same method again using the value of nextPageToken as pageToken.",
+ "type": "string"
+ }
+ },
+ "id": "ListSinksResponse"
+ },
"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"
@@ -2827,17 +321,6 @@
"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"
@@ -2866,16 +349,16 @@
"description": "Result returned from ListLogEntries.",
"type": "object",
"properties": {
+ "nextPageToken": {
+ "description": "If there might be more results than those appearing in this response, then nextPageToken is included. To get the next set of results, call this method again using the value of nextPageToken as pageToken.If a value for next_page_token appears and the entries field is empty, it means that the search found no log entries so far but it did not have time to search all the possible log entries. Retry the method with this value for page_token to continue the search. Alternatively, consider speeding up the search by changing your filter to specify a single log name or resource type, or to narrow the time range of the search.",
+ "type": "string"
+ },
"entries": {
"description": "A list of log entries. If entries is empty, nextPageToken may still be returned, indicating that more entries may exist. See nextPageToken for more information.",
"type": "array",
"items": {
"$ref": "LogEntry"
}
- },
- "nextPageToken": {
- "description": "If there might be more results than those appearing in this response, then nextPageToken is included. To get the next set of results, call this method again using the value of nextPageToken as pageToken.If a value for next_page_token appears and the entries field is empty, it means that the search found no log entries so far but it did not have time to search all the possible log entries. Retry the method with this value for page_token to continue the search. Alternatively, consider speeding up the search by changing your filter to specify a single log name or resource type, or to narrow the time range of the search.",
- "type": "string"
}
},
"id": "ListLogEntriesResponse"
@@ -2978,6 +461,11 @@
"description": "The parameters to ListLogEntries.",
"type": "object",
"properties": {
+ "pageSize": {
+ "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of next_page_token in the response indicates that more results might be available.",
+ "format": "int32",
+ "type": "integer"
+ },
"orderBy": {
"description": "Optional. How the results should be sorted. Presently, the only permitted values are \"timestamp asc\" (default) and \"timestamp desc\". The first option returns entries in order of increasing values of LogEntry.timestamp (oldest first), and the second option returns entries in order of decreasing timestamps (newest first). Entries with equal timestamps are returned in order of their insert_id values.",
"type": "string"
@@ -2989,10 +477,6 @@
"type": "string"
}
},
- "filter": {
- "description": "Optional. A filter that chooses which log entries to return. See Advanced Logs Filters. Only log entries that match the filter are returned. An empty filter matches all log entries in the resources listed in resource_names. Referencing a parent resource that is not listed in resource_names will cause the filter to return no results. The maximum length of the filter is 20000 characters.",
- "type": "string"
- },
"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.",
"type": "array",
@@ -3000,14 +484,13 @@
"type": "string"
}
},
+ "filter": {
+ "description": "Optional. A filter that chooses which log entries to return. See Advanced Logs Filters. Only log entries that match the filter are returned. An empty filter matches all log entries in the resources listed in resource_names. Referencing a parent resource that is not listed in resource_names will cause the filter to return no results. The maximum length of the filter is 20000 characters.",
+ "type": "string"
+ },
"pageToken": {
"description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. page_token must be the value of next_page_token from the previous response. The values of other method parameters should be identical to those in the previous call.",
"type": "string"
- },
- "pageSize": {
- "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of next_page_token in the response indicates that more results might be available.",
- "format": "int32",
- "type": "integer"
}
},
"id": "ListLogEntriesRequest"
@@ -3082,8 +565,8 @@
"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"
+ "$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."
},
"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.",
@@ -3112,6 +595,8 @@
"type": "string"
},
"valueType": {
+ "description": "The type of data that can be assigned to the label.",
+ "type": "string",
"enumDescriptions": [
"A variable-length string. This is the default.",
"Boolean; true or false.",
@@ -3121,9 +606,7 @@
"STRING",
"BOOL",
"INT64"
- ],
- "description": "The type of data that can be assigned to the label.",
- "type": "string"
+ ]
},
"key": {
"description": "The label key.",
@@ -3145,8 +628,8 @@
"description": "The explicit buckets."
},
"exponentialBuckets": {
- "description": "The exponential buckets.",
- "$ref": "Exponential"
+ "$ref": "Exponential",
+ "description": "The exponential buckets."
}
},
"id": "BucketOptions"
@@ -3173,36 +656,11 @@
"description": "Defines a metric type and its schema. Once a metric descriptor is created, deleting or altering it stops data collection and makes the metric type's existing data unusable.",
"type": "object",
"properties": {
- "displayName": {
- "description": "A concise name for the metric, which can be displayed in user interfaces. Use sentence case without an ending period, for example \"Request count\". This field is optional but it is recommended to be set for any metrics associated with user-visible concepts, such as Quota.",
- "type": "string"
- },
- "description": {
- "description": "A detailed description of the metric, which can be used in documentation.",
- "type": "string"
- },
- "unit": {
- "description": "The unit in which the metric value is reported. It is only applicable if the value_type is INT64, DOUBLE, or DISTRIBUTION. The supported units are a subset of The Unified Code for Units of Measure (http://unitsofmeasure.org/ucum.html) standard:Basic units (UNIT)\nbit bit\nBy byte\ns second\nmin minute\nh hour\nd dayPrefixes (PREFIX)\nk kilo (10**3)\nM mega (10**6)\nG giga (10**9)\nT tera (10**12)\nP peta (10**15)\nE exa (10**18)\nZ zetta (10**21)\nY yotta (10**24)\nm milli (10**-3)\nu micro (10**-6)\nn nano (10**-9)\np pico (10**-12)\nf femto (10**-15)\na atto (10**-18)\nz zepto (10**-21)\ny yocto (10**-24)\nKi kibi (2**10)\nMi mebi (2**20)\nGi gibi (2**30)\nTi tebi (2**40)GrammarThe grammar includes the dimensionless unit 1, such as 1/s.The grammar also includes these connectors:\n/ division (as an infix operator, e.g. 1/s).\n. multiplication (as an infix operator, e.g. GBy.d)The grammar for a unit is as follows:\nExpression = Component { \".\" Component } { \"/\" Component } ;\n\nComponent = [ PREFIX ] UNIT [ Annotation ]\n | Annotation\n | \"1\"\n ;\n\nAnnotation = \"{\" NAME \"}\" ;\nNotes:\nAnnotation is just a comment if it follows a UNIT and is equivalent to 1 if it is used alone. For examples, {requests}/s == 1/s, By{transmitted}/s == By/s.\nNAME is a sequence of non-blank printable ASCII characters not containing '{' or '}'.",
- "type": "string"
- },
- "labels": {
- "description": "The set of labels that can be used to describe a specific instance of this metric type. For example, the appengine.googleapis.com/http/server/response_latencies metric type has a label for the HTTP response code, response_code, so you can look at latencies for successful responses or just for responses that failed.",
- "type": "array",
- "items": {
- "$ref": "LabelDescriptor"
- }
- },
- "name": {
- "description": "The resource name of the metric descriptor.",
- "type": "string"
- },
"type": {
"description": "The metric type, including its DNS name prefix. The type is not URL-encoded. All user-defined custom metric types have the DNS name custom.googleapis.com. Metric types should use a natural hierarchical grouping. For example:\n\"custom.googleapis.com/invoice/paid/amount\"\n\"appengine.googleapis.com/http/server/response_latencies\"\n",
"type": "string"
},
"valueType": {
- "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.",
@@ -3220,7 +678,9 @@
"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": [
@@ -3237,6 +697,29 @@
],
"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"
@@ -3245,12 +728,48 @@
"description": "An individual entry in a log.",
"type": "object",
"properties": {
+ "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"
+ },
+ "httpRequest": {
+ "description": "Optional. Information about the HTTP request associated with this log entry, if applicable.",
+ "$ref": "HttpRequest"
+ },
+ "jsonPayload": {
+ "description": "The log entry payload, represented as a structure that is expressed as a JSON object.",
+ "type": "object",
+ "additionalProperties": {
+ "description": "Properties of the object.",
+ "type": "any"
+ }
+ },
+ "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"
+ },
+ "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"
- },
- "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",
@@ -3303,42 +822,6 @@
"logName": {
"description": "Required. The resource name of the log to which this log entry belongs:\n\"projects/[PROJECT_ID]/logs/[LOG_ID]\"\n\"organizations/[ORGANIZATION_ID]/logs/[LOG_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]\"\n\"folders/[FOLDER_ID]/logs/[LOG_ID]\"\nA project number may optionally be used in place of PROJECT_ID. The project number is translated to its corresponding PROJECT_ID internally and the log_name field will contain PROJECT_ID in queries and exports.[LOG_ID] must be URL-encoded within log_name. Example: \"organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity\". [LOG_ID] must be less than 512 characters long and can only include the following characters: upper and lower case alphanumeric characters, forward-slash, underscore, hyphen, and period.For backward compatibility, if log_name begins with a forward-slash, such as /projects/..., then the log entry is ingested as usual but the forward-slash is removed. Listing the log entry will not show the leading slash and filtering for a log name with a leading slash will never return any results.",
"type": "string"
- },
- "resource": {
- "description": "Required. The monitored resource associated with this log entry. Example: a log entry that reports a database error would be associated with the monitored resource designating the particular database that reported the error.",
- "$ref": "MonitoredResource"
- },
- "httpRequest": {
- "$ref": "HttpRequest",
- "description": "Optional. Information about the HTTP request associated with this log entry, if applicable."
- },
- "jsonPayload": {
- "description": "The log entry payload, represented as a structure that is expressed as a JSON object.",
- "type": "object",
- "additionalProperties": {
- "description": "Properties of the object.",
- "type": "any"
- }
- },
- "insertId": {
- "description": "Optional. A unique identifier for the log entry. If you provide a value, then Stackdriver Logging considers other log entries in the same project, with the same timestamp, and with the same insert_id to be duplicates which can be removed. If omitted in new log entries, then Stackdriver Logging assigns its own unique identifier. The insert_id is also used to order log entries that have the same timestamp value.",
- "type": "string"
- },
- "operation": {
- "description": "Optional. Information about an operation associated with the log entry, if applicable.",
- "$ref": "LogEntryOperation"
- },
- "textPayload": {
- "description": "The log entry payload, represented as a Unicode string (UTF-8).",
- "type": "string"
- },
- "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"
- }
}
},
"id": "LogEntry"
@@ -3347,11 +830,6 @@
"description": "Complete log information about a single HTTP request to an App Engine application.",
"type": "object",
"properties": {
- "latency": {
- "description": "Latency of the request.",
- "format": "google-duration",
- "type": "string"
- },
"ip": {
"description": "Origin IP address.",
"type": "string"
@@ -3430,14 +908,14 @@
"$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"
},
+ "referrer": {
+ "description": "Referrer URL of request.",
+ "type": "string"
+ },
"requestId": {
"description": "Globally unique identifier for a request, which is based on the request start time. Request IDs for requests which started later will compare greater as strings than those for requests which started earlier.",
"type": "string"
@@ -3451,15 +929,15 @@
"format": "int32",
"type": "integer"
},
+ "resource": {
+ "description": "Contains the path and query portion of the URL that was requested. For example, if the URL was \"http://example.com/app?name=val\", the resource would be \"/app?name=val\". The fragment identifier, which is identified by the # character, is not included.",
+ "type": "string"
+ },
"pendingTime": {
"description": "Time this request spent in the pending request queue.",
"format": "google-duration",
"type": "string"
},
- "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"
- },
"taskName": {
"description": "Task name of the request, in the case of an offline request.",
"type": "string"
@@ -3473,14 +951,14 @@
"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"
},
+ "host": {
+ "description": "Internet host and port number of the resource being requested.",
+ "type": "string"
+ },
"httpVersion": {
"description": "HTTP version of request. Example: \"HTTP/1.1\".",
"type": "string"
@@ -3489,6 +967,11 @@
"description": "Time when the request started.",
"format": "google-datetime",
"type": "string"
+ },
+ "latency": {
+ "description": "Latency of the request.",
+ "format": "google-duration",
+ "type": "string"
}
},
"id": "RequestLog"
@@ -3497,10 +980,6 @@
"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"
@@ -3512,16 +991,20 @@
"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": {
+ "description": "Optional. A description of this exclusion.",
+ "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"
},
- "protocol": "rest",
"canonicalName": "Logging",
"auth": {
"oauth2": {
@@ -3543,5 +1026,2522 @@
}
}
}
- }
+ },
+ "rootUrl": "https://logging.googleapis.com/",
+ "ownerDomain": "google.com",
+ "name": "logging",
+ "batchPath": "batch",
+ "fullyEncodeReservedExpansion": true,
+ "title": "Stackdriver Logging API",
+ "ownerName": "Google",
+ "resources": {
+ "projects": {
+ "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": "^projects/[^/]+/logs/[^/]+$",
+ "location": "path"
+ }
+ },
+ "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}"
+ },
+ "list": {
+ "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": {
+ "description": "Required. The resource name that owns the logs:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+$",
+ "location": "path"
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.",
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only",
+ "https://www.googleapis.com/auth/logging.admin",
+ "https://www.googleapis.com/auth/logging.read"
+ ],
+ "flatPath": "v2/projects/{projectsId}/logs",
+ "id": "logging.projects.logs.list",
+ "path": "v2/{+parent}/logs",
+ "description": "Lists the logs in projects, organizations, folders, or billing accounts. Only logs that have entries are listed."
+ }
+ }
+ },
+ "sinks": {
+ "methods": {
+ "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": "^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"
+ },
+ "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/projects/{projectsId}/sinks/{sinksId}",
+ "path": "v2/{+sinkName}",
+ "id": "logging.projects.sinks.patch"
+ },
+ "get": {
+ "description": "Gets a sink.",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "LogSink"
+ },
+ "parameterOrder": [
+ "sinkName"
+ ],
+ "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"
+ ],
+ "flatPath": "v2/projects/{projectsId}/sinks/{sinksId}",
+ "id": "logging.projects.sinks.get",
+ "path": "v2/{+sinkName}"
+ },
+ "update": {
+ "request": {
+ "$ref": "LogSink"
+ },
+ "description": "Updates a sink. This method replaces the following fields in the existing sink with values from the new sink: destination, and filter. The updated sink might also have a new writer_identity; see the unique_writer_identity field.",
+ "httpMethod": "PUT",
+ "parameterOrder": [
+ "sinkName"
+ ],
+ "response": {
+ "$ref": "LogSink"
+ },
+ "parameters": {
+ "sinkName": {
+ "location": "path",
+ "description": "Required. The full resource name of the sink to update, including the parent resource and the sink identifier:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/sinks/[^/]+$"
+ },
+ "uniqueWriterIdentity": {
+ "description": "Optional. See sinks.create for a description of this field. When updating a sink, the effect of this field on the value of writer_identity in the updated sink depends on both the old and new values of this field:\nIf the old and new values of this field are both false or both true, then there is no change to the sink's writer_identity.\nIf the old value is false and the new value is true, then writer_identity is changed to a unique service account.\nIt is an error if the old value is true and the new value is set to false or defaulted to false.",
+ "type": "boolean",
+ "location": "query"
+ },
+ "updateMask": {
+ "location": "query",
+ "description": "Optional. Field mask that specifies the fields in sink that need an update. A sink field will be overwritten if, and only if, it is in the update mask. name and output only fields cannot be updated.An empty updateMask is temporarily treated as using the following mask for backwards compatibility purposes: destination,filter,includeChildren At some point in the future, behavior will be removed and specifying an empty updateMask will be an error.For a detailed FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmaskExample: updateMask=filter.",
+ "format": "google-fieldmask",
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/logging.admin"
+ ],
+ "flatPath": "v2/projects/{projectsId}/sinks/{sinksId}",
+ "id": "logging.projects.sinks.update",
+ "path": "v2/{+sinkName}"
+ },
+ "delete": {
+ "flatPath": "v2/projects/{projectsId}/sinks/{sinksId}",
+ "id": "logging.projects.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": "^projects/[^/]+/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",
+ "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"
+ },
+ "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"
+ }
+ },
+ "flatPath": "v2/projects/{projectsId}/sinks",
+ "path": "v2/{+parent}/sinks",
+ "id": "logging.projects.sinks.list"
+ },
+ "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": {
+ "description": "Required. The resource in which to create the sink:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\nExamples: \"projects/my-logging-project\", \"organizations/123456789\".",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+$",
+ "location": "path"
+ },
+ "uniqueWriterIdentity": {
+ "description": "Optional. Determines the kind of IAM identity returned as writer_identity in the new sink. If this value is omitted or set to false, and if the sink's parent is a project, then the value returned as writer_identity is the same group or service account used by Stackdriver Logging before the addition of writer identities to this API. The sink's destination must be in the same project as the sink itself.If this field is set to true, or if the sink is owned by a non-project resource such as an organization, then the value of writer_identity will be a unique service account used only for exports from the new sink. For more information, see writer_identity in LogSink.",
+ "type": "boolean",
+ "location": "query"
+ }
+ },
+ "flatPath": "v2/projects/{projectsId}/sinks",
+ "path": "v2/{+parent}/sinks",
+ "id": "logging.projects.sinks.create",
+ "description": "Creates a sink that exports specified log entries to a destination. The export of newly-ingested log entries begins immediately, unless the sink's writer_identity is not permitted to write to the destination. A sink can export log entries only from the resource owning the sink.",
+ "request": {
+ "$ref": "LogSink"
+ }
+ }
+ }
+ },
+ "exclusions": {
+ "methods": {
+ "delete": {
+ "description": "Deletes an exclusion.",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "DELETE",
+ "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": "^projects/[^/]+/exclusions/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/logging.admin"
+ ],
+ "flatPath": "v2/projects/{projectsId}/exclusions/{exclusionsId}",
+ "path": "v2/{+name}",
+ "id": "logging.projects.exclusions.delete"
+ },
+ "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"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only",
+ "https://www.googleapis.com/auth/logging.admin",
+ "https://www.googleapis.com/auth/logging.read"
+ ],
+ "parameters": {
+ "pageToken": {
+ "location": "query",
+ "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.",
+ "type": "string"
+ },
+ "pageSize": {
+ "location": "query",
+ "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "parent": {
+ "description": "Required. The parent resource whose exclusions are to be listed.\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+$",
+ "location": "path"
+ }
+ }
+ },
+ "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": {
+ "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": "^projects/[^/]+/exclusions/[^/]+$"
+ }
+ },
+ "flatPath": "v2/projects/{projectsId}/exclusions/{exclusionsId}",
+ "path": "v2/{+name}",
+ "id": "logging.projects.exclusions.get"
+ },
+ "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": "^projects/[^/]+/exclusions/[^/]+$"
+ }
+ },
+ "flatPath": "v2/projects/{projectsId}/exclusions/{exclusionsId}",
+ "path": "v2/{+name}",
+ "id": "logging.projects.exclusions.patch"
+ },
+ "create": {
+ "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": "^projects/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/logging.admin"
+ ],
+ "flatPath": "v2/projects/{projectsId}/exclusions",
+ "path": "v2/{+parent}/exclusions",
+ "id": "logging.projects.exclusions.create",
+ "request": {
+ "$ref": "LogExclusion"
+ },
+ "description": "Creates a new exclusion in a specified parent resource. Only log entries belonging to that resource can be excluded. You can have up to 10 exclusions in a resource."
+ }
+ }
+ },
+ "metrics": {
+ "methods": {
+ "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": "v2/projects/{projectsId}/metrics/{metricsId}",
+ "path": "v2/{+metricName}",
+ "id": "logging.projects.metrics.delete"
+ },
+ "list": {
+ "response": {
+ "$ref": "ListLogMetricsResponse"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "pageSize": {
+ "location": "query",
+ "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "parent": {
+ "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"
+ }
+ },
+ "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",
+ "path": "v2/{+parent}/metrics",
+ "id": "logging.projects.metrics.list",
+ "description": "Lists logs-based metrics."
+ },
+ "get": {
+ "description": "Gets a logs-based metric.",
+ "response": {
+ "$ref": "LogMetric"
+ },
+ "parameterOrder": [
+ "metricName"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only",
+ "https://www.googleapis.com/auth/logging.admin",
+ "https://www.googleapis.com/auth/logging.read"
+ ],
+ "parameters": {
+ "metricName": {
+ "location": "path",
+ "description": "The resource name of the desired metric:\n\"projects/[PROJECT_ID]/metrics/[METRIC_ID]\"\n",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/metrics/[^/]+$"
+ }
+ },
+ "flatPath": "v2/projects/{projectsId}/metrics/{metricsId}",
+ "path": "v2/{+metricName}",
+ "id": "logging.projects.metrics.get"
+ },
+ "update": {
+ "flatPath": "v2/projects/{projectsId}/metrics/{metricsId}",
+ "path": "v2/{+metricName}",
+ "id": "logging.projects.metrics.update",
+ "description": "Creates or updates a logs-based metric.",
+ "request": {
+ "$ref": "LogMetric"
+ },
+ "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": {
+ "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"
+ }
+ }
+ },
+ "create": {
+ "request": {
+ "$ref": "LogMetric"
+ },
+ "description": "Creates a logs-based metric.",
+ "response": {
+ "$ref": "LogMetric"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "POST",
+ "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": "v2/projects/{projectsId}/metrics",
+ "path": "v2/{+parent}/metrics",
+ "id": "logging.projects.metrics.create"
+ }
+ }
+ }
+ }
+ },
+ "billingAccounts": {
+ "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": {
+ "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": {
+ "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": {
+ "pageSize": {
+ "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.",
+ "format": "int32",
+ "type": "integer",
+ "location": "query"
+ },
+ "parent": {
+ "location": "path",
+ "description": "Required. The resource name that owns the logs:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n",
+ "required": true,
+ "type": "string",
+ "pattern": "^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"
+ }
+ },
+ "flatPath": "v2/billingAccounts/{billingAccountsId}/logs",
+ "path": "v2/{+parent}/logs",
+ "id": "logging.billingAccounts.logs.list",
+ "description": "Lists the logs in projects, organizations, folders, or billing accounts. Only logs that have entries are listed."
+ }
+ }
+ },
+ "sinks": {
+ "methods": {
+ "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": {
+ "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"
+ }
+ },
+ "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"
+ },
+ "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": {
+ "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": "^billingAccounts/[^/]+$",
+ "location": "path"
+ },
+ "uniqueWriterIdentity": {
+ "location": "query",
+ "description": "Optional. Determines the kind of IAM identity returned as writer_identity in the new sink. If this value is omitted or set to false, and if the sink's parent is a project, then the value returned as writer_identity is the same group or service account used by Stackdriver Logging before the addition of writer identities to this API. The sink's destination must be in the same project as the sink itself.If this field is set to true, or if the sink is owned by a non-project resource such as an organization, then the value of writer_identity will be a unique service account used only for exports from the new sink. For more information, see writer_identity in LogSink.",
+ "type": "boolean"
+ }
+ },
+ "flatPath": "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"
+ }
+ },
+ "get": {
+ "description": "Gets a sink.",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "LogSink"
+ },
+ "parameterOrder": [
+ "sinkName"
+ ],
+ "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"
+ ],
+ "flatPath": "v2/billingAccounts/{billingAccountsId}/sinks/{sinksId}",
+ "id": "logging.billingAccounts.sinks.get",
+ "path": "v2/{+sinkName}"
+ },
+ "patch": {
+ "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": "^billingAccounts/[^/]+/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/billingAccounts/{billingAccountsId}/sinks/{sinksId}",
+ "path": "v2/{+sinkName}",
+ "id": "logging.billingAccounts.sinks.patch",
+ "description": "Updates a sink. This method replaces the following fields in the existing sink with values from the new sink: destination, and filter. The updated sink might also have a new writer_identity; see the unique_writer_identity field.",
+ "request": {
+ "$ref": "LogSink"
+ }
+ },
+ "update": {
+ "httpMethod": "PUT",
+ "parameterOrder": [
+ "sinkName"
+ ],
+ "response": {
+ "$ref": "LogSink"
+ },
+ "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"
+ ],
+ "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": {
+ "flatPath": "v2/billingAccounts/{billingAccountsId}/sinks/{sinksId}",
+ "path": "v2/{+sinkName}",
+ "id": "logging.billingAccounts.sinks.delete",
+ "description": "Deletes a sink. If the sink has a unique writer_identity, then that service account is also deleted.",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "sinkName"
+ ],
+ "httpMethod": "DELETE",
+ "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 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/[^/]+$"
+ }
+ }
+ }
+ }
+ },
+ "exclusions": {
+ "methods": {
+ "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"
+ }
+ },
+ "flatPath": "v2/billingAccounts/{billingAccountsId}/exclusions/{exclusionsId}",
+ "path": "v2/{+name}",
+ "id": "logging.billingAccounts.exclusions.delete"
+ },
+ "list": {
+ "description": "Lists all the exclusions in a parent resource.",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "ListExclusionsResponse"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "parameters": {
+ "pageSize": {
+ "location": "query",
+ "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "parent": {
+ "location": "path",
+ "description": "Required. The parent resource whose 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": {
+ "location": "query",
+ "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.",
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only",
+ "https://www.googleapis.com/auth/logging.admin",
+ "https://www.googleapis.com/auth/logging.read"
+ ],
+ "flatPath": "v2/billingAccounts/{billingAccountsId}/exclusions",
+ "id": "logging.billingAccounts.exclusions.list",
+ "path": "v2/{+parent}/exclusions"
+ },
+ "get": {
+ "flatPath": "v2/billingAccounts/{billingAccountsId}/exclusions/{exclusionsId}",
+ "path": "v2/{+name}",
+ "id": "logging.billingAccounts.exclusions.get",
+ "description": "Gets the description of an exclusion.",
+ "response": {
+ "$ref": "LogExclusion"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only",
+ "https://www.googleapis.com/auth/logging.admin",
+ "https://www.googleapis.com/auth/logging.read"
+ ],
+ "parameters": {
+ "name": {
+ "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"
+ }
+ }
+ },
+ "patch": {
+ "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": "^billingAccounts/[^/]+/exclusions/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/logging.admin"
+ ],
+ "flatPath": "v2/billingAccounts/{billingAccountsId}/exclusions/{exclusionsId}",
+ "id": "logging.billingAccounts.exclusions.patch",
+ "path": "v2/{+name}"
+ },
+ "create": {
+ "flatPath": "v2/billingAccounts/{billingAccountsId}/exclusions",
+ "id": "logging.billingAccounts.exclusions.create",
+ "path": "v2/{+parent}/exclusions",
+ "request": {
+ "$ref": "LogExclusion"
+ },
+ "description": "Creates a new exclusion in a specified parent resource. Only log entries belonging to that resource can be excluded. You can have up to 10 exclusions in a resource.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "parent"
+ ],
+ "response": {
+ "$ref": "LogExclusion"
+ },
+ "parameters": {
+ "parent": {
+ "location": "path",
+ "description": "Required. The parent resource in which to create the exclusion:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\nExamples: \"projects/my-logging-project\", \"organizations/123456789\".",
+ "required": true,
+ "type": "string",
+ "pattern": "^billingAccounts/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/logging.admin"
+ ]
+ }
+ }
+ }
+ }
+ },
+ "folders": {
+ "resources": {
+ "logs": {
+ "methods": {
+ "list": {
+ "response": {
+ "$ref": "ListLogsResponse"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "pageToken": {
+ "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageSize": {
+ "location": "query",
+ "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "parent": {
+ "description": "Required. The resource name that owns the logs:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n",
+ "required": true,
+ "type": "string",
+ "pattern": "^folders/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only",
+ "https://www.googleapis.com/auth/logging.admin",
+ "https://www.googleapis.com/auth/logging.read"
+ ],
+ "flatPath": "v2/folders/{foldersId}/logs",
+ "path": "v2/{+parent}/logs",
+ "id": "logging.folders.logs.list",
+ "description": "Lists the logs in projects, organizations, folders, or billing accounts. Only logs that have entries are listed."
+ },
+ "delete": {
+ "flatPath": "v2/folders/{foldersId}/logs/{logsId}",
+ "id": "logging.folders.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.",
+ "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": "^folders/[^/]+/logs/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/logging.admin"
+ ]
+ }
+ }
+ },
+ "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": {
+ "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": "^folders/[^/]+$"
+ },
+ "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"
+ }
+ },
+ "flatPath": "v2/folders/{foldersId}/sinks",
+ "path": "v2/{+parent}/sinks",
+ "id": "logging.folders.sinks.list"
+ },
+ "create": {
+ "response": {
+ "$ref": "LogSink"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/logging.admin"
+ ],
+ "parameters": {
+ "uniqueWriterIdentity": {
+ "description": "Optional. Determines the kind of IAM identity returned as writer_identity in the new sink. If this value is omitted or set to false, and if the sink's parent is a project, then the value returned as writer_identity is the same group or service account used by Stackdriver Logging before the addition of writer identities to this API. The sink's destination must be in the same project as the sink itself.If this field is set to true, or if the sink is owned by a non-project resource such as an organization, then the value of writer_identity will be a unique service account used only for exports from the new sink. For more information, see writer_identity in LogSink.",
+ "type": "boolean",
+ "location": "query"
+ },
+ "parent": {
+ "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": "^folders/[^/]+$"
+ }
+ },
+ "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"
+ }
+ },
+ "get": {
+ "description": "Gets a sink.",
+ "response": {
+ "$ref": "LogSink"
+ },
+ "parameterOrder": [
+ "sinkName"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only",
+ "https://www.googleapis.com/auth/logging.admin",
+ "https://www.googleapis.com/auth/logging.read"
+ ],
+ "parameters": {
+ "sinkName": {
+ "location": "path",
+ "description": "Required. The resource name of the sink:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".",
+ "required": true,
+ "type": "string",
+ "pattern": "^folders/[^/]+/sinks/[^/]+$"
+ }
+ },
+ "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",
+ "description": "Updates a sink. This method replaces the following fields in the existing sink with values from the new sink: destination, and filter. The updated sink might also have a new writer_identity; see the unique_writer_identity field.",
+ "request": {
+ "$ref": "LogSink"
+ },
+ "response": {
+ "$ref": "LogSink"
+ },
+ "parameterOrder": [
+ "sinkName"
+ ],
+ "httpMethod": "PATCH",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/logging.admin"
+ ],
+ "parameters": {
+ "sinkName": {
+ "description": "Required. The full resource name of the sink to update, including the parent resource and the sink identifier:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".",
+ "required": true,
+ "type": "string",
+ "pattern": "^folders/[^/]+/sinks/[^/]+$",
+ "location": "path"
+ },
+ "uniqueWriterIdentity": {
+ "description": "Optional. See sinks.create for a description of this field. When updating a sink, the effect of this field on the value of writer_identity in the updated sink depends on both the old and new values of this field:\nIf the old and new values of this field are both false or both true, then there is no change to the sink's writer_identity.\nIf the old value is false and the new value is true, then writer_identity is changed to a unique service account.\nIt is an error if the old value is true and the new value is set to false or defaulted to false.",
+ "type": "boolean",
+ "location": "query"
+ },
+ "updateMask": {
+ "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": {
+ "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": {
+ "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/folders/{foldersId}/sinks/{sinksId}",
+ "path": "v2/{+sinkName}",
+ "id": "logging.folders.sinks.update"
+ },
+ "delete": {
+ "description": "Deletes a sink. If the sink has a unique writer_identity, then that service account is also deleted.",
+ "httpMethod": "DELETE",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "sinkName"
+ ],
+ "parameters": {
+ "sinkName": {
+ "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}",
+ "id": "logging.folders.sinks.delete",
+ "path": "v2/{+sinkName}"
+ }
+ }
+ },
+ "exclusions": {
+ "methods": {
+ "delete": {
+ "description": "Deletes an exclusion.",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "DELETE",
+ "parameters": {
+ "name": {
+ "description": "Required. The resource name of an existing exclusion to delete:\n\"projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]\"\n\"organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]\"\n\"folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]\"\nExample: \"projects/my-project-id/exclusions/my-exclusion-id\".",
+ "required": true,
+ "type": "string",
+ "pattern": "^folders/[^/]+/exclusions/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/logging.admin"
+ ],
+ "flatPath": "v2/folders/{foldersId}/exclusions/{exclusionsId}",
+ "path": "v2/{+name}",
+ "id": "logging.folders.exclusions.delete"
+ },
+ "list": {
+ "description": "Lists all the exclusions in a parent resource.",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "ListExclusionsResponse"
+ },
+ "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": {
+ "description": "Required. The parent resource whose exclusions are to be listed.\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n",
+ "required": true,
+ "type": "string",
+ "pattern": "^folders/[^/]+$",
+ "location": "path"
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.",
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only",
+ "https://www.googleapis.com/auth/logging.admin",
+ "https://www.googleapis.com/auth/logging.read"
+ ],
+ "flatPath": "v2/folders/{foldersId}/exclusions",
+ "id": "logging.folders.exclusions.list",
+ "path": "v2/{+parent}/exclusions"
+ },
+ "get": {
+ "description": "Gets the description of an exclusion.",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "LogExclusion"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "description": "Required. The resource name of an existing exclusion:\n\"projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]\"\n\"organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]\"\n\"folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]\"\nExample: \"projects/my-project-id/exclusions/my-exclusion-id\".",
+ "required": true,
+ "type": "string",
+ "pattern": "^folders/[^/]+/exclusions/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only",
+ "https://www.googleapis.com/auth/logging.admin",
+ "https://www.googleapis.com/auth/logging.read"
+ ],
+ "flatPath": "v2/folders/{foldersId}/exclusions/{exclusionsId}",
+ "id": "logging.folders.exclusions.get",
+ "path": "v2/{+name}"
+ },
+ "patch": {
+ "description": "Changes one or more properties of an existing exclusion.",
+ "request": {
+ "$ref": "LogExclusion"
+ },
+ "response": {
+ "$ref": "LogExclusion"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "PATCH",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/logging.admin"
+ ],
+ "parameters": {
+ "updateMask": {
+ "location": "query",
+ "description": "Required. A nonempty list of fields to change in the existing exclusion. New values for the fields are taken from the corresponding fields in the LogExclusion included in this request. Fields not mentioned in update_mask are not changed and are ignored in the request.For example, to change the filter and description of an exclusion, specify an update_mask of \"filter,description\".",
+ "format": "google-fieldmask",
+ "type": "string"
+ },
+ "name": {
+ "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/folders/{foldersId}/exclusions/{exclusionsId}",
+ "path": "v2/{+name}",
+ "id": "logging.folders.exclusions.patch"
+ },
+ "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": {
+ "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"
+ }
+ },
+ "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"
+ }
+ }
+ }
+ }
+ }
+ },
+ "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": {
+ "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": "^[^/]+/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v2/{v2Id}/{v2Id1}/exclusions",
+ "path": "v2/{+parent}/exclusions",
+ "id": "logging.exclusions.list",
+ "description": "Lists all the exclusions in a parent resource."
+ },
+ "get": {
+ "description": "Gets the description of an exclusion.",
+ "response": {
+ "$ref": "LogExclusion"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "name": {
+ "description": "Required. The resource name of an existing exclusion:\n\"projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]\"\n\"organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]\"\n\"folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]\"\nExample: \"projects/my-project-id/exclusions/my-exclusion-id\".",
+ "required": true,
+ "type": "string",
+ "pattern": "^[^/]+/[^/]+/exclusions/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only",
+ "https://www.googleapis.com/auth/logging.admin",
+ "https://www.googleapis.com/auth/logging.read"
+ ],
+ "flatPath": "v2/{v2Id}/{v2Id1}/exclusions/{exclusionsId}",
+ "path": "v2/{+name}",
+ "id": "logging.exclusions.get"
+ },
+ "patch": {
+ "description": "Changes one or more properties of an existing exclusion.",
+ "request": {
+ "$ref": "LogExclusion"
+ },
+ "response": {
+ "$ref": "LogExclusion"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "PATCH",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/logging.admin"
+ ],
+ "parameters": {
+ "updateMask": {
+ "location": "query",
+ "description": "Required. A nonempty list of fields to change in the existing exclusion. New values for the fields are taken from the corresponding fields in the LogExclusion included in this request. Fields not mentioned in update_mask are not changed and are ignored in the request.For example, to change the filter and description of an exclusion, specify an update_mask of \"filter,description\".",
+ "format": "google-fieldmask",
+ "type": "string"
+ },
+ "name": {
+ "description": "Required. The resource name of the exclusion to update:\n\"projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]\"\n\"organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]\"\n\"folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]\"\nExample: \"projects/my-project-id/exclusions/my-exclusion-id\".",
+ "required": true,
+ "type": "string",
+ "pattern": "^[^/]+/[^/]+/exclusions/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v2/{v2Id}/{v2Id1}/exclusions/{exclusionsId}",
+ "path": "v2/{+name}",
+ "id": "logging.exclusions.patch"
+ },
+ "create": {
+ "flatPath": "v2/{v2Id}/{v2Id1}/exclusions",
+ "path": "v2/{+parent}/exclusions",
+ "id": "logging.exclusions.create",
+ "request": {
+ "$ref": "LogExclusion"
+ },
+ "description": "Creates a new exclusion in a specified parent resource. Only log entries belonging to that resource can be excluded. You can have up to 10 exclusions in a resource.",
+ "response": {
+ "$ref": "LogExclusion"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "POST",
+ "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": "^[^/]+/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/logging.admin"
+ ]
+ },
+ "delete": {
+ "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": "^[^/]+/[^/]+/exclusions/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/logging.admin"
+ ],
+ "flatPath": "v2/{v2Id}/{v2Id1}/exclusions/{exclusionsId}",
+ "id": "logging.exclusions.delete",
+ "path": "v2/{+name}",
+ "description": "Deletes an exclusion."
+ }
+ }
+ },
+ "monitoredResourceDescriptors": {
+ "methods": {
+ "list": {
+ "flatPath": "v2/monitoredResourceDescriptors",
+ "id": "logging.monitoredResourceDescriptors.list",
+ "path": "v2/monitoredResourceDescriptors",
+ "description": "Lists the descriptors for monitored resource types used by Stackdriver Logging.",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "ListMonitoredResourceDescriptorsResponse"
+ },
+ "parameterOrder": [],
+ "parameters": {
+ "pageToken": {
+ "location": "query",
+ "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.",
+ "type": "string"
+ },
+ "pageSize": {
+ "location": "query",
+ "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only",
+ "https://www.googleapis.com/auth/logging.admin",
+ "https://www.googleapis.com/auth/logging.read"
+ ]
+ }
+ }
+ },
+ "organizations": {
+ "resources": {
+ "exclusions": {
+ "methods": {
+ "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": {
+ "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": "^organizations/[^/]+$"
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.",
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only",
+ "https://www.googleapis.com/auth/logging.admin",
+ "https://www.googleapis.com/auth/logging.read"
+ ]
+ },
+ "get": {
+ "flatPath": "v2/organizations/{organizationsId}/exclusions/{exclusionsId}",
+ "path": "v2/{+name}",
+ "id": "logging.organizations.exclusions.get",
+ "description": "Gets the description of an exclusion.",
+ "response": {
+ "$ref": "LogExclusion"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "name": {
+ "description": "Required. The resource name of an existing exclusion:\n\"projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]\"\n\"organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]\"\n\"folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]\"\nExample: \"projects/my-project-id/exclusions/my-exclusion-id\".",
+ "required": true,
+ "type": "string",
+ "pattern": "^organizations/[^/]+/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"
+ ]
+ },
+ "patch": {
+ "flatPath": "v2/organizations/{organizationsId}/exclusions/{exclusionsId}",
+ "path": "v2/{+name}",
+ "id": "logging.organizations.exclusions.patch",
+ "description": "Changes one or more properties of an existing exclusion.",
+ "request": {
+ "$ref": "LogExclusion"
+ },
+ "response": {
+ "$ref": "LogExclusion"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "PATCH",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/logging.admin"
+ ],
+ "parameters": {
+ "updateMask": {
+ "description": "Required. A nonempty list of fields to change in the existing exclusion. New values for the fields are taken from the corresponding fields in the LogExclusion included in this request. Fields not mentioned in update_mask are not changed and are ignored in the request.For example, to change the filter and description of an exclusion, specify an update_mask of \"filter,description\".",
+ "format": "google-fieldmask",
+ "type": "string",
+ "location": "query"
+ },
+ "name": {
+ "location": "path",
+ "description": "Required. The resource name of the exclusion to update:\n\"projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]\"\n\"organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]\"\n\"folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]\"\nExample: \"projects/my-project-id/exclusions/my-exclusion-id\".",
+ "required": true,
+ "type": "string",
+ "pattern": "^organizations/[^/]+/exclusions/[^/]+$"
+ }
+ }
+ },
+ "create": {
+ "flatPath": "v2/organizations/{organizationsId}/exclusions",
+ "id": "logging.organizations.exclusions.create",
+ "path": "v2/{+parent}/exclusions",
+ "request": {
+ "$ref": "LogExclusion"
+ },
+ "description": "Creates a new exclusion in a specified parent resource. Only log entries belonging to that resource can be excluded. You can have up to 10 exclusions in a resource.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "parent"
+ ],
+ "response": {
+ "$ref": "LogExclusion"
+ },
+ "parameters": {
+ "parent": {
+ "location": "path",
+ "description": "Required. The parent resource in which to create the exclusion:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\nExamples: \"projects/my-logging-project\", \"organizations/123456789\".",
+ "required": true,
+ "type": "string",
+ "pattern": "^organizations/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/logging.admin"
+ ]
+ },
+ "delete": {
+ "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": "^organizations/[^/]+/exclusions/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v2/organizations/{organizationsId}/exclusions/{exclusionsId}",
+ "path": "v2/{+name}",
+ "id": "logging.organizations.exclusions.delete",
+ "description": "Deletes an exclusion."
+ }
+ }
+ },
+ "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": {
+ "location": "path",
+ "description": "Required. The resource name of the log to delete:\n\"projects/[PROJECT_ID]/logs/[LOG_ID]\"\n\"organizations/[ORGANIZATION_ID]/logs/[LOG_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]\"\n\"folders/[FOLDER_ID]/logs/[LOG_ID]\"\n[LOG_ID] must be URL-encoded. For example, \"projects/my-project-id/logs/syslog\", \"organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity\". For more information about log names, see LogEntry.",
+ "required": true,
+ "type": "string",
+ "pattern": "^organizations/[^/]+/logs/[^/]+$"
+ }
+ },
+ "flatPath": "v2/organizations/{organizationsId}/logs/{logsId}",
+ "path": "v2/{+logName}",
+ "id": "logging.organizations.logs.delete"
+ },
+ "list": {
+ "response": {
+ "$ref": "ListLogsResponse"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "pageSize": {
+ "location": "query",
+ "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "parent": {
+ "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/[^/]+$"
+ },
+ "pageToken": {
+ "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only",
+ "https://www.googleapis.com/auth/logging.admin",
+ "https://www.googleapis.com/auth/logging.read"
+ ],
+ "flatPath": "v2/organizations/{organizationsId}/logs",
+ "path": "v2/{+parent}/logs",
+ "id": "logging.organizations.logs.list",
+ "description": "Lists the logs in projects, organizations, folders, or billing accounts. Only logs that have entries are listed."
+ }
+ }
+ },
+ "sinks": {
+ "methods": {
+ "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": {
+ "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": "PATCH",
+ "parameterOrder": [
+ "sinkName"
+ ],
+ "response": {
+ "$ref": "LogSink"
+ },
+ "parameters": {
+ "sinkName": {
+ "description": "Required. The full resource name of the sink to update, including the parent resource and the sink identifier:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".",
+ "required": true,
+ "type": "string",
+ "pattern": "^organizations/[^/]+/sinks/[^/]+$",
+ "location": "path"
+ },
+ "uniqueWriterIdentity": {
+ "description": "Optional. See sinks.create for a description of this field. When updating a sink, the effect of this field on the value of writer_identity in the updated sink depends on both the old and new values of this field:\nIf the old and new values of this field are both false or both true, then there is no change to the sink's writer_identity.\nIf the old value is false and the new value is true, then writer_identity is changed to a unique service account.\nIt is an error if the old value is true and the new value is set to false or defaulted to false.",
+ "type": "boolean",
+ "location": "query"
+ },
+ "updateMask": {
+ "description": "Optional. Field mask that specifies the fields in sink that need an update. A sink field will be overwritten if, and only if, it is in the update mask. name and output only fields cannot be updated.An empty updateMask is temporarily treated as using the following mask for backwards compatibility purposes: destination,filter,includeChildren At some point in the future, behavior will be removed and specifying an empty updateMask will be an error.For a detailed FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmaskExample: updateMask=filter.",
+ "format": "google-fieldmask",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/logging.admin"
+ ],
+ "flatPath": "v2/organizations/{organizationsId}/sinks/{sinksId}",
+ "id": "logging.organizations.sinks.patch",
+ "path": "v2/{+sinkName}"
+ },
+ "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": {
+ "description": "Required. The full resource name of the sink to update, including the parent resource and the sink identifier:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".",
+ "required": true,
+ "type": "string",
+ "pattern": "^organizations/[^/]+/sinks/[^/]+$",
+ "location": "path"
+ },
+ "uniqueWriterIdentity": {
+ "description": "Optional. See sinks.create for a description of this field. When updating a sink, the effect of this field on the value of writer_identity in the updated sink depends on both the old and new values of this field:\nIf the old and new values of this field are both false or both true, then there is no change to the sink's writer_identity.\nIf the old value is false and the new value is true, then writer_identity is changed to a unique service account.\nIt is an error if the old value is true and the new value is set to false or defaulted to false.",
+ "type": "boolean",
+ "location": "query"
+ },
+ "updateMask": {
+ "location": "query",
+ "description": "Optional. Field mask that specifies the fields in sink that need an update. A sink field will be overwritten if, and only if, it is in the update mask. name and output only fields cannot be updated.An empty updateMask is temporarily treated as using the following mask for backwards compatibility purposes: destination,filter,includeChildren At some point in the future, behavior will be removed and specifying an empty updateMask will be an error.For a detailed FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmaskExample: updateMask=filter.",
+ "format": "google-fieldmask",
+ "type": "string"
+ }
+ },
+ "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": {
+ "httpMethod": "DELETE",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "sinkName"
+ ],
+ "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": "^organizations/[^/]+/sinks/[^/]+$",
+ "location": "path"
+ }
+ },
+ "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.delete",
+ "path": "v2/{+sinkName}",
+ "description": "Deletes a sink. If the sink has a unique writer_identity, then that service account is also deleted."
+ },
+ "list": {
+ "response": {
+ "$ref": "ListSinksResponse"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only",
+ "https://www.googleapis.com/auth/logging.admin",
+ "https://www.googleapis.com/auth/logging.read"
+ ],
+ "parameters": {
+ "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/[^/]+$"
+ },
+ "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"
+ }
+ },
+ "flatPath": "v2/organizations/{organizationsId}/sinks",
+ "path": "v2/{+parent}/sinks",
+ "id": "logging.organizations.sinks.list",
+ "description": "Lists sinks."
+ },
+ "create": {
+ "flatPath": "v2/organizations/{organizationsId}/sinks",
+ "path": "v2/{+parent}/sinks",
+ "id": "logging.organizations.sinks.create",
+ "description": "Creates a sink that exports specified log entries to a destination. The export of newly-ingested log entries begins immediately, unless the sink's writer_identity is not permitted to write to the destination. A sink can export log entries only from the resource owning the sink.",
+ "request": {
+ "$ref": "LogSink"
+ },
+ "response": {
+ "$ref": "LogSink"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/logging.admin"
+ ],
+ "parameters": {
+ "parent": {
+ "description": "Required. The resource in which to create the sink:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\nExamples: \"projects/my-logging-project\", \"organizations/123456789\".",
+ "required": true,
+ "type": "string",
+ "pattern": "^organizations/[^/]+$",
+ "location": "path"
+ },
+ "uniqueWriterIdentity": {
+ "description": "Optional. Determines the kind of IAM identity returned as writer_identity in the new sink. If this value is omitted or set to false, and if the sink's parent is a project, then the value returned as writer_identity is the same group or service account used by Stackdriver Logging before the addition of writer identities to this API. The sink's destination must be in the same project as the sink itself.If this field is set to true, or if the sink is owned by a non-project resource such as an organization, then the value of writer_identity will be a unique service account used only for exports from the new sink. For more information, see writer_identity in LogSink.",
+ "type": "boolean",
+ "location": "query"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "entries": {
+ "methods": {
+ "list": {
+ "request": {
+ "$ref": "ListLogEntriesRequest"
+ },
+ "description": "Lists log entries. Use this method to retrieve log entries from Stackdriver Logging. For ways to export log entries, see Exporting Logs.",
+ "response": {
+ "$ref": "ListLogEntriesResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "parameters": {},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only",
+ "https://www.googleapis.com/auth/logging.admin",
+ "https://www.googleapis.com/auth/logging.read"
+ ],
+ "flatPath": "v2/entries:list",
+ "path": "v2/entries:list",
+ "id": "logging.entries.list"
+ },
+ "write": {
+ "response": {
+ "$ref": "WriteLogEntriesResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/logging.admin",
+ "https://www.googleapis.com/auth/logging.write"
+ ],
+ "parameters": {},
+ "flatPath": "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"
+ }
+ }
+ }
+ },
+ "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": "^[^/]+/[^/]+/logs/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v2/{v2Id}/{v2Id1}/logs/{logsId}",
+ "path": "v2/{+logName}",
+ "id": "logging.logs.delete"
+ },
+ "list": {
+ "flatPath": "v2/{v2Id}/{v2Id1}/logs",
+ "id": "logging.logs.list",
+ "path": "v2/{+parent}/logs",
+ "description": "Lists the logs in projects, organizations, folders, or billing accounts. Only logs that have entries are listed.",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "ListLogsResponse"
+ },
+ "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 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"
+ }
+ },
+ "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": {
+ "delete": {
+ "description": "Deletes a sink. If the sink has a unique writer_identity, then that service account is also deleted.",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "sinkName"
+ ],
+ "httpMethod": "DELETE",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/logging.admin"
+ ],
+ "parameters": {
+ "sinkName": {
+ "description": "Required. The full resource name of the sink to delete, including the parent resource and the sink identifier:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".",
+ "required": true,
+ "type": "string",
+ "pattern": "^[^/]+/[^/]+/sinks/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v2/{v2Id}/{v2Id1}/sinks/{sinksId}",
+ "path": "v2/{+sinkName}",
+ "id": "logging.sinks.delete"
+ },
+ "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": {
+ "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": "^[^/]+/[^/]+$",
+ "location": "path"
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.",
+ "type": "string"
+ }
+ }
+ },
+ "get": {
+ "description": "Gets a sink.",
+ "response": {
+ "$ref": "LogSink"
+ },
+ "parameterOrder": [
+ "sinkName"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only",
+ "https://www.googleapis.com/auth/logging.admin",
+ "https://www.googleapis.com/auth/logging.read"
+ ],
+ "parameters": {
+ "sinkName": {
+ "location": "path",
+ "description": "Required. The resource name of the sink:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".",
+ "required": true,
+ "type": "string",
+ "pattern": "^[^/]+/[^/]+/sinks/[^/]+$"
+ }
+ },
+ "flatPath": "v2/{v2Id}/{v2Id1}/sinks/{sinksId}",
+ "path": "v2/{+sinkName}",
+ "id": "logging.sinks.get"
+ },
+ "update": {
+ "flatPath": "v2/{v2Id}/{v2Id1}/sinks/{sinksId}",
+ "path": "v2/{+sinkName}",
+ "id": "logging.sinks.update",
+ "request": {
+ "$ref": "LogSink"
+ },
+ "description": "Updates a sink. This method replaces the following fields in the existing sink with values from the new sink: destination, and filter. The updated sink might also have a new writer_identity; see the unique_writer_identity field.",
+ "response": {
+ "$ref": "LogSink"
+ },
+ "parameterOrder": [
+ "sinkName"
+ ],
+ "httpMethod": "PUT",
+ "parameters": {
+ "sinkName": {
+ "description": "Required. The full resource name of the sink to update, including the parent resource and the sink identifier:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".",
+ "required": true,
+ "type": "string",
+ "pattern": "^[^/]+/[^/]+/sinks/[^/]+$",
+ "location": "path"
+ },
+ "uniqueWriterIdentity": {
+ "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"
+ ]
+ },
+ "create": {
+ "description": "Creates a sink that exports specified log entries to a destination. The export of newly-ingested log entries begins immediately, unless the sink's writer_identity is not permitted to write to the destination. A sink can export log entries only from the resource owning the sink.",
+ "request": {
+ "$ref": "LogSink"
+ },
+ "response": {
+ "$ref": "LogSink"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/logging.admin"
+ ],
+ "parameters": {
+ "parent": {
+ "description": "Required. The resource in which to create the sink:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\nExamples: \"projects/my-logging-project\", \"organizations/123456789\".",
+ "required": true,
+ "type": "string",
+ "pattern": "^[^/]+/[^/]+$",
+ "location": "path"
+ },
+ "uniqueWriterIdentity": {
+ "location": "query",
+ "description": "Optional. Determines the kind of IAM identity returned as writer_identity in the new sink. If this value is omitted or set to false, and if the sink's parent is a project, then the value returned as writer_identity is the same group or service account used by Stackdriver Logging before the addition of writer identities to this API. The sink's destination must be in the same project as the sink itself.If this field is set to true, or if the sink is owned by a non-project resource such as an organization, then the value of writer_identity will be a unique service account used only for exports from the new sink. For more information, see writer_identity in LogSink.",
+ "type": "boolean"
+ }
+ },
+ "flatPath": "v2/{v2Id}/{v2Id1}/sinks",
+ "path": "v2/{+parent}/sinks",
+ "id": "logging.sinks.create"
+ }
+ }
+ }
+ },
+ "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": {
+ "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"
+ },
+ "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": {
+ "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": "v2",
+ "baseUrl": "https://logging.googleapis.com/"
}
diff --git a/logging/v2beta1/logging-api.json b/logging/v2beta1/logging-api.json
index 0573711..92444b1 100644
--- a/logging/v2beta1/logging-api.json
+++ b/logging/v2beta1/logging-api.json
@@ -1,7 +1,946 @@
{
+ "ownerDomain": "google.com",
+ "name": "logging",
+ "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": {
+ "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",
+ "path": "v2beta1/monitoredResourceDescriptors",
+ "id": "logging.monitoredResourceDescriptors.list",
+ "description": "Lists the descriptors for monitored resource types used by Stackdriver Logging."
+ }
+ }
+ },
+ "organizations": {
+ "resources": {
+ "logs": {
+ "methods": {
+ "delete": {
+ "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.",
+ "httpMethod": "DELETE",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "logName"
+ ],
+ "parameters": {
+ "logName": {
+ "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."
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/logging.admin"
+ ]
+ },
+ "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": {
+ "parent": {
+ "description": "Required. The resource name that owns the logs:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n",
+ "required": true,
+ "type": "string",
+ "pattern": "^organizations/[^/]+$",
+ "location": "path"
+ },
+ "pageToken": {
+ "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageSize": {
+ "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.",
+ "format": "int32",
+ "type": "integer",
+ "location": "query"
+ }
+ },
+ "flatPath": "v2beta1/organizations/{organizationsId}/logs",
+ "path": "v2beta1/{+parent}/logs",
+ "id": "logging.organizations.logs.list"
+ }
+ }
+ }
+ }
+ },
+ "entries": {
+ "methods": {
+ "list": {
+ "parameters": {},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only",
+ "https://www.googleapis.com/auth/logging.admin",
+ "https://www.googleapis.com/auth/logging.read"
+ ],
+ "flatPath": "v2beta1/entries:list",
+ "id": "logging.entries.list",
+ "path": "v2beta1/entries:list",
+ "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"
+ }
+ },
+ "write": {
+ "flatPath": "v2beta1/entries:write",
+ "id": "logging.entries.write",
+ "path": "v2beta1/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"
+ },
+ "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": {}
+ }
+ }
+ },
+ "projects": {
+ "resources": {
+ "metrics": {
+ "methods": {
+ "delete": {
+ "flatPath": "v2beta1/projects/{projectsId}/metrics/{metricsId}",
+ "path": "v2beta1/{+metricName}",
+ "id": "logging.projects.metrics.delete",
+ "description": "Deletes a logs-based metric.",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "metricName"
+ ],
+ "httpMethod": "DELETE",
+ "parameters": {
+ "metricName": {
+ "pattern": "^projects/[^/]+/metrics/[^/]+$",
+ "location": "path",
+ "description": "The resource name of the metric to delete:\n\"projects/[PROJECT_ID]/metrics/[METRIC_ID]\"\n",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/logging.admin",
+ "https://www.googleapis.com/auth/logging.write"
+ ]
+ },
+ "list": {
+ "description": "Lists logs-based metrics.",
+ "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": {
+ "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 name of the project containing the metrics:\n\"projects/[PROJECT_ID]\"\n",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v2beta1/projects/{projectsId}/metrics",
+ "path": "v2beta1/{+parent}/metrics",
+ "id": "logging.projects.metrics.list"
+ },
+ "get": {
+ "description": "Gets a logs-based metric.",
+ "response": {
+ "$ref": "LogMetric"
+ },
+ "parameterOrder": [
+ "metricName"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "metricName": {
+ "pattern": "^projects/[^/]+/metrics/[^/]+$",
+ "location": "path",
+ "description": "The resource name of the desired metric:\n\"projects/[PROJECT_ID]/metrics/[METRIC_ID]\"\n",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only",
+ "https://www.googleapis.com/auth/logging.admin",
+ "https://www.googleapis.com/auth/logging.read"
+ ],
+ "flatPath": "v2beta1/projects/{projectsId}/metrics/{metricsId}",
+ "path": "v2beta1/{+metricName}",
+ "id": "logging.projects.metrics.get"
+ },
+ "update": {
+ "request": {
+ "$ref": "LogMetric"
+ },
+ "description": "Creates or updates a logs-based metric.",
+ "response": {
+ "$ref": "LogMetric"
+ },
+ "parameterOrder": [
+ "metricName"
+ ],
+ "httpMethod": "PUT",
+ "parameters": {
+ "metricName": {
+ "description": "The resource name of the metric to update:\n\"projects/[PROJECT_ID]/metrics/[METRIC_ID]\"\nThe updated metric must be provided in the request and it's name field must be the same as [METRIC_ID] If the metric does not exist in [PROJECT_ID], then a new metric is created.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/metrics/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/logging.admin",
+ "https://www.googleapis.com/auth/logging.write"
+ ],
+ "flatPath": "v2beta1/projects/{projectsId}/metrics/{metricsId}",
+ "path": "v2beta1/{+metricName}",
+ "id": "logging.projects.metrics.update"
+ },
+ "create": {
+ "request": {
+ "$ref": "LogMetric"
+ },
+ "description": "Creates a logs-based metric.",
+ "response": {
+ "$ref": "LogMetric"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "POST",
+ "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",
+ "path": "v2beta1/{+parent}/metrics",
+ "id": "logging.projects.metrics.create"
+ }
+ }
+ },
+ "logs": {
+ "methods": {
+ "delete": {
+ "httpMethod": "DELETE",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "logName"
+ ],
+ "parameters": {
+ "logName": {
+ "pattern": "^projects/[^/]+/logs/[^/]+$",
+ "location": "path",
+ "description": "Required. The resource name of the log to delete:\n\"projects/[PROJECT_ID]/logs/[LOG_ID]\"\n\"organizations/[ORGANIZATION_ID]/logs/[LOG_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]\"\n\"folders/[FOLDER_ID]/logs/[LOG_ID]\"\n[LOG_ID] must be URL-encoded. For example, \"projects/my-project-id/logs/syslog\", \"organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity\". For more information about log names, see LogEntry.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/logging.admin"
+ ],
+ "flatPath": "v2beta1/projects/{projectsId}/logs/{logsId}",
+ "id": "logging.projects.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.",
+ "response": {
+ "$ref": "ListLogsResponse"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "parent": {
+ "description": "Required. The resource name that owns the logs:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+$",
+ "location": "path"
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.",
+ "type": "string"
+ },
+ "pageSize": {
+ "location": "query",
+ "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only",
+ "https://www.googleapis.com/auth/logging.admin",
+ "https://www.googleapis.com/auth/logging.read"
+ ],
+ "flatPath": "v2beta1/projects/{projectsId}/logs",
+ "path": "v2beta1/{+parent}/logs",
+ "id": "logging.projects.logs.list"
+ }
+ }
+ },
+ "sinks": {
+ "methods": {
+ "list": {
+ "flatPath": "v2beta1/projects/{projectsId}/sinks",
+ "path": "v2beta1/{+parent}/sinks",
+ "id": "logging.projects.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": {
+ "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": {
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+$",
+ "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"
+ }
+ }
+ },
+ "get": {
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "LogSink"
+ },
+ "parameterOrder": [
+ "sinkName"
+ ],
+ "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"
+ ],
+ "flatPath": "v2beta1/projects/{projectsId}/sinks/{sinksId}",
+ "id": "logging.projects.sinks.get",
+ "path": "v2beta1/{+sinkName}",
+ "description": "Gets a sink."
+ },
+ "update": {
+ "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": {
+ "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": "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.",
+ "response": {
+ "$ref": "LogSink"
+ },
+ "parameterOrder": [
+ "sinkName"
+ ],
+ "httpMethod": "PUT"
+ },
+ "create": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "parent"
+ ],
+ "response": {
+ "$ref": "LogSink"
+ },
+ "parameters": {
+ "parent": {
+ "description": "Required. The resource in which to create the sink:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\nExamples: \"projects/my-logging-project\", \"organizations/123456789\".",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+$",
+ "location": "path"
+ },
+ "uniqueWriterIdentity": {
+ "location": "query",
+ "description": "Optional. Determines the kind of IAM identity returned as writer_identity in the new sink. If this value is omitted or set to false, and if the sink's parent is a project, then the value returned as writer_identity is the same group or service account used by Stackdriver Logging before the addition of writer identities to this API. The sink's destination must be in the same project as the sink itself.If this field is set to true, or if the sink is owned by a non-project resource such as an organization, then the value of writer_identity will be a unique service account used only for exports from the new sink. For more information, see writer_identity in LogSink.",
+ "type": "boolean"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/logging.admin"
+ ],
+ "flatPath": "v2beta1/projects/{projectsId}/sinks",
+ "id": "logging.projects.sinks.create",
+ "path": "v2beta1/{+parent}/sinks",
+ "request": {
+ "$ref": "LogSink"
+ },
+ "description": "Creates a sink that exports specified log entries to a destination. The export of newly-ingested log entries begins immediately, unless the sink's writer_identity is not permitted to write to the destination. A sink can export log entries only from the resource owning the sink."
+ },
+ "delete": {
+ "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"
+ },
+ "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": "^projects/[^/]+/sinks/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/logging.admin"
+ ],
+ "flatPath": "v2beta1/projects/{projectsId}/sinks/{sinksId}"
+ }
+ }
+ }
+ }
+ },
+ "billingAccounts": {
+ "resources": {
+ "logs": {
+ "methods": {
+ "delete": {
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/logging.admin"
+ ],
+ "parameters": {
+ "logName": {
+ "required": true,
+ "type": "string",
+ "pattern": "^billingAccounts/[^/]+/logs/[^/]+$",
+ "location": "path",
+ "description": "Required. The resource name of the log to delete:\n\"projects/[PROJECT_ID]/logs/[LOG_ID]\"\n\"organizations/[ORGANIZATION_ID]/logs/[LOG_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]\"\n\"folders/[FOLDER_ID]/logs/[LOG_ID]\"\n[LOG_ID] must be URL-encoded. For example, \"projects/my-project-id/logs/syslog\", \"organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity\". For more information about log names, see LogEntry."
+ }
+ },
+ "flatPath": "v2beta1/billingAccounts/{billingAccountsId}/logs/{logsId}",
+ "path": "v2beta1/{+logName}",
+ "id": "logging.billingAccounts.logs.delete",
+ "description": "Deletes all the log entries in a log. The log reappears if it receives new entries. Log entries written shortly before the delete operation might not be deleted.",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "logName"
+ ],
+ "httpMethod": "DELETE"
+ },
+ "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": {
+ "location": "path",
+ "description": "Required. The resource name that owns the logs:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n",
+ "required": true,
+ "type": "string",
+ "pattern": "^billingAccounts/[^/]+$"
+ }
+ },
+ "flatPath": "v2beta1/billingAccounts/{billingAccountsId}/logs",
+ "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."
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": {
+ "pp": {
+ "description": "Pretty-print response.",
+ "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": {
+ "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": {
+ "type": "string",
+ "location": "query",
+ "description": "JSONP"
+ },
+ "$.xgafv": {
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query",
+ "enum": [
+ "1",
+ "2"
+ ],
+ "description": "V1 error format.",
+ "type": "string"
+ },
+ "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"
+ }
+ },
+ "version": "v2beta1",
+ "baseUrl": "https://logging.googleapis.com/",
+ "kind": "discovery#restDescription",
+ "description": "Writes log entries and manages your Stackdriver Logging configuration.",
+ "servicePath": "",
+ "basePath": "",
+ "revision": "20171229",
+ "documentationLink": "https://cloud.google.com/logging/docs/",
+ "id": "logging:v2beta1",
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
+ "MonitoredResource": {
+ "properties": {
+ "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": {
+ "type": "string",
+ "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."
+ }
+ },
+ "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"
+ },
+ "LogSink": {
+ "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",
+ "type": "boolean"
+ },
+ "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"
+ },
+ "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"
+ },
+ "endTime": {
+ "description": "Deprecated. This field is ignored when creating or updating sinks.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "writerIdentity": {
+ "type": "string",
+ "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."
+ },
+ "startTime": {
+ "description": "Deprecated. This field is ignored when creating or updating sinks.",
+ "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"
+ },
+ "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",
+ "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."
+ },
+ "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"
+ }
+ }
+ },
+ "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": {
+ "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"
+ },
+ "requestSize": {
+ "description": "The size of the HTTP request message in bytes, including the request headers and the request body.",
+ "format": "int64",
+ "type": "string"
+ },
+ "responseSize": {
+ "type": "string",
+ "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"
+ },
+ "protocol": {
+ "description": "Protocol used for the request. Examples: \"HTTP/1.1\", \"HTTP/2\", \"websocket\"",
+ "type": "string"
+ },
+ "requestUrl": {
+ "description": "The scheme (http, https), the host name, the path and the query portion of the URL that was requested. Example: \"http://example.com/some/info?color=red\".",
+ "type": "string"
+ },
+ "remoteIp": {
+ "description": "The IP address (IPv4 or IPv6) of the client that issued the HTTP request. Examples: \"192.168.1.1\", \"FE80::0202:B3FF:FE1E:8329\".",
+ "type": "string"
+ },
+ "serverIp": {
+ "description": "The IP address (IPv4 or IPv6) of the origin server that the request was sent to.",
+ "type": "string"
+ },
+ "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"
+ }
+ },
+ "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.",
+ "type": "string"
+ },
+ "sinks": {
+ "description": "A list of sinks.",
+ "type": "array",
+ "items": {
+ "$ref": "LogSink"
+ }
+ }
+ },
+ "id": "ListSinksResponse"
+ },
+ "MonitoredResourceDescriptor": {
+ "properties": {
+ "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"
+ },
+ "description": {
+ "type": "string",
+ "description": "Optional. A detailed description of the monitored resource type that might be used in documentation."
+ },
+ "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"
+ }
+ }
+ },
+ "id": "MonitoredResourceDescriptor",
+ "description": "An object that describes the schema of a MonitoredResource object using a type name and a set of labels. For example, the monitored resource descriptor for Google Compute Engine VM instances has a type of \"gce_instance\" and specifies the use of the labels \"instance_id\" and \"zone\" to identify particular VM instances.Different APIs can support different monitored resource types. APIs generally provide a list method that returns the monitored resource descriptors used by the API.",
+ "type": "object"
+ },
"LogEntrySourceLocation": {
"description": "Additional information about the source code location that produced the log entry.",
"type": "object",
@@ -11,13 +950,13 @@
"type": "string"
},
"function": {
- "type": "string",
- "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)."
+ "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"
@@ -26,23 +965,21 @@
"description": "Result returned from ListLogEntries.",
"type": "object",
"properties": {
+ "nextPageToken": {
+ "description": "If there might be more results than those appearing in this response, then nextPageToken is included. To get the next set of results, call this method again using the value of nextPageToken as pageToken.If a value for next_page_token appears and the entries field is empty, it means that the search found no log entries so far but it did not have time to search all the possible log entries. Retry the method with this value for page_token to continue the search. Alternatively, consider speeding up the search by changing your filter to specify a single log name or resource type, or to narrow the time range of the search.",
+ "type": "string"
+ },
"entries": {
"description": "A list of log entries. If entries is empty, nextPageToken may still be returned, indicating that more entries may exist. See nextPageToken for more information.",
"type": "array",
"items": {
"$ref": "LogEntry"
}
- },
- "nextPageToken": {
- "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."
}
},
"id": "ListLogEntriesResponse"
},
"LogLine": {
- "description": "Application log line emitted while processing a request.",
- "type": "object",
"properties": {
"severity": {
"enum": [
@@ -71,48 +1008,50 @@
]
},
"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"
+ "id": "LogLine",
+ "description": "Application log line emitted while processing a request.",
+ "type": "object"
},
"Linear": {
- "description": "Specifies a linear sequence of buckets that all have the same width (except overflow and underflow). Each bucket represents a constant absolute uncertainty on the specific value in the bucket.There are num_finite_buckets + 2 (= N) buckets. Bucket i has the following boundaries:Upper bound (0 \u003c= i \u003c N-1): offset + (width * i). Lower bound (1 \u003c= i \u003c N): offset + (width * (i - 1)).",
- "type": "object",
"properties": {
+ "numFiniteBuckets": {
+ "description": "Must be greater than 0.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "width": {
+ "description": "Must be greater than 0.",
+ "format": "double",
+ "type": "number"
+ },
"offset": {
"description": "Lower bound of the first bucket.",
"format": "double",
"type": "number"
- },
- "numFiniteBuckets": {
- "type": "integer",
- "description": "Must be greater than 0.",
- "format": "int32"
- },
- "width": {
- "type": "number",
- "description": "Must be greater than 0.",
- "format": "double"
}
},
- "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": {
- "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 {}."
+ "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance:\nservice Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n}\nThe JSON representation for Empty is empty JSON object {}.",
+ "type": "object"
},
"SourceLocation": {
"type": "object",
@@ -122,8 +1061,8 @@
"type": "string"
},
"functionName": {
- "type": "string",
- "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)."
+ "description": "Human-readable name of the function or method being invoked, with optional context such as the class or package name. This information is used in contexts such as the logs viewer, where a file and line number are less meaningful. The format can vary by language. For example: qual.if.ied.Class.method (Java), dir/package.func (Go), function (Python).",
+ "type": "string"
},
"line": {
"description": "Line within the source file.",
@@ -135,20 +1074,17 @@
"description": "Specifies a location in a source code file."
},
"ListLogEntriesRequest": {
+ "description": "The parameters to ListLogEntries.",
"type": "object",
"properties": {
- "pageToken": {
- "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. page_token must be the value of next_page_token from the previous response. The values of other method parameters should be identical to those in the previous call.",
- "type": "string"
- },
"pageSize": {
"description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of next_page_token in the response indicates that more results might be available.",
"format": "int32",
"type": "integer"
},
"orderBy": {
- "type": "string",
- "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."
+ "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.",
@@ -167,10 +1103,13 @@
"filter": {
"description": "Optional. A filter that chooses which log entries to return. See Advanced Logs Filters. Only log entries that match the filter are returned. An empty filter matches all log entries in the resources listed in resource_names. Referencing a parent resource that is not listed in resource_names will cause the filter to return no results. The maximum length of the filter is 20000 characters.",
"type": "string"
+ },
+ "pageToken": {
+ "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. page_token must be the value of next_page_token from the previous response. The values of other method parameters should be identical to those in the previous call.",
+ "type": "string"
}
},
- "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.",
@@ -188,6 +1127,7 @@
"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": {
@@ -195,75 +1135,75 @@
"description": "Optional. A URI string identifying the repository. Example: \"https://github.com/GoogleCloudPlatform/kubernetes.git\""
},
"revisionId": {
- "type": "string",
- "description": "The canonical and persistent identifier of the deployed revision. Example (git): \"0035781c50ec7aa23385dc841529ce8a4b70db1b\""
+ "description": "The canonical and persistent identifier of the deployed revision. Example (git): \"0035781c50ec7aa23385dc841529ce8a4b70db1b\"",
+ "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": {
- "type": "object",
"properties": {},
"id": "WriteLogEntriesResponse",
- "description": "Result returned from WriteLogEntries. empty"
+ "description": "Result returned from WriteLogEntries. empty",
+ "type": "object"
},
"Exponential": {
+ "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",
"properties": {
- "growthFactor": {
- "description": "Must be greater than 1.",
- "format": "double",
- "type": "number"
- },
"scale": {
"description": "Must be greater than 0.",
"format": "double",
"type": "number"
},
"numFiniteBuckets": {
- "type": "integer",
"description": "Must be greater than 0.",
- "format": "int32"
+ "format": "int32",
+ "type": "integer"
+ },
+ "growthFactor": {
+ "description": "Must be greater than 1.",
+ "format": "double",
+ "type": "number"
}
- },
- "id": "Exponential"
+ }
},
"WriteLogEntriesRequest": {
+ "description": "The parameters to WriteLogEntries.",
"type": "object",
"properties": {
- "logName": {
- "type": "string",
- "description": "Optional. A default log resource name that is assigned to all log entries in entries that do not specify a value for log_name:\n\"projects/[PROJECT_ID]/logs/[LOG_ID]\"\n\"organizations/[ORGANIZATION_ID]/logs/[LOG_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]\"\n\"folders/[FOLDER_ID]/logs/[LOG_ID]\"\n[LOG_ID] must be URL-encoded. For example, \"projects/my-project-id/logs/syslog\" or \"organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity\". For more information about log names, see LogEntry."
- },
- "entries": {
- "type": "array",
- "items": {
- "$ref": "LogEntry"
- },
- "description": "Required. The log entries to send to Stackdriver Logging. The order of log entries in this list does not matter. Values supplied in this method's log_name, resource, and labels fields are copied into those log entries in this list that do not include values for their corresponding fields. For more information, see the LogEntry type.If the timestamp or insert_id fields are missing in log entries, then this method supplies the current time or a unique identifier, respectively. The supplied values are chosen so that, among the log entries that did not supply their own values, the entries earlier in the list will sort before the entries later in the list. See the entries.list method.Log entries with timestamps that are more than the logs retention period in the past or more than 24 hours in the future will not be available when calling entries.list. However, those log entries can still be exported with LogSinks.To improve throughput and to avoid exceeding the quota limit for calls to entries.write, you should try to include several log entries in this list, rather than calling this method for each individual log entry."
- },
- "partialSuccess": {
- "type": "boolean",
- "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."
- },
- "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."
+ },
+ "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 will not be available when calling entries.list. However, those log entries can still be exported with LogSinks.To improve throughput and to avoid exceeding the quota limit for calls to entries.write, you should try to include several log entries in this list, rather than calling this method for each individual log entry.",
+ "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"
}
},
- "id": "WriteLogEntriesRequest",
- "description": "The parameters to WriteLogEntries."
+ "id": "WriteLogEntriesRequest"
},
"LabelDescriptor": {
+ "description": "A description of a label.",
"type": "object",
"properties": {
"key": {
@@ -275,52 +1215,51 @@
"type": "string"
},
"valueType": {
+ "enumDescriptions": [
+ "A variable-length string. This is the default.",
+ "Boolean; true or false.",
+ "A 64-bit signed integer."
+ ],
"enum": [
"STRING",
"BOOL",
"INT64"
],
"description": "The type of data that can be assigned to the label.",
- "type": "string",
- "enumDescriptions": [
- "A variable-length string. This is the default.",
- "Boolean; true or false.",
- "A 64-bit signed integer."
- ]
+ "type": "string"
}
},
- "id": "LabelDescriptor",
- "description": "A description of a label."
+ "id": "LabelDescriptor"
},
"BucketOptions": {
+ "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.",
"type": "object",
"properties": {
"exponentialBuckets": {
- "$ref": "Exponential",
- "description": "The exponential buckets."
+ "description": "The exponential buckets.",
+ "$ref": "Exponential"
},
"linearBuckets": {
- "$ref": "Linear",
- "description": "The linear bucket."
+ "description": "The linear bucket.",
+ "$ref": "Linear"
},
"explicitBuckets": {
- "$ref": "Explicit",
- "description": "The explicit buckets."
+ "description": "The explicit buckets.",
+ "$ref": "Explicit"
}
- },
- "id": "BucketOptions"
+ }
},
"ListLogMetricsResponse": {
"description": "Result returned from ListLogMetrics.",
"type": "object",
"properties": {
"metrics": {
+ "description": "A list of logs-based 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.",
@@ -334,12 +1273,6 @@
"type": "object",
"properties": {
"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": [
@@ -347,16 +1280,22 @@
"An instantaneous measurement of a value.",
"The change in a value during a time interval.",
"A value accumulated over a time interval. Cumulative measurements in a time series should have the same start time and increasing end times, until an event resets the cumulative value to zero and sets a new start time for the following points."
+ ],
+ "enum": [
+ "METRIC_KIND_UNSPECIFIED",
+ "GAUGE",
+ "DELTA",
+ "CUMULATIVE"
]
},
+ "displayName": {
+ "description": "A concise name for the metric, which can be displayed in user interfaces. Use sentence case without an ending period, for example \"Request count\". This field is optional but it is recommended to be set for any metrics associated with user-visible concepts, such as Quota.",
+ "type": "string"
+ },
"description": {
"description": "A detailed description of the metric, which can be used in documentation.",
"type": "string"
},
- "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."
- },
"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"
@@ -369,24 +1308,14 @@
}
},
"name": {
- "type": "string",
- "description": "The resource name of the metric descriptor."
+ "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"
+ "description": "The metric type, including its DNS name prefix. The type is not URL-encoded. All user-defined custom metric types have the DNS name custom.googleapis.com. Metric types should use a natural hierarchical grouping. For example:\n\"custom.googleapis.com/invoice/paid/amount\"\n\"appengine.googleapis.com/http/server/response_latencies\"\n",
+ "type": "string"
},
"valueType": {
- "type": "string",
- "enumDescriptions": [
- "Do not use this default value.",
- "The value is a boolean. This value type can be used only if the metric kind is GAUGE.",
- "The value is a signed 64-bit integer.",
- "The value is a double precision floating point number.",
- "The value is a text string. This value type can be used only if the metric kind is GAUGE.",
- "The value is a Distribution.",
- "The value is money."
- ],
"enum": [
"VALUE_TYPE_UNSPECIFIED",
"BOOL",
@@ -396,40 +1325,33 @@
"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."
+ "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"
},
"LogEntry": {
+ "description": "An individual entry in a log.",
"type": "object",
"properties": {
- "spanId": {
- "type": "string",
- "description": "Optional. The span ID within the trace associated with the log entry. For Stackdriver Trace spans, this is the same format that the Stackdriver Trace API v2 uses: a 16-character hexadecimal encoding of an 8-byte array, such as \u003ccode\u003e\"000000000000004a\"\u003c/code\u003e."
- },
- "receiveTimestamp": {
- "description": "Output only. The time the log entry was received by Stackdriver Logging.",
- "format": "google-datetime",
- "type": "string"
- },
- "timestamp": {
- "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. Log entries outside those time boundaries will not be available when calling entries.list, but those log entries can still be exported with LogSinks.",
- "format": "google-datetime"
- },
- "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."
},
+ "httpRequest": {
+ "description": "Optional. Information about the HTTP request associated with this log entry, if applicable.",
+ "$ref": "HttpRequest"
+ },
"jsonPayload": {
"additionalProperties": {
"description": "Properties of the object.",
@@ -438,49 +1360,38 @@
"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."
},
- "insertId": {
- "type": "string",
- "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."
- },
"textPayload": {
- "type": "string",
- "description": "The log entry payload, represented as a Unicode string (UTF-8)."
+ "description": "The log entry payload, represented as a Unicode string (UTF-8).",
+ "type": "string"
},
"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."
- },
- "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"
+ "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": {
+ "type": "object",
"additionalProperties": {
"type": "string"
},
- "description": "Optional. A set of user-defined (key, value) data that provides additional information about the log entry.",
- "type": "object"
+ "description": "Optional. A set of user-defined (key, value) data that provides additional information about the log entry."
+ },
+ "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": {
- "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",
"enumDescriptions": [
@@ -493,28 +1404,47 @@
"(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": "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. Log entries outside those time boundaries will not be available when calling entries.list, but those log entries can still be exported with LogSinks.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "receiveTimestamp": {
+ "type": "string",
+ "description": "Output only. The time the log entry was received by Stackdriver Logging.",
+ "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"
}
},
- "id": "LogEntry",
- "description": "An individual entry in a log."
+ "id": "LogEntry"
},
"RequestLog": {
"type": "object",
"properties": {
- "responseSize": {
- "description": "Size in bytes sent back to client by request.",
- "format": "int64",
- "type": "string"
- },
- "traceId": {
- "type": "string",
- "description": "Stackdriver Trace identifier for this request."
- },
"line": {
"description": "A list of log lines emitted by the application while serving this request.",
"type": "array",
@@ -527,16 +1457,16 @@
"type": "string"
},
"taskQueueName": {
- "type": "string",
- "description": "Queue name of the request, in the case of an offline request."
+ "description": "Queue name of the request, in the case of an offline request.",
+ "type": "string"
},
"requestId": {
- "type": "string",
- "description": "Globally unique identifier for a request, which is based on the request start time. Request IDs for requests which started later will compare greater as strings than those for requests which started earlier."
+ "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": {
- "type": "string",
- "description": "The logged-in user who made the request.Most likely, this is the part of the user's email before the @ sign. The field value is the same for different requests from the same user, but different users can have similar names. This information is also available to the application via the App Engine Users API.This field will be populated starting with App Engine 1.9.21."
+ "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": {
"type": "integer",
@@ -544,8 +1474,8 @@
"format": "int32"
},
"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."
+ "description": "Contains the path and query portion of the URL that was requested. For example, if the URL was \"http://example.com/app?name=val\", the resource would be \"/app?name=val\". The fragment identifier, which is identified by the # character, is not included.",
+ "type": "string"
},
"pendingTime": {
"description": "Time this request spent in the pending request queue.",
@@ -557,30 +1487,30 @@
"type": "string"
},
"urlMapEntry": {
- "type": "string",
- "description": "File or class that handled the request."
+ "description": "File or class that handled the request.",
+ "type": "string"
},
"instanceIndex": {
- "type": "integer",
"description": "If the instance processing this request belongs to a manually scaled module, then this is the 0-based index of the instance. Otherwise, this value is -1.",
- "format": "int32"
+ "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"
},
- "host": {
- "type": "string",
- "description": "Internet host and port number of the resource being requested."
- },
"httpVersion": {
"description": "HTTP version of request. Example: \"HTTP/1.1\".",
"type": "string"
},
"startTime": {
- "type": "string",
"description": "Time when the request started.",
- "format": "google-datetime"
+ "format": "google-datetime",
+ "type": "string"
},
"latency": {
"description": "Latency of the request.",
@@ -588,25 +1518,25 @@
"type": "string"
},
"ip": {
- "type": "string",
- "description": "Origin IP address."
+ "description": "Origin IP address.",
+ "type": "string"
},
"appId": {
- "type": "string",
- "description": "Application that handled this request."
+ "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\"."
+ "description": "Request method. Example: \"GET\", \"HEAD\", \"PUT\", \"POST\", \"DELETE\".",
+ "type": "string"
},
"cost": {
- "type": "number",
"description": "An indication of the relative cost of serving this request.",
- "format": "double"
+ "format": "double",
+ "type": "number"
},
"instanceId": {
"description": "An identifier for the instance that handled the request.",
@@ -618,36 +1548,45 @@
"type": "string"
},
"first": {
- "type": "boolean",
- "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."
+ "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": {
- "type": "string",
- "description": "Module of the application that handled this request."
+ "description": "Module of the application that handled this request.",
+ "type": "string"
},
"endTime": {
- "type": "string",
"description": "Time when the request finished.",
- "format": "google-datetime"
+ "format": "google-datetime",
+ "type": "string"
},
"userAgent": {
"description": "User agent that made the request.",
"type": "string"
},
"wasLoadingRequest": {
- "type": "boolean",
- "description": "Whether this was a loading request for the instance."
+ "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"
- },
- "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": {
+ "description": "Size in bytes sent back to client by request.",
+ "format": "int64",
+ "type": "string"
+ },
+ "traceId": {
+ "description": "Stackdriver Trace identifier for this request.",
+ "type": "string"
}
},
"id": "RequestLog",
@@ -658,298 +1597,91 @@
"type": "object",
"properties": {
"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."
+ "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"
},
"LogEntryOperation": {
+ "description": "Additional information about a potentially long-running operation with which a log entry is associated.",
"type": "object",
"properties": {
- "producer": {
- "type": "string",
- "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\"."
- },
- "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."
+ "description": "Optional. Set this to True if this is the last log entry in the operation.",
+ "type": "boolean"
},
"id": {
- "type": "string",
- "description": "Optional. An arbitrary operation identifier. Log entries with the same identifier are assumed to be part of the same operation."
+ "description": "Optional. An arbitrary operation identifier. Log entries with the same identifier are assumed to be part of the same operation.",
+ "type": "string"
+ },
+ "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"
}
},
- "id": "LogEntryOperation",
- "description": "Additional information about a potentially long-running operation with which a log entry is associated."
+ "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": {
- "version": {
- "enum": [
- "V2",
- "V1"
- ],
- "description": "Deprecated. The API version that created or updated this metric. The v2 format is used by default and cannot be changed.",
- "type": "string",
- "enumDescriptions": [
- "Stackdriver Logging API v2.",
- "Stackdriver Logging API v1."
- ]
- },
- "metricDescriptor": {
- "$ref": "MetricDescriptor",
- "description": "Optional. The metric descriptor associated with the logs-based metric. If unspecified, it uses a default metric descriptor with a DELTA metric kind, INT64 value type, with no labels and a unit of \"1\". Such a metric counts the number of log entries matching the filter expression.The name, type, and description fields in the metric_descriptor are output only, and is constructed using the name and description field in the LogMetric.To create a logs-based metric that records a distribution of log values, a DELTA metric kind with a DISTRIBUTION value type must be used along with a value_extractor expression in the LogMetric.Each label in the metric descriptor must have a matching label name as the key and an extractor expression as the value in the label_extractors map.The metric_kind and value_type fields in the metric_descriptor cannot be updated once initially configured. New labels can be added in the metric_descriptor, but existing labels cannot be modified except for their description."
- },
- "filter": {
- "type": "string",
- "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."
- },
"description": {
"type": "string",
"description": "Optional. A description of this metric, which is used in documentation."
},
- "valueExtractor": {
- "type": "string",
- "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+).*\")"
- },
"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": {
- "type": "string",
- "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\"."
+ "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."
- }
- },
- "id": "LogMetric"
- },
- "MonitoredResource": {
- "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"
- }
- },
- "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"
- },
- "LogSink": {
- "type": "object",
- "properties": {
- "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."
+ "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"
},
- "includeChildren": {
- "type": "boolean",
- "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"
- },
- "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"
- },
- "endTime": {
- "type": "string",
- "description": "Deprecated. This field is ignored when creating or updating sinks.",
- "format": "google-datetime"
- },
- "writerIdentity": {
- "description": "Output only. An IAM identity—a service account or group—under which Stackdriver Logging writes the exported log entries to the sink's destination. This field is set by sinks.create and sinks.update, based on the setting of unique_writer_identity in those methods.Until you grant this identity write-access to the destination, log entry exports from this sink will fail. For more information, see Granting access for a resource. Consult the destination service's documentation to determine the appropriate IAM roles to assign to the identity.",
- "type": "string"
- },
- "startTime": {
- "description": "Deprecated. This field is ignored when creating or updating sinks.",
- "format": "google-datetime",
- "type": "string"
- },
- "outputVersionFormat": {
+ "version": {
"type": "string",
"enumDescriptions": [
- "An unspecified format version that will default to V2.",
- "LogEntry version 2 format.",
- "LogEntry version 1 format."
+ "Stackdriver Logging API v2.",
+ "Stackdriver Logging API v1."
],
"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."
- }
- },
- "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."
- },
- "ListLogsResponse": {
- "description": "Result returned from ListLogs.",
- "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."
+ "description": "Deprecated. The API version that created or updated this metric. The v2 format is used by default and cannot be changed."
},
- "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"
- }
- }
- },
- "id": "ListLogsResponse"
- },
- "ListSinksResponse": {
- "description": "Result returned from ListSinks.",
- "type": "object",
- "properties": {
- "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."
- },
- "sinks": {
- "description": "A list of sinks.",
- "type": "array",
- "items": {
- "$ref": "LogSink"
- }
- }
- },
- "id": "ListSinksResponse"
- },
- "HttpRequest": {
- "type": "object",
- "properties": {
- "requestSize": {
- "description": "The size of the HTTP request message in bytes, including the request headers and the request body.",
- "format": "int64",
- "type": "string"
- },
- "protocol": {
- "type": "string",
- "description": "Protocol used for the request. Examples: \"HTTP/1.1\", \"HTTP/2\", \"websocket\""
- },
- "responseSize": {
- "type": "string",
- "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"
- },
- "requestUrl": {
- "type": "string",
- "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\"."
- },
- "serverIp": {
- "type": "string",
- "description": "The IP address (IPv4 or IPv6) of the origin server that the request was sent to."
- },
- "remoteIp": {
- "description": "The IP address (IPv4 or IPv6) of the client that issued the HTTP request. Examples: \"192.168.1.1\", \"FE80::0202:B3FF:FE1E:8329\".",
- "type": "string"
- },
- "cacheLookup": {
- "type": "boolean",
- "description": "Whether or not a cache lookup was attempted."
- },
- "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": {
- "type": "integer",
- "description": "The response code indicating the status of response. Examples: 200, 404.",
- "format": "int32"
- },
- "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": {
- "type": "string",
- "description": "The request processing latency on the server, from the time the request was received until the response was sent.",
- "format": "google-duration"
- },
- "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\".",
+ "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"
}
},
- "id": "HttpRequest",
- "description": "A common proto for logging HTTP requests. Only contains semantics defined by the HTTP specification. Product-specific logging information MUST be defined in a separate message."
- },
- "MonitoredResourceDescriptor": {
- "type": "object",
- "properties": {
- "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."
- },
- "labels": {
- "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"
- },
- "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": {
- "type": "string",
- "description": "Optional. A detailed description of the monitored resource type that might be used in documentation."
- }
- },
- "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."
+ "id": "LogMetric"
}
},
"protocol": "rest",
@@ -979,737 +1711,5 @@
}
}
},
- "rootUrl": "https://logging.googleapis.com/",
- "ownerDomain": "google.com",
- "name": "logging",
- "batchPath": "batch",
- "fullyEncodeReservedExpansion": true,
- "title": "Stackdriver Logging API",
- "ownerName": "Google",
- "resources": {
- "billingAccounts": {
- "resources": {
- "logs": {
- "methods": {
- "list": {
- "flatPath": "v2beta1/billingAccounts/{billingAccountsId}/logs",
- "path": "v2beta1/{+parent}/logs",
- "id": "logging.billingAccounts.logs.list",
- "description": "Lists the logs in projects, organizations, folders, or billing accounts. Only logs that have entries are listed.",
- "response": {
- "$ref": "ListLogsResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/logging.admin",
- "https://www.googleapis.com/auth/logging.read"
- ],
- "parameters": {
- "pageToken": {
- "location": "query",
- "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.",
- "type": "string"
- },
- "pageSize": {
- "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 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/[^/]+$"
- }
- }
- },
- "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": "^billingAccounts/[^/]+/logs/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/logging.admin"
- ],
- "flatPath": "v2beta1/billingAccounts/{billingAccountsId}/logs/{logsId}",
- "id": "logging.billingAccounts.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."
- }
- }
- }
- }
- },
- "monitoredResourceDescriptors": {
- "methods": {
- "list": {
- "flatPath": "v2beta1/monitoredResourceDescriptors",
- "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",
- "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"
- }
- },
- "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"
- ]
- }
- }
- },
- "organizations": {
- "resources": {
- "logs": {
- "methods": {
- "delete": {
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "logName"
- ],
- "httpMethod": "DELETE",
- "parameters": {
- "logName": {
- "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."
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/logging.admin"
- ],
- "flatPath": "v2beta1/organizations/{organizationsId}/logs/{logsId}",
- "path": "v2beta1/{+logName}",
- "id": "logging.organizations.logs.delete",
- "description": "Deletes all the log entries in a log. The log reappears if it receives new entries. Log entries written shortly before the delete operation might not be deleted."
- },
- "list": {
- "response": {
- "$ref": "ListLogsResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/logging.admin",
- "https://www.googleapis.com/auth/logging.read"
- ],
- "parameters": {
- "pageToken": {
- "location": "query",
- "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.",
- "type": "string"
- },
- "pageSize": {
- "location": "query",
- "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.",
- "format": "int32",
- "type": "integer"
- },
- "parent": {
- "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/[^/]+$"
- }
- },
- "flatPath": "v2beta1/organizations/{organizationsId}/logs",
- "path": "v2beta1/{+parent}/logs",
- "id": "logging.organizations.logs.list",
- "description": "Lists the logs in projects, organizations, folders, or billing accounts. Only logs that have entries are listed."
- }
- }
- }
- }
- },
- "entries": {
- "methods": {
- "list": {
- "response": {
- "$ref": "ListLogEntriesResponse"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "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": {},
- "flatPath": "v2beta1/entries:list",
- "path": "v2beta1/entries:list",
- "id": "logging.entries.list",
- "description": "Lists log entries. Use this method to retrieve log entries from Stackdriver Logging. For ways to export log entries, see Exporting Logs.",
- "request": {
- "$ref": "ListLogEntriesRequest"
- }
- },
- "write": {
- "response": {
- "$ref": "WriteLogEntriesResponse"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "parameters": {},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/logging.admin",
- "https://www.googleapis.com/auth/logging.write"
- ],
- "flatPath": "v2beta1/entries:write",
- "path": "v2beta1/entries:write",
- "id": "logging.entries.write",
- "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."
- }
- }
- },
- "projects": {
- "resources": {
- "logs": {
- "methods": {
- "delete": {
- "httpMethod": "DELETE",
- "parameterOrder": [
- "logName"
- ],
- "response": {
- "$ref": "Empty"
- },
- "parameters": {
- "logName": {
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/logs/[^/]+$",
- "location": "path",
- "description": "Required. The resource name of the log to delete:\n\"projects/[PROJECT_ID]/logs/[LOG_ID]\"\n\"organizations/[ORGANIZATION_ID]/logs/[LOG_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]\"\n\"folders/[FOLDER_ID]/logs/[LOG_ID]\"\n[LOG_ID] must be URL-encoded. For example, \"projects/my-project-id/logs/syslog\", \"organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity\". For more information about log names, see LogEntry."
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/logging.admin"
- ],
- "flatPath": "v2beta1/projects/{projectsId}/logs/{logsId}",
- "id": "logging.projects.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",
- "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": {
- "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": "^projects/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/logging.admin",
- "https://www.googleapis.com/auth/logging.read"
- ],
- "flatPath": "v2beta1/projects/{projectsId}/logs",
- "id": "logging.projects.logs.list",
- "path": "v2beta1/{+parent}/logs"
- }
- }
- },
- "sinks": {
- "methods": {
- "delete": {
- "description": "Deletes a sink. If the sink has a unique writer_identity, then that service account is also deleted.",
- "httpMethod": "DELETE",
- "parameterOrder": [
- "sinkName"
- ],
- "response": {
- "$ref": "Empty"
- },
- "parameters": {
- "sinkName": {
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/sinks/[^/]+$",
- "location": "path",
- "description": "Required. The full resource name of the sink to delete, including the parent resource and the sink identifier:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\"."
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/logging.admin"
- ],
- "flatPath": "v2beta1/projects/{projectsId}/sinks/{sinksId}",
- "id": "logging.projects.sinks.delete",
- "path": "v2beta1/{+sinkName}"
- },
- "list": {
- "response": {
- "$ref": "ListSinksResponse"
- },
- "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 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/[^/]+$"
- }
- },
- "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",
- "description": "Lists sinks."
- },
- "get": {
- "description": "Gets a sink.",
- "response": {
- "$ref": "LogSink"
- },
- "parameterOrder": [
- "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"
- ],
- "flatPath": "v2beta1/projects/{projectsId}/sinks/{sinksId}",
- "path": "v2beta1/{+sinkName}",
- "id": "logging.projects.sinks.get"
- },
- "update": {
- "response": {
- "$ref": "LogSink"
- },
- "parameterOrder": [
- "sinkName"
- ],
- "httpMethod": "PUT",
- "parameters": {
- "sinkName": {
- "location": "path",
- "description": "Required. The full resource name of the sink to update, including the parent resource and the sink identifier:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/sinks/[^/]+$"
- },
- "uniqueWriterIdentity": {
- "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": {
- "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": "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."
- },
- "create": {
- "flatPath": "v2beta1/projects/{projectsId}/sinks",
- "path": "v2beta1/{+parent}/sinks",
- "id": "logging.projects.sinks.create",
- "description": "Creates a sink that exports specified log entries to a destination. The export of newly-ingested log entries begins immediately, unless the sink's writer_identity is not permitted to write to the destination. A sink can export log entries only from the resource owning the sink.",
- "request": {
- "$ref": "LogSink"
- },
- "response": {
- "$ref": "LogSink"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/logging.admin"
- ],
- "parameters": {
- "parent": {
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+$",
- "location": "path",
- "description": "Required. The resource in which to create the sink:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\nExamples: \"projects/my-logging-project\", \"organizations/123456789\"."
- },
- "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"
- }
- }
- }
- }
- },
- "metrics": {
- "methods": {
- "delete": {
- "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": {
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/metrics/[^/]+$",
- "location": "path",
- "description": "The resource name of the metric to delete:\n\"projects/[PROJECT_ID]/metrics/[METRIC_ID]\"\n"
- }
- },
- "flatPath": "v2beta1/projects/{projectsId}/metrics/{metricsId}",
- "path": "v2beta1/{+metricName}",
- "id": "logging.projects.metrics.delete",
- "description": "Deletes a logs-based metric."
- },
- "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": {
- "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": {
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+$",
- "location": "path",
- "description": "Required. The name of the project containing the metrics:\n\"projects/[PROJECT_ID]\"\n"
- }
- },
- "flatPath": "v2beta1/projects/{projectsId}/metrics",
- "path": "v2beta1/{+parent}/metrics",
- "id": "logging.projects.metrics.list",
- "description": "Lists logs-based metrics."
- },
- "get": {
- "response": {
- "$ref": "LogMetric"
- },
- "parameterOrder": [
- "metricName"
- ],
- "httpMethod": "GET",
- "parameters": {
- "metricName": {
- "location": "path",
- "description": "The resource name of the desired metric:\n\"projects/[PROJECT_ID]/metrics/[METRIC_ID]\"\n",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/metrics/[^/]+$"
- }
- },
- "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}",
- "path": "v2beta1/{+metricName}",
- "id": "logging.projects.metrics.get",
- "description": "Gets a logs-based metric."
- },
- "update": {
- "response": {
- "$ref": "LogMetric"
- },
- "parameterOrder": [
- "metricName"
- ],
- "httpMethod": "PUT",
- "parameters": {
- "metricName": {
- "location": "path",
- "description": "The resource name of the metric to update:\n\"projects/[PROJECT_ID]/metrics/[METRIC_ID]\"\nThe updated metric must be provided in the request and it's name field must be the same as [METRIC_ID] If the metric does not exist in [PROJECT_ID], then a new metric is created.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/metrics/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/logging.admin",
- "https://www.googleapis.com/auth/logging.write"
- ],
- "flatPath": "v2beta1/projects/{projectsId}/metrics/{metricsId}",
- "path": "v2beta1/{+metricName}",
- "id": "logging.projects.metrics.update",
- "request": {
- "$ref": "LogMetric"
- },
- "description": "Creates or updates a logs-based metric."
- },
- "create": {
- "response": {
- "$ref": "LogMetric"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "POST",
- "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",
- "path": "v2beta1/{+parent}/metrics",
- "id": "logging.projects.metrics.create",
- "request": {
- "$ref": "LogMetric"
- },
- "description": "Creates a logs-based metric."
- }
- }
- }
- }
- }
- },
- "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": {
- "location": "query",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string"
- },
- "quotaUser": {
- "type": "string",
- "location": "query",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters."
- },
- "pp": {
- "location": "query",
- "description": "Pretty-print response.",
- "type": "boolean",
- "default": "true"
- },
- "bearer_token": {
- "type": "string",
- "location": "query",
- "description": "OAuth bearer token."
- },
- "oauth_token": {
- "type": "string",
- "location": "query",
- "description": "OAuth 2.0 token for the current user."
- },
- "upload_protocol": {
- "location": "query",
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string"
- },
- "prettyPrint": {
- "location": "query",
- "description": "Returns response with indentations and line breaks.",
- "type": "boolean",
- "default": "true"
- },
- "fields": {
- "location": "query",
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string"
- },
- "uploadType": {
- "type": "string",
- "location": "query",
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")."
- },
- "callback": {
- "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": "v2beta1",
- "baseUrl": "https://logging.googleapis.com/",
- "servicePath": "",
- "description": "Writes log entries and manages your Stackdriver Logging configuration.",
- "kind": "discovery#restDescription",
- "basePath": "",
- "revision": "20171219",
- "documentationLink": "https://cloud.google.com/logging/docs/",
- "id": "logging:v2beta1"
+ "rootUrl": "https://logging.googleapis.com/"
}
diff --git a/manufacturers/v1/manufacturers-api.json b/manufacturers/v1/manufacturers-api.json
index 1c486d3..e39f8a4 100644
--- a/manufacturers/v1/manufacturers-api.json
+++ b/manufacturers/v1/manufacturers-api.json
@@ -1,262 +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": {
- "resources": {
- "products": {
- "methods": {
- "update": {
- "httpMethod": "PUT",
- "parameterOrder": [
- "parent",
- "name"
- ],
- "response": {
- "$ref": "Product"
- },
- "parameters": {
- "parent": {
- "description": "Parent ID in the format `accounts/{account_id}`.\n\n`account_id` - The ID of the Manufacturer Center account.",
- "required": true,
- "type": "string",
- "pattern": "^accounts/[^/]+$",
- "location": "path"
- },
- "name": {
- "description": "Name in the format `{target_country}:{content_language}:{product_id}`.\n\n`target_country` - The target country of the product as a CLDR territory\n code (for example, US).\n\n`content_language` - The content language of the product as a two-letter\n ISO 639-1 language code (for example, en).\n\n`product_id` - The ID of the product. For more information, see\n https://support.google.com/manufacturers/answer/6124116#id.",
- "required": true,
- "type": "string",
- "pattern": "^[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/manufacturercenter"
- ],
- "flatPath": "v1/accounts/{accountsId}/products/{productsId}",
- "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."
- },
- "delete": {
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "parent",
- "name"
- ],
- "httpMethod": "DELETE",
- "scopes": [
- "https://www.googleapis.com/auth/manufacturercenter"
- ],
- "parameters": {
- "parent": {
- "description": "Parent ID in the format `accounts/{account_id}`.\n\n`account_id` - The ID of the Manufacturer Center account.",
- "required": true,
- "type": "string",
- "pattern": "^accounts/[^/]+$",
- "location": "path"
- },
- "name": {
- "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": "^[^/]+$"
- }
- },
- "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."
- },
- "list": {
- "description": "Lists all the products in a Manufacturer Center account.",
- "httpMethod": "GET",
- "response": {
- "$ref": "ListProductsResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "parameters": {
- "pageSize": {
- "description": "Maximum number of product statuses to return in the response, used for\npaging.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- },
- "parent": {
- "description": "Parent ID in the format `accounts/{account_id}`.\n\n`account_id` - The ID of the Manufacturer Center account.",
- "required": true,
- "type": "string",
- "pattern": "^accounts/[^/]+$",
- "location": "path"
- },
- "pageToken": {
- "description": "The token returned by the previous request.",
- "type": "string",
- "location": "query"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/manufacturercenter"
- ],
- "flatPath": "v1/accounts/{accountsId}/products",
- "id": "manufacturers.accounts.products.list",
- "path": "v1/{+parent}/products"
- },
- "get": {
- "id": "manufacturers.accounts.products.get",
- "path": "v1/{+parent}/products/{+name}",
- "description": "Gets the product from a Manufacturer Center account, including product\nissues.\n\nA recently updated product takes around 15 minutes to process. Changes are\nonly visible after it has been processed. While some issues may be\navailable once the product has been processed, other issues may take days\nto appear.",
- "httpMethod": "GET",
- "parameterOrder": [
- "parent",
- "name"
- ],
- "response": {
- "$ref": "Product"
- },
- "parameters": {
- "parent": {
- "description": "Parent ID in the format `accounts/{account_id}`.\n\n`account_id` - The ID of the Manufacturer Center account.",
- "required": true,
- "type": "string",
- "pattern": "^accounts/[^/]+$",
- "location": "path"
- },
- "name": {
- "description": "Name in the format `{target_country}:{content_language}:{product_id}`.\n\n`target_country` - The target country of the product as a CLDR territory\n code (for example, US).\n\n`content_language` - The content language of the product as a two-letter\n ISO 639-1 language code (for example, en).\n\n`product_id` - The ID of the product. For more information, see\n https://support.google.com/manufacturers/answer/6124116#id.",
- "required": true,
- "type": "string",
- "pattern": "^[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/manufacturercenter"
- ],
- "flatPath": "v1/accounts/{accountsId}/products/{productsId}"
- }
- }
- }
- }
- }
- },
- "parameters": {
- "bearer_token": {
- "location": "query",
- "description": "OAuth bearer token.",
- "type": "string"
- },
- "oauth_token": {
- "location": "query",
- "description": "OAuth 2.0 token for the current user.",
- "type": "string"
- },
- "upload_protocol": {
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string",
- "location": "query"
- },
- "prettyPrint": {
- "description": "Returns response with indentations and line breaks.",
- "type": "boolean",
- "default": "true",
- "location": "query"
- },
- "fields": {
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string",
- "location": "query"
- },
- "uploadType": {
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string",
- "location": "query"
- },
- "callback": {
- "description": "JSONP",
- "type": "string",
- "location": "query"
- },
- "$.xgafv": {
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query",
- "enum": [
- "1",
- "2"
- ],
- "description": "V1 error format.",
- "type": "string"
- },
- "alt": {
- "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"
- }
- },
- "version": "v1",
- "baseUrl": "https://manufacturers.googleapis.com/",
- "kind": "discovery#restDescription",
- "description": "Public API for managing Manufacturer Center related data.",
- "servicePath": "",
- "basePath": "",
"id": "manufacturers:v1",
"documentationLink": "https://developers.google.com/manufacturers/",
"revision": "20171207",
@@ -264,6 +6,8 @@
"version_module": true,
"schemas": {
"Count": {
+ "description": "The number of products in a single package. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#count.",
+ "type": "object",
"properties": {
"value": {
"description": "The numeric value of the number of products in a package.",
@@ -275,12 +19,28 @@
"type": "string"
}
},
- "id": "Count",
- "description": "The number of products in a single package. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#count.",
- "type": "object"
+ "id": "Count"
},
"Product": {
+ "description": "Product data.",
+ "type": "object",
"properties": {
+ "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"
@@ -297,13 +57,6 @@
"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"
},
- "manuallyDeletedAttributes": {
- "description": "Names of the attributes of the product deleted manually via the\nManufacturer Center UI.\n@OutputOnly",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
"issues": {
"description": "A server-generated list of issues associated with the product.\n@OutputOnly",
"type": "array",
@@ -311,26 +64,15 @@
"$ref": "Issue"
}
},
- "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": {
- "$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"
+ "manuallyDeletedAttributes": {
+ "description": "Names of the attributes of the product deleted manually via the\nManufacturer Center UI.\n@OutputOnly",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
}
},
- "id": "Product",
- "description": "Product data.",
- "type": "object"
+ "id": "Product"
},
"Capacity": {
"description": "The capacity of a product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#capacity.",
@@ -351,16 +93,16 @@
"ListProductsResponse": {
"type": "object",
"properties": {
- "nextPageToken": {
- "description": "The token for the retrieval of the next page of product statuses.",
- "type": "string"
- },
"products": {
"description": "List of the products.",
"type": "array",
"items": {
"$ref": "Product"
}
+ },
+ "nextPageToken": {
+ "description": "The token for the retrieval of the next page of product statuses.",
+ "type": "string"
}
},
"id": "ListProductsResponse"
@@ -388,6 +130,10 @@
"description": "A feature description of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#featuredesc.",
"type": "object",
"properties": {
+ "text": {
+ "description": "A detailed description of the feature.",
+ "type": "string"
+ },
"image": {
"$ref": "Image",
"description": "An optional image describing the feature."
@@ -395,10 +141,6 @@
"headline": {
"description": "A short description of the feature.",
"type": "string"
- },
- "text": {
- "description": "A detailed description of the feature.",
- "type": "string"
}
},
"id": "FeatureDescription"
@@ -407,10 +149,6 @@
"description": "Product issue.",
"type": "object",
"properties": {
- "attribute": {
- "description": "If present, the attribute that triggered the issue. For more information\nabout attributes, see\nhttps://support.google.com/manufacturers/answer/6124116.",
- "type": "string"
- },
"timestamp": {
"description": "The timestamp when this issue appeared.",
"format": "google-datetime",
@@ -439,6 +177,10 @@
"type": {
"description": "The server-generated type of the issue, for example,\n“INCORRECT_TEXT_FORMATTING”, “IMAGE_NOT_SERVEABLE”, etc.",
"type": "string"
+ },
+ "attribute": {
+ "description": "If present, the attribute that triggered the issue. For more information\nabout attributes, see\nhttps://support.google.com/manufacturers/answer/6124116.",
+ "type": "string"
}
},
"id": "Issue"
@@ -465,6 +207,8 @@
"id": "Empty"
},
"Image": {
+ "description": "An image.",
+ "type": "object",
"properties": {
"type": {
"description": "The type of the image, i.e., crawled or uploaded.\n@OutputOnly",
@@ -519,65 +263,12 @@
"type": "string"
}
},
- "id": "Image",
- "description": "An image.",
- "type": "object"
+ "id": "Image"
},
"Attributes": {
"description": "Attributes of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116.",
"type": "object",
"properties": {
- "count": {
- "$ref": "Count",
- "description": "The count of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#count."
- },
- "brand": {
- "description": "The brand name of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#brand.",
- "type": "string"
- },
- "disclosureDate": {
- "description": "The disclosure date of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#disclosure.",
- "type": "string"
- },
- "material": {
- "description": "The material of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#material.",
- "type": "string"
- },
- "scent": {
- "description": "The scent of the product. For more information, see\n https://support.google.com/manufacturers/answer/6124116#scent.",
- "type": "string"
- },
- "ageGroup": {
- "description": "The target age group of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#agegroup.",
- "type": "string"
- },
- "productDetail": {
- "description": "The details of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#productdetail.",
- "type": "array",
- "items": {
- "$ref": "ProductDetail"
- }
- },
- "flavor": {
- "description": "The flavor of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#flavor.",
- "type": "string"
- },
- "mpn": {
- "description": "The Manufacturer Part Number (MPN) of the product. For more information,\nsee https://support.google.com/manufacturers/answer/6124116#mpn.",
- "type": "string"
- },
- "productPageUrl": {
- "description": "The URL of the detail page of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#productpage.",
- "type": "string"
- },
- "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",
@@ -585,13 +276,17 @@
"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.",
@@ -659,8 +354,8 @@
"type": "string"
},
"suggestedRetailPrice": {
- "description": "The suggested retail price (MSRP) of the product. For more information,\nsee https://support.google.com/manufacturers/answer/6124116#price.",
- "$ref": "Price"
+ "$ref": "Price",
+ "description": "The suggested retail price (MSRP) of the product. For more information,\nsee https://support.google.com/manufacturers/answer/6124116#price."
},
"featureDescription": {
"description": "The rich format description of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#featuredesc.",
@@ -676,14 +371,319 @@
"title": {
"description": "The title of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#title.",
"type": "string"
+ },
+ "count": {
+ "description": "The count of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#count.",
+ "$ref": "Count"
+ },
+ "brand": {
+ "description": "The brand name of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#brand.",
+ "type": "string"
+ },
+ "material": {
+ "description": "The material of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#material.",
+ "type": "string"
+ },
+ "disclosureDate": {
+ "description": "The disclosure date of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#disclosure.",
+ "type": "string"
+ },
+ "scent": {
+ "description": "The scent of the product. For more information, see\n https://support.google.com/manufacturers/answer/6124116#scent.",
+ "type": "string"
+ },
+ "ageGroup": {
+ "description": "The target age group of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#agegroup.",
+ "type": "string"
+ },
+ "productDetail": {
+ "description": "The details of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#productdetail.",
+ "type": "array",
+ "items": {
+ "$ref": "ProductDetail"
+ }
+ },
+ "flavor": {
+ "description": "The flavor of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#flavor.",
+ "type": "string"
+ },
+ "mpn": {
+ "description": "The Manufacturer Part Number (MPN) of the product. For more information,\nsee https://support.google.com/manufacturers/answer/6124116#mpn.",
+ "type": "string"
+ },
+ "productPageUrl": {
+ "description": "The URL of the detail page of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#productpage.",
+ "type": "string"
+ },
+ "releaseDate": {
+ "description": "The release date of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#release.",
+ "type": "string"
}
},
"id": "Attributes"
}
},
"icons": {
- "x32": "http://www.google.com/images/icons/product/search-32.gif",
- "x16": "http://www.google.com/images/icons/product/search-16.gif"
+ "x16": "http://www.google.com/images/icons/product/search-16.gif",
+ "x32": "http://www.google.com/images/icons/product/search-32.gif"
},
- "protocol": "rest"
+ "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",
+ "ownerName": "Google",
+ "resources": {
+ "accounts": {
+ "resources": {
+ "products": {
+ "methods": {
+ "list": {
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "parent"
+ ],
+ "response": {
+ "$ref": "ListProductsResponse"
+ },
+ "parameters": {
+ "pageToken": {
+ "location": "query",
+ "description": "The token returned by the previous request.",
+ "type": "string"
+ },
+ "pageSize": {
+ "location": "query",
+ "description": "Maximum number of product statuses to return in the response, used for\npaging.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "parent": {
+ "description": "Parent ID in the format `accounts/{account_id}`.\n\n`account_id` - The ID of the Manufacturer Center account.",
+ "required": true,
+ "type": "string",
+ "pattern": "^accounts/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/manufacturercenter"
+ ],
+ "flatPath": "v1/accounts/{accountsId}/products",
+ "id": "manufacturers.accounts.products.list",
+ "path": "v1/{+parent}/products",
+ "description": "Lists all the products in a Manufacturer Center account."
+ },
+ "get": {
+ "flatPath": "v1/accounts/{accountsId}/products/{productsId}",
+ "path": "v1/{+parent}/products/{+name}",
+ "id": "manufacturers.accounts.products.get",
+ "description": "Gets the product from a Manufacturer Center account, including product\nissues.\n\nA recently updated product takes around 15 minutes to process. Changes are\nonly visible after it has been processed. While some issues may be\navailable once the product has been processed, other issues may take days\nto appear.",
+ "response": {
+ "$ref": "Product"
+ },
+ "parameterOrder": [
+ "parent",
+ "name"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "name": {
+ "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": "^[^/]+$"
+ },
+ "parent": {
+ "description": "Parent ID in the format `accounts/{account_id}`.\n\n`account_id` - The ID of the Manufacturer Center account.",
+ "required": true,
+ "type": "string",
+ "pattern": "^accounts/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/manufacturercenter"
+ ]
+ },
+ "update": {
+ "response": {
+ "$ref": "Product"
+ },
+ "parameterOrder": [
+ "parent",
+ "name"
+ ],
+ "httpMethod": "PUT",
+ "parameters": {
+ "name": {
+ "description": "Name in the format `{target_country}:{content_language}:{product_id}`.\n\n`target_country` - The target country of the product as a CLDR territory\n code (for example, US).\n\n`content_language` - The content language of the product as a two-letter\n ISO 639-1 language code (for example, en).\n\n`product_id` - The ID of the product. For more information, see\n https://support.google.com/manufacturers/answer/6124116#id.",
+ "required": true,
+ "type": "string",
+ "pattern": "^[^/]+$",
+ "location": "path"
+ },
+ "parent": {
+ "description": "Parent ID in the format `accounts/{account_id}`.\n\n`account_id` - The ID of the Manufacturer Center account.",
+ "required": true,
+ "type": "string",
+ "pattern": "^accounts/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/manufacturercenter"
+ ],
+ "flatPath": "v1/accounts/{accountsId}/products/{productsId}",
+ "path": "v1/{+parent}/products/{+name}",
+ "id": "manufacturers.accounts.products.update",
+ "request": {
+ "$ref": "Product"
+ },
+ "description": "Inserts or updates the product in a Manufacturer Center account.\n\nThe checks at upload time are minimal. All required attributes need to be\npresent for a product to be valid. Issues may show up later\nafter the API has accepted an update for a product and it is possible to\noverwrite an existing valid product with an invalid product. To detect\nthis, you should retrieve the product and check it for issues once the\nupdated version is available.\n\nInserted or updated products first need to be processed before they can be\nretrieved. Until then, new products will be unavailable, and retrieval\nof updated products will return the original state of the product."
+ },
+ "delete": {
+ "description": "Deletes the product from a Manufacturer Center account.",
+ "httpMethod": "DELETE",
+ "parameterOrder": [
+ "parent",
+ "name"
+ ],
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameters": {
+ "parent": {
+ "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/[^/]+$"
+ },
+ "name": {
+ "description": "Name in the format `{target_country}:{content_language}:{product_id}`.\n\n`target_country` - The target country of the product as a CLDR territory\n code (for example, US).\n\n`content_language` - The content language of the product as a two-letter\n ISO 639-1 language code (for example, en).\n\n`product_id` - The ID of the product. For more information, see\n https://support.google.com/manufacturers/answer/6124116#id.",
+ "required": true,
+ "type": "string",
+ "pattern": "^[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/manufacturercenter"
+ ],
+ "flatPath": "v1/accounts/{accountsId}/products/{productsId}",
+ "id": "manufacturers.accounts.products.delete",
+ "path": "v1/{+parent}/products/{+name}"
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": {
+ "callback": {
+ "description": "JSONP",
+ "type": "string",
+ "location": "query"
+ },
+ "$.xgafv": {
+ "description": "V1 error format.",
+ "type": "string",
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query",
+ "enum": [
+ "1",
+ "2"
+ ]
+ },
+ "alt": {
+ "type": "string",
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query",
+ "description": "Data format for response.",
+ "default": "json",
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ]
+ },
+ "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"
+ },
+ "bearer_token": {
+ "description": "OAuth bearer token.",
+ "type": "string",
+ "location": "query"
+ },
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string",
+ "location": "query"
+ },
+ "upload_protocol": {
+ "location": "query",
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "type": "string"
+ },
+ "prettyPrint": {
+ "location": "query",
+ "description": "Returns response with indentations and line breaks.",
+ "type": "boolean",
+ "default": "true"
+ },
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
+ "type": "string",
+ "location": "query"
+ },
+ "uploadType": {
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "version": "v1",
+ "baseUrl": "https://manufacturers.googleapis.com/",
+ "kind": "discovery#restDescription",
+ "description": "Public API for managing Manufacturer Center related data.",
+ "servicePath": "",
+ "basePath": ""
}
diff --git a/ml/v1/ml-api.json b/ml/v1/ml-api.json
index 7643f27..8c64c34 100644
--- a/ml/v1/ml-api.json
+++ b/ml/v1/ml-api.json
@@ -1,25 +1,9 @@
{
- "canonicalName": "Cloud Machine Learning Engine",
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/cloud-platform": {
- "description": "View and manage your data across Google Cloud Platform services"
- }
- }
- }
- },
- "rootUrl": "https://ml.googleapis.com/",
- "ownerDomain": "google.com",
- "name": "ml",
- "batchPath": "batch",
- "fullyEncodeReservedExpansion": true,
- "title": "Google Cloud Machine Learning Engine",
- "ownerName": "Google",
"resources": {
"projects": {
"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"
},
@@ -27,9 +11,6 @@
"name"
],
"httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
"parameters": {
"name": {
"description": "Required. The project name.",
@@ -39,14 +20,14 @@
"location": "path"
}
},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
"flatPath": "v1/projects/{projectsId}:getConfig",
"path": "v1/{+name}:getConfig",
- "id": "ml.projects.getConfig",
- "description": "Get the service account information associated with your project. You need\nthis information in order to grant the service account persmissions for\nthe Google Cloud Storage location where you put your model training code\nfor training the model with Google Cloud Machine Learning."
+ "id": "ml.projects.getConfig"
},
"predict": {
- "path": "v1/{+name}:predict",
- "id": "ml.projects.predict",
"request": {
"$ref": "GoogleCloudMlV1__PredictRequest"
},
@@ -60,47 +41,355 @@
"httpMethod": "POST",
"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/.+$"
+ "pattern": "^projects/.+$",
+ "location": "path"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
- "flatPath": "v1/projects/{projectsId}:predict"
+ "flatPath": "v1/projects/{projectsId}:predict",
+ "path": "v1/{+name}:predict",
+ "id": "ml.projects.predict"
}
},
"resources": {
- "operations": {
+ "locations": {
"methods": {
- "cancel": {
- "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`.",
- "httpMethod": "POST",
+ "get": {
+ "id": "ml.projects.locations.get",
+ "path": "v1/{+name}",
+ "description": "Get the complete list of CMLE capabilities in a location, along with their\nlocation-specific properties.",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "GoogleCloudMlV1__Location"
+ },
"parameterOrder": [
"name"
],
- "response": {
- "$ref": "GoogleProtobuf__Empty"
- },
"parameters": {
"name": {
- "description": "The name of the operation resource to be cancelled.",
+ "description": "Required. The name of the location.",
"required": true,
"type": "string",
- "pattern": "^projects/[^/]+/operations/[^/]+$",
+ "pattern": "^projects/[^/]+/locations/[^/]+$",
"location": "path"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}"
+ },
+ "list": {
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "parent"
+ ],
+ "response": {
+ "$ref": "GoogleCloudMlV1__ListLocationsResponse"
+ },
+ "parameters": {
+ "pageSize": {
+ "location": "query",
+ "description": "Optional. The number of locations to retrieve per \"page\" of results. If there\nare more remaining results than this number, the response message will\ncontain a valid value in the `next_page_token` field.\n\nThe default value is 20, and the maximum page size is 100.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "parent": {
+ "location": "path",
+ "description": "Required. The name of the project for which available locations are to be\nlisted (since some locations might be whitelisted for specific projects).",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+$"
+ },
+ "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"
+ }
+ },
+ "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": {
+ "testIamPermissions": {
+ "request": {
+ "$ref": "GoogleIamV1__TestIamPermissionsRequest"
+ },
+ "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning.",
+ "response": {
+ "$ref": "GoogleIamV1__TestIamPermissionsResponse"
+ },
+ "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/[^/]+/jobs/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectsId}/jobs/{jobsId}:testIamPermissions",
+ "path": "v1/{+resource}:testIamPermissions",
+ "id": "ml.projects.jobs.testIamPermissions"
+ },
+ "list": {
+ "flatPath": "v1/projects/{projectsId}/jobs",
+ "id": "ml.projects.jobs.list",
+ "path": "v1/{+parent}/jobs",
+ "description": "Lists the jobs in the project.\n\nIf there are no jobs that match the request parameters, the list\nrequest returns an empty response body: {}.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "parent"
+ ],
+ "response": {
+ "$ref": "GoogleCloudMlV1__ListJobsResponse"
+ },
+ "parameters": {
+ "pageSize": {
+ "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",
+ "location": "query"
+ },
+ "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.\nYou can filter on the value of one or more attributes of the job object.\nFor example, retrieve jobs with a job identifier that starts with 'census':\n\u003cp\u003e\u003ccode\u003egcloud ml-engine jobs list --filter='jobId:census*'\u003c/code\u003e\n\u003cp\u003eList all failed jobs with names that start with 'rnn':\n\u003cp\u003e\u003ccode\u003egcloud ml-engine jobs list --filter='jobId:rnn*\nAND state:FAILED'\u003c/code\u003e\n\u003cp\u003eFor more examples, see the guide to\n\u003ca href=\"/ml-engine/docs/monitor-training\"\u003emonitoring jobs\u003c/a\u003e.",
+ "type": "string",
+ "location": "query"
+ },
+ "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"
]
},
+ "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": {
+ "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/[^/]+$"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/jobs/{jobsId}:setIamPolicy",
+ "path": "v1/{+resource}:setIamPolicy",
+ "id": "ml.projects.jobs.setIamPolicy"
+ },
+ "create": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "parent"
+ ],
+ "response": {
+ "$ref": "GoogleCloudMlV1__Job"
+ },
+ "parameters": {
+ "parent": {
+ "description": "Required. The project name.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectsId}/jobs",
+ "id": "ml.projects.jobs.create",
+ "path": "v1/{+parent}/jobs",
+ "request": {
+ "$ref": "GoogleCloudMlV1__Job"
+ },
+ "description": "Creates a training or a batch prediction job."
+ },
+ "cancel": {
+ "flatPath": "v1/projects/{projectsId}/jobs/{jobsId}:cancel",
+ "path": "v1/{+name}:cancel",
+ "id": "ml.projects.jobs.cancel",
+ "description": "Cancels a running job.",
+ "request": {
+ "$ref": "GoogleCloudMlV1__CancelJobRequest"
+ },
+ "response": {
+ "$ref": "GoogleProtobuf__Empty"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "description": "Required. The name of the job to cancel.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/jobs/[^/]+$",
+ "location": "path"
+ }
+ }
+ },
+ "getIamPolicy": {
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "resource"
+ ],
+ "response": {
+ "$ref": "GoogleIamV1__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/[^/]+/jobs/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectsId}/jobs/{jobsId}:getIamPolicy",
+ "id": "ml.projects.jobs.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."
+ },
+ "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": {
+ "location": "query",
+ "description": "Required. Specifies the path, relative to `Job`, of the field to update.\nTo adopt etag mechanism, include `etag` field in the mask, and include the\n`etag` value in your job resource.\n\nFor example, to change the labels of a job, the `update_mask` parameter\nwould be specified as `labels`, `etag`, and the\n`PATCH` request body would specify the new value, as follows:\n {\n \"labels\": {\n \"owner\": \"Google\",\n \"color\": \"Blue\"\n }\n \"etag\": \"33a64df551425fcc55e4d42a148795d9f25f89d4\"\n }\nIf `etag` matches the one on the server, the labels of the job will be\nreplaced with the given ones, and the server end `etag` will be\nrecalculated.\n\nCurrently the only supported update masks are `labels` and `etag`.",
+ "format": "google-fieldmask",
+ "type": "string"
+ },
+ "name": {
+ "description": "Required. The job name.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/jobs/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/jobs/{jobsId}",
+ "path": "v1/{+name}",
+ "id": "ml.projects.jobs.patch"
+ },
+ "get": {
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "GoogleCloudMlV1__Job"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+/jobs/[^/]+$",
+ "location": "path",
+ "description": "Required. The name of the job to get the description of.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectsId}/jobs/{jobsId}",
+ "id": "ml.projects.jobs.get",
+ "path": "v1/{+name}",
+ "description": "Describes a job."
+ }
+ }
+ },
+ "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": "GoogleProtobuf__Empty"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "location": "path",
+ "description": "The name of the operation resource to be cancelled.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/operations/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectsId}/operations/{operationsId}:cancel",
+ "id": "ml.projects.operations.cancel",
+ "path": "v1/{+name}:cancel"
+ },
"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": {
@@ -127,47 +416,50 @@
"id": "ml.projects.operations.delete"
},
"list": {
- "description": "Lists operations that match the specified filter in the request. If the\nserver doesn't support this method, it returns `UNIMPLEMENTED`.\n\nNOTE: the `name` binding allows API services to override the binding\nto use different resource name schemes, such as `users/*/operations`. To\noverride the binding, API services can add a binding such as\n`\"/v1/{name=users/*}/operations\"` to their service configuration.\nFor backwards compatibility, the default name includes the operations\ncollection id, however overriding users must ensure the name binding\nis the parent resource, without the operations collection id.",
+ "httpMethod": "GET",
"response": {
"$ref": "GoogleLongrunning__ListOperationsResponse"
},
"parameterOrder": [
"name"
],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
"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",
- "location": "query"
+ "type": "integer"
},
"filter": {
- "location": "query",
"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": {
+ "location": "query",
+ "description": "The standard list page token.",
"type": "string"
}
},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
"flatPath": "v1/projects/{projectsId}/operations",
+ "id": "ml.projects.operations.list",
"path": "v1/{+name}/operations",
- "id": "ml.projects.operations.list"
+ "description": "Lists operations that match the specified filter in the request. If the\nserver doesn't support this method, it returns `UNIMPLEMENTED`.\n\nNOTE: the `name` binding allows API services to override the binding\nto use different resource name schemes, such as `users/*/operations`. To\noverride the binding, API services can add a binding such as\n`\"/v1/{name=users/*}/operations\"` to their service configuration.\nFor backwards compatibility, the default name includes the operations\ncollection id, however overriding users must ensure the name binding\nis the parent resource, without the operations collection id."
},
"get": {
+ "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.",
"response": {
"$ref": "GoogleLongrunning__Operation"
},
@@ -187,15 +479,293 @@
"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."
+ "flatPath": "v1/projects/{projectsId}/operations/{operationsId}"
}
}
},
"models": {
+ "resources": {
+ "versions": {
+ "methods": {
+ "patch": {
+ "response": {
+ "$ref": "GoogleLongrunning__Operation"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "PATCH",
+ "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`, and `expire_time`.",
+ "format": "google-fieldmask",
+ "type": "string",
+ "location": "query"
+ },
+ "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": {
+ "description": "Required. The name of the version.",
+ "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}",
+ "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."
+ },
+ "setDefault": {
+ "request": {
+ "$ref": "GoogleCloudMlV1__SetDefaultVersionRequest"
+ },
+ "description": "Designates a version to be the default for the model.\n\nThe default version is used for prediction requests made against the model\nthat don't specify a version.\n\nThe first version to be created for a model is automatically set as the\ndefault. You must make any subsequent changes to the default version\nsetting manually using this method.",
+ "response": {
+ "$ref": "GoogleCloudMlV1__Version"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "name": {
+ "location": "path",
+ "description": "Required. The name of the version to make the default for the model. You\ncan get the names of all the versions of a model by calling\n[projects.models.versions.list](/ml-engine/reference/rest/v1/projects.models.versions/list).",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/models/[^/]+/versions/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectsId}/models/{modelsId}/versions/{versionsId}:setDefault",
+ "path": "v1/{+name}:setDefault",
+ "id": "ml.projects.models.versions.setDefault"
+ },
+ "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",
+ "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"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectsId}/models/{modelsId}/versions/{versionsId}",
+ "path": "v1/{+name}",
+ "id": "ml.projects.models.versions.delete"
+ },
+ "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 many versions, or if you need to handle\nonly a limited number of results at a time, you can request that the list\nbe retrieved in batches (called pages).\n\nIf there are no versions that match the request parameters, the list\nrequest returns an empty response body: {}.",
+ "response": {
+ "$ref": "GoogleCloudMlV1__ListVersionsResponse"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "filter": {
+ "description": "Optional. Specifies the subset of versions 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": {
+ "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": {
+ "pattern": "^projects/[^/]+/models/[^/]+$",
+ "location": "path",
+ "description": "Required. The name of the model for which to list the version.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectsId}/models/{modelsId}/versions"
+ },
+ "create": {
+ "response": {
+ "$ref": "GoogleLongrunning__Operation"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "parent": {
+ "location": "path",
+ "description": "Required. The name of the model.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/models/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectsId}/models/{modelsId}/versions",
+ "path": "v1/{+parent}/versions",
+ "id": "ml.projects.models.versions.create",
+ "request": {
+ "$ref": "GoogleCloudMlV1__Version"
+ },
+ "description": "Creates a new version of a model from a trained TensorFlow model.\n\nIf the version created in the cloud by this call is the first deployed\nversion of the specified model, it will be made the default version of the\nmodel. When you add a version to a model that already has one or more\nversions, the default version does not automatically change. If you want a\nnew version to be the default, you must call\n[projects.models.versions.setDefault](/ml-engine/reference/rest/v1/projects.models.versions/setDefault)."
+ }
+ }
+ }
+ },
"methods": {
+ "testIamPermissions": {
+ "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.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "resource"
+ ],
+ "response": {
+ "$ref": "GoogleIamV1__TestIamPermissionsResponse"
+ },
+ "parameters": {
+ "resource": {
+ "pattern": "^projects/[^/]+/models/[^/]+$",
+ "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"
+ ]
+ },
+ "delete": {
+ "flatPath": "v1/projects/{projectsId}/models/{modelsId}",
+ "path": "v1/{+name}",
+ "id": "ml.projects.models.delete",
+ "description": "Deletes a model.\n\nYou can only delete a model if there are no versions in it. You can delete\nversions by calling\n[projects.models.versions.delete](/ml-engine/reference/rest/v1/projects.models.versions/delete).",
+ "response": {
+ "$ref": "GoogleLongrunning__Operation"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "DELETE",
+ "parameters": {
+ "name": {
+ "description": "Required. The name of the model.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/models/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "list": {
+ "response": {
+ "$ref": "GoogleCloudMlV1__ListModelsResponse"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "filter": {
+ "description": "Optional. Specifies the subset of models to retrieve.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "Optional. A page token to request the next page of results.\n\nYou get the token from the `next_page_token` field of the response from\nthe previous call.",
+ "type": "string"
+ },
+ "pageSize": {
+ "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/[^/]+$"
+ }
+ },
+ "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.\n\nIf there are no models that match the request parameters, the list request\nreturns an empty response body: {}."
+ },
"setIamPolicy": {
"response": {
"$ref": "GoogleIamV1__Policy"
@@ -204,27 +774,31 @@
"resource"
],
"httpMethod": "POST",
+ "parameters": {
+ "resource": {
+ "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/models/[^/]+$",
+ "location": "path"
+ }
+ },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
- "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"
- }
- },
"flatPath": "v1/projects/{projectsId}/models/{modelsId}:setIamPolicy",
"path": "v1/{+resource}:setIamPolicy",
"id": "ml.projects.models.setIamPolicy",
- "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.",
"request": {
"$ref": "GoogleIamV1__SetIamPolicyRequest"
- }
+ },
+ "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy."
},
"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"
},
@@ -232,6 +806,9 @@
"parent"
],
"httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
"parameters": {
"parent": {
"description": "Required. The project name.",
@@ -241,31 +818,18 @@
"location": "path"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
"flatPath": "v1/projects/{projectsId}/models",
"path": "v1/{+parent}/models",
- "id": "ml.projects.models.create",
- "request": {
- "$ref": "GoogleCloudMlV1__Model"
- },
- "description": "Creates a model which will later contain one or more versions.\n\nYou must add at least one version before you can request predictions from\nthe model. Add versions by calling\n[projects.models.versions.create](/ml-engine/reference/rest/v1/projects.models.versions/create)."
+ "id": "ml.projects.models.create"
},
"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.",
+ "httpMethod": "GET",
"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.",
@@ -275,7 +839,38 @@
"location": "path"
}
},
- "flatPath": "v1/projects/{projectsId}/models/{modelsId}:getIamPolicy"
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "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."
+ },
+ "get": {
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "GoogleCloudMlV1__Model"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "location": "path",
+ "description": "Required. The name of the model.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/models/[^/]+$"
+ }
+ },
+ "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)."
},
"patch": {
"request": {
@@ -290,18 +885,18 @@
],
"httpMethod": "PATCH",
"parameters": {
- "updateMask": {
- "description": "Required. Specifies the path, relative to `Model`, of the field to update.\n\nFor example, to change the description of a model to \"foo\" and set its\ndefault version to \"version_1\", the `update_mask` parameter would be\nspecified as `description`, `default_version.name`, and the `PATCH`\nrequest body would specify the new value, as follows:\n {\n \"description\": \"foo\",\n \"defaultVersion\": {\n \"name\":\"version_1\"\n }\n }\nIn this example, the model is blindly overwritten since no etag is given.\n\nTo adopt etag mechanism, include `etag` field in the mask, and include the\n`etag` value in your model resource.\n\nCurrently the supported update masks are `description`,\n`default_version.name`, `labels`, and `etag`.",
- "format": "google-fieldmask",
- "type": "string",
- "location": "query"
- },
"name": {
"description": "Required. The project name.",
"required": true,
"type": "string",
"pattern": "^projects/[^/]+/models/[^/]+$",
"location": "path"
+ },
+ "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"
}
},
"scopes": [
@@ -310,618 +905,6 @@
"flatPath": "v1/projects/{projectsId}/models/{modelsId}",
"path": "v1/{+name}",
"id": "ml.projects.models.patch"
- },
- "get": {
- "flatPath": "v1/projects/{projectsId}/models/{modelsId}",
- "path": "v1/{+name}",
- "id": "ml.projects.models.get",
- "description": "Gets information about a model, including its name, the description (if\nset), and the default version (if at least one version of the model has\nbeen deployed).",
- "response": {
- "$ref": "GoogleCloudMlV1__Model"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "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"
- }
- }
- },
- "testIamPermissions": {
- "response": {
- "$ref": "GoogleIamV1__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/[^/]+/models/[^/]+$"
- }
- },
- "flatPath": "v1/projects/{projectsId}/models/{modelsId}:testIamPermissions",
- "path": "v1/{+resource}:testIamPermissions",
- "id": "ml.projects.models.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"
- }
- },
- "delete": {
- "id": "ml.projects.models.delete",
- "path": "v1/{+name}",
- "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).",
- "httpMethod": "DELETE",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "GoogleLongrunning__Operation"
- },
- "parameters": {
- "name": {
- "description": "Required. The name of the model.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/models/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/models/{modelsId}"
- },
- "list": {
- "response": {
- "$ref": "GoogleCloudMlV1__ListModelsResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "parent": {
- "location": "path",
- "description": "Required. The name of the project whose models are to be listed.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+$"
- },
- "filter": {
- "description": "Optional. Specifies the subset of models 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": {
- "location": "query",
- "description": "Optional. The number of models to retrieve per \"page\" of results. If there\nare more remaining results than this number, the response message will\ncontain a valid value in the `next_page_token` field.\n\nThe default value is 20, and the maximum page size is 100.",
- "format": "int32",
- "type": "integer"
- }
- },
- "flatPath": "v1/projects/{projectsId}/models",
- "path": "v1/{+parent}/models",
- "id": "ml.projects.models.list",
- "description": "Lists the models in a project.\n\nEach project can contain multiple models, and each model can have multiple\nversions.\n\nIf there are no models that match the request parameters, the list request\nreturns an empty response body: {}."
- }
- },
- "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": {
- "httpMethod": "DELETE",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "GoogleLongrunning__Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "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",
- "pattern": "^projects/[^/]+/models/[^/]+/versions/[^/]+$"
- }
- },
- "flatPath": "v1/projects/{projectsId}/models/{modelsId}/versions/{versionsId}",
- "id": "ml.projects.models.versions.delete",
- "path": "v1/{+name}",
- "description": "Deletes a model version.\n\nEach model can have multiple versions deployed and in use at any given\ntime. Use this method to remove a single version.\n\nNote: You cannot delete the version that is set as the default version\nof the model unless it is the only remaining version."
- },
- "list": {
- "description": "Gets basic information about all the versions of a model.\n\nIf you expect that a model has many versions, or if you need to handle\nonly a limited number of results at a time, you can request that the list\nbe retrieved in batches (called pages).\n\nIf there are no versions that match the request parameters, the list\nrequest returns an empty response body: {}.",
- "response": {
- "$ref": "GoogleCloudMlV1__ListVersionsResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "pageToken": {
- "description": "Optional. A page token to request the next page of results.\n\nYou get the token from the `next_page_token` field of the response from\nthe previous call.",
- "type": "string",
- "location": "query"
- },
- "pageSize": {
- "type": "integer",
- "location": "query",
- "description": "Optional. The number of 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"
- },
- "parent": {
- "pattern": "^projects/[^/]+/models/[^/]+$",
- "location": "path",
- "description": "Required. The name of the model for which to list the version.",
- "required": true,
- "type": "string"
- },
- "filter": {
- "location": "query",
- "description": "Optional. Specifies the subset of versions to retrieve.",
- "type": "string"
- }
- },
- "flatPath": "v1/projects/{projectsId}/models/{modelsId}/versions",
- "path": "v1/{+parent}/versions",
- "id": "ml.projects.models.versions.list"
- },
- "create": {
- "response": {
- "$ref": "GoogleLongrunning__Operation"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "POST",
- "parameters": {
- "parent": {
- "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}/versions",
- "path": "v1/{+parent}/versions",
- "id": "ml.projects.models.versions.create",
- "request": {
- "$ref": "GoogleCloudMlV1__Version"
- },
- "description": "Creates a new version of a model from a trained TensorFlow model.\n\nIf the version created in the cloud by this call is the first deployed\nversion of the specified model, it will be made the default version of the\nmodel. When you add a version to a model that already has one or more\nversions, the default version does not automatically change. If you want a\nnew version to be the default, you must call\n[projects.models.versions.setDefault](/ml-engine/reference/rest/v1/projects.models.versions/setDefault)."
- },
- "patch": {
- "description": "Updates the specified Version resource.\n\nCurrently the only supported field to update is `description`.",
- "request": {
- "$ref": "GoogleCloudMlV1__Version"
- },
- "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 `Version`, of the field to\nupdate. Must be present and non-empty.\n\nFor example, to change the description of a version to \"foo\", the\n`update_mask` parameter would be specified as `description`, and the\n`PATCH` request body would specify the new value, as follows:\n {\n \"description\": \"foo\"\n }\nIn this example, the version is blindly overwritten since no etag is given.\n\nTo adopt etag mechanism, include `etag` field in the mask, and include the\n`etag` value in your version resource.\n\nCurrently the only supported update masks are `description`, `labels`, and\n`etag`, and `expire_time`.",
- "format": "google-fieldmask",
- "type": "string"
- },
- "name": {
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/models/[^/]+/versions/[^/]+$",
- "location": "path",
- "description": "Required. The name of the model."
- }
- },
- "flatPath": "v1/projects/{projectsId}/models/{modelsId}/versions/{versionsId}",
- "path": "v1/{+name}",
- "id": "ml.projects.models.versions.patch"
- },
- "get": {
- "response": {
- "$ref": "GoogleCloudMlV1__Version"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "parameters": {
- "name": {
- "description": "Required. The name of the version.",
- "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.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."
- }
- }
- }
- }
- },
- "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",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/locations/[^/]+$",
- "location": "path",
- "description": "Required. The name of the location.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}",
- "path": "v1/{+name}",
- "id": "ml.projects.locations.get"
- },
- "list": {
- "description": "List all locations that provides at least one type of CMLE capability.",
- "httpMethod": "GET",
- "response": {
- "$ref": "GoogleCloudMlV1__ListLocationsResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "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 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",
- "id": "ml.projects.locations.list",
- "path": "v1/{+parent}/locations"
- }
- }
- },
- "jobs": {
- "methods": {
- "list": {
- "path": "v1/{+parent}/jobs",
- "id": "ml.projects.jobs.list",
- "description": "Lists the jobs in the project.\n\nIf there are no jobs that match the request parameters, the list\nrequest returns an empty response body: {}.",
- "response": {
- "$ref": "GoogleCloudMlV1__ListJobsResponse"
- },
- "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 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",
- "location": "query"
- },
- "parent": {
- "description": "Required. The name of the project for which to list jobs.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+$",
- "location": "path"
- },
- "filter": {
- "location": "query",
- "description": "Optional. Specifies the subset of jobs to retrieve.\nYou can filter on the value of one or more attributes of the job object.\nFor example, retrieve jobs with a job identifier that starts with 'census':\n\u003cp\u003e\u003ccode\u003egcloud ml-engine jobs list --filter='jobId:census*'\u003c/code\u003e\n\u003cp\u003eList all failed jobs with names that start with 'rnn':\n\u003cp\u003e\u003ccode\u003egcloud ml-engine jobs list --filter='jobId:rnn*\nAND state:FAILED'\u003c/code\u003e\n\u003cp\u003eFor more examples, see the guide to\n\u003ca href=\"/ml-engine/docs/monitor-training\"\u003emonitoring jobs\u003c/a\u003e.",
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/jobs"
- },
- "setIamPolicy": {
- "response": {
- "$ref": "GoogleIamV1__Policy"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "resource": {
- "location": "path",
- "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/jobs/[^/]+$"
- }
- },
- "flatPath": "v1/projects/{projectsId}/jobs/{jobsId}:setIamPolicy",
- "path": "v1/{+resource}:setIamPolicy",
- "id": "ml.projects.jobs.setIamPolicy",
- "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.",
- "request": {
- "$ref": "GoogleIamV1__SetIamPolicyRequest"
- }
- },
- "create": {
- "parameters": {
- "parent": {
- "description": "Required. The project name.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/jobs",
- "id": "ml.projects.jobs.create",
- "path": "v1/{+parent}/jobs",
- "request": {
- "$ref": "GoogleCloudMlV1__Job"
- },
- "description": "Creates a training or a batch prediction job.",
- "httpMethod": "POST",
- "parameterOrder": [
- "parent"
- ],
- "response": {
- "$ref": "GoogleCloudMlV1__Job"
- }
- },
- "cancel": {
- "response": {
- "$ref": "GoogleProtobuf__Empty"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "description": "Required. The name of the job to cancel.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/jobs/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1/projects/{projectsId}/jobs/{jobsId}:cancel",
- "path": "v1/{+name}:cancel",
- "id": "ml.projects.jobs.cancel",
- "description": "Cancels a running job.",
- "request": {
- "$ref": "GoogleCloudMlV1__CancelJobRequest"
- }
- },
- "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": {
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/jobs/[^/]+$",
- "location": "path",
- "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field."
- }
- },
- "flatPath": "v1/projects/{projectsId}/jobs/{jobsId}:getIamPolicy",
- "path": "v1/{+resource}:getIamPolicy",
- "id": "ml.projects.jobs.getIamPolicy"
- },
- "patch": {
- "request": {
- "$ref": "GoogleCloudMlV1__Job"
- },
- "description": "Updates a specific job resource.\n\nCurrently the only supported fields to update are `labels`.",
- "response": {
- "$ref": "GoogleCloudMlV1__Job"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "PATCH",
- "parameters": {
- "updateMask": {
- "location": "query",
- "description": "Required. Specifies the path, relative to `Job`, of the field to update.\nTo adopt etag mechanism, include `etag` field in the mask, and include the\n`etag` value in your job resource.\n\nFor example, to change the labels of a job, the `update_mask` parameter\nwould be specified as `labels`, `etag`, and the\n`PATCH` request body would specify the new value, as follows:\n {\n \"labels\": {\n \"owner\": \"Google\",\n \"color\": \"Blue\"\n }\n \"etag\": \"33a64df551425fcc55e4d42a148795d9f25f89d4\"\n }\nIf `etag` matches the one on the server, the labels of the job will be\nreplaced with the given ones, and the server end `etag` will be\nrecalculated.\n\nCurrently the only supported update masks are `labels` and `etag`.",
- "format": "google-fieldmask",
- "type": "string"
- },
- "name": {
- "description": "Required. The job name.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/jobs/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "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",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/jobs/[^/]+$",
- "location": "path",
- "description": "Required. The name of the job to get the description of.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1/projects/{projectsId}/jobs/{jobsId}",
- "path": "v1/{+name}",
- "id": "ml.projects.jobs.get"
- },
- "testIamPermissions": {
- "httpMethod": "POST",
- "parameterOrder": [
- "resource"
- ],
- "response": {
- "$ref": "GoogleIamV1__TestIamPermissionsResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "resource": {
- "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/jobs/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1/projects/{projectsId}/jobs/{jobsId}:testIamPermissions",
- "id": "ml.projects.jobs.testIamPermissions",
- "path": "v1/{+resource}:testIamPermissions",
- "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning.",
- "request": {
- "$ref": "GoogleIamV1__TestIamPermissionsRequest"
- }
}
}
}
@@ -929,37 +912,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.",
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
"type": "string",
"location": "query"
},
- "quotaUser": {
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string",
- "location": "query"
- },
- "pp": {
- "type": "boolean",
- "default": "true",
- "location": "query",
- "description": "Pretty-print response."
- },
"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",
@@ -971,33 +933,33 @@
"type": "boolean",
"default": "true"
},
- "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"
},
- "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": {
- "type": "string",
- "location": "query",
- "description": "JSONP"
- },
"$.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": "V1 error format."
+ "description": "JSONP",
+ "type": "string"
},
"alt": {
"enum": [
@@ -1014,13 +976,34 @@
"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": {
+ "location": "query",
+ "description": "Pretty-print response.",
+ "type": "boolean",
+ "default": "true"
}
},
"version": "v1",
"baseUrl": "https://ml.googleapis.com/",
- "kind": "discovery#restDescription",
- "description": "An API to enable creating and using machine learning models.",
"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/",
@@ -1028,15 +1011,41 @@
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
- "GoogleCloudMlV1__Version": {
+ "GoogleCloudMlV1__PredictRequest": {
+ "description": "Request for predictions to be issued against a trained model.",
+ "type": "object",
"properties": {
- "runtimeVersion": {
- "description": "Optional. The Google Cloud ML runtime version to use for this deployment.\nIf not set, Google Cloud ML will choose a version.",
+ "httpBody": {
+ "$ref": "GoogleApi__HttpBody",
+ "description": "\nRequired. The prediction request body."
+ }
+ },
+ "id": "GoogleCloudMlV1__PredictRequest"
+ },
+ "GoogleCloudMlV1_HyperparameterOutput_HyperparameterMetric": {
+ "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",
+ "description": "An observed value of a metric.",
+ "type": "object"
+ },
+ "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": {
"description": {
- "type": "string",
- "description": "Optional. The description specified for the version when it was created."
+ "description": "Optional. The description specified for the version when it was created.",
+ "type": "string"
},
"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 `GetVersion`, and\nsystems are expected to put that etag in the request to `UpdateVersion` to\nensure that their change will be applied to the model as intended.",
@@ -1048,18 +1057,10 @@
"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"
+ "$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."
},
"state": {
- "type": "string",
- "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",
@@ -1067,24 +1068,32 @@
"FAILED",
"DELETING"
],
- "description": "Output only. The state of a version."
+ "description": "Output only. The state of a version.",
+ "type": "string",
+ "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."
+ ]
},
"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": {
- "type": "string",
"description": "Output only. The time the version was last used for prediction.",
- "format": "google-datetime"
+ "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"
},
"autoScaling": {
- "$ref": "GoogleCloudMlV1__AutoScaling",
- "description": "Automatically scale the number of nodes used to serve the model in\nresponse to increases and decreases in traffic. Care should be\ntaken to ramp up traffic according to the model's ability to scale\nor you will start seeing increases in latency and 429 response codes."
+ "description": "Automatically scale the number of nodes used to serve the model in\nresponse to increases and decreases in traffic. Care should be\ntaken to ramp up traffic according to the model's ability to scale\nor you will start seeing increases in latency and 429 response codes.",
+ "$ref": "GoogleCloudMlV1__AutoScaling"
},
"createTime": {
"description": "Output only. The time the version was created.",
@@ -1092,28 +1101,25 @@
"type": "string"
},
"labels": {
- "description": "Optional. One or more labels that you can add, to organize your model\nversions. Each label is a key-value pair, where both the key and the value\nare arbitrary strings that you supply.\nFor more information, see the documentation on\n\u003ca href=\"/ml-engine/docs/how-tos/resource-labels\"\u003eusing labels\u003c/a\u003e.",
- "type": "object",
"additionalProperties": {
"type": "string"
- }
+ },
+ "description": "Optional. One or more labels that you can add, to organize your model\nversions. Each label is a key-value pair, where both the key and the value\nare arbitrary strings that you supply.\nFor more information, see the documentation on\n\u003ca href=\"/ml-engine/docs/how-tos/resource-labels\"\u003eusing labels\u003c/a\u003e.",
+ "type": "object"
},
"errorMessage": {
"description": "Output only. The details of a failure or a cancellation.",
"type": "string"
+ },
+ "runtimeVersion": {
+ "description": "Optional. The Google Cloud ML runtime version to use for this deployment.\nIf not set, Google Cloud ML will choose a version.",
+ "type": "string"
}
},
- "id": "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"
+ "id": "GoogleCloudMlV1__Version"
},
"GoogleCloudMlV1__ParameterSpec": {
"properties": {
- "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",
- "type": "number"
- },
"discreteValues": {
"description": "Required if type is `DISCRETE`.\nA list of feasible points.\nThe list should be in strictly increasing order. For instance, this\nparameter might have possible settings of 1.5, 2.5, and 4.0. This list\nshould not contain more than 1,000 values.",
"type": "array",
@@ -1123,6 +1129,8 @@
}
},
"scaleType": {
+ "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": [
"By default, no scaling is applied.",
"Scales the feasible space to (0, 1) linearly.",
@@ -1134,14 +1142,12 @@
"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"
+ ]
},
"maxValue": {
- "type": "number",
"description": "Required if typeis `DOUBLE` or `INTEGER`. This field\nshould be unset if type is `CATEGORICAL`. This value should be integers if\ntype is `INTEGER`.",
- "format": "double"
+ "format": "double",
+ "type": "number"
},
"type": {
"enumDescriptions": [
@@ -1169,21 +1175,46 @@
}
},
"parameterName": {
- "type": "string",
- "description": "Required. The parameter name must be unique amongst all ParameterConfigs in\na HyperparameterSpec message. E.g., \"learning_rate\"."
+ "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",
+ "type": "number"
}
},
"id": "GoogleCloudMlV1__ParameterSpec",
"description": "Represents a single hyperparameter to optimize.",
"type": "object"
},
+ "GoogleCloudMlV1__Location": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string"
+ },
+ "capabilities": {
+ "description": "Capabilities available in the location.",
+ "type": "array",
+ "items": {
+ "$ref": "GoogleCloudMlV1__Capability"
+ }
+ }
+ },
+ "id": "GoogleCloudMlV1__Location"
+ },
"GoogleCloudMlV1__PredictionInput": {
"description": "Represents input parameters for a prediction job.",
"type": "object",
"properties": {
+ "region": {
+ "description": "Required. The Google Compute Engine region to run the prediction job in.\nSee the \u003ca href=\"/ml-engine/docs/regions\"\u003eavailable regions\u003c/a\u003e for\nML Engine services.",
+ "type": "string"
+ },
"versionName": {
- "type": "string",
- "description": "Use this field if you want to specify a version of the model to use. The\nstring is formatted the same way as `model_version`, with the addition\nof the version information:\n\n`\"projects/\u003cvar\u003e[YOUR_PROJECT]\u003c/var\u003e/models/\u003cvar\u003eYOUR_MODEL/versions/\u003cvar\u003e[YOUR_VERSION]\u003c/var\u003e\"`"
+ "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\"`",
@@ -1193,15 +1224,15 @@
"description": "Required. The output Google Cloud Storage location.",
"type": "string"
},
+ "maxWorkerCount": {
+ "description": "Optional. The maximum number of workers to be used for parallel processing.\nDefaults to 10 if not specified.",
+ "format": "int64",
+ "type": "string"
+ },
"uri": {
"description": "Use this field if you want to specify a Google Cloud Storage path for\nthe model to use.",
"type": "string"
},
- "maxWorkerCount": {
- "type": "string",
- "description": "Optional. The maximum number of workers to be used for parallel processing.\nDefaults to 10 if not specified.",
- "format": "int64"
- },
"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"
@@ -1224,55 +1255,88 @@
"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"
+ },
"batchSize": {
"description": "Optional. Number of records per batch, defaults to 64.\nThe service will buffer batch_size number of records in memory before\ninvoking one Tensorflow prediction call internally. So take the record\nsize and memory available into consideration when setting this parameter.",
"format": "int64",
"type": "string"
},
- "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"
- },
"inputPaths": {
"description": "Required. The Google Cloud Storage location of the input data files.\nMay contain wildcards.",
"type": "array",
"items": {
"type": "string"
}
- },
- "region": {
- "description": "Required. The Google Compute Engine region to run the prediction job in.\nSee the \u003ca href=\"/ml-engine/docs/regions\"\u003eavailable regions\u003c/a\u003e for\nML Engine services.",
- "type": "string"
}
},
"id": "GoogleCloudMlV1__PredictionInput"
},
- "GoogleCloudMlV1__Location": {
+ "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": {
- "name": {
+ "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"
},
- "capabilities": {
- "type": "array",
- "items": {
- "$ref": "GoogleCloudMlV1__Capability"
- },
- "description": "Capabilities available in the location."
+ "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": "GoogleCloudMlV1__Location"
+ "id": "GoogleType__Expr"
+ },
+ "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.",
+ "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": "GoogleIamV1__AuditLogConfig"
},
"GoogleCloudMlV1__OperationMetadata": {
"description": "Represents the metadata of the long-running operation.",
"type": "object",
"properties": {
"labels": {
+ "description": "The user labels, inherited from the model or the model version being\noperated on.",
+ "type": "object",
"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.",
@@ -1319,71 +1383,18 @@
"format": "google-datetime",
"type": "string"
},
+ "isCancellationRequested": {
+ "description": "Indicates whether a request to cancel this operation has been made.",
+ "type": "boolean"
+ },
"projectNumber": {
"description": "Contains the project number associated with the operation.",
"format": "int64",
"type": "string"
- },
- "isCancellationRequested": {
- "description": "Indicates whether a request to cancel this operation has been made.",
- "type": "boolean"
}
},
"id": "GoogleCloudMlV1__OperationMetadata"
},
- "GoogleIamV1__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": {
- "enum": [
- "LOG_TYPE_UNSPECIFIED",
- "ADMIN_READ",
- "DATA_WRITE",
- "DATA_READ"
- ],
- "description": "The log type that this config enables.",
- "type": "string",
- "enumDescriptions": [
- "Default case. Should never be this.",
- "Admin reads. Example: CloudIAM getIamPolicy",
- "Data writes. Example: CloudSQL Users create",
- "Data reads. Example: CloudSQL Users list"
- ]
- }
- },
- "id": "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"
- },
- "GoogleType__Expr": {
- "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": {
- "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"
- }
- },
- "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"
- },
"GoogleCloudMlV1__ListLocationsResponse": {
"type": "object",
"properties": {
@@ -1402,9 +1413,6 @@
"id": "GoogleCloudMlV1__ListLocationsResponse"
},
"GoogleCloudMlV1__HyperparameterSpec": {
- "id": "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.",
@@ -1426,24 +1434,29 @@
"type": "string"
},
"hyperparameterMetricTag": {
- "type": "string",
- "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."
+ "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.",
+ "type": "string"
},
"params": {
+ "description": "Required. The set of parameters to tune.",
"type": "array",
"items": {
"$ref": "GoogleCloudMlV1__ParameterSpec"
- },
- "description": "Required. The set of parameters to tune."
+ }
},
"maxTrials": {
"description": "Optional. How many training trials should be attempted to optimize\nthe specified hyperparameters.\n\nDefaults to one.",
"format": "int32",
"type": "integer"
}
- }
+ },
+ "id": "GoogleCloudMlV1__HyperparameterSpec",
+ "description": "Represents a set of hyperparameters to optimize.",
+ "type": "object"
},
"GoogleCloudMlV1__ListJobsResponse": {
+ "description": "Response message for the ListJobs method.",
+ "type": "object",
"properties": {
"jobs": {
"description": "The list of jobs.",
@@ -1457,32 +1470,16 @@
"type": "string"
}
},
- "id": "GoogleCloudMlV1__ListJobsResponse",
- "description": "Response message for the ListJobs method.",
- "type": "object"
+ "id": "GoogleCloudMlV1__ListJobsResponse"
},
"GoogleCloudMlV1__SetDefaultVersionRequest": {
+ "properties": {},
"id": "GoogleCloudMlV1__SetDefaultVersionRequest",
"description": "Request message for the SetDefaultVersion request.",
- "type": "object",
- "properties": {}
+ "type": "object"
},
"GoogleLongrunning__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": "GoogleRpc__Status",
"description": "The error result of the operation in case of failure or cancellation."
@@ -1498,18 +1495,28 @@
"done": {
"description": "If the value is `false`, it means the operation is still in progress.\nIf `true`, the operation is completed, and either `error` or `response` is\navailable.",
"type": "boolean"
+ },
+ "response": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "description": "The normal response of the operation in case of success. If the original\nmethod returns no data on success, such as `Delete`, the response is\n`google.protobuf.Empty`. If the original method is standard\n`Get`/`Create`/`Update`, the response should be the resource. For other\nmethods, the response should have the type `XxxResponse`, where `Xxx`\nis the original method name. For example, if the original method name\nis `TakeSnapshot()`, the inferred response type is\n`TakeSnapshotResponse`.",
+ "type": "object"
+ },
+ "name": {
+ "description": "The server-assigned name, which is only unique within the same service that\noriginally returns it. If you use the default HTTP mapping, the\n`name` should have the format of `operations/some/unique/name`.",
+ "type": "string"
}
},
- "id": "GoogleLongrunning__Operation"
+ "id": "GoogleLongrunning__Operation",
+ "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
+ "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",
"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",
@@ -1522,11 +1529,16 @@
"items": {
"type": "string"
}
+ },
+ "service": {
+ "description": "Specifies a service that will be enabled for audit logging.\nFor example, `storage.googleapis.com`, `cloudsql.googleapis.com`.\n`allServices` is a special value that covers all services.",
+ "type": "string"
}
},
"id": "GoogleIamV1__AuditConfig"
},
"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": {
"description": {
@@ -1543,19 +1555,19 @@
"type": "string"
},
"labels": {
+ "description": "Optional. One or more labels that you can add, to organize your models.\nEach label is a key-value pair, where both the key and the value are\narbitrary strings that you supply.\nFor more information, see the documentation on\n\u003ca href=\"/ml-engine/docs/how-tos/resource-labels\"\u003eusing labels\u003c/a\u003e.",
+ "type": "object",
"additionalProperties": {
"type": "string"
- },
- "description": "Optional. One or more labels that you can add, to organize your models.\nEach label is a key-value pair, where both the key and the value are\narbitrary strings that you supply.\nFor more information, see the documentation on\n\u003ca href=\"/ml-engine/docs/how-tos/resource-labels\"\u003eusing labels\u003c/a\u003e.",
- "type": "object"
+ }
},
"name": {
"description": "Required. The name specified for the model when it was created.\n\nThe model name must be unique within the project it is created in.",
"type": "string"
},
"defaultVersion": {
- "description": "Output only. The default version of the model. This version will be used to\nhandle prediction requests that do not specify a version.\n\nYou can change the default version by calling\n[projects.methods.versions.setDefault](/ml-engine/reference/rest/v1/projects.models.versions/setDefault).",
- "$ref": "GoogleCloudMlV1__Version"
+ "$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.\nSee the \u003ca href=\"/ml-engine/docs/regions\"\u003eavailable regions\u003c/a\u003e for\nML Engine services.\nNote:\n* No matter where a model is deployed, it can always be accessed by\n users from anywhere, both for online and batch prediction.\n* The region for a batch prediction job is set by the region field when\n submitting the batch prediction job and does not take its value from\n this field.",
@@ -1565,8 +1577,7 @@
}
}
},
- "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."
+ "id": "GoogleCloudMlV1__Model"
},
"GoogleProtobuf__Empty": {
"properties": {},
@@ -1591,11 +1602,11 @@
"GoogleCloudMlV1__ListVersionsResponse": {
"properties": {
"versions": {
+ "description": "The list of versions.",
"type": "array",
"items": {
"$ref": "GoogleCloudMlV1__Version"
- },
- "description": "The list of versions."
+ }
},
"nextPageToken": {
"description": "Optional. Pass this token as the `page_token` field of the request for a\nsubsequent call.",
@@ -1616,15 +1627,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": {
- "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",
@@ -1635,6 +1637,15 @@
},
"type": "object"
}
+ },
+ "code": {
+ "description": "The status code, which should be an enum value of google.rpc.Code.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "message": {
+ "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
+ "type": "string"
}
},
"id": "GoogleRpc__Status"
@@ -1651,93 +1662,6 @@
},
"id": "GoogleCloudMlV1__AutoScaling"
},
- "GoogleCloudMlV1__TrainingInput": {
- "description": "Represents input parameters for a training job. When using the\ngcloud command to submit your training job, you can specify\nthe input parameters as command-line arguments and/or in a YAML configuration\nfile referenced from the --config command-line argument. For\ndetails, see the guide to\n\u003ca href=\"/ml-engine/docs/training-jobs\"\u003esubmitting a training job\u003c/a\u003e.",
- "type": "object",
- "properties": {
- "workerCount": {
- "description": "Optional. The number of worker replicas to use for the training job. Each\nreplica in the cluster will be of the type specified in `worker_type`.\n\nThis value can only be used when `scale_tier` is set to `CUSTOM`. If you\nset this value, you must also set `worker_type`.",
- "format": "int64",
- "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 Beta 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 Beta 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"
- },
- "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.\nSee the \u003ca href=\"/ml-engine/docs/regions\"\u003eavailable regions\u003c/a\u003e for\nML Engine services.",
- "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": {
- "$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'. Python '3.5' is available when `runtime_version` is set\nto '1.4' and above. Python '2.7' works with all supported runtime versions.",
- "type": "string"
- },
- "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`.",
- "format": "int64",
- "type": "string"
- },
- "packageUris": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "description": "Required. The Google Cloud Storage location of the packages with\nthe training program and any additional dependencies.\nThe maximum number of package URIs is 100."
- }
- },
- "id": "GoogleCloudMlV1__TrainingInput"
- },
"GoogleCloudMlV1__ListModelsResponse": {
"description": "Response message for the ListModels method.",
"type": "object",
@@ -1756,10 +1680,126 @@
},
"id": "GoogleCloudMlV1__ListModelsResponse"
},
+ "GoogleCloudMlV1__TrainingInput": {
+ "description": "Represents input parameters for a training job. When using the\ngcloud command to submit your training job, you can specify\nthe input parameters as command-line arguments and/or in a YAML configuration\nfile referenced from the --config command-line argument. For\ndetails, see the guide to\n\u003ca href=\"/ml-engine/docs/training-jobs\"\u003esubmitting a training job\u003c/a\u003e.",
+ "type": "object",
+ "properties": {
+ "region": {
+ "description": "Required. The Google Compute Engine region to run the training job in.\nSee the \u003ca href=\"/ml-engine/docs/regions\"\u003eavailable regions\u003c/a\u003e for\nML Engine services.",
+ "type": "string"
+ },
+ "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"
+ },
+ "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": {
+ "$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'. Python '3.5' is available when `runtime_version` is set\nto '1.4' and above. Python '2.7' works with all supported runtime versions.",
+ "type": "string"
+ },
+ "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`.",
+ "format": "int64",
+ "type": "string"
+ },
+ "packageUris": {
+ "description": "Required. The Google Cloud Storage location of the packages with\nthe training program and any additional dependencies.\nThe maximum number of package URIs is 100.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "workerCount": {
+ "description": "Optional. The number of worker replicas to use for the training job. Each\nreplica in the cluster will be of the type specified in `worker_type`.\n\nThis value can only be used when `scale_tier` is set to `CUSTOM`. If you\nset this value, you must also set `worker_type`.",
+ "format": "int64",
+ "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 Beta 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 Beta 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"
+ }
+ },
+ "id": "GoogleCloudMlV1__TrainingInput"
+ },
"GoogleCloudMlV1__Job": {
"description": "Represents a training or prediction job.",
"type": "object",
"properties": {
+ "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."
+ },
+ "labels": {
+ "description": "Optional. One or more labels that you can add, to organize your jobs.\nEach label is a key-value pair, where both the key and the value are\narbitrary strings that you supply.\nFor more information, see the documentation on\n\u003ca href=\"/ml-engine/docs/how-tos/resource-labels\"\u003eusing labels\u003c/a\u003e.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "createTime": {
+ "description": "Output only. When the job was created.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "predictionInput": {
+ "description": "Input parameters to create a prediction job.",
+ "$ref": "GoogleCloudMlV1__PredictionInput"
+ },
"errorMessage": {
"description": "Output only. The details of a failure or a cancellation.",
"type": "string"
@@ -1774,8 +1814,6 @@
"$ref": "GoogleCloudMlV1__TrainingInput"
},
"state": {
- "description": "Output only. The detailed state of a job.",
- "type": "string",
"enumDescriptions": [
"The job state is unspecified.",
"The job has been just created and processing has not yet begun.",
@@ -1795,7 +1833,9 @@
"FAILED",
"CANCELLING",
"CANCELLED"
- ]
+ ],
+ "description": "Output only. The detailed state of a job.",
+ "type": "string"
},
"jobId": {
"description": "Required. The user-specified id of the job.",
@@ -1805,66 +1845,10 @@
"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": {
- "description": "Output only. When the job was created.",
- "format": "google-datetime",
- "type": "string"
- },
- "labels": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "Optional. One or more labels that you can add, to organize your jobs.\nEach label is a key-value pair, where both the key and the value are\narbitrary strings that you supply.\nFor more information, see the documentation on\n\u003ca href=\"/ml-engine/docs/how-tos/resource-labels\"\u003eusing labels\u003c/a\u003e.",
- "type": "object"
- },
- "predictionInput": {
- "$ref": "GoogleCloudMlV1__PredictionInput",
- "description": "Input parameters to create a prediction job."
}
},
"id": "GoogleCloudMlV1__Job"
},
- "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": {
- "type": "array",
- "items": {
- "type": "object",
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- }
- },
- "description": "Application specific response metadata. Must be set in the first response\nfor streaming APIs."
- },
- "data": {
- "description": "HTTP body binary data.",
- "format": "byte",
- "type": "string"
- },
- "contentType": {
- "description": "The HTTP Content-Type string representing the content type of the body.",
- "type": "string"
- }
- },
- "id": "GoogleApi__HttpBody"
- },
"GoogleCloudMlV1__Capability": {
"type": "object",
"properties": {
@@ -1884,6 +1868,12 @@
"type": "string"
},
"availableAccelerators": {
+ "enumDescriptions": [
+ "Unspecified accelerator type. Default to no GPU.",
+ "Nvidia tesla k80 GPU.",
+ "Nvidia tesla P100 GPU."
+ ],
+ "description": "Available accelerators for the capability.",
"type": "array",
"items": {
"enum": [
@@ -1892,19 +1882,39 @@
"NVIDIA_TESLA_P100"
],
"type": "string"
- },
- "enumDescriptions": [
- "Unspecified accelerator type. Default to no GPU.",
- "Nvidia tesla k80 GPU.",
- "Nvidia tesla P100 GPU."
- ],
- "description": "Available accelerators for the capability."
+ }
}
},
"id": "GoogleCloudMlV1__Capability"
},
+ "GoogleApi__HttpBody": {
+ "description": "Message that represents an arbitrary HTTP body. It should only be used for\npayload formats that can't be represented as JSON, such as raw binary or\nan HTML page.\n\n\nThis message can be used both in streaming and non-streaming API methods in\nthe request as well as the response.\n\nIt can be used as a top-level request field, which is convenient if one\nwants to extract parameters from either the URL or HTTP template into the\nrequest fields and also want access to the raw HTTP body.\n\nExample:\n\n message GetResourceRequest {\n // A unique request id.\n string request_id = 1;\n\n // The raw HTTP body is bound to this field.\n google.api.HttpBody http_body = 2;\n }\n\n service ResourceService {\n rpc GetResource(GetResourceRequest) returns (google.api.HttpBody);\n rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty);\n }\n\nExample with streaming methods:\n\n service CaldavService {\n rpc GetCalendar(stream google.api.HttpBody)\n returns (stream google.api.HttpBody);\n rpc UpdateCalendar(stream google.api.HttpBody)\n returns (stream google.api.HttpBody);\n }\n\nUse of this type only changes how the request and response bodies are\nhandled, all other features will continue to work unchanged.",
+ "type": "object",
+ "properties": {
+ "data": {
+ "description": "HTTP body binary data.",
+ "format": "byte",
+ "type": "string"
+ },
+ "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"
+ },
"GoogleCloudMlV1__GetConfigResponse": {
- "id": "GoogleCloudMlV1__GetConfigResponse",
"description": "Returns service account information associated with a project.",
"type": "object",
"properties": {
@@ -1917,32 +1927,37 @@
"description": "The service account Cloud ML uses to access resources in the project.",
"type": "string"
}
- }
+ },
+ "id": "GoogleCloudMlV1__GetConfigResponse"
},
"GoogleIamV1__TestIamPermissionsResponse": {
+ "description": "Response message for `TestIamPermissions` method.",
"type": "object",
"properties": {
"permissions": {
+ "description": "A subset of `TestPermissionsRequest.permissions` that the caller is\nallowed.",
"type": "array",
"items": {
"type": "string"
- },
- "description": "A subset of `TestPermissionsRequest.permissions` that the caller is\nallowed."
+ }
}
},
- "id": "GoogleIamV1__TestIamPermissionsResponse",
- "description": "Response message for `TestIamPermissions` method."
+ "id": "GoogleIamV1__TestIamPermissionsResponse"
},
"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": {
+ "finalMetric": {
+ "description": "The final objective metric seen for this trial.",
+ "$ref": "GoogleCloudMlV1_HyperparameterOutput_HyperparameterMetric"
+ },
"hyperparameters": {
+ "description": "The hyperparameters given to this trial.",
+ "type": "object",
"additionalProperties": {
"type": "string"
- },
- "description": "The hyperparameters given to this trial.",
- "type": "object"
+ }
},
"trialId": {
"description": "The trial id for these results.",
@@ -1954,10 +1969,6 @@
"items": {
"$ref": "GoogleCloudMlV1_HyperparameterOutput_HyperparameterMetric"
}
- },
- "finalMetric": {
- "description": "The final objective metric seen for this trial.",
- "$ref": "GoogleCloudMlV1_HyperparameterOutput_HyperparameterMetric"
}
},
"id": "GoogleCloudMlV1__HyperparameterOutput"
@@ -1966,14 +1977,14 @@
"description": "Request message for `SetIamPolicy` method.",
"type": "object",
"properties": {
+ "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."
+ },
"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"
@@ -2008,6 +2019,14 @@
"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",
@@ -2026,14 +2045,6 @@
"items": {
"$ref": "GoogleIamV1__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"
}
},
"id": "GoogleIamV1__Policy"
@@ -2057,6 +2068,7 @@
"id": "GoogleLongrunning__ListOperationsResponse"
},
"GoogleCloudMlV1__ManualScaling": {
+ "description": "Options for manually scaling a model.",
"type": "object",
"properties": {
"nodes": {
@@ -2065,13 +2077,21 @@
"type": "integer"
}
},
- "id": "GoogleCloudMlV1__ManualScaling",
- "description": "Options for manually scaling a model."
+ "id": "GoogleCloudMlV1__ManualScaling"
},
"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.",
+ "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",
@@ -2083,20 +2103,12 @@
"items": {
"$ref": "GoogleCloudMlV1__HyperparameterOutput"
}
- },
- "completedTrialCount": {
- "type": "string",
- "description": "The number of hyperparameter tuning trials that completed successfully.\nOnly set for hyperparameter tuning jobs.",
- "format": "int64"
- },
- "isHyperparameterTuningJob": {
- "description": "Whether this job is a hyperparameter tuning job.",
- "type": "boolean"
}
},
"id": "GoogleCloudMlV1__TrainingOutput"
},
"GoogleIamV1__Binding": {
+ "description": "Associates `members` with a `role`.",
"type": "object",
"properties": {
"condition": {
@@ -2115,41 +2127,29 @@
"type": "string"
}
},
- "id": "GoogleIamV1__Binding",
- "description": "Associates `members` with a `role`."
- },
- "GoogleCloudMlV1__PredictRequest": {
- "type": "object",
- "properties": {
- "httpBody": {
- "$ref": "GoogleApi__HttpBody",
- "description": "\nRequired. The prediction request body."
- }
- },
- "id": "GoogleCloudMlV1__PredictRequest",
- "description": "Request for predictions to be issued against a trained model."
- },
- "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": "GoogleIamV1__Binding"
}
},
- "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 Machine Learning Engine",
+ "auth": {
+ "oauth2": {
+ "scopes": {
+ "https://www.googleapis.com/auth/cloud-platform": {
+ "description": "View and manage your data across Google Cloud Platform services"
+ }
+ }
+ }
+ },
+ "rootUrl": "https://ml.googleapis.com/",
+ "ownerDomain": "google.com",
+ "name": "ml",
+ "batchPath": "batch",
+ "fullyEncodeReservedExpansion": true,
+ "title": "Google Cloud Machine Learning Engine",
+ "ownerName": "Google"
}
diff --git a/monitoring/v3/monitoring-api.json b/monitoring/v3/monitoring-api.json
index f7064f2..5fcad75 100644
--- a/monitoring/v3/monitoring-api.json
+++ b/monitoring/v3/monitoring-api.json
@@ -1,961 +1,9 @@
{
- "canonicalName": "Monitoring",
- "auth": {
- "oauth2": {
- "scopes": {
- "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"
- },
- "https://www.googleapis.com/auth/monitoring": {
- "description": "View and write monitoring data for all of your Google and third-party Cloud and API 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": {
- "create": {
- "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"
- ],
- "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."
- },
- "list": {
- "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.",
- "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": {
- "interval.endTime": {
- "location": "query",
- "description": "Required. The end of the time interval.",
- "format": "google-datetime",
- "type": "string"
- },
- "aggregation.alignmentPeriod": {
- "location": "query",
- "description": "The alignment period for per-time series alignment. If present, alignmentPeriod must be at least 60 seconds. After per-time series alignment, each time series will contain data points only on the period boundaries. If perSeriesAligner is not specified or equals ALIGN_NONE, then this field is ignored. If perSeriesAligner is specified and does not equal ALIGN_NONE, then this field must be defined; otherwise an error is returned.",
- "format": "google-duration",
- "type": "string"
- },
- "pageSize": {
- "location": "query",
- "description": "A positive number that is the maximum number of results to return. When view field sets to FULL, it limits the number of Points server will return; if view field is HEADERS, it limits the number of TimeSeries server will return.",
- "format": "int32",
- "type": "integer"
- },
- "orderBy": {
- "location": "query",
- "description": "Specifies the order in which the points of the time series should be returned. By default, results are not ordered. Currently, this field must be left blank.",
- "type": "string"
- },
- "aggregation.crossSeriesReducer": {
- "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"
- },
- "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": {
- "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"
- },
- "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"
- },
- "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/[^/]+$"
- },
- "aggregation.groupByFields": {
- "repeated": true,
- "location": "query",
- "description": "The set of fields to preserve when crossSeriesReducer is specified. The groupByFields determine how the time series are partitioned into subsets prior to applying the aggregation function. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The crossSeriesReducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly contains resource.type. Fields not specified in groupByFields are aggregated away. If groupByFields is not specified and all the time series have the same resource type, then the time series are aggregated into a single output time series. If crossSeriesReducer is not defined, this field is ignored.",
- "type": "string"
- }
- },
- "flatPath": "v3/projects/{projectsId}/timeSeries"
- }
- }
- },
- "uptimeCheckConfigs": {
- "methods": {
- "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",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Empty"
- },
- "parameters": {
- "name": {
- "location": "path",
- "description": "The uptime check configuration to delete. The format isprojects/[PROJECT_ID]/uptimeCheckConfigs/[UPTIME_CHECK_ID].",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/uptimeCheckConfigs/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/monitoring"
- ],
- "flatPath": "v3/projects/{projectsId}/uptimeCheckConfigs/{uptimeCheckConfigsId}"
- },
- "list": {
- "description": "Lists the existing valid uptime check configurations for the project, leaving out any invalid configurations.",
- "response": {
- "$ref": "ListUptimeCheckConfigsResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "GET",
- "parameters": {
- "pageToken": {
- "location": "query",
- "description": "If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method. Using this field causes the method to return more results from the previous method call.",
- "type": "string"
- },
- "pageSize": {
- "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": {
- "pattern": "^projects/[^/]+$",
- "location": "path",
- "description": "The project whose uptime check configurations are listed. The format isprojects/[PROJECT_ID].",
- "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"
- ],
- "flatPath": "v3/projects/{projectsId}/uptimeCheckConfigs",
- "path": "v3/{+parent}/uptimeCheckConfigs",
- "id": "monitoring.projects.uptimeCheckConfigs.list"
- },
- "get": {
- "description": "Gets a single uptime check configuration.",
- "httpMethod": "GET",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "UptimeCheckConfig"
- },
- "parameters": {
- "name": {
- "location": "path",
- "description": "The uptime check configuration to retrieve. The format isprojects/[PROJECT_ID]/uptimeCheckConfigs/[UPTIME_CHECK_ID].",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/uptimeCheckConfigs/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/monitoring",
- "https://www.googleapis.com/auth/monitoring.read"
- ],
- "flatPath": "v3/projects/{projectsId}/uptimeCheckConfigs/{uptimeCheckConfigsId}",
- "id": "monitoring.projects.uptimeCheckConfigs.get",
- "path": "v3/{+name}"
- },
- "patch": {
- "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": {
- "pattern": "^projects/[^/]+/uptimeCheckConfigs/[^/]+$",
- "location": "path",
- "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"
- }
- },
- "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": {
- "response": {
- "$ref": "UptimeCheckConfig"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "POST",
- "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",
- "path": "v3/{+parent}/uptimeCheckConfigs",
- "id": "monitoring.projects.uptimeCheckConfigs.create",
- "request": {
- "$ref": "UptimeCheckConfig"
- },
- "description": "Creates a new uptime check configuration."
- }
- }
- },
- "monitoredResourceDescriptors": {
- "methods": {
- "list": {
- "httpMethod": "GET",
- "response": {
- "$ref": "ListMonitoredResourceDescriptorsResponse"
- },
- "parameterOrder": [
- "name"
- ],
- "parameters": {
- "filter": {
- "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",
- "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": {
- "description": "If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call.",
- "type": "string",
- "location": "query"
- },
- "pageSize": {
- "location": "query",
- "description": "A positive number that is the maximum number of results to return.",
- "format": "int32",
- "type": "integer"
- }
- },
- "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",
- "description": "Lists monitored resource descriptors that match a filter. This method does not require a Stackdriver account."
- },
- "get": {
- "httpMethod": "GET",
- "response": {
- "$ref": "MonitoredResourceDescriptor"
- },
- "parameterOrder": [
- "name"
- ],
- "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}",
- "description": "Gets a single monitored resource descriptor. This method does not require a Stackdriver account."
- }
- }
- },
- "groups": {
- "methods": {
- "delete": {
- "path": "v3/{+name}",
- "id": "monitoring.projects.groups.delete",
- "description": "Deletes an existing group.",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "DELETE",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/monitoring"
- ],
- "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"
- }
- },
- "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": {
- "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"
- },
- "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"
- }
- }
- },
- "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"
- ],
- "flatPath": "v3/projects/{projectsId}/groups/{groupsId}",
- "path": "v3/{+name}",
- "id": "monitoring.projects.groups.get"
- },
- "update": {
- "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.",
- "response": {
- "$ref": "Group"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "PUT",
- "parameters": {
- "name": {
- "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/[^/]+$",
- "location": "path"
- },
- "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"
- ]
- },
- "create": {
- "request": {
- "$ref": "Group"
- },
- "description": "Creates a new group.",
- "httpMethod": "POST",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Group"
- },
- "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",
- "id": "monitoring.projects.groups.create",
- "path": "v3/{+name}/groups"
- }
- },
- "resources": {
- "members": {
- "methods": {
- "list": {
- "description": "Lists the monitored resources that are members of a group.",
- "response": {
- "$ref": "ListGroupMembersResponse"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/monitoring",
- "https://www.googleapis.com/auth/monitoring.read"
- ],
- "parameters": {
- "pageToken": {
- "location": "query",
- "description": "If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call.",
- "type": "string"
- },
- "pageSize": {
- "description": "A positive number that is the maximum number of results to return.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- },
- "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": {
- "location": "path",
- "description": "The group whose members are listed. The format is \"projects/{project_id_or_number}/groups/{group_id}\".",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/groups/[^/]+$"
- },
- "interval.endTime": {
- "location": "query",
- "description": "Required. The end of the time interval.",
- "format": "google-datetime",
- "type": "string"
- },
- "filter": {
- "description": "An optional list filter describing the members to be returned. The filter may reference the type, labels, and metadata of monitored resources that comprise the group. For example, to return only resources representing Compute Engine VM instances, use this filter:\nresource.type = \"gce_instance\"\n",
- "type": "string",
- "location": "query"
- }
- },
- "flatPath": "v3/projects/{projectsId}/groups/{groupsId}/members",
- "path": "v3/{+name}/members",
- "id": "monitoring.projects.groups.members.list"
- }
- }
- }
- }
- },
- "collectdTimeSeries": {
- "methods": {
- "create": {
- "request": {
- "$ref": "CreateCollectdTimeSeriesRequest"
- },
- "description": "Stackdriver Monitoring Agent only: Creates a new time series.\u003caside class=\"caution\"\u003eThis method is only for use by the Stackdriver Monitoring Agent. Use projects.timeSeries.create instead.\u003c/aside\u003e",
- "httpMethod": "POST",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "CreateCollectdTimeSeriesResponse"
- },
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+$",
- "location": "path",
- "description": "The project in which to create the time series. 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}/collectdTimeSeries",
- "id": "monitoring.projects.collectdTimeSeries.create",
- "path": "v3/{+name}/collectdTimeSeries"
- }
- }
- },
- "metricDescriptors": {
- "methods": {
- "create": {
- "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",
- "request": {
- "$ref": "MetricDescriptor"
- },
- "description": "Creates a new metric descriptor. User-created metric descriptors define custom metrics."
- },
- "delete": {
- "description": "Deletes a metric descriptor. Only user-created custom metrics can be deleted.",
- "httpMethod": "DELETE",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "name"
- ],
- "parameters": {
- "name": {
- "description": "The metric descriptor on which to execute the request. The format is \"projects/{project_id_or_number}/metricDescriptors/{metric_id}\". An example 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}",
- "id": "monitoring.projects.metricDescriptors.delete",
- "path": "v3/{+name}"
- },
- "list": {
- "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": {
- "pageSize": {
- "description": "A positive number that is the maximum number of results to return.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- },
- "filter": {
- "location": "query",
- "description": "If this field is empty, all custom and system-defined metric descriptors are returned. Otherwise, the filter specifies which metric descriptors are to be returned. For example, the following filter matches all custom metrics:\nmetric.type = starts_with(\"custom.googleapis.com/\")\n",
- "type": "string"
- },
- "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"
- },
- "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"
- }
- },
- "flatPath": "v3/projects/{projectsId}/metricDescriptors",
- "path": "v3/{+name}/metricDescriptors",
- "id": "monitoring.projects.metricDescriptors.list",
- "description": "Lists metric descriptors that match a filter. This method does not require a Stackdriver account."
- },
- "get": {
- "path": "v3/{+name}",
- "id": "monitoring.projects.metricDescriptors.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}"
- }
- }
- }
- }
- },
- "uptimeCheckIps": {
- "methods": {
- "list": {
- "description": "Returns the list of IPs that checkers run from",
- "httpMethod": "GET",
- "response": {
- "$ref": "ListUptimeCheckIpsResponse"
- },
- "parameterOrder": [],
- "parameters": {
- "pageToken": {
- "location": "query",
- "description": "If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method. Using this field causes the method to return more results from the previous method call. NOTE: this field is not yet implemented",
- "type": "string"
- },
- "pageSize": {
- "description": "The maximum number of results to return in a single response. The server may further constrain the maximum number of results returned in a single page. If the page_size is \u003c=0, the server will decide the number of results to be returned. NOTE: this field is not yet implemented",
- "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/uptimeCheckIps",
- "id": "monitoring.uptimeCheckIps.list",
- "path": "v3/uptimeCheckIps"
- }
- }
- }
- },
- "parameters": {
- "alt": {
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query",
- "description": "Data format for response.",
- "default": "json",
- "enum": [
- "json",
- "media",
- "proto"
- ],
- "type": "string"
- },
- "access_token": {
- "location": "query",
- "description": "OAuth access token.",
- "type": "string"
- },
- "key": {
- "location": "query",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string"
- },
- "quotaUser": {
- "location": "query",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string"
- },
- "pp": {
- "description": "Pretty-print response.",
- "type": "boolean",
- "default": "true",
- "location": "query"
- },
- "bearer_token": {
- "description": "OAuth bearer token.",
- "type": "string",
- "location": "query"
- },
- "oauth_token": {
- "description": "OAuth 2.0 token for the current user.",
- "type": "string",
- "location": "query"
- },
- "upload_protocol": {
- "location": "query",
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string"
- },
- "prettyPrint": {
- "description": "Returns response with indentations and line breaks.",
- "type": "boolean",
- "default": "true",
- "location": "query"
- },
- "fields": {
- "location": "query",
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string"
- },
- "uploadType": {
- "location": "query",
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string"
- },
- "callback": {
- "location": "query",
- "description": "JSONP",
- "type": "string"
- },
- "$.xgafv": {
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query",
- "enum": [
- "1",
- "2"
- ],
- "description": "V1 error format.",
- "type": "string"
- }
- },
"version": "v3",
"baseUrl": "https://monitoring.googleapis.com/",
- "kind": "discovery#restDescription",
- "description": "Manages your Stackdriver Monitoring data and configurations. Most projects must be associated with a Stackdriver account, with a few exceptions as noted on the individual method pages.",
"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": "20171218",
"documentationLink": "https://cloud.google.com/monitoring/api/",
@@ -963,13 +11,395 @@
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
- "Linear": {
+ "ListMonitoredResourceDescriptorsResponse": {
+ "description": "The ListMonitoredResourceDescriptors response.",
+ "type": "object",
"properties": {
- "width": {
- "description": "Must be greater than 0.",
+ "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"
+ },
+ "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": {
+ "valueType": {
+ "enum": [
+ "VALUE_TYPE_UNSPECIFIED",
+ "BOOL",
+ "INT64",
+ "DOUBLE",
+ "STRING",
+ "DISTRIBUTION",
+ "MONEY"
+ ],
+ "description": "The value type of the time series. When listing time series, this value type might be different from the value type of the associated metric if this time series is an alignment or reduction of other time series.When creating a time series, this field is optional. If present, it must be the same as the type of the data in the points field.",
+ "type": "string",
+ "enumDescriptions": [
+ "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": {
+ "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.",
+ "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"
+ ]
+ },
+ "metric": {
+ "$ref": "Metric",
+ "description": "The associated metric. A fully-specified metric used to identify the time series."
+ },
+ "points": {
+ "description": "The data points of this time series. When listing time series, the order of the points is specified by the list method.When creating a time series, this field must contain exactly one point and the point's type must be the same as the value type of the associated metric. If the associated metric's descriptor must be auto-created, then the value type of the descriptor is determined by the point's type, which must be BOOL, INT64, DOUBLE, or DISTRIBUTION.",
+ "type": "array",
+ "items": {
+ "$ref": "Point"
+ }
+ },
+ "resource": {
+ "$ref": "MonitoredResource",
+ "description": "The associated monitored resource. Custom metrics can use only certain monitored resource types in their time series data."
+ },
+ "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."
+ }
+ },
+ "id": "TimeSeries"
+ },
+ "CreateTimeSeriesRequest": {
+ "properties": {
+ "timeSeries": {
+ "description": "The new data to be added to a list of time series. Adds at most one data point to each of several time series. The new data point must be more recent than any other point in its time series. Each TimeSeries value must fully specify a unique time series by supplying all label values for the metric and the monitored resource.",
+ "type": "array",
+ "items": {
+ "$ref": "TimeSeries"
+ }
+ }
+ },
+ "id": "CreateTimeSeriesRequest",
+ "description": "The CreateTimeSeries request.",
+ "type": "object"
+ },
+ "Distribution": {
+ "properties": {
+ "bucketOptions": {
+ "$ref": "BucketOptions",
+ "description": "Required in the Stackdriver Monitoring API v3. Defines the histogram bucket boundaries."
+ },
+ "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.",
"format": "double",
"type": "number"
},
+ "range": {
+ "$ref": "Range",
+ "description": "If specified, contains the range of the population values. The field must not be present if the count is zero. This field is presently ignored by the Stackdriver Monitoring API v3."
+ },
+ "count": {
+ "description": "The number of values in the population. Must be non-negative. This value must equal the sum of the values in bucket_counts if a histogram is provided.",
+ "format": "int64",
+ "type": "string"
+ },
+ "mean": {
+ "description": "The arithmetic mean of the values in the population. If count is zero then this field must be zero.",
+ "format": "double",
+ "type": "number"
+ },
+ "bucketCounts": {
+ "description": "Required in the Stackdriver Monitoring API v3. The values for each bucket specified in bucket_options. The sum of the values in bucketCounts must equal the value in the count field of the Distribution object. The order of the bucket counts follows the numbering schemes described for the three bucket types. The underflow bucket has number 0; the finite buckets, if any, have numbers 1 through N-2; and the overflow bucket has number N-1. The size of bucket_counts must not be greater than N. If the size is less than N, then the remaining buckets are assigned values of zero.",
+ "type": "array",
+ "items": {
+ "format": "int64",
+ "type": "string"
+ }
+ }
+ },
+ "id": "Distribution",
+ "description": "Distribution contains summary statistics for a population of values. It optionally contains a histogram representing the distribution of those values across a set of buckets.The summary statistics are the count, mean, sum of the squared deviation from the mean, the minimum, and the maximum of the set of population of values. The histogram is based on a sequence of buckets and gives a count of values that fall into each bucket. The boundaries of the buckets are given either explicitly or by formulas for buckets of fixed or exponentially increasing widths.Although it is not forbidden, it is generally a bad idea to include non-finite values (infinities or NaNs) in the population of values, as this will render the mean and sum_of_squared_deviation fields meaningless.",
+ "type": "object"
+ },
+ "MonitoredResource": {
+ "description": "An object representing a resource that can be used for monitoring, logging, billing, or other purposes. Examples include virtual machine instances, databases, and storage devices such as disks. The type field identifies a MonitoredResourceDescriptor object that describes the resource's schema. Information in the labels field identifies the actual resource and its attributes according to the schema. For example, a particular Compute Engine VM instance could be represented by the following object, because the MonitoredResourceDescriptor for \"gce_instance\" has labels \"instance_id\" and \"zone\":\n{ \"type\": \"gce_instance\",\n \"labels\": { \"instance_id\": \"12345678901234\",\n \"zone\": \"us-central1-a\" }}\n",
+ "type": "object",
+ "properties": {
+ "labels": {
+ "description": "Required. Values for all of the labels listed in the associated monitored resource descriptor. For example, Compute Engine VM instances use the labels \"project_id\", \"instance_id\", and \"zone\".",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "type": {
+ "description": "Required. The monitored resource type. This field must match the type field of a MonitoredResourceDescriptor object. For example, the type of a Compute Engine VM instance is gce_instance.",
+ "type": "string"
+ }
+ },
+ "id": "MonitoredResource"
+ },
+ "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.",
+ "type": "array",
+ "items": {
+ "$ref": "MetricDescriptor"
+ }
+ },
+ "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": "ListMetricDescriptorsResponse"
+ },
+ "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": {
+ "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"
+ },
+ "description": {
+ "description": "Optional. A detailed description of the monitored resource type that might be used in documentation.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Required. The monitored resource type. For example, the type \"cloudsql_database\" represents databases in Google Cloud SQL. The maximum length of this value is 256 characters.",
+ "type": "string"
+ }
+ },
+ "id": "MonitoredResourceDescriptor"
+ },
+ "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": {
+ "description": "A distribution value.",
+ "$ref": "Distribution"
+ }
+ },
+ "id": "TypedValue"
+ },
+ "ResourceGroup": {
+ "properties": {
+ "resourceType": {
+ "enum": [
+ "RESOURCE_TYPE_UNSPECIFIED",
+ "INSTANCE",
+ "AWS_ELB_LOAD_BALANCER"
+ ],
+ "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."
+ ]
+ },
+ "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",
+ "description": "The resource submessage for group checks. It can be used instead of a monitored resource, when multiple resources are being monitored.",
+ "type": "object"
+ },
+ "CollectdValueError": {
+ "description": "Describes the error status for values that were not written.",
+ "type": "object",
+ "properties": {
+ "index": {
+ "description": "The zero-based index in CollectdPayload.values within the parent CreateCollectdTimeSeriesRequest.collectd_payloads.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "error": {
+ "description": "Records the error status for the value.",
+ "$ref": "Status"
+ }
+ },
+ "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": {
+ "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"
+ },
+ "CollectdPayload": {
+ "description": "A collection of data points sent from a collectd-based plugin. See the collectd documentation for more information.",
+ "type": "object",
+ "properties": {
+ "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": {
+ "description": "The measurement metadata. Example: \"process_id\" -\u003e 12345",
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "TypedValue"
+ }
+ },
+ "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"
+ },
+ "startTime": {
+ "description": "The start time of the interval.",
+ "format": "google-datetime",
+ "type": "string"
+ }
+ },
+ "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": {
+ "properties": {
"offset": {
"description": "Lower bound of the first bucket.",
"format": "double",
@@ -979,6 +409,11 @@
"description": "Must be greater than 0.",
"format": "int32",
"type": "integer"
+ },
+ "width": {
+ "description": "Must be greater than 0.",
+ "format": "double",
+ "type": "number"
}
},
"id": "Linear",
@@ -992,15 +427,15 @@
"id": "Empty"
},
"ContentMatcher": {
- "description": "Used to perform string matching. Currently, this matches on the exact content. In the future, it can be expanded to allow for regular expressions and more complex matching.",
- "type": "object",
"properties": {
"content": {
"description": "String content to match",
"type": "string"
}
},
- "id": "ContentMatcher"
+ "id": "ContentMatcher",
+ "description": "Used to perform string matching. Currently, this matches on the exact content. In the future, it can be expanded to allow for regular expressions and more complex matching.",
+ "type": "object"
},
"Option": {
"description": "A protocol buffer option, which can be attached to a message, field, enumeration, etc.",
@@ -1025,10 +460,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"
@@ -1044,13 +475,15 @@
"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.",
@@ -1058,7 +491,9 @@
"type": "integer"
}
},
- "id": "TcpCheck"
+ "id": "TcpCheck",
+ "description": "Information required for a TCP uptime check request.",
+ "type": "object"
},
"Explicit": {
"properties": {
@@ -1093,8 +528,6 @@
"type": "object"
},
"ListUptimeCheckIpsResponse": {
- "description": "The protocol for the ListUptimeCheckIps response.",
- "type": "object",
"properties": {
"uptimeCheckIps": {
"description": "The returned list of IP addresses (including region and location) that the checkers run from.",
@@ -1108,12 +541,17 @@
"type": "string"
}
},
- "id": "ListUptimeCheckIpsResponse"
+ "id": "ListUptimeCheckIpsResponse",
+ "description": "The protocol for the ListUptimeCheckIps response.",
+ "type": "object"
},
"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",
@@ -1123,43 +561,47 @@
"description": "Must be greater than 0.",
"format": "int32",
"type": "integer"
- },
- "growthFactor": {
- "description": "Must be greater than 1.",
- "format": "double",
- "type": "number"
}
},
- "id": "Exponential"
+ "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"
},
"Point": {
- "description": "A single data point in a time series.",
- "type": "object",
"properties": {
- "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"
- },
"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"
+ "id": "Point",
+ "description": "A single data point in a time series.",
+ "type": "object"
+ },
+ "Metric": {
+ "properties": {
+ "labels": {
+ "description": "The set of label values that uniquely identify this metric. All labels listed in the MetricDescriptor must be assigned values.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "type": {
+ "description": "An existing metric type, see google.api.MetricDescriptor. For example, custom.googleapis.com/invoice/paid/amount.",
+ "type": "string"
+ }
+ },
+ "id": "Metric",
+ "description": "A specific metric, identified by specifying values for all of the labels of a MetricDescriptor.",
+ "type": "object"
},
"Field": {
- "description": "A single field of a message type.",
- "type": "object",
"properties": {
- "typeUrl": {
- "description": "The field type URL, without the scheme, for message or enumeration types. Example: \"type.googleapis.com/google.protobuf.Timestamp\".",
- "type": "string"
- },
- "number": {
- "description": "The field number.",
- "format": "int32",
- "type": "integer"
- },
"jsonName": {
"description": "The field JSON name.",
"type": "string"
@@ -1249,58 +691,41 @@
"name": {
"description": "The field name.",
"type": "string"
+ },
+ "typeUrl": {
+ "description": "The field type URL, without the scheme, for message or enumeration types. Example: \"type.googleapis.com/google.protobuf.Timestamp\".",
+ "type": "string"
+ },
+ "number": {
+ "description": "The field number.",
+ "format": "int32",
+ "type": "integer"
}
},
- "id": "Field"
+ "id": "Field",
+ "description": "A single field of a message type.",
+ "type": "object"
},
"ListUptimeCheckConfigsResponse": {
"description": "The protocol for the ListUptimeCheckConfigs response.",
"type": "object",
"properties": {
- "nextPageToken": {
- "description": "This field represents the pagination token to retrieve the next page of results. If the value is empty, it means no further results for the request. To retrieve the next page of results, the value of the next_page_token is passed to the subsequent List method call (in the request message's page_token field).",
- "type": "string"
- },
"uptimeCheckConfigs": {
"description": "The returned uptime check configurations.",
"type": "array",
"items": {
"$ref": "UptimeCheckConfig"
}
+ },
+ "nextPageToken": {
+ "description": "This field represents the pagination token to retrieve the next page of results. If the value is empty, it means no further results for the request. To retrieve the next page of results, the value of the next_page_token is passed to the subsequent List method call (in the request message's page_token field).",
+ "type": "string"
}
},
"id": "ListUptimeCheckConfigsResponse"
},
- "Metric": {
- "properties": {
- "type": {
- "description": "An existing metric type, see google.api.MetricDescriptor. For example, custom.googleapis.com/invoice/paid/amount.",
- "type": "string"
- },
- "labels": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "The set of label values that uniquely identify this metric. All labels listed in the MetricDescriptor must be assigned values.",
- "type": "object"
- }
- },
- "id": "Metric",
- "description": "A specific metric, identified by specifying values for all of the labels of a MetricDescriptor.",
- "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"
- },
"valueType": {
"enumDescriptions": [
"A variable-length string. This is the default.",
@@ -1314,9 +739,19 @@
],
"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"
+ "id": "LabelDescriptor",
+ "description": "A description of a label.",
+ "type": "object"
},
"ListTimeSeriesResponse": {
"description": "The ListTimeSeries response.",
@@ -1340,6 +775,10 @@
"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": {
+ "filter": {
+ "description": "The filter used to determine which monitored resources belong to this group.",
+ "type": "string"
+ },
"name": {
"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.",
"type": "string"
@@ -1355,10 +794,6 @@
"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"
}
},
"id": "Group"
@@ -1392,28 +827,26 @@
"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",
- "enumDescriptions": [
- "Syntax proto2.",
- "Syntax proto3."
- ]
+ "type": "string"
+ },
+ "sourceContext": {
+ "$ref": "SourceContext",
+ "description": "The source context."
}
},
"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.",
@@ -1424,51 +857,67 @@
"type": "string"
}
},
- "id": "BasicAuthentication"
+ "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"
},
"MonitoredResourceMetadata": {
+ "description": "Auxiliary metadata for a MonitoredResource object. MonitoredResource objects contain the minimum set of information to uniquely identify a monitored resource instance. There is some other useful auxiliary metadata. Google Stackdriver Monitoring & Logging uses an ingestion pipeline to extract metadata for cloud resources of all types , and stores the metadata in this message.",
+ "type": "object",
"properties": {
- "userLabels": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "Output only. A map of user-defined metadata labels.",
- "type": "object"
- },
"systemLabels": {
+ "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",
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
- },
- "description": "Output only. Values for predefined system metadata labels. System labels are a kind of metadata extracted by Google Stackdriver. Stackdriver determines what system labels are useful and how to obtain their values. Some examples: \"machine_image\", \"vpc\", \"subnet_id\", \"security_group\", \"name\", etc. System label values can be only strings, Boolean values, or a list of strings. For example:\n{ \"name\": \"my-test-instance\",\n \"security_group\": [\"a\", \"b\", \"c\"],\n \"spot_instance\": false }\n",
- "type": "object"
+ }
+ },
+ "userLabels": {
+ "description": "Output only. A map of user-defined metadata labels.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
}
},
- "id": "MonitoredResourceMetadata",
- "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"
+ },
"linearBuckets": {
- "description": "The linear bucket.",
- "$ref": "Linear"
+ "$ref": "Linear",
+ "description": "The linear bucket."
},
"explicitBuckets": {
- "$ref": "Explicit",
- "description": "The explicit buckets."
- },
- "exponentialBuckets": {
- "$ref": "Exponential",
- "description": "The exponential buckets."
+ "description": "The explicit buckets.",
+ "$ref": "Explicit"
}
},
- "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.",
- "type": "object"
+ "id": "BucketOptions"
},
"HttpCheck": {
+ "description": "Information involved in an HTTP/HTTPS uptime check request.",
+ "type": "object",
"properties": {
+ "useSsl": {
+ "description": "If true, use HTTPS instead of HTTP to run the check.",
+ "type": "boolean"
+ },
+ "maskHeaders": {
+ "description": "Boolean specifiying whether to encrypt the header information. Encryption should be specified for any headers related to authentication that you do not wish to be seen when retrieving the configuration. The server will be responsible for encrypting the headers. On Get/List calls, if mask_headers is set to True then the headers will be obscured with ******.",
+ "type": "boolean"
+ },
+ "authInfo": {
+ "$ref": "BasicAuthentication",
+ "description": "The authentication information. Optional when creating an HTTP check; defaults to empty."
+ },
"headers": {
"additionalProperties": {
"type": "string"
@@ -1484,29 +933,24 @@
"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"
- },
- "useSsl": {
- "description": "If true, use HTTPS instead of HTTP to run the check.",
- "type": "boolean"
- },
- "maskHeaders": {
- "description": "Boolean specifiying whether to encrypt the header information. Encryption should be specified for any headers related to authentication that you do not wish to be seen when retrieving the configuration. The server will be responsible for encrypting the headers. On Get/List calls, if mask_headers is set to True then the headers will be obscured with ******.",
- "type": "boolean"
- },
- "authInfo": {
- "description": "The authentication information. Optional when creating an HTTP check; defaults to empty.",
- "$ref": "BasicAuthentication"
}
},
- "id": "HttpCheck",
- "description": "Information involved in an HTTP/HTTPS uptime check request.",
- "type": "object"
+ "id": "HttpCheck"
},
"CollectdValue": {
- "description": "A single data point from a collectd-based plugin.",
- "type": "object",
"properties": {
+ "value": {
+ "$ref": "TypedValue",
+ "description": "The measurement value."
+ },
"dataSourceType": {
+ "enumDescriptions": [
+ "An unspecified data source type. This corresponds to google.api.MetricDescriptor.MetricKind.METRIC_KIND_UNSPECIFIED.",
+ "An instantaneous measurement of a varying quantity. This corresponds to google.api.MetricDescriptor.MetricKind.GAUGE.",
+ "A cumulative value over time. This corresponds to google.api.MetricDescriptor.MetricKind.CUMULATIVE.",
+ "A rate of change of the measurement.",
+ "An amount of change since the last measurement interval. This corresponds to google.api.MetricDescriptor.MetricKind.DELTA."
+ ],
"enum": [
"UNSPECIFIED_DATA_SOURCE_TYPE",
"GAUGE",
@@ -1515,28 +959,25 @@
"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."
- ]
+ "type": "string"
},
"dataSourceName": {
"description": "The data source for the collectd value. For example there are two data sources for network measurements: \"rx\" and \"tx\".",
"type": "string"
- },
- "value": {
- "description": "The measurement value.",
- "$ref": "TypedValue"
}
},
- "id": "CollectdValue"
+ "id": "CollectdValue",
+ "description": "A single data point from a collectd-based plugin.",
+ "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",
@@ -1552,15 +993,9 @@
"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"
+ "id": "Status"
},
"SourceContext": {
"description": "SourceContext represents information about the source of a protobuf element, like the file in which it is defined.",
@@ -1577,6 +1012,43 @@
"description": "Defines a metric type and its schema. Once a metric descriptor is created, deleting or altering it stops data collection and makes the metric type's existing data unusable.",
"type": "object",
"properties": {
+ "labels": {
+ "description": "The set of labels that can be used to describe a specific instance of this metric type. For example, the appengine.googleapis.com/http/server/response_latencies metric type has a label for the HTTP response code, response_code, so you can look at latencies for successful responses or just for responses that failed.",
+ "type": "array",
+ "items": {
+ "$ref": "LabelDescriptor"
+ }
+ },
+ "name": {
+ "description": "The resource name of the metric descriptor.",
+ "type": "string"
+ },
+ "type": {
+ "description": "The metric type, including its DNS name prefix. The type is not URL-encoded. All user-defined custom metric types have the DNS name custom.googleapis.com. Metric types should use a natural hierarchical grouping. For example:\n\"custom.googleapis.com/invoice/paid/amount\"\n\"appengine.googleapis.com/http/server/response_latencies\"\n",
+ "type": "string"
+ },
+ "valueType": {
+ "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": {
"enumDescriptions": [
"Do not use this default value.",
@@ -1604,43 +1076,6 @@
"unit": {
"description": "Optional. The unit in which the metric value is reported. For example, kBy/s means kilobytes/sec, and 1 is the dimensionless unit. The supported units are a subset of The Unified Code for Units of Measure standard (http://unitsofmeasure.org/ucum.html).\u003cbr\u003e\u003cbr\u003e This field is part of the metric's documentation, but it is ignored by Stackdriver.",
"type": "string"
- },
- "labels": {
- "description": "The set of labels that can be used to describe a specific instance of this metric type. For example, the appengine.googleapis.com/http/server/response_latencies metric type has a label for the HTTP response code, response_code, so you can look at latencies for successful responses or just for responses that failed.",
- "type": "array",
- "items": {
- "$ref": "LabelDescriptor"
- }
- },
- "name": {
- "description": "The resource name of the metric descriptor.",
- "type": "string"
- },
- "type": {
- "description": "The metric type, including its DNS name prefix. The type is not URL-encoded. All user-defined custom metric types have the DNS name custom.googleapis.com. Metric types should use a natural hierarchical grouping. For example:\n\"custom.googleapis.com/invoice/paid/amount\"\n\"appengine.googleapis.com/http/server/response_latencies\"\n",
- "type": "string"
- },
- "valueType": {
- "enumDescriptions": [
- "Do not use this default value.",
- "The value is a boolean. This value type can be used only if the metric kind is GAUGE.",
- "The value is a signed 64-bit integer.",
- "The value is a double precision floating point number.",
- "The value is a text string. This value type can be used only if the metric kind is GAUGE.",
- "The value is a Distribution.",
- "The value is money."
- ],
- "enum": [
- "VALUE_TYPE_UNSPECIFIED",
- "BOOL",
- "INT64",
- "DOUBLE",
- "STRING",
- "DISTRIBUTION",
- "MONEY"
- ],
- "description": "Whether the measurement is an integer, a floating-point number, etc. Some combinations of metric_kind and value_type might not be supported.",
- "type": "string"
}
},
"id": "MetricDescriptor"
@@ -1649,13 +1084,13 @@
"description": "The range of the population values.",
"type": "object",
"properties": {
- "max": {
- "description": "The maximum of the population values.",
+ "min": {
+ "description": "The minimum of the population values.",
"format": "double",
"type": "number"
},
- "min": {
- "description": "The minimum of the population values.",
+ "max": {
+ "description": "The maximum of the population values.",
"format": "double",
"type": "number"
}
@@ -1664,13 +1099,6 @@
},
"UptimeCheckConfig": {
"properties": {
- "contentMatchers": {
- "description": "The expected content on the page the check is run against. Currently, only the first entry in the list is supported, and other entries will be ignored. The server will look for an exact match of the string in the page response's content. This field is optional and should only be specified if a content match is required.",
- "type": "array",
- "items": {
- "$ref": "ContentMatcher"
- }
- },
"timeout": {
"description": "The maximum amount of time to wait for the request to complete (must be between 1 and 60 seconds). Required.",
"format": "google-duration",
@@ -1712,14 +1140,14 @@
"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"
- ],
- "type": "string"
+ ]
},
"enumDescriptions": [
"Default value if no region is specified. Will result in uptime checks running from all regions.",
@@ -1734,8 +1162,15 @@
"type": "string"
},
"monitoredResource": {
- "description": "The monitored resource associated with the configuration.",
- "$ref": "MonitoredResource"
+ "$ref": "MonitoredResource",
+ "description": "The monitored resource associated with the configuration."
+ },
+ "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",
@@ -1765,8 +1200,8 @@
"type": "object",
"properties": {
"resource": {
- "$ref": "MonitoredResource",
- "description": "The monitored resource associated with the time series."
+ "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.",
@@ -1783,6 +1218,8 @@
"id": "CreateCollectdTimeSeriesRequest"
},
"ListGroupMembersResponse": {
+ "description": "The ListGroupMembers 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.",
@@ -1801,401 +1238,964 @@
}
}
},
- "id": "ListGroupMembersResponse",
- "description": "The ListGroupMembers response.",
- "type": "object"
- },
- "ListMonitoredResourceDescriptorsResponse": {
- "description": "The ListMonitoredResourceDescriptors response.",
- "type": "object",
- "properties": {
- "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"
- },
- "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": {
- "resource": {
- "description": "The associated monitored resource. Custom metrics can use only certain monitored resource types in their time series data.",
- "$ref": "MonitoredResource"
- },
- "metadata": {
- "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": {
- "description": "The value type of the time series. When listing time series, this value type might be different from the value type of the associated metric if this time series is an alignment or reduction of other time series.When creating a time series, this field is optional. If present, it must be the same as the type of the data in the points field.",
- "type": "string",
- "enumDescriptions": [
- "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": "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.",
- "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."
- ]
- },
- "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"
- }
- }
- },
- "id": "TimeSeries"
- },
- "CreateTimeSeriesRequest": {
- "properties": {
- "timeSeries": {
- "description": "The new data to be added to a list of time series. Adds at most one data point to each of several time series. The new data point must be more recent than any other point in its time series. Each TimeSeries value must fully specify a unique time series by supplying all label values for the metric and the monitored resource.",
- "type": "array",
- "items": {
- "$ref": "TimeSeries"
- }
- }
- },
- "id": "CreateTimeSeriesRequest",
- "description": "The CreateTimeSeries request.",
- "type": "object"
- },
- "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": {
- "bucketCounts": {
- "description": "Required in the Stackdriver Monitoring API v3. The values for each bucket specified in bucket_options. The sum of the values in bucketCounts must equal the value in the count field of the Distribution object. The order of the bucket counts follows the numbering schemes described for the three bucket types. The underflow bucket has number 0; the finite buckets, if any, have numbers 1 through N-2; and the overflow bucket has number N-1. The size of bucket_counts must not be greater than N. If the size is less than N, then the remaining buckets are assigned values of zero.",
- "type": "array",
- "items": {
- "format": "int64",
- "type": "string"
- }
- },
- "bucketOptions": {
- "description": "Required in the Stackdriver Monitoring API v3. Defines the histogram bucket boundaries.",
- "$ref": "BucketOptions"
- },
- "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.",
- "format": "double",
- "type": "number"
- },
- "range": {
- "description": "If specified, contains the range of the population values. The field must not be present if the count is zero. This field is presently ignored by the Stackdriver Monitoring API v3.",
- "$ref": "Range"
- },
- "count": {
- "description": "The number of values in the population. Must be non-negative. This value must equal the sum of the values in bucket_counts if a histogram is provided.",
- "format": "int64",
- "type": "string"
- },
- "mean": {
- "description": "The arithmetic mean of the values in the population. If count is zero then this field must be zero.",
- "format": "double",
- "type": "number"
- }
- },
- "id": "Distribution"
- },
- "MonitoredResource": {
- "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"
- }
- },
- "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": {
- "properties": {
- "metricDescriptors": {
- "description": "The metric descriptors that are available to the project and that match the value of filter, if present.",
- "type": "array",
- "items": {
- "$ref": "MetricDescriptor"
- }
- },
- "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": "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"
- },
- "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": {
- "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"
- },
- "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": {
- "index": {
- "description": "The zero-based index in CollectdPayload.values within the parent CreateCollectdTimeSeriesRequest.collectd_payloads.",
- "format": "int32",
- "type": "integer"
- },
- "error": {
- "description": "Records the error status for the value.",
- "$ref": "Status"
- }
- },
- "id": "CollectdValueError"
- },
- "UptimeCheckIp": {
- "description": "Contains the region, location, and list of IP addresses where checkers in the location run from.",
- "type": "object",
- "properties": {
- "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"
- },
- "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"
- }
- },
- "id": "UptimeCheckIp"
- },
- "CollectdPayload": {
- "properties": {
- "typeInstance": {
- "description": "The measurement type instance. Example: \"used\".",
- "type": "string"
- },
- "metadata": {
- "additionalProperties": {
- "$ref": "TypedValue"
- },
- "description": "The measurement metadata. Example: \"process_id\" -\u003e 12345",
- "type": "object"
- },
- "type": {
- "description": "The measurement type. Example: \"memory\".",
- "type": "string"
- },
- "plugin": {
- "description": "The name of the plugin. Example: \"disk\".",
- "type": "string"
- },
- "pluginInstance": {
- "description": "The instance name of the plugin Example: \"hdcl\".",
- "type": "string"
- },
- "endTime": {
- "description": "The end time of the interval.",
- "format": "google-datetime",
- "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",
- "description": "A collection of data points sent from a collectd-based plugin. See the collectd documentation for more information.",
- "type": "object"
- },
- "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"
+ "id": "ListGroupMembersResponse"
}
},
"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": "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": {
+ "projects": {
+ "resources": {
+ "metricDescriptors": {
+ "methods": {
+ "create": {
+ "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": {
+ "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/[^/]+$"
+ }
+ },
+ "flatPath": "v3/projects/{projectsId}/metricDescriptors"
+ },
+ "delete": {
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "DELETE",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/monitoring"
+ ],
+ "parameters": {
+ "name": {
+ "location": "path",
+ "description": "The metric descriptor on which to execute the request. The format is \"projects/{project_id_or_number}/metricDescriptors/{metric_id}\". An example of {metric_id} is: \"custom.googleapis.com/my_test_metric\".",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/metricDescriptors/.+$"
+ }
+ },
+ "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"
+ }
+ }
+ },
+ "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": {
+ "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": {
+ "location": "query",
+ "description": "A monitoring filter that specifies which time series should be returned. The filter must specify a single metric type, and can additionally specify metric labels and other information. For example:\nmetric.type = \"compute.googleapis.com/instance/cpu/usage_time\" AND\n metric.label.instance_name = \"my-instance-name\"\n",
+ "type": "string"
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call.",
+ "type": "string"
+ },
+ "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"
+ },
+ "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": {
+ "description": "Specifies which information is returned about the time series.",
+ "type": "string",
+ "location": "query",
+ "enum": [
+ "FULL",
+ "HEADERS"
+ ]
+ },
+ "aggregation.groupByFields": {
+ "location": "query",
+ "description": "The set of fields to preserve when crossSeriesReducer is specified. The groupByFields determine how the time series are partitioned into subsets prior to applying the aggregation function. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The crossSeriesReducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly contains resource.type. Fields not specified in groupByFields are aggregated away. If groupByFields is not specified and all the time series have the same resource type, then the time series are aggregated into a single output time series. If crossSeriesReducer is not defined, this field is ignored.",
+ "type": "string",
+ "repeated": true
+ },
+ "name": {
+ "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"
+ },
+ "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"
+ }
+ },
+ "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": {
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/monitoring",
+ "https://www.googleapis.com/auth/monitoring.write"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The project on which to execute the request. The format is \"projects/{project_id_or_number}\".",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v3/projects/{projectsId}/timeSeries",
+ "path": "v3/{+name}/timeSeries",
+ "id": "monitoring.projects.timeSeries.create",
+ "description": "Creates or adds data to one or more time series. The response is empty if all time series in the request were written. If any time series could not be written, a corresponding failure message is included in the error response.",
+ "request": {
+ "$ref": "CreateTimeSeriesRequest"
+ }
+ }
+ }
+ },
+ "uptimeCheckConfigs": {
+ "methods": {
+ "list": {
+ "response": {
+ "$ref": "ListUptimeCheckConfigsResponse"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "pageToken": {
+ "location": "query",
+ "description": "If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method. Using this field causes the method to return more results from the previous method call.",
+ "type": "string"
+ },
+ "pageSize": {
+ "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": {
+ "pattern": "^projects/[^/]+$",
+ "location": "path",
+ "description": "The project whose uptime check configurations are listed. The format isprojects/[PROJECT_ID].",
+ "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"
+ ],
+ "flatPath": "v3/projects/{projectsId}/uptimeCheckConfigs",
+ "path": "v3/{+parent}/uptimeCheckConfigs",
+ "id": "monitoring.projects.uptimeCheckConfigs.list",
+ "description": "Lists the existing valid uptime check configurations for the project, leaving out any invalid configurations."
+ },
+ "get": {
+ "description": "Gets a single uptime check configuration.",
+ "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"
+ },
+ "patch": {
+ "request": {
+ "$ref": "UptimeCheckConfig"
+ },
+ "description": "Updates an uptime check configuration. You can either replace the entire configuration with a new one or replace only certain fields in the current configuration by specifying the fields to be updated via \"updateMask\". Returns the updated configuration.",
+ "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}",
+ "id": "monitoring.projects.uptimeCheckConfigs.patch",
+ "path": "v3/{+name}"
+ },
+ "create": {
+ "path": "v3/{+parent}/uptimeCheckConfigs",
+ "id": "monitoring.projects.uptimeCheckConfigs.create",
+ "description": "Creates a new uptime check configuration.",
+ "request": {
+ "$ref": "UptimeCheckConfig"
+ },
+ "response": {
+ "$ref": "UptimeCheckConfig"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/monitoring"
+ ],
+ "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"
+ }
+ },
+ "flatPath": "v3/projects/{projectsId}/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.",
+ "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"
+ }
+ }
+ },
+ "monitoredResourceDescriptors": {
+ "methods": {
+ "list": {
+ "description": "Lists monitored resource descriptors that match a filter. This method does not require a Stackdriver account.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "ListMonitoredResourceDescriptorsResponse"
+ },
+ "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": {
+ "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}/monitoredResourceDescriptors",
+ "id": "monitoring.projects.monitoredResourceDescriptors.list",
+ "path": "v3/{+name}/monitoredResourceDescriptors"
+ },
+ "get": {
+ "id": "monitoring.projects.monitoredResourceDescriptors.get",
+ "path": "v3/{+name}",
+ "description": "Gets a single monitored resource descriptor. This method does not require a Stackdriver account.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "MonitoredResourceDescriptor"
+ },
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+/monitoredResourceDescriptors/[^/]+$",
+ "location": "path",
+ "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"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/monitoring",
+ "https://www.googleapis.com/auth/monitoring.read",
+ "https://www.googleapis.com/auth/monitoring.write"
+ ],
+ "flatPath": "v3/projects/{projectsId}/monitoredResourceDescriptors/{monitoredResourceDescriptorsId}"
+ }
+ }
+ },
+ "groups": {
+ "resources": {
+ "members": {
+ "methods": {
+ "list": {
+ "response": {
+ "$ref": "ListGroupMembersResponse"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "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": {
+ "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"
+ },
+ "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"
+ },
+ "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",
+ "path": "v3/{+name}/members",
+ "id": "monitoring.projects.groups.members.list",
+ "description": "Lists the monitored resources that are members of a group."
+ }
+ }
+ }
+ },
+ "methods": {
+ "update": {
+ "httpMethod": "PUT",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Group"
+ },
+ "parameters": {
+ "name": {
+ "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/[^/]+$",
+ "location": "path"
+ },
+ "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}",
+ "id": "monitoring.projects.groups.update",
+ "path": "v3/{+name}",
+ "request": {
+ "$ref": "Group"
+ },
+ "description": "Updates an existing group. You can change any group attributes except name."
+ },
+ "create": {
+ "request": {
+ "$ref": "Group"
+ },
+ "description": "Creates a new group.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Group"
+ },
+ "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",
+ "id": "monitoring.projects.groups.create",
+ "path": "v3/{+name}/groups"
+ },
+ "delete": {
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "DELETE",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/monitoring"
+ ],
+ "parameters": {
+ "name": {
+ "location": "path",
+ "description": "The group to delete. The format is \"projects/{project_id_or_number}/groups/{group_id}\".",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/groups/[^/]+$"
+ }
+ },
+ "flatPath": "v3/projects/{projectsId}/groups/{groupsId}",
+ "path": "v3/{+name}",
+ "id": "monitoring.projects.groups.delete",
+ "description": "Deletes an existing group."
+ },
+ "list": {
+ "id": "monitoring.projects.groups.list",
+ "path": "v3/{+name}/groups",
+ "description": "Lists the existing groups.",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "ListGroupsResponse"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "pageToken": {
+ "description": "If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageSize": {
+ "location": "query",
+ "description": "A positive number that is the maximum number of results to return.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "ancestorsOfGroup": {
+ "description": "A group name: \"projects/{project_id_or_number}/groups/{group_id}\". Returns groups that are ancestors of the specified group. The groups are returned in order, starting with the immediate parent and ending with the most distant ancestor. If the specified group has no immediate parent, the results are empty.",
+ "type": "string",
+ "location": "query"
+ },
+ "name": {
+ "pattern": "^projects/[^/]+$",
+ "location": "path",
+ "description": "The project whose groups are to be listed. The format is \"projects/{project_id_or_number}\".",
+ "required": true,
+ "type": "string"
+ },
+ "childrenOfGroup": {
+ "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",
+ "location": "query"
+ },
+ "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"
+ }
+ },
+ "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"
+ },
+ "get": {
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Group"
+ },
+ "parameters": {
+ "name": {
+ "location": "path",
+ "description": "The group to retrieve. The format is \"projects/{project_id_or_number}/groups/{group_id}\".",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/groups/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/monitoring",
+ "https://www.googleapis.com/auth/monitoring.read"
+ ],
+ "flatPath": "v3/projects/{projectsId}/groups/{groupsId}",
+ "id": "monitoring.projects.groups.get",
+ "path": "v3/{+name}",
+ "description": "Gets a single group."
+ }
+ }
+ },
+ "collectdTimeSeries": {
+ "methods": {
+ "create": {
+ "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",
+ "response": {
+ "$ref": "CreateCollectdTimeSeriesResponse"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+$",
+ "location": "path",
+ "description": "The project in which to create the time series. 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"
+ ]
+ }
+ }
+ }
+ }
+ },
+ "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": {
+ "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"
+ },
+ "pageSize": {
+ "description": "The maximum number of results to return in a single response. The server may further constrain the maximum number of results returned in a single page. If the page_size is \u003c=0, the server will decide the number of results to be returned. NOTE: this field is not yet implemented",
+ "format": "int32",
+ "type": "integer",
+ "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": {
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "type": "string",
+ "location": "query"
+ },
+ "pp": {
+ "location": "query",
+ "description": "Pretty-print response.",
+ "type": "boolean",
+ "default": "true"
+ },
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string",
+ "location": "query"
+ },
+ "bearer_token": {
+ "description": "OAuth bearer token.",
+ "type": "string",
+ "location": "query"
+ },
+ "upload_protocol": {
+ "location": "query",
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "type": "string"
+ },
+ "prettyPrint": {
+ "description": "Returns response with indentations and line breaks.",
+ "type": "boolean",
+ "default": "true",
+ "location": "query"
+ },
+ "uploadType": {
+ "location": "query",
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string"
+ },
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
+ "type": "string",
+ "location": "query"
+ },
+ "$.xgafv": {
+ "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"
+ ]
+ }
}
}
diff --git a/oslogin/v1/oslogin-api.json b/oslogin/v1/oslogin-api.json
index 271fe69..12efaa9 100644
--- a/oslogin/v1/oslogin-api.json
+++ b/oslogin/v1/oslogin-api.json
@@ -1,5 +1,33 @@
{
+ "discoveryVersion": "v1",
+ "version_module": true,
"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"
+ },
+ "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",
@@ -15,6 +43,18 @@
"description": "The POSIX account information associated with a Google account.",
"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"
+ },
"primary": {
"description": "Only one POSIX account can be marked as primary.",
"type": "boolean"
@@ -40,18 +80,6 @@
"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"
@@ -76,56 +104,30 @@
"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": {
- "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"
- },
- "SshPublicKey": {
- "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",
- "description": "The SSH public key information associated with a Google account.",
- "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": "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"
}
}
}
@@ -141,28 +143,22 @@
"users": {
"methods": {
"importSshPublicKey": {
- "path": "v1/{+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"
},
- "response": {
- "$ref": "ImportSshPublicKeyResponse"
- },
+ "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"
],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
+ "response": {
+ "$ref": "ImportSshPublicKeyResponse"
+ },
"parameters": {
"projectId": {
+ "location": "query",
"description": "The project ID of the Google Cloud Platform project.",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"parent": {
"description": "The unique ID for the user in format `users/{user}`.",
@@ -172,11 +168,15 @@
"location": "path"
}
},
- "flatPath": "v1/users/{usersId}:importSshPublicKey"
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "flatPath": "v1/users/{usersId}:importSshPublicKey",
+ "id": "oslogin.users.importSshPublicKey",
+ "path": "v1/{+parent}:importSshPublicKey"
},
"getLoginProfile": {
- "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.",
"response": {
"$ref": "LoginProfile"
@@ -187,22 +187,24 @@
"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": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
],
- "flatPath": "v1/users/{usersId}/loginProfile"
+ "flatPath": "v1/users/{usersId}/loginProfile",
+ "path": "v1/{+name}/loginProfile",
+ "id": "oslogin.users.getLoginProfile"
}
},
"resources": {
- "sshPublicKeys": {
+ "projects": {
"methods": {
"delete": {
"response": {
@@ -218,21 +220,23 @@
],
"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}`.",
+ "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/[^/]+/sshPublicKeys/[^/]+$",
- "location": "path"
+ "pattern": "^users/[^/]+/projects/[^/]+$"
}
},
- "flatPath": "v1/users/{usersId}/sshPublicKeys/{sshPublicKeysId}",
+ "flatPath": "v1/users/{usersId}/projects/{projectsId}",
"path": "v1/{+name}",
- "id": "oslogin.users.sshPublicKeys.delete",
- "description": "Deletes an SSH public key."
- },
+ "id": "oslogin.users.projects.delete",
+ "description": "Deletes a POSIX account."
+ }
+ }
+ },
+ "sshPublicKeys": {
+ "methods": {
"get": {
- "path": "v1/{+name}",
- "id": "oslogin.users.sshPublicKeys.get",
"description": "Retrieves an SSH public key.",
"response": {
"$ref": "SshPublicKey"
@@ -241,22 +245,28 @@
"name"
],
"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"
],
- "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}"
+ "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"
@@ -265,18 +275,18 @@
"$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": {
+ "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/[^/]+$",
- "location": "path"
- },
- "updateMask": {
- "description": "Mask to control which fields get updated. Updates all if not present.",
- "format": "google-fieldmask",
- "type": "string",
- "location": "query"
+ "pattern": "^users/[^/]+/sshPublicKeys/[^/]+$"
}
},
"scopes": [
@@ -285,41 +295,33 @@
],
"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": {
+ "path": "v1/{+name}"
+ },
"delete": {
- "httpMethod": "DELETE",
+ "description": "Deletes an SSH public key.",
"response": {
"$ref": "Empty"
},
"parameterOrder": [
"name"
],
+ "httpMethod": "DELETE",
"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}`.",
+ "description": "The fingerprint of the public key to update. Public keys are identified by\ntheir SHA-256 fingerprint. The fingerprint of the public key is in format\n`users/{user}/sshPublicKeys/{fingerprint}`.",
"required": true,
- "type": "string"
+ "type": "string",
+ "pattern": "^users/[^/]+/sshPublicKeys/[^/]+$"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
],
- "flatPath": "v1/users/{usersId}/projects/{projectsId}",
- "id": "oslogin.users.projects.delete",
+ "flatPath": "v1/users/{usersId}/sshPublicKeys/{sshPublicKeysId}",
"path": "v1/{+name}",
- "description": "Deletes a POSIX account."
+ "id": "oslogin.users.sshPublicKeys.delete"
}
}
}
@@ -327,9 +329,15 @@
}
},
"parameters": {
- "uploadType": {
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "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": {
@@ -337,30 +345,30 @@
"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": {
- "enum": [
- "1",
- "2"
- ],
"description": "V1 error format.",
"type": "string",
"enumDescriptions": [
"v1 error format",
"v2 error format"
],
- "location": "query"
+ "location": "query",
+ "enum": [
+ "1",
+ "2"
+ ]
},
"alt": {
- "enum": [
- "json",
- "media",
- "proto"
- ],
"type": "string",
"enumDescriptions": [
"Responses with Content-Type of application/json",
@@ -369,22 +377,27 @@
],
"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"
+ "default": "json",
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ]
},
"access_token": {
+ "location": "query",
"description": "OAuth access token.",
- "type": "string",
- "location": "query"
+ "type": "string"
+ },
+ "key": {
+ "location": "query",
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "type": "string"
},
"quotaUser": {
- "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.",
@@ -393,36 +406,23 @@
"location": "query"
},
"bearer_token": {
+ "location": "query",
"description": "OAuth bearer token.",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"oauth_token": {
"description": "OAuth 2.0 token for the current user.",
"type": "string",
"location": "query"
- },
- "upload_protocol": {
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string",
- "location": "query"
- },
- "prettyPrint": {
- "location": "query",
- "description": "Returns response with indentations and line breaks.",
- "type": "boolean",
- "default": "true"
}
},
"version": "v1",
"baseUrl": "https://oslogin.googleapis.com/",
- "servicePath": "",
- "description": "Manages OS login configuration for Google account users.",
"kind": "discovery#restDescription",
+ "description": "Manages OS login configuration for Google account users.",
+ "servicePath": "",
"basePath": "",
- "documentationLink": "https://cloud.google.com/compute/docs/oslogin/rest/",
"id": "oslogin:v1",
- "revision": "20171211",
- "discoveryVersion": "v1",
- "version_module": true
+ "documentationLink": "https://cloud.google.com/compute/docs/oslogin/rest/",
+ "revision": "20171211"
}
diff --git a/oslogin/v1alpha/oslogin-api.json b/oslogin/v1alpha/oslogin-api.json
index de932df..3eeefc4 100644
--- a/oslogin/v1alpha/oslogin-api.json
+++ b/oslogin/v1alpha/oslogin-api.json
@@ -1,19 +1,137 @@
{
+ "schemas": {
+ "PosixAccount": {
+ "description": "The POSIX account information associated with a Google account.",
+ "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"
+ },
+ "primary": {
+ "description": "Only one POSIX account can be marked as primary.",
+ "type": "boolean"
+ },
+ "accountId": {
+ "description": "Output only. A POSIX account identifier.",
+ "type": "string"
+ },
+ "gid": {
+ "description": "The default group ID.",
+ "format": "int64",
+ "type": "string"
+ },
+ "uid": {
+ "description": "The user ID.",
+ "format": "int64",
+ "type": "string"
+ },
+ "username": {
+ "description": "The username of the POSIX account.",
+ "type": "string"
+ },
+ "shell": {
+ "description": "The path to the logic shell for this account.",
+ "type": "string"
+ }
+ },
+ "id": "PosixAccount"
+ },
+ "LoginProfile": {
+ "id": "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"
+ },
+ "posixAccounts": {
+ "description": "The list of POSIX accounts associated with the Directory API user.",
+ "type": "array",
+ "items": {
+ "$ref": "PosixAccount"
+ }
+ },
+ "suspended": {
+ "description": "Indicates if the user is suspended.",
+ "type": "boolean"
+ }
+ }
+ },
+ "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": {
+ "id": "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"
+ }
+ }
+ },
+ "ImportSshPublicKeyResponse": {
+ "id": "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."
+ }
+ }
+ }
+ },
+ "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 OS Login",
"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/compute.readonly": {
"description": "View your Google Compute Engine resources"
},
"https://www.googleapis.com/auth/compute": {
"description": "View and manage your Google Compute Engine resources"
+ },
+ "https://www.googleapis.com/auth/cloud-platform.read-only": {
+ "description": "View your data across Google Cloud Platform services"
+ },
+ "https://www.googleapis.com/auth/cloud-platform": {
+ "description": "View and manage your data across Google Cloud Platform services"
}
}
}
@@ -28,165 +146,164 @@
"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"
- ],
+ "getLoginProfile": {
"parameters": {
- "projectId": {
- "type": "string",
- "location": "query",
- "description": "The project ID of the Google Cloud Platform project."
- },
- "parent": {
- "location": "path",
+ "name": {
"description": "The unique ID for the user in format `users/{user}`.",
"required": true,
"type": "string",
- "pattern": "^users/[^/]+$"
+ "pattern": "^users/[^/]+$",
+ "location": "path"
}
},
- "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": {
- "flatPath": "v1alpha/users/{usersId}/loginProfile",
- "path": "v1alpha/{+name}/loginProfile",
- "id": "oslogin.users.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/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.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "LoginProfile"
+ }
+ },
+ "importSshPublicKey": {
"parameters": {
- "name": {
- "required": true,
- "type": "string",
+ "projectId": {
+ "location": "query",
+ "description": "The project ID of the Google Cloud Platform project.",
+ "type": "string"
+ },
+ "parent": {
"pattern": "^users/[^/]+$",
"location": "path",
- "description": "The unique ID for the user in format `users/{user}`."
+ "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": "v1alpha/users/{usersId}:importSshPublicKey",
+ "path": "v1alpha/{+parent}:importSshPublicKey",
+ "id": "oslogin.users.importSshPublicKey",
+ "request": {
+ "$ref": "SshPublicKey"
+ },
+ "description": "Adds an SSH public key and returns the profile information. Default POSIX\naccount information is set when no username and UID exist as part of the\nlogin profile.",
+ "response": {
+ "$ref": "ImportSshPublicKeyResponse"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "POST"
}
},
"resources": {
"sshPublicKeys": {
"methods": {
- "get": {
- "response": {
- "$ref": "SshPublicKey"
- },
- "parameterOrder": [
- "name"
- ],
- "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": "v1alpha/users/{usersId}/sshPublicKeys/{sshPublicKeysId}",
- "path": "v1alpha/{+name}",
- "id": "oslogin.users.sshPublicKeys.get",
- "description": "Retrieves an SSH public key."
- },
- "patch": {
- "response": {
- "$ref": "SshPublicKey"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "PATCH",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "parameters": {
- "name": {
- "required": true,
- "type": "string",
- "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}`."
- },
- "updateMask": {
- "type": "string",
- "location": "query",
- "description": "Mask to control which fields get updated. Updates all if not present.",
- "format": "google-fieldmask"
- }
- },
- "flatPath": "v1alpha/users/{usersId}/sshPublicKeys/{sshPublicKeysId}",
- "path": "v1alpha/{+name}",
- "id": "oslogin.users.sshPublicKeys.patch",
- "description": "Updates an SSH public key and returns the profile information. This method\nsupports patch semantics.",
- "request": {
- "$ref": "SshPublicKey"
- }
- },
"delete": {
- "flatPath": "v1alpha/users/{usersId}/sshPublicKeys/{sshPublicKeysId}",
- "id": "oslogin.users.sshPublicKeys.delete",
- "path": "v1alpha/{+name}",
"description": "Deletes an SSH public key.",
- "httpMethod": "DELETE",
- "parameterOrder": [
- "name"
- ],
"response": {
"$ref": "Empty"
},
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "DELETE",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
"parameters": {
"name": {
- "required": true,
- "type": "string",
"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}`."
+ "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"
+ },
+ "get": {
+ "id": "oslogin.users.sshPublicKeys.get",
+ "path": "v1alpha/{+name}",
+ "description": "Retrieves an SSH public key.",
+ "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}"
+ },
+ "patch": {
+ "parameters": {
+ "name": {
+ "pattern": "^users/[^/]+/sshPublicKeys/[^/]+$",
+ "location": "path",
+ "description": "The fingerprint of the public key to update. Public keys are identified by\ntheir SHA-256 fingerprint. The fingerprint of the public key is in format\n`users/{user}/sshPublicKeys/{fingerprint}`.",
+ "required": true,
+ "type": "string"
+ },
+ "updateMask": {
+ "description": "Mask to control which fields get updated. Updates all if not present.",
+ "format": "google-fieldmask",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "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.",
+ "httpMethod": "PATCH",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "SshPublicKey"
+ }
}
}
},
"projects": {
"methods": {
"delete": {
- "description": "Deletes a POSIX account.",
"response": {
"$ref": "Empty"
},
@@ -194,22 +311,23 @@
"name"
],
"httpMethod": "DELETE",
- "parameters": {
- "name": {
- "location": "path",
- "description": "A reference to the POSIX account to update. POSIX accounts are identified\nby the project ID they are associated with. A reference to the POSIX\naccount is in format `users/{user}/projects/{project}`.",
- "required": true,
- "type": "string",
- "pattern": "^users/[^/]+/projects/[^/]+$"
- }
- },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
],
+ "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": "v1alpha/users/{usersId}/projects/{projectsId}",
"path": "v1alpha/{+name}",
- "id": "oslogin.users.projects.delete"
+ "id": "oslogin.users.projects.delete",
+ "description": "Deletes a POSIX account."
}
}
}
@@ -217,29 +335,38 @@
}
},
"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": {
- "location": "query",
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string"
+ "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": {
- "type": "string",
"enumDescriptions": [
"v1 error format",
"v2 error format"
@@ -249,7 +376,8 @@
"1",
"2"
],
- "description": "V1 error format."
+ "description": "V1 error format.",
+ "type": "string"
},
"callback": {
"location": "query",
@@ -257,51 +385,41 @@
"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": {
- "location": "query",
- "description": "OAuth access 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"
},
"key": {
"location": "query",
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
"type": "string"
},
- "quotaUser": {
- "type": "string",
+ "access_token": {
"location": "query",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters."
+ "description": "OAuth access token.",
+ "type": "string"
+ },
+ "quotaUser": {
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "type": "string",
+ "location": "query"
},
"pp": {
+ "location": "query",
+ "description": "Pretty-print response.",
"type": "boolean",
- "default": "true",
- "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."
+ "default": "true"
}
},
"version": "v1alpha",
@@ -310,127 +428,9 @@
"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": {
- "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": {
- "type": "object",
- "properties": {
- "homeDirectory": {
- "description": "The path to the home directory for this account.",
- "type": "string"
- },
- "systemId": {
- "type": "string",
- "description": "System identifier for which account the username or uid applies to.\nBy default, the empty value is used."
- },
- "gecos": {
- "type": "string",
- "description": "The GECOS (user information) entry for this account."
- },
- "primary": {
- "type": "boolean",
- "description": "Only one POSIX account can be marked as primary."
- },
- "accountId": {
- "type": "string",
- "description": "Output only. A POSIX account identifier."
- },
- "gid": {
- "type": "string",
- "description": "The default group ID.",
- "format": "int64"
- },
- "uid": {
- "type": "string",
- "description": "The user ID.",
- "format": "int64"
- },
- "username": {
- "type": "string",
- "description": "The username of the POSIX account."
- },
- "shell": {
- "type": "string",
- "description": "The path to the logic shell for this account."
- }
- },
- "id": "PosixAccount",
- "description": "The POSIX account information associated with a Google account."
- },
- "LoginProfile": {
- "type": "object",
- "properties": {
- "suspended": {
- "type": "boolean",
- "description": "Indicates if the user is suspended."
- },
- "sshPublicKeys": {
- "additionalProperties": {
- "$ref": "SshPublicKey"
- },
- "description": "A map from SSH public key fingerprint to the associated key object.",
- "type": "object"
- },
- "name": {
- "type": "string",
- "description": "A unique user ID for identifying the user."
- },
- "posixAccounts": {
- "type": "array",
- "items": {
- "$ref": "PosixAccount"
- },
- "description": "The list of POSIX accounts associated with the Directory API user."
- }
- },
- "id": "LoginProfile",
- "description": "The user profile information used for logging in to a virtual machine on\nGoogle Compute Engine."
- },
- "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": {
- "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"
- },
- "expirationTimeUsec": {
- "type": "string",
- "description": "An expiration time in microseconds since epoch.",
- "format": "int64"
- }
- },
- "id": "SshPublicKey"
- }
- },
- "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_module": true
}
diff --git a/oslogin/v1beta/oslogin-api.json b/oslogin/v1beta/oslogin-api.json
index d0cc8c4..7f4ad47 100644
--- a/oslogin/v1beta/oslogin-api.json
+++ b/oslogin/v1beta/oslogin-api.json
@@ -1,145 +1,4 @@
{
- "schemas": {
- "PosixAccount": {
- "description": "The POSIX account information associated with a Google account.",
- "type": "object",
- "properties": {
- "accountId": {
- "description": "Output only. A POSIX account identifier.",
- "type": "string"
- },
- "gid": {
- "description": "The default group ID.",
- "format": "int64",
- "type": "string"
- },
- "uid": {
- "description": "The user ID.",
- "format": "int64",
- "type": "string"
- },
- "username": {
- "description": "The username of the POSIX account.",
- "type": "string"
- },
- "shell": {
- "description": "The path to the logic shell for this account.",
- "type": "string"
- },
- "homeDirectory": {
- "description": "The path to the home directory for this account.",
- "type": "string"
- },
- "systemId": {
- "description": "System identifier for which account the username or uid applies to.\nBy default, the empty value is used.",
- "type": "string"
- },
- "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": {
- "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"
- }
- },
- "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": {
- "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"
- },
- "canonicalName": "Cloud OS Login",
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/compute.readonly": {
- "description": "View your Google Compute Engine resources"
- },
- "https://www.googleapis.com/auth/compute": {
- "description": "View and manage your Google Compute Engine resources"
- },
- "https://www.googleapis.com/auth/cloud-platform.read-only": {
- "description": "View your data across Google Cloud Platform services"
- },
- "https://www.googleapis.com/auth/cloud-platform": {
- "description": "View and manage your data across Google Cloud Platform services"
- }
- }
- }
- },
- "rootUrl": "https://oslogin.googleapis.com/",
- "ownerDomain": "google.com",
- "name": "oslogin",
- "batchPath": "batch",
"fullyEncodeReservedExpansion": true,
"title": "Google Cloud OS Login API",
"ownerName": "Google",
@@ -147,6 +6,10 @@
"users": {
"methods": {
"importSshPublicKey": {
+ "description": "Adds an SSH public key and returns the profile information. Default POSIX\naccount information is set when no username and UID exist as part of the\nlogin profile.",
+ "request": {
+ "$ref": "SshPublicKey"
+ },
"response": {
"$ref": "ImportSshPublicKeyResponse"
},
@@ -154,6 +17,10 @@
"parent"
],
"httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
"parameters": {
"projectId": {
"location": "query",
@@ -168,45 +35,37 @@
"pattern": "^users/[^/]+$"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
"flatPath": "v1beta/users/{usersId}:importSshPublicKey",
"path": "v1beta/{+parent}:importSshPublicKey",
- "id": "oslogin.users.importSshPublicKey",
- "request": {
- "$ref": "SshPublicKey"
- },
- "description": "Adds an SSH public key and returns the profile information. Default POSIX\naccount information is set when no username and UID exist as part of the\nlogin profile."
+ "id": "oslogin.users.importSshPublicKey"
},
"getLoginProfile": {
- "httpMethod": "GET",
+ "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.",
"response": {
"$ref": "LoginProfile"
},
"parameterOrder": [
"name"
],
- "parameters": {
- "name": {
- "description": "The unique ID for the user in format `users/{user}`.",
- "required": true,
- "type": "string",
- "pattern": "^users/[^/]+$",
- "location": "path"
- }
- },
+ "httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
],
- "flatPath": "v1beta/users/{usersId}/loginProfile",
- "id": "oslogin.users.getLoginProfile",
- "path": "v1beta/{+name}/loginProfile",
- "description": "Retrieves the profile information used for logging in to a virtual machine\non Google Compute Engine."
+ "parameters": {
+ "name": {
+ "location": "path",
+ "description": "The unique ID for the user in format `users/{user}`.",
+ "required": true,
+ "type": "string",
+ "pattern": "^users/[^/]+$"
+ }
+ }
}
},
"resources": {
@@ -243,74 +102,43 @@
"sshPublicKeys": {
"methods": {
"delete": {
+ "flatPath": "v1beta/users/{usersId}/sshPublicKeys/{sshPublicKeysId}",
+ "path": "v1beta/{+name}",
+ "id": "oslogin.users.sshPublicKeys.delete",
"description": "Deletes an SSH public key.",
- "httpMethod": "DELETE",
"response": {
"$ref": "Empty"
},
"parameterOrder": [
"name"
],
- "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/[^/]+$"
- }
- },
+ "httpMethod": "DELETE",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
],
- "flatPath": "v1beta/users/{usersId}/sshPublicKeys/{sshPublicKeysId}",
- "id": "oslogin.users.sshPublicKeys.delete",
- "path": "v1beta/{+name}"
+ "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"
+ }
+ }
},
"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": "v1beta/users/{usersId}/sshPublicKeys/{sshPublicKeysId}",
- "path": "v1beta/{+name}",
- "id": "oslogin.users.sshPublicKeys.get"
- },
- "patch": {
"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": {
- "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}`.",
+ "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/[^/]+$",
@@ -322,8 +150,39 @@
"https://www.googleapis.com/auth/compute"
],
"flatPath": "v1beta/users/{usersId}/sshPublicKeys/{sshPublicKeysId}",
- "path": "v1beta/{+name}",
+ "id": "oslogin.users.sshPublicKeys.get",
+ "path": "v1beta/{+name}"
+ },
+ "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": {
+ "location": "path",
+ "description": "The fingerprint of the public key to update. Public keys are identified by\ntheir SHA-256 fingerprint. The fingerprint of the public key is in format\n`users/{user}/sshPublicKeys/{fingerprint}`.",
+ "required": true,
+ "type": "string",
+ "pattern": "^users/[^/]+/sshPublicKeys/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "flatPath": "v1beta/users/{usersId}/sshPublicKeys/{sshPublicKeysId}",
"id": "oslogin.users.sshPublicKeys.patch",
+ "path": "v1beta/{+name}",
"request": {
"$ref": "SshPublicKey"
},
@@ -335,32 +194,26 @@
}
},
"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": {
"location": "query",
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "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",
- "location": "query"
+ "default": "true"
},
"uploadType": {
"location": "query",
@@ -368,9 +221,9 @@
"type": "string"
},
"fields": {
+ "location": "query",
"description": "Selector specifying which fields to include in a partial response.",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"$.xgafv": {
"enumDescriptions": [
@@ -386,9 +239,9 @@
"type": "string"
},
"callback": {
+ "location": "query",
"description": "JSONP",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"alt": {
"enum": [
@@ -406,20 +259,26 @@
"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": {
+ "location": "query",
+ "description": "OAuth access token.",
+ "type": "string"
+ },
"quotaUser": {
"location": "query",
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
"type": "string"
+ },
+ "pp": {
+ "description": "Pretty-print response.",
+ "type": "boolean",
+ "default": "true",
+ "location": "query"
}
},
"version": "v1beta",
@@ -428,9 +287,150 @@
"description": "Manages OS login configuration for Google account users.",
"servicePath": "",
"basePath": "",
- "id": "oslogin:v1beta",
- "documentationLink": "https://cloud.google.com/compute/docs/oslogin/rest/",
"revision": "20171211",
+ "documentationLink": "https://cloud.google.com/compute/docs/oslogin/rest/",
+ "id": "oslogin:v1beta",
"discoveryVersion": "v1",
- "version_module": true
+ "version_module": true,
+ "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"
+ },
+ "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"
+ },
+ "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"
+ },
+ "primary": {
+ "description": "Only one POSIX account can be marked as primary.",
+ "type": "boolean"
+ },
+ "accountId": {
+ "description": "Output only. A POSIX account identifier.",
+ "type": "string"
+ },
+ "gid": {
+ "description": "The default group ID.",
+ "format": "int64",
+ "type": "string"
+ },
+ "uid": {
+ "description": "The user ID.",
+ "format": "int64",
+ "type": "string"
+ },
+ "username": {
+ "description": "The username of the POSIX account.",
+ "type": "string"
+ }
+ },
+ "id": "PosixAccount"
+ },
+ "LoginProfile": {
+ "description": "The user profile information used for logging in to a virtual machine on\nGoogle Compute Engine.",
+ "type": "object",
+ "properties": {
+ "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"
+ },
+ "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"
+ }
+ }
+ },
+ "id": "LoginProfile"
+ }
+ },
+ "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": {
+ "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/compute.readonly": {
+ "description": "View your Google Compute Engine resources"
+ },
+ "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"
}
diff --git a/partners/v2/partners-api.json b/partners/v2/partners-api.json
index 53e3dbc..54da324 100644
--- a/partners/v2/partners-api.json
+++ b/partners/v2/partners-api.json
@@ -1,30 +1,20 @@
{
+ "name": "partners",
+ "batchPath": "batch",
+ "revision": "20171211",
+ "documentationLink": "https://developers.google.com/partners/",
+ "id": "partners:v2",
+ "title": "Google Partners API",
"discoveryVersion": "v1",
"ownerName": "Google",
"version_module": true,
"resources": {
- "clientMessages": {
- "methods": {
- "log": {
- "path": "v2/clientMessages:log",
- "id": "partners.clientMessages.log",
- "description": "Logs a generic message from the client, such as\n`Failed to render component`, `Profile page is running slow`,\n`More than 500 users have accessed this result.`, etc.",
- "request": {
- "$ref": "LogMessageRequest"
- },
- "response": {
- "$ref": "LogMessageResponse"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "parameters": {},
- "flatPath": "v2/clientMessages:log"
- }
- }
- },
"exams": {
"methods": {
"getToken": {
+ "path": "v2/exams/{examType}/token",
+ "id": "partners.exams.getToken",
+ "description": "Gets an Exam Token for a Partner's user to take an exam in the Exams System",
"response": {
"$ref": "ExamToken"
},
@@ -33,28 +23,13 @@
],
"httpMethod": "GET",
"parameters": {
- "requestMetadata.locale": {
- "description": "Locale to use for the current request.",
+ "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.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"
- },
- "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"
- },
"examType": {
+ "location": "path",
"enum": [
"CERTIFICATION_EXAM_TYPE_UNSPECIFIED",
"CET_ADWORDS_FUNDAMENTALS",
@@ -70,61 +45,97 @@
],
"description": "The exam type we are requesting a token for.",
"required": true,
- "type": "string",
- "location": "path"
- },
- "requestMetadata.partnersSessionId": {
- "description": "Google Partners session ID.",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"requestMetadata.userOverrides.userId": {
"description": "Logged-in user ID to impersonate instead of the user's ID.",
"type": "string",
"location": "query"
},
- "requestMetadata.trafficSource.trafficSourceId": {
- "description": "Identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.",
+ "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": {
+ "description": "Experiment IDs the current request belongs to.",
+ "type": "string",
+ "repeated": true,
+ "location": "query"
}
},
- "flatPath": "v2/exams/{examType}/token",
- "path": "v2/exams/{examType}/token",
- "id": "partners.exams.getToken",
- "description": "Gets an Exam Token for a Partner's user to take an exam in the Exams System"
+ "flatPath": "v2/exams/{examType}/token"
}
}
},
"leads": {
"methods": {
"list": {
+ "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": {
- "requestMetadata.userOverrides.userId": {
+ "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": "Logged-in user ID to impersonate instead of the user's ID.",
+ "description": "Experiment IDs the current request belongs to.",
"type": "string"
},
- "requestMetadata.partnersSessionId": {
+ "orderBy": {
"location": "query",
- "description": "Google Partners session ID.",
+ "description": "How to order Leads. Currently, only `create_time`\nand `create_time desc` are supported",
"type": "string"
},
+ "requestMetadata.trafficSource.trafficSubId": {
+ "description": "Second level identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.",
+ "type": "string",
+ "location": "query"
+ },
+ "requestMetadata.partnersSessionId": {
+ "description": "Google Partners session ID.",
+ "type": "string",
+ "location": "query"
+ },
+ "requestMetadata.userOverrides.userId": {
+ "description": "Logged-in user ID to impersonate instead of the user's ID.",
+ "type": "string",
+ "location": "query"
+ },
"pageToken": {
"location": "query",
"description": "A token identifying a page of results that the server returns.\nTypically, this is the value of `ListLeadsResponse.next_page_token`\nreturned from the previous call to\nListLeads.",
"type": "string"
},
"pageSize": {
+ "location": "query",
"description": "Requested page size. Server may return fewer leads than requested.\nIf unspecified, server picks an appropriate default.",
"format": "int32",
- "type": "integer",
- "location": "query"
+ "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.",
@@ -135,41 +146,15 @@
"location": "query",
"description": "Locale to use for the current request.",
"type": "string"
- },
- "requestMetadata.userOverrides.ipAddress": {
- "location": "query",
- "description": "IP address to use instead of the user's geo-located IP address.",
- "type": "string"
- },
- "requestMetadata.experimentIds": {
- "repeated": true,
- "location": "query",
- "description": "Experiment IDs the current request belongs to.",
- "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": {
- "description": "How to order Leads. Currently, only `create_time`\nand `create_time desc` are supported",
- "type": "string",
- "location": "query"
}
},
- "flatPath": "v2/leads",
- "path": "v2/leads",
- "id": "partners.leads.list",
- "description": "Lists advertiser leads for a user's associated company.\nShould only be called within the context of an authorized logged in user."
+ "flatPath": "v2/leads"
}
}
},
"offers": {
"methods": {
"list": {
- "path": "v2/offers",
- "id": "partners.offers.list",
"description": "Lists the Offers available for the current user",
"response": {
"$ref": "ListOffersResponse"
@@ -177,16 +162,21 @@
"parameterOrder": [],
"httpMethod": "GET",
"parameters": {
- "requestMetadata.locale": {
- "location": "query",
- "description": "Locale to use for the current request.",
- "type": "string"
- },
- "requestMetadata.userOverrides.ipAddress": {
- "description": "IP address to use instead of the user's geo-located IP address.",
+ "requestMetadata.trafficSource.trafficSourceId": {
+ "description": "Identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.",
"type": "string",
"location": "query"
},
+ "requestMetadata.locale": {
+ "description": "Locale to use for the current request.",
+ "type": "string",
+ "location": "query"
+ },
+ "requestMetadata.userOverrides.ipAddress": {
+ "location": "query",
+ "description": "IP address to use instead of the user's geo-located IP address.",
+ "type": "string"
+ },
"requestMetadata.experimentIds": {
"repeated": true,
"location": "query",
@@ -198,49 +188,41 @@
"type": "string",
"location": "query"
},
+ "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.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"
}
},
- "flatPath": "v2/offers"
+ "flatPath": "v2/offers",
+ "path": "v2/offers",
+ "id": "partners.offers.list"
}
},
"resources": {
"history": {
"methods": {
"list": {
+ "httpMethod": "GET",
+ "parameterOrder": [],
"response": {
"$ref": "ListOffersHistoryResponse"
},
- "parameterOrder": [],
- "httpMethod": "GET",
"parameters": {
- "requestMetadata.locale": {
- "location": "query",
- "description": "Locale to use for the current request.",
- "type": "string"
- },
"requestMetadata.userOverrides.ipAddress": {
"description": "IP address to use instead of the user's geo-located IP address.",
"type": "string",
"location": "query"
},
"entireCompany": {
+ "location": "query",
"description": "if true, show history for the entire company. Requires user to be admin.",
- "type": "boolean",
- "location": "query"
+ "type": "boolean"
},
"requestMetadata.experimentIds": {
"description": "Experiment IDs the current request belongs to.",
@@ -248,15 +230,15 @@
"repeated": true,
"location": "query"
},
- "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.trafficSource.trafficSubId": {
+ "location": "query",
"description": "Second level identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.",
- "type": "string",
- "location": "query"
+ "type": "string"
+ },
+ "orderBy": {
+ "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.",
+ "type": "string"
},
"requestMetadata.partnersSessionId": {
"location": "query",
@@ -264,9 +246,9 @@
"type": "string"
},
"requestMetadata.userOverrides.userId": {
+ "location": "query",
"description": "Logged-in user ID to impersonate instead of the user's ID.",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"pageToken": {
"location": "query",
@@ -274,229 +256,240 @@
"type": "string"
},
"pageSize": {
+ "location": "query",
"description": "Maximum number of rows to return per page.",
"format": "int32",
- "type": "integer",
- "location": "query"
+ "type": "integer"
},
"requestMetadata.trafficSource.trafficSourceId": {
+ "location": "query",
"description": "Identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.",
+ "type": "string"
+ },
+ "requestMetadata.locale": {
+ "description": "Locale to use for the current request.",
"type": "string",
"location": "query"
}
},
"flatPath": "v2/offers/history",
- "path": "v2/offers/history",
"id": "partners.offers.history.list",
+ "path": "v2/offers/history",
"description": "Lists the Historical Offers for the current user (or user's entire company)"
}
}
}
}
},
+ "analytics": {
+ "methods": {
+ "list": {
+ "parameters": {
+ "requestMetadata.userOverrides.userId": {
+ "description": "Logged-in user ID to impersonate instead of the user's ID.",
+ "type": "string",
+ "location": "query"
+ },
+ "requestMetadata.partnersSessionId": {
+ "description": "Google Partners session ID.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "A token identifying a page of results that the server returns.\nTypically, this is the value of `ListAnalyticsResponse.next_page_token`\nreturned from the previous call to\nListAnalytics.\nWill be a date string in `YYYY-MM-DD` format representing the end date\nof the date range of results to return.\nIf unspecified or set to \"\", default value is the current date.",
+ "type": "string"
+ },
+ "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": {
+ "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"
+ }
+ },
+ "flatPath": "v2/analytics",
+ "id": "partners.analytics.list",
+ "path": "v2/analytics",
+ "description": "Lists analytics data for a user's associated company.\nShould only be called within the context of an authorized logged in user.",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "ListAnalyticsResponse"
+ },
+ "parameterOrder": []
+ }
+ }
+ },
"userStates": {
"methods": {
"list": {
- "description": "Lists states for current user.",
"response": {
"$ref": "ListUserStatesResponse"
},
"parameterOrder": [],
"httpMethod": "GET",
"parameters": {
+ "requestMetadata.trafficSource.trafficSourceId": {
+ "description": "Identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.",
+ "type": "string",
+ "location": "query"
+ },
+ "requestMetadata.locale": {
+ "description": "Locale to use for the current request.",
+ "type": "string",
+ "location": "query"
+ },
+ "requestMetadata.userOverrides.ipAddress": {
+ "location": "query",
+ "description": "IP address to use instead of the user's geo-located IP address.",
+ "type": "string"
+ },
+ "requestMetadata.experimentIds": {
+ "description": "Experiment IDs the current request belongs to.",
+ "type": "string",
+ "repeated": true,
+ "location": "query"
+ },
+ "requestMetadata.trafficSource.trafficSubId": {
+ "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": {
- "location": "query",
- "description": "Locale to use for the current request.",
- "type": "string"
- },
- "requestMetadata.userOverrides.ipAddress": {
- "description": "IP address to use instead of the user's geo-located IP address.",
- "type": "string",
- "location": "query"
- },
- "requestMetadata.experimentIds": {
- "repeated": true,
- "location": "query",
- "description": "Experiment IDs the current request belongs to.",
- "type": "string"
- },
- "requestMetadata.trafficSource.trafficSubId": {
- "description": "Second level identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.",
"type": "string",
"location": "query"
}
},
"flatPath": "v2/userStates",
"path": "v2/userStates",
- "id": "partners.userStates.list"
- }
- }
- },
- "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.locale": {
- "location": "query",
- "description": "Locale to use for the current request.",
- "type": "string"
- },
- "requestMetadata.userOverrides.ipAddress": {
- "location": "query",
- "description": "IP address to use instead of the user's geo-located IP address.",
- "type": "string"
- },
- "requestMetadata.experimentIds": {
- "repeated": true,
- "location": "query",
- "description": "Experiment IDs the current request belongs to.",
- "type": "string"
- },
- "requestMetadata.trafficSource.trafficSubId": {
- "description": "Second level identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.",
- "type": "string",
- "location": "query"
- },
- "requestMetadata.partnersSessionId": {
- "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"
- },
- "pageToken": {
- "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",
- "location": "query"
- },
- "pageSize": {
- "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",
- "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"
- }
- },
- "flatPath": "v2/analytics",
- "path": "v2/analytics",
- "id": "partners.analytics.list"
+ "id": "partners.userStates.list",
+ "description": "Lists states for current user."
}
}
},
"v2": {
"methods": {
"updateLeads": {
- "description": "Updates the specified lead.",
- "request": {
- "$ref": "Lead"
- },
- "response": {
- "$ref": "Lead"
- },
- "parameterOrder": [],
- "httpMethod": "PATCH",
"parameters": {
- "requestMetadata.userOverrides.userId": {
- "description": "Logged-in user ID to impersonate instead of the user's ID.",
- "type": "string",
- "location": "query"
- },
- "requestMetadata.partnersSessionId": {
- "location": "query",
- "description": "Google Partners session ID.",
- "type": "string"
- },
"requestMetadata.trafficSource.trafficSourceId": {
"description": "Identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.",
"type": "string",
"location": "query"
},
"requestMetadata.locale": {
- "location": "query",
"description": "Locale to use for the current request.",
- "type": "string"
+ "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"
- },
- "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",
+ "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.",
+ "updateMask": {
+ "description": "Standard field mask for the set of fields to be updated.\nRequired with at least 1 value in FieldMask's paths.\nOnly `state` and `adwords_customer_id` are currently supported.",
+ "format": "google-fieldmask",
"type": "string",
- "repeated": true,
"location": "query"
},
+ "requestMetadata.experimentIds": {
+ "repeated": true,
+ "location": "query",
+ "description": "Experiment IDs the current request belongs to.",
+ "type": "string"
+ },
"requestMetadata.trafficSource.trafficSubId": {
"location": "query",
"description": "Second level identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.",
"type": "string"
- }
- },
- "flatPath": "v2/leads",
- "path": "v2/leads",
- "id": "partners.updateLeads"
- },
- "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"
+ "type": "string",
+ "location": "query"
},
"requestMetadata.partnersSessionId": {
"location": "query",
"description": "Google Partners session ID.",
"type": "string"
+ }
+ },
+ "flatPath": "v2/leads",
+ "id": "partners.updateLeads",
+ "path": "v2/leads",
+ "description": "Updates the specified lead.",
+ "request": {
+ "$ref": "Lead"
+ },
+ "httpMethod": "PATCH",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "Lead"
+ }
+ },
+ "updateCompanies": {
+ "path": "v2/companies",
+ "id": "partners.updateCompanies",
+ "request": {
+ "$ref": "Company"
+ },
+ "description": "Update company.\nShould only be called within the context of an authorized logged in user.",
+ "response": {
+ "$ref": "Company"
+ },
+ "parameterOrder": [],
+ "httpMethod": "PATCH",
+ "parameters": {
+ "requestMetadata.partnersSessionId": {
+ "description": "Google Partners session ID.",
+ "type": "string",
+ "location": "query"
+ },
+ "requestMetadata.userOverrides.userId": {
+ "description": "Logged-in user ID to impersonate instead of the user's ID.",
+ "type": "string",
+ "location": "query"
},
"requestMetadata.trafficSource.trafficSourceId": {
- "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"
+ "type": "string",
+ "location": "query"
},
"requestMetadata.locale": {
- "location": "query",
"description": "Locale to use for the current request.",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"requestMetadata.userOverrides.ipAddress": {
"location": "query",
@@ -521,31 +514,28 @@
"location": "query"
}
},
- "flatPath": "v2/companies",
- "id": "partners.updateCompanies",
- "path": "v2/companies",
- "description": "Update company.\nShould only be called within the context of an authorized logged in user.",
- "request": {
- "$ref": "Company"
- }
+ "flatPath": "v2/companies"
},
"getPartnersstatus": {
- "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.",
- "httpMethod": "GET",
"response": {
"$ref": "GetPartnersStatusResponse"
},
"parameterOrder": [],
+ "httpMethod": "GET",
"parameters": {
- "requestMetadata.userOverrides.userId": {
+ "requestMetadata.trafficSource.trafficSubId": {
"location": "query",
- "description": "Logged-in user ID to impersonate instead of the user's ID.",
+ "description": "Second level identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.",
"type": "string"
},
"requestMetadata.partnersSessionId": {
+ "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"
},
@@ -565,46 +555,35 @@
"type": "string"
},
"requestMetadata.experimentIds": {
- "repeated": true,
- "location": "query",
"description": "Experiment IDs the current request belongs to.",
- "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",
+ "repeated": true,
"location": "query"
}
},
- "flatPath": "v2/partnersstatus"
+ "flatPath": "v2/partnersstatus",
+ "path": "v2/partnersstatus",
+ "id": "partners.getPartnersstatus"
}
}
},
"users": {
"methods": {
"createCompanyRelation": {
- "response": {
- "$ref": "CompanyRelation"
- },
- "parameterOrder": [
- "userId"
- ],
- "httpMethod": "PUT",
"parameters": {
- "requestMetadata.experimentIds": {
- "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",
- "repeated": true,
"location": "query"
},
"userId": {
+ "location": "path",
"description": "The ID of the user. Can be set to \u003ccode\u003eme\u003c/code\u003e to mean\nthe currently authenticated user.",
"required": true,
- "type": "string",
- "location": "path"
+ "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.",
+ "requestMetadata.partnersSessionId": {
+ "description": "Google Partners session ID.",
"type": "string",
"location": "query"
},
@@ -613,11 +592,6 @@
"description": "Logged-in user ID to impersonate instead of the user's ID.",
"type": "string"
},
- "requestMetadata.partnersSessionId": {
- "description": "Google Partners session ID.",
- "type": "string",
- "location": "query"
- },
"requestMetadata.trafficSource.trafficSourceId": {
"location": "query",
"description": "Identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.",
@@ -629,154 +603,102 @@
"location": "query"
},
"requestMetadata.userOverrides.ipAddress": {
+ "location": "query",
"description": "IP address to use instead of the user's geo-located IP address.",
- "type": "string",
- "location": "query"
+ "type": "string"
+ },
+ "requestMetadata.experimentIds": {
+ "repeated": true,
+ "location": "query",
+ "description": "Experiment IDs the current request belongs to.",
+ "type": "string"
}
},
"flatPath": "v2/users/{userId}/companyRelation",
- "path": "v2/users/{userId}/companyRelation",
"id": "partners.users.createCompanyRelation",
- "description": "Creates a user's company relation. Affiliates the user to a company.",
+ "path": "v2/users/{userId}/companyRelation",
"request": {
"$ref": "CompanyRelation"
+ },
+ "description": "Creates a user's company relation. Affiliates the user to a company.",
+ "httpMethod": "PUT",
+ "parameterOrder": [
+ "userId"
+ ],
+ "response": {
+ "$ref": "CompanyRelation"
}
},
"deleteCompanyRelation": {
- "description": "Deletes a user's company relation. Unaffiliaites the user from a company.",
- "response": {
- "$ref": "Empty"
- },
+ "httpMethod": "DELETE",
"parameterOrder": [
"userId"
],
- "httpMethod": "DELETE",
+ "response": {
+ "$ref": "Empty"
+ },
"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": {
+ "location": "query",
+ "description": "Locale to use for the current request.",
+ "type": "string"
+ },
+ "requestMetadata.userOverrides.ipAddress": {
+ "description": "IP address to use instead of the user's geo-located IP address.",
+ "type": "string",
+ "location": "query"
+ },
"requestMetadata.experimentIds": {
"description": "Experiment IDs the current request belongs to.",
"type": "string",
"repeated": true,
"location": "query"
},
- "userId": {
- "description": "The ID of the user. Can be set to \u003ccode\u003eme\u003c/code\u003e to mean\nthe currently authenticated user.",
- "required": true,
- "type": "string",
- "location": "path"
- },
"requestMetadata.trafficSource.trafficSubId": {
"location": "query",
"description": "Second level identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.",
"type": "string"
},
- "requestMetadata.partnersSessionId": {
- "description": "Google Partners session ID.",
- "type": "string",
- "location": "query"
+ "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.userOverrides.userId": {
+ "location": "query",
"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": {
+ "requestMetadata.partnersSessionId": {
"location": "query",
- "description": "Locale to use for the current request.",
- "type": "string"
- },
- "requestMetadata.userOverrides.ipAddress": {
- "location": "query",
- "description": "IP address to use instead of the user's geo-located IP address.",
+ "description": "Google Partners session ID.",
"type": "string"
}
},
"flatPath": "v2/users/{userId}/companyRelation",
+ "id": "partners.users.deleteCompanyRelation",
"path": "v2/users/{userId}/companyRelation",
- "id": "partners.users.deleteCompanyRelation"
+ "description": "Deletes a user's company relation. Unaffiliaites the user from a company."
},
"get": {
- "response": {
- "$ref": "User"
- },
- "parameterOrder": [
- "userId"
- ],
- "httpMethod": "GET",
"parameters": {
- "requestMetadata.userOverrides.userId": {
- "location": "query",
- "description": "Logged-in user ID to impersonate instead of the user's ID.",
- "type": "string"
- },
- "requestMetadata.partnersSessionId": {
- "description": "Google Partners session ID.",
+ "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"
},
- "userView": {
- "enum": [
- "BASIC",
- "PROFILE",
- "PUBLIC_PROFILE"
- ],
- "description": "Specifies what parts of the user information to return.",
- "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": {
- "description": "Experiment IDs the current request belongs to.",
- "type": "string",
- "repeated": true,
- "location": "query"
- },
"userId": {
"description": "Identifier of the user. Can be set to \u003ccode\u003eme\u003c/code\u003e to mean the currently\nauthenticated user.",
"required": true,
"type": "string",
"location": "path"
},
- "requestMetadata.trafficSource.trafficSubId": {
- "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}",
- "path": "v2/users/{userId}",
- "id": "partners.users.get",
- "description": "Gets a user."
- },
- "updateProfile": {
- "request": {
- "$ref": "UserProfile"
- },
- "description": "Updates a user's profile. A user can only update their own profile and\nshould only be called within the context of a logged in user.",
- "response": {
- "$ref": "UserProfile"
- },
- "parameterOrder": [],
- "httpMethod": "PATCH",
- "parameters": {
"requestMetadata.userOverrides.userId": {
"location": "query",
"description": "Logged-in user ID to impersonate instead of the user's ID.",
@@ -787,6 +709,83 @@
"description": "Google Partners session 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": {
+ "description": "Identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.",
+ "type": "string",
+ "location": "query"
+ },
+ "requestMetadata.locale": {
+ "description": "Locale to use for the current request.",
+ "type": "string",
+ "location": "query"
+ },
+ "requestMetadata.userOverrides.ipAddress": {
+ "location": "query",
+ "description": "IP address to use instead of the user's geo-located IP address.",
+ "type": "string"
+ },
+ "requestMetadata.experimentIds": {
+ "repeated": true,
+ "location": "query",
+ "description": "Experiment IDs the current request belongs to.",
+ "type": "string"
+ }
+ },
+ "flatPath": "v2/users/{userId}",
+ "id": "partners.users.get",
+ "path": "v2/users/{userId}",
+ "description": "Gets a user.",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "User"
+ },
+ "parameterOrder": [
+ "userId"
+ ]
+ },
+ "updateProfile": {
+ "httpMethod": "PATCH",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "UserProfile"
+ },
+ "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"
+ },
+ "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",
@@ -796,102 +795,58 @@
"location": "query",
"description": "Locale to use for the current request.",
"type": "string"
- },
- "requestMetadata.userOverrides.ipAddress": {
- "description": "IP address to use instead of the user's geo-located IP address.",
- "type": "string",
- "location": "query"
- },
- "requestMetadata.experimentIds": {
- "repeated": true,
- "location": "query",
- "description": "Experiment IDs the current request belongs to.",
- "type": "string"
- },
- "requestMetadata.trafficSource.trafficSubId": {
- "description": "Second level identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.",
- "type": "string",
- "location": "query"
}
},
"flatPath": "v2/users/profile",
+ "id": "partners.users.updateProfile",
"path": "v2/users/profile",
- "id": "partners.users.updateProfile"
+ "description": "Updates a user's profile. A user can only update their own profile and\nshould only be called within the context of a logged in user.",
+ "request": {
+ "$ref": "UserProfile"
+ }
}
}
},
"companies": {
- "resources": {
- "leads": {
- "methods": {
- "create": {
- "id": "partners.companies.leads.create",
- "path": "v2/companies/{companyId}/leads",
- "request": {
- "$ref": "CreateLeadRequest"
- },
- "description": "Creates an advertiser lead for the given company ID.",
- "httpMethod": "POST",
- "parameterOrder": [
- "companyId"
- ],
- "response": {
- "$ref": "CreateLeadResponse"
- },
- "parameters": {
- "companyId": {
- "location": "path",
- "description": "The ID of the company to contact.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v2/companies/{companyId}/leads"
- }
- }
- }
- },
"methods": {
"get": {
- "response": {
- "$ref": "GetCompanyResponse"
- },
+ "id": "partners.companies.get",
+ "path": "v2/companies/{companyId}",
+ "description": "Gets a company.",
+ "httpMethod": "GET",
"parameterOrder": [
"companyId"
],
- "httpMethod": "GET",
+ "response": {
+ "$ref": "GetCompanyResponse"
+ },
"parameters": {
- "requestMetadata.trafficSource.trafficSourceId": {
- "location": "query",
- "description": "Identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.",
- "type": "string"
- },
"requestMetadata.userOverrides.ipAddress": {
"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",
- "location": "path"
+ "type": "string"
},
"currencyCode": {
+ "location": "query",
"description": "If the company's budget is in a different currency code than this one, then\nthe converted budget is converted to this currency code.",
- "type": "string",
- "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.",
+ "type": "string"
},
"requestMetadata.trafficSource.trafficSubId": {
+ "location": "query",
"description": "Second level identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"orderBy": {
"location": "query",
@@ -899,9 +854,9 @@
"type": "string"
},
"requestMetadata.partnersSessionId": {
+ "location": "query",
"description": "Google Partners session ID.",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"requestMetadata.userOverrides.userId": {
"location": "query",
@@ -909,157 +864,49 @@
"type": "string"
},
"view": {
+ "description": "The view of `Company` resource to be returned. This must not be\n`COMPANY_VIEW_UNSPECIFIED`.",
+ "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`.",
- "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.locale": {
+ "location": "query",
"description": "Locale to use for the current request.",
+ "type": "string"
+ },
+ "address": {
+ "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.",
+ "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"
}
},
- "flatPath": "v2/companies/{companyId}",
- "path": "v2/companies/{companyId}",
- "id": "partners.companies.get",
- "description": "Gets a company."
+ "flatPath": "v2/companies/{companyId}"
},
"list": {
- "path": "v2/companies",
- "id": "partners.companies.list",
"description": "Lists companies.",
+ "httpMethod": "GET",
+ "parameterOrder": [],
"response": {
"$ref": "ListCompaniesResponse"
},
- "parameterOrder": [],
- "httpMethod": "GET",
"parameters": {
- "requestMetadata.experimentIds": {
- "repeated": true,
- "location": "query",
- "description": "Experiment IDs the current request belongs to.",
- "type": "string"
- },
- "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"
- },
- "specializations": {
- "enum": [
- "BADGE_SPECIALIZATION_UNKNOWN",
- "BADGE_SPECIALIZATION_ADWORDS_SEARCH",
- "BADGE_SPECIALIZATION_ADWORDS_DISPLAY",
- "BADGE_SPECIALIZATION_ADWORDS_MOBILE",
- "BADGE_SPECIALIZATION_ADWORDS_VIDEO",
- "BADGE_SPECIALIZATION_ADWORDS_SHOPPING"
- ],
- "description": "List of specializations that the returned agencies should provide. If this\nis not empty, any returned agency must have at least one of these\nspecializations, or one of the services in the \"services\" field.",
- "type": "string",
- "repeated": true,
- "location": "query"
- },
- "maxMonthlyBudget.currencyCode": {
- "location": "query",
- "description": "The 3-letter currency code defined in ISO 4217.",
- "type": "string"
- },
- "requestMetadata.userOverrides.userId": {
- "location": "query",
- "description": "Logged-in user ID to impersonate instead of the user's ID.",
- "type": "string"
- },
- "minMonthlyBudget.currencyCode": {
- "location": "query",
- "description": "The 3-letter currency code defined in ISO 4217.",
- "type": "string"
- },
- "view": {
- "location": "query",
- "enum": [
- "COMPANY_VIEW_UNSPECIFIED",
- "CV_GOOGLE_PARTNER_SEARCH"
- ],
- "description": "The view of the `Company` resource to be returned. This must not be\n`COMPANY_VIEW_UNSPECIFIED`.",
- "type": "string"
- },
- "requestMetadata.locale": {
- "description": "Locale to use for the current request.",
- "type": "string",
- "location": "query"
- },
- "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"
- },
- "minMonthlyBudget.units": {
- "description": "The whole units of the amount.\nFor example if `currencyCode` is `\"USD\"`, then 1 unit is one US dollar.",
- "format": "int64",
- "type": "string",
- "location": "query"
- },
- "maxMonthlyBudget.nanos": {
- "location": "query",
- "description": "Number of nano (10^-9) units of the amount.\nThe value must be between -999,999,999 and +999,999,999 inclusive.\nIf `units` is positive, `nanos` must be positive or zero.\nIf `units` is zero, `nanos` can be positive, zero, or negative.\nIf `units` is negative, `nanos` must be negative or zero.\nFor example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.",
- "format": "int32",
- "type": "integer"
- },
- "services": {
- "enum": [
- "SERVICE_UNSPECIFIED",
- "S_ADVANCED_ADWORDS_SUPPORT",
- "S_ADVERTISING_ON_GOOGLE",
- "S_AN_ENHANCED_WEBSITE",
- "S_AN_ONLINE_MARKETING_PLAN",
- "S_MOBILE_AND_VIDEO_ADS",
- "S_MOBILE_WEBSITE_SERVICES"
- ],
- "description": "List of services that the returned agencies should provide. If this is\nnot empty, any returned agency must have at least one of these services,\nor one of the specializations in the \"specializations\" field.",
- "type": "string",
- "repeated": true,
- "location": "query"
- },
- "maxMonthlyBudget.units": {
- "location": "query",
- "description": "The whole units of the amount.\nFor example if `currencyCode` is `\"USD\"`, then 1 unit is one US dollar.",
- "format": "int64",
- "type": "string"
- },
- "requestMetadata.trafficSource.trafficSourceId": {
- "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.trafficSource.trafficSubId": {
- "description": "Second level identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.",
- "type": "string",
- "location": "query"
- },
- "minMonthlyBudget.nanos": {
- "location": "query",
- "description": "Number of nano (10^-9) units of the amount.\nThe value must be between -999,999,999 and +999,999,999 inclusive.\nIf `units` is positive, `nanos` must be positive or zero.\nIf `units` is zero, `nanos` can be positive, zero, or negative.\nIf `units` is negative, `nanos` must be negative or zero.\nFor example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.",
- "format": "int32",
- "type": "integer"
- },
"requestMetadata.partnersSessionId": {
- "location": "query",
"description": "Google Partners session ID.",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"companyName": {
- "location": "query",
"description": "Company name to search for.",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"pageToken": {
"description": "A token identifying a page of results that the server returns.\nTypically, this is the value of `ListCompaniesResponse.next_page_token`\nreturned from the previous call to\nListCompanies.",
@@ -1067,6 +914,8 @@
"location": "query"
},
"industries": {
+ "repeated": true,
+ "location": "query",
"enum": [
"INDUSTRY_UNSPECIFIED",
"I_AUTOMOTIVE",
@@ -1081,131 +930,269 @@
"I_TRAVEL"
],
"description": "List of industries the company can help with.",
- "type": "string",
- "repeated": true,
- "location": "query"
+ "type": "string"
},
"websiteUrl": {
+ "location": "query",
"description": "Website URL that will help to find a better matched company.\n.",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"gpsMotivations": {
+ "description": "List of reasons for using Google Partner Search to get companies.",
+ "type": "string",
+ "repeated": true,
+ "location": "query",
"enum": [
"GPS_MOTIVATION_UNSPECIFIED",
"GPSM_HELP_WITH_ADVERTISING",
"GPSM_HELP_WITH_WEBSITE",
"GPSM_NO_WEBSITE"
- ],
- "description": "List of reasons for using Google Partner Search to get companies.",
- "type": "string",
- "repeated": true,
- "location": "query"
+ ]
},
"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"
+ "location": "query",
+ "description": "List of language codes that company can support. Only primary language\nsubtags are accepted as defined by\n\u003ca href=\"https://tools.ietf.org/html/bcp47\"\u003eBCP 47\u003c/a\u003e\n(IETF BCP 47, \"Tags for Identifying Languages\").",
+ "type": "string"
},
"pageSize": {
+ "location": "query",
"description": "Requested page size. Server may return fewer companies than requested.\nIf unspecified, server picks an appropriate default.",
"format": "int32",
+ "type": "integer"
+ },
+ "requestMetadata.userOverrides.ipAddress": {
+ "description": "IP address to use instead of the user's geo-located IP address.",
+ "type": "string",
+ "location": "query"
+ },
+ "requestMetadata.experimentIds": {
+ "repeated": true,
+ "location": "query",
+ "description": "Experiment IDs the current request belongs to.",
+ "type": "string"
+ },
+ "orderBy": {
+ "location": "query",
+ "description": "How to order addresses within the returned companies. Currently, only\n`address` and `address desc` is supported which will sorted by closest to\nfarthest in distance from given address and farthest to closest distance\nfrom given address respectively.",
+ "type": "string"
+ },
+ "specializations": {
+ "description": "List of specializations that the returned agencies should provide. If this\nis not empty, any returned agency must have at least one of these\nspecializations, or one of the services in the \"services\" field.",
+ "type": "string",
+ "repeated": true,
+ "location": "query",
+ "enum": [
+ "BADGE_SPECIALIZATION_UNKNOWN",
+ "BADGE_SPECIALIZATION_ADWORDS_SEARCH",
+ "BADGE_SPECIALIZATION_ADWORDS_DISPLAY",
+ "BADGE_SPECIALIZATION_ADWORDS_MOBILE",
+ "BADGE_SPECIALIZATION_ADWORDS_VIDEO",
+ "BADGE_SPECIALIZATION_ADWORDS_SHOPPING"
+ ]
+ },
+ "maxMonthlyBudget.currencyCode": {
+ "description": "The 3-letter currency code defined in ISO 4217.",
+ "type": "string",
+ "location": "query"
+ },
+ "minMonthlyBudget.currencyCode": {
+ "description": "The 3-letter currency code defined in ISO 4217.",
+ "type": "string",
+ "location": "query"
+ },
+ "requestMetadata.userOverrides.userId": {
+ "description": "Logged-in user ID to impersonate instead of the user's ID.",
+ "type": "string",
+ "location": "query"
+ },
+ "view": {
+ "location": "query",
+ "enum": [
+ "COMPANY_VIEW_UNSPECIFIED",
+ "CV_GOOGLE_PARTNER_SEARCH"
+ ],
+ "description": "The view of the `Company` resource to be returned. This must not be\n`COMPANY_VIEW_UNSPECIFIED`.",
+ "type": "string"
+ },
+ "address": {
+ "description": "The address to use when searching for companies.\nIf not given, the geo-located address of the request is used.",
+ "type": "string",
+ "location": "query"
+ },
+ "requestMetadata.locale": {
+ "description": "Locale to use for the current request.",
+ "type": "string",
+ "location": "query"
+ },
+ "minMonthlyBudget.units": {
+ "location": "query",
+ "description": "The whole units of the amount.\nFor example if `currencyCode` is `\"USD\"`, then 1 unit is one US dollar.",
+ "format": "int64",
+ "type": "string"
+ },
+ "maxMonthlyBudget.nanos": {
+ "location": "query",
+ "description": "Number of nano (10^-9) units of the amount.\nThe value must be between -999,999,999 and +999,999,999 inclusive.\nIf `units` is positive, `nanos` must be positive or zero.\nIf `units` is zero, `nanos` can be positive, zero, or negative.\nIf `units` is negative, `nanos` must be negative or zero.\nFor example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "services": {
+ "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",
+ "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"
+ ]
+ },
+ "requestMetadata.trafficSource.trafficSourceId": {
+ "location": "query",
+ "description": "Identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.",
+ "type": "string"
+ },
+ "maxMonthlyBudget.units": {
+ "location": "query",
+ "description": "The whole units of the amount.\nFor example if `currencyCode` is `\"USD\"`, then 1 unit is one US dollar.",
+ "format": "int64",
+ "type": "string"
+ },
+ "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"
+ },
+ "minMonthlyBudget.nanos": {
+ "description": "Number of nano (10^-9) units of the amount.\nThe value must be between -999,999,999 and +999,999,999 inclusive.\nIf `units` is positive, `nanos` must be positive or zero.\nIf `units` is zero, `nanos` can be positive, zero, or negative.\nIf `units` is negative, `nanos` must be negative or zero.\nFor example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.",
+ "format": "int32",
"type": "integer",
"location": "query"
- },
- "requestMetadata.userOverrides.ipAddress": {
- "location": "query",
- "description": "IP address to use instead of the user's geo-located IP address.",
- "type": "string"
}
},
- "flatPath": "v2/companies"
+ "flatPath": "v2/companies",
+ "id": "partners.companies.list",
+ "path": "v2/companies"
+ }
+ },
+ "resources": {
+ "leads": {
+ "methods": {
+ "create": {
+ "parameters": {
+ "companyId": {
+ "description": "The ID of the company to contact.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "flatPath": "v2/companies/{companyId}/leads",
+ "id": "partners.companies.leads.create",
+ "path": "v2/companies/{companyId}/leads",
+ "description": "Creates an advertiser lead for the given company ID.",
+ "request": {
+ "$ref": "CreateLeadRequest"
+ },
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "companyId"
+ ],
+ "response": {
+ "$ref": "CreateLeadResponse"
+ }
+ }
+ }
}
}
},
"userEvents": {
"methods": {
"log": {
- "httpMethod": "POST",
- "parameterOrder": [],
- "response": {
- "$ref": "LogUserEventResponse"
- },
- "parameters": {},
- "flatPath": "v2/userEvents:log",
- "id": "partners.userEvents.log",
- "path": "v2/userEvents:log",
+ "description": "Logs a user event.",
"request": {
"$ref": "LogUserEventRequest"
},
- "description": "Logs a user event."
+ "response": {
+ "$ref": "LogUserEventResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "parameters": {},
+ "flatPath": "v2/userEvents:log",
+ "path": "v2/userEvents:log",
+ "id": "partners.userEvents.log"
+ }
+ }
+ },
+ "clientMessages": {
+ "methods": {
+ "log": {
+ "description": "Logs a generic message from the client, such as\n`Failed to render component`, `Profile page is running slow`,\n`More than 500 users have accessed this result.`, etc.",
+ "request": {
+ "$ref": "LogMessageRequest"
+ },
+ "response": {
+ "$ref": "LogMessageResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "parameters": {},
+ "flatPath": "v2/clientMessages:log",
+ "path": "v2/clientMessages:log",
+ "id": "partners.clientMessages.log"
}
}
}
},
"parameters": {
- "quotaUser": {
- "location": "query",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string"
- },
- "pp": {
- "description": "Pretty-print response.",
- "type": "boolean",
- "default": "true",
- "location": "query"
- },
- "bearer_token": {
- "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"
+ "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",
+ "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"
},
"alt": {
+ "description": "Data format for response.",
+ "default": "json",
"enum": [
"json",
"media",
@@ -1217,9 +1204,7 @@
"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"
},
"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.",
@@ -1230,40 +1215,1129 @@
"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"
}
},
"schemas": {
- "ListLeadsResponse": {
- "description": "Response message for ListLeads.",
+ "AnalyticsSummary": {
+ "id": "AnalyticsSummary",
+ "description": "Analytics aggregated data for a `Company` for a given date range.",
+ "type": "object",
+ "properties": {
+ "searchViewsCount": {
+ "description": "Aggregated number of times users saw the `Company`\nin Google Partners Search results for given date range.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "contactsCount": {
+ "description": "Aggregated number of times users contacted the `Company`\nfor given date range.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "profileViewsCount": {
+ "description": "Aggregated number of profile views for the `Company` for given date range.",
+ "format": "int32",
+ "type": "integer"
+ }
+ }
+ },
+ "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"
+ }
+ },
+ "requestMetadata": {
+ "$ref": "RequestMetadata",
+ "description": "Current request metadata."
+ },
+ "level": {
+ "enumDescriptions": [
+ "Unchosen.",
+ "Message level for tracing information.",
+ "Message level for informational messages.",
+ "Message level for potential problems.",
+ "Message level for serious failures."
+ ],
+ "enum": [
+ "MESSAGE_LEVEL_UNSPECIFIED",
+ "ML_FINE",
+ "ML_INFO",
+ "ML_WARNING",
+ "ML_SEVERE"
+ ],
+ "description": "Message level of client message.",
+ "type": "string"
+ },
+ "details": {
+ "description": "Details about the client message.",
+ "type": "string"
+ }
+ },
+ "id": "LogMessageRequest"
+ },
+ "Lead": {
+ "id": "Lead",
+ "description": "A lead resource that represents an advertiser contact for a `Company`. These\nare usually generated via Google Partner Search (the advertiser portal).",
+ "type": "object",
+ "properties": {
+ "adwordsCustomerId": {
+ "description": "The AdWords Customer ID of the lead.",
+ "format": "int64",
+ "type": "string"
+ },
+ "phoneNumber": {
+ "description": "Phone number of lead source.",
+ "type": "string"
+ },
+ "createTime": {
+ "description": "Timestamp of when this lead was created.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "marketingOptIn": {
+ "description": "Whether or not the lead signed up for marketing emails",
+ "type": "boolean"
+ },
+ "type": {
+ "enumDescriptions": [
+ "Unchosen.",
+ "Google Partner Search."
+ ],
+ "enum": [
+ "LEAD_TYPE_UNSPECIFIED",
+ "LT_GPS"
+ ],
+ "description": "Type of lead.",
+ "type": "string"
+ },
+ "givenName": {
+ "description": "First name of lead source.",
+ "type": "string"
+ },
+ "minMonthlyBudget": {
+ "description": "The minimum monthly budget lead source is willing to spend.",
+ "$ref": "Money"
+ },
+ "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"
+ },
+ "websiteUrl": {
+ "description": "Website URL of lead source.",
+ "type": "string"
+ },
+ "gpsMotivations": {
+ "description": "List of reasons for using Google Partner Search and creating a lead.",
+ "type": "array",
+ "items": {
+ "enum": [
+ "GPS_MOTIVATION_UNSPECIFIED",
+ "GPSM_HELP_WITH_ADVERTISING",
+ "GPSM_HELP_WITH_WEBSITE",
+ "GPSM_NO_WEBSITE"
+ ],
+ "type": "string"
+ },
+ "enumDescriptions": [
+ "Unchosen.",
+ "Advertiser needs help with their advertising.",
+ "Advertiser needs help with their website.",
+ "Advertiser does not have a website."
+ ]
+ },
+ "state": {
+ "description": "The lead's state in relation to the company.",
+ "type": "string",
+ "enumDescriptions": [
+ "Unchosen.",
+ "Lead not yet contacted.",
+ "Lead has been contacted.",
+ "Lead has become a client.",
+ "Lead in a state not covered by other options."
+ ],
+ "enum": [
+ "LEAD_STATE_UNSPECIFIED",
+ "LEAD",
+ "CONTACTED",
+ "CLIENT",
+ "OTHER"
+ ]
+ },
+ "email": {
+ "description": "Email address of lead source.",
+ "type": "string"
+ },
+ "familyName": {
+ "description": "Last name of lead source.",
+ "type": "string"
+ },
+ "comments": {
+ "description": "Comments lead source gave.",
+ "type": "string"
+ },
+ "id": {
+ "description": "ID of the lead.",
+ "type": "string"
+ }
+ }
+ },
+ "DebugInfo": {
+ "id": "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"
+ },
+ "serverTraceInfo": {
+ "description": "Server-side debug stack trace.",
+ "type": "string"
+ }
+ }
+ },
+ "ListUserStatesResponse": {
+ "id": "ListUserStatesResponse",
+ "description": "Response message for\nListUserStates.",
+ "type": "object",
+ "properties": {
+ "responseMetadata": {
+ "description": "Current response metadata.",
+ "$ref": "ResponseMetadata"
+ },
+ "userStates": {
+ "description": "User's states.",
+ "type": "array",
+ "items": {
+ "type": "string",
+ "enum": [
+ "USER_STATE_UNSPECIFIED",
+ "US_REQUIRES_RECAPTCHA_FOR_GPS_CONTACT"
+ ]
+ },
+ "enumDescriptions": [
+ "Unchosen.",
+ "User must pass \u003ca href=\"https://www.google.com/recaptcha/\"\u003ereCaptcha\u003c/a\u003e to\ncontact a Partner via Google Partner Search."
+ ]
+ }
+ }
+ },
+ "CompanyRelation": {
+ "description": "A CompanyRelation resource representing information about a user's\naffiliation and standing with a company in Partners.",
+ "type": "object",
+ "properties": {
+ "specializationStatus": {
+ "description": "The list of Google Partners specialization statuses for the company.",
+ "type": "array",
+ "items": {
+ "$ref": "SpecializationStatus"
+ }
+ },
+ "badgeTier": {
+ "enumDescriptions": [
+ "Tier badge is not set.",
+ "Agency has regular partner badge.",
+ "Agency has premier badge."
+ ],
+ "enum": [
+ "BADGE_TIER_NONE",
+ "BADGE_TIER_REGULAR",
+ "BADGE_TIER_PREMIER"
+ ],
+ "description": "Whether the company is a Partner.",
+ "type": "string"
+ },
+ "website": {
+ "description": "The website URL for this company.",
+ "type": "string"
+ },
+ "phoneNumber": {
+ "description": "The phone number for the company's primary address.",
+ "type": "string"
+ },
+ "primaryCountryCode": {
+ "description": "The primary country code of the company.",
+ "type": "string"
+ },
+ "companyId": {
+ "description": "The ID of the company. There may be no id if this is a\npending company.5",
+ "type": "string"
+ },
+ "primaryLanguageCode": {
+ "description": "The primary language code of the company.",
+ "type": "string"
+ },
+ "logoUrl": {
+ "description": "A URL to a profile photo, e.g. a G+ profile photo.",
+ "type": "string"
+ },
+ "resolvedTimestamp": {
+ "description": "The timestamp when the user was approved.\n@OutputOnly",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "companyAdmin": {
+ "description": "Indicates if the user is an admin for this company.",
+ "type": "boolean"
+ },
+ "address": {
+ "description": "The primary address for this company.",
+ "type": "string"
+ },
+ "isPending": {
+ "description": "The flag that indicates if the company is pending verification.",
+ "type": "boolean"
+ },
+ "creationTime": {
+ "description": "The timestamp of when affiliation was requested.\n@OutputOnly",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "state": {
+ "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"
+ ]
+ },
+ "primaryAddress": {
+ "$ref": "Location",
+ "description": "The primary location of the company."
+ },
+ "managerAccount": {
+ "description": "The AdWords manager account # associated this company.",
+ "format": "int64",
+ "type": "string"
+ },
+ "name": {
+ "description": "The name (in the company's primary language) for the company.",
+ "type": "string"
+ },
+ "segment": {
+ "description": "The segment the company is classified as.",
+ "type": "array",
+ "items": {
+ "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"
+ }
+ },
+ "id": "CompanyRelation"
+ },
+ "Date": {
+ "description": "Represents a whole calendar date, e.g. date of birth. The time of day and\ntime zone are either specified elsewhere or are not significant. The date\nis relative to the Proleptic Gregorian Calendar. The day may be 0 to\nrepresent a year and month where the day is not significant, e.g. credit card\nexpiration date. The year may be 0 to represent a month and day independent\nof year, e.g. anniversary date. Related types are google.type.TimeOfDay\nand `google.protobuf.Timestamp`.",
+ "type": "object",
+ "properties": {
+ "year": {
+ "description": "Year of date. Must be from 1 to 9999, or 0 if specifying a date without\na year.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "day": {
+ "description": "Day of month. Must be from 1 to 31 and valid for the year and month, or 0\nif specifying a year/month where the day is not significant.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "month": {
+ "description": "Month of year. Must be from 1 to 12.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "Date"
+ },
+ "Empty": {
+ "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
+ "type": "object",
+ "properties": {},
+ "id": "Empty"
+ },
+ "TrafficSource": {
+ "description": "Source of traffic for the current request.",
+ "type": "object",
+ "properties": {
+ "trafficSourceId": {
+ "description": "Identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.",
+ "type": "string"
+ },
+ "trafficSubId": {
+ "description": "Second level identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.",
+ "type": "string"
+ }
+ },
+ "id": "TrafficSource"
+ },
+ "RequestMetadata": {
+ "id": "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": {
+ "description": "Values to use instead of the user's respective defaults for the current\nrequest. These are only honored by whitelisted products.",
+ "$ref": "UserOverrides"
+ },
+ "partnersSessionId": {
+ "description": "Google Partners session ID.",
+ "type": "string"
+ }
+ }
+ },
+ "CreateLeadRequest": {
+ "description": "Request message for CreateLead.",
+ "type": "object",
+ "properties": {
+ "requestMetadata": {
+ "$ref": "RequestMetadata",
+ "description": "Current request metadata."
+ },
+ "lead": {
+ "$ref": "Lead",
+ "description": "The lead resource. The `LeadType` must not be `LEAD_TYPE_UNSPECIFIED`\nand either `email` or `phone_number` must be provided."
+ },
+ "recaptchaChallenge": {
+ "description": "\u003ca href=\"https://www.google.com/recaptcha/\"\u003ereCaptcha\u003c/a\u003e challenge info.",
+ "$ref": "RecaptchaChallenge"
+ }
+ },
+ "id": "CreateLeadRequest"
+ },
+ "EventData": {
+ "id": "EventData",
+ "description": "Key value data pair for an event.",
+ "type": "object",
+ "properties": {
+ "key": {
+ "description": "Data type.",
+ "type": "string",
+ "enumDescriptions": [
+ "Unchosen.",
+ "Action data.",
+ "Agency ID data.",
+ "Agency name data.",
+ "Agency phone number data.",
+ "Agency website data.",
+ "Budget data.",
+ "Center-point data.",
+ "Certification data.",
+ "Comment data.",
+ "Country data.",
+ "Currency data.",
+ "Currently viewed agency ID data.",
+ "Distance data.",
+ "Distance type data.",
+ "Exam data.",
+ "History token data.",
+ "Identifier data.",
+ "Industry data.",
+ "Insight tag data.",
+ "Language data.",
+ "Location data.",
+ "Marketing opt-in data.",
+ "Query data.",
+ "Search start index data.",
+ "Service data.",
+ "Show vow data.",
+ "Solution data.",
+ "Traffic source ID data.",
+ "Traffic sub ID data.",
+ "Viewport data.",
+ "Website data.",
+ "Details data.",
+ "Experiment ID data.",
+ "Google Partner Search motivation data.",
+ "URL data.",
+ "Element we wanted user to focus on.",
+ "Progress when viewing an item \\[0-100\\]."
+ ],
+ "enum": [
+ "EVENT_DATA_TYPE_UNSPECIFIED",
+ "ACTION",
+ "AGENCY_ID",
+ "AGENCY_NAME",
+ "AGENCY_PHONE_NUMBER",
+ "AGENCY_WEBSITE",
+ "BUDGET",
+ "CENTER_POINT",
+ "CERTIFICATION",
+ "COMMENT",
+ "COUNTRY",
+ "CURRENCY",
+ "CURRENTLY_VIEWED_AGENCY_ID",
+ "DISTANCE",
+ "DISTANCE_TYPE",
+ "EXAM",
+ "HISTORY_TOKEN",
+ "ID",
+ "INDUSTRY",
+ "INSIGHT_TAG",
+ "LANGUAGE",
+ "LOCATION",
+ "MARKETING_OPT_IN",
+ "QUERY",
+ "SEARCH_START_INDEX",
+ "SERVICE",
+ "SHOW_VOW",
+ "SOLUTION",
+ "TRAFFIC_SOURCE_ID",
+ "TRAFFIC_SUB_ID",
+ "VIEW_PORT",
+ "WEBSITE",
+ "DETAILS",
+ "EXPERIMENT_ID",
+ "GPS_MOTIVATION",
+ "URL",
+ "ELEMENT_FOCUS",
+ "PROGRESS"
+ ]
+ },
+ "values": {
+ "description": "Data values.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "ExamStatus": {
+ "description": "A user's information on a specific exam.",
+ "type": "object",
+ "properties": {
+ "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"
+ },
+ "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"
+ ]
+ }
+ },
+ "id": "ExamStatus"
+ },
+ "ListOffersResponse": {
+ "description": "Response for ListOffer.",
+ "type": "object",
+ "properties": {
+ "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"
+ ]
+ },
+ "availableOffers": {
+ "description": "Available Offers to be distributed.",
+ "type": "array",
+ "items": {
+ "$ref": "AvailableOffer"
+ }
+ }
+ },
+ "id": "ListOffersResponse"
+ },
+ "CountryOfferInfo": {
+ "description": "Offer info by country.",
+ "type": "object",
+ "properties": {
+ "offerType": {
+ "description": "Type of offer country is eligible for.",
+ "type": "string",
+ "enumDescriptions": [
+ "Unset.",
+ "AdWords spend X get Y.",
+ "Youtube video.",
+ "Spend Match up to Y."
+ ],
+ "enum": [
+ "OFFER_TYPE_UNSPECIFIED",
+ "OFFER_TYPE_SPEND_X_GET_Y",
+ "OFFER_TYPE_VIDEO",
+ "OFFER_TYPE_SPEND_MATCH"
+ ]
+ },
+ "getYAmount": {
+ "description": "(localized) Get Y amount for that country's offer.",
+ "type": "string"
+ },
+ "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": {
+ "description": "Response message for\nListCompanies.",
+ "type": "object",
+ "properties": {
+ "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"
+ }
+ },
+ "id": "ListCompaniesResponse"
+ },
+ "OfferCustomer": {
+ "description": "Customers qualified for an offer.",
+ "type": "object",
+ "properties": {
+ "adwordsUrl": {
+ "description": "URL to the customer's AdWords page.",
+ "type": "string"
+ },
+ "eligibilityDaysLeft": {
+ "description": "Days the customer is still eligible.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "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 the offer",
+ "type": "string"
+ },
+ "externalCid": {
+ "description": "External CID for the customer.",
+ "format": "int64",
+ "type": "string"
+ },
+ "countryCode": {
+ "description": "Country code of the customer.",
+ "type": "string"
+ },
+ "creationTime": {
+ "description": "Time the customer was created.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "getYAmount": {
+ "description": "Formatted Get Y amount with currency code.",
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of the customer.",
+ "type": "string"
+ },
+ "spendXAmount": {
+ "description": "Formatted Spend X amount with currency code.",
+ "type": "string"
+ }
+ },
+ "id": "OfferCustomer"
+ },
+ "CertificationStatus": {
+ "description": "Google Partners certification status.",
+ "type": "object",
+ "properties": {
+ "examStatuses": {
+ "description": "List of certification exam statuses.",
+ "type": "array",
+ "items": {
+ "$ref": "CertificationExamStatus"
+ }
+ },
+ "type": {
+ "enumDescriptions": [
+ "Unchosen.",
+ "AdWords certified.",
+ "YouTube certified.",
+ "VideoAds certified.",
+ "Analytics certified.",
+ "DoubleClick certified.",
+ "Shopping certified.",
+ "Mobile certified.",
+ "Digital sales certified.",
+ "AdWords Search certified.",
+ "AdWords Display certified.",
+ "Mobile Sites certified."
+ ],
+ "enum": [
+ "CERTIFICATION_TYPE_UNSPECIFIED",
+ "CT_ADWORDS",
+ "CT_YOUTUBE",
+ "CT_VIDEOADS",
+ "CT_ANALYTICS",
+ "CT_DOUBLECLICK",
+ "CT_SHOPPING",
+ "CT_MOBILE",
+ "CT_DIGITAL_SALES",
+ "CT_ADWORDS_SEARCH",
+ "CT_ADWORDS_DISPLAY",
+ "CT_MOBILE_SITES"
+ ],
+ "description": "The type of the certification.",
+ "type": "string"
+ },
+ "userCount": {
+ "description": "Number of people who are certified,",
+ "format": "int32",
+ "type": "integer"
+ },
+ "isCertified": {
+ "description": "Whether certification is passing.",
+ "type": "boolean"
+ }
+ },
+ "id": "CertificationStatus"
+ },
+ "LocalizedCompanyInfo": {
+ "id": "LocalizedCompanyInfo",
+ "description": "The localized company information.",
+ "type": "object",
+ "properties": {
+ "languageCode": {
+ "description": "Language code of the localized company info, as defined by\n\u003ca href=\"https://tools.ietf.org/html/bcp47\"\u003eBCP 47\u003c/a\u003e\n(IETF BCP 47, \"Tags for Identifying Languages\").",
+ "type": "string"
+ },
+ "countryCodes": {
+ "description": "List of country codes for the localized company info.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "overview": {
+ "description": "Localized brief description that the company uses to advertise themselves.",
+ "type": "string"
+ },
+ "displayName": {
+ "description": "Localized display name.",
+ "type": "string"
+ }
+ }
+ },
+ "LogUserEventResponse": {
+ "id": "LogUserEventResponse",
+ "description": "Response message for\nLogUserEvent.",
+ "type": "object",
+ "properties": {
+ "responseMetadata": {
+ "description": "Current response metadata.",
+ "$ref": "ResponseMetadata"
+ }
+ }
+ },
+ "ListOffersHistoryResponse": {
+ "id": "ListOffersHistoryResponse",
+ "description": "Response for ListOfferHistory.",
"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.",
+ "description": "Supply this token in a ListOffersHistoryRequest to retrieve the next page.",
"type": "string"
},
"responseMetadata": {
"description": "Current response metadata.",
"$ref": "ResponseMetadata"
},
- "totalSize": {
- "description": "The total count of leads for the given company.",
+ "canShowEntireCompany": {
+ "description": "True if the user has the option to show entire company history.",
+ "type": "boolean"
+ },
+ "totalResults": {
+ "description": "Number of results across all pages.",
"format": "int32",
"type": "integer"
},
- "leads": {
- "description": "The list of leads.",
+ "showingEntireCompany": {
+ "description": "True if this response is showing entire company history.",
+ "type": "boolean"
+ },
+ "offers": {
+ "description": "Historical offers meeting request.",
"type": "array",
"items": {
- "$ref": "Lead"
+ "$ref": "HistoricalOffer"
}
}
+ }
+ },
+ "LogMessageResponse": {
+ "description": "Response message for\nLogClientMessage.",
+ "type": "object",
+ "properties": {
+ "responseMetadata": {
+ "$ref": "ResponseMetadata",
+ "description": "Current response metadata."
+ }
},
- "id": "ListLeadsResponse"
+ "id": "LogMessageResponse"
+ },
+ "SpecializationStatus": {
+ "description": "Agency specialization status",
+ "type": "object",
+ "properties": {
+ "badgeSpecialization": {
+ "description": "The specialization this status is for.",
+ "type": "string",
+ "enumDescriptions": [
+ "Unknown specialization",
+ "AdWords Search specialization",
+ "AdWords Display specialization",
+ "AdWords Mobile specialization",
+ "AdWords Video specialization",
+ "AdWords Shopping specialization"
+ ],
+ "enum": [
+ "BADGE_SPECIALIZATION_UNKNOWN",
+ "BADGE_SPECIALIZATION_ADWORDS_SEARCH",
+ "BADGE_SPECIALIZATION_ADWORDS_DISPLAY",
+ "BADGE_SPECIALIZATION_ADWORDS_MOBILE",
+ "BADGE_SPECIALIZATION_ADWORDS_VIDEO",
+ "BADGE_SPECIALIZATION_ADWORDS_SHOPPING"
+ ]
+ },
+ "badgeSpecializationState": {
+ "description": "State of agency specialization.",
+ "type": "string",
+ "enumDescriptions": [
+ "Unknown state",
+ "Specialization passed",
+ "Specialization not passed",
+ "Specialization in grace"
+ ],
+ "enum": [
+ "BADGE_SPECIALIZATION_STATE_UNKNOWN",
+ "BADGE_SPECIALIZATION_STATE_PASSED",
+ "BADGE_SPECIALIZATION_STATE_NOT_PASSED",
+ "BADGE_SPECIALIZATION_STATE_IN_GRACE"
+ ]
+ }
+ },
+ "id": "SpecializationStatus"
+ },
+ "Certification": {
+ "id": "Certification",
+ "description": "A user's information on a specific certification.",
+ "type": "object",
+ "properties": {
+ "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": {
+ "enumDescriptions": [
+ "Unchosen.",
+ "AdWords certified.",
+ "YouTube certified.",
+ "VideoAds certified.",
+ "Analytics certified.",
+ "DoubleClick certified.",
+ "Shopping certified.",
+ "Mobile certified.",
+ "Digital sales certified.",
+ "AdWords Search certified.",
+ "AdWords Display certified.",
+ "Mobile Sites certified."
+ ],
+ "enum": [
+ "CERTIFICATION_TYPE_UNSPECIFIED",
+ "CT_ADWORDS",
+ "CT_YOUTUBE",
+ "CT_VIDEOADS",
+ "CT_ANALYTICS",
+ "CT_DOUBLECLICK",
+ "CT_SHOPPING",
+ "CT_MOBILE",
+ "CT_DIGITAL_SALES",
+ "CT_ADWORDS_SEARCH",
+ "CT_ADWORDS_DISPLAY",
+ "CT_MOBILE_SITES"
+ ],
+ "description": "The type of certification, the area of expertise.",
+ "type": "string"
+ },
+ "lastAchieved": {
+ "description": "The date the user last achieved certification.",
+ "format": "google-datetime",
+ "type": "string"
+ }
+ }
+ },
+ "User": {
+ "id": "User",
+ "description": "A resource representing a user of the Partners platform.",
+ "type": "object",
+ "properties": {
+ "profile": {
+ "description": "The profile information of a Partners user, contains all the directly\neditable user information.",
+ "$ref": "UserProfile"
+ },
+ "company": {
+ "$ref": "CompanyRelation",
+ "description": "The company that the user is associated with.\nIf not present, the user is not associated with any company."
+ },
+ "lastAccessTime": {
+ "description": "The most recent time the user interacted with the Partners site.\n@OutputOnly",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "availableAdwordsManagerAccounts": {
+ "description": "This is the list of AdWords Manager Accounts the user has edit access to.\nIf the user has edit access to multiple accounts, the user can choose the\npreferred account and we use this when a personal account is needed. Can\nbe empty meaning the user has access to no accounts.\n@OutputOnly",
+ "type": "array",
+ "items": {
+ "$ref": "AdWordsManagerAccountInfo"
+ }
+ },
+ "primaryEmails": {
+ "description": "The list of emails the user has access to/can select as primary.\n@OutputOnly",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "internalId": {
+ "description": "The internal user ID.\nOnly available for a whitelisted set of api clients.",
+ "type": "string"
+ },
+ "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"
+ }
+ },
+ "id": {
+ "description": "The ID of the user.",
+ "type": "string"
+ },
+ "publicProfile": {
+ "$ref": "PublicProfile",
+ "description": "Information about a user's external public profile outside Google Partners."
+ },
+ "companyVerificationEmail": {
+ "description": "The email address used by the user used for company verification.\n@OutputOnly",
+ "type": "string"
+ },
+ "certificationStatus": {
+ "description": "The list of achieved certifications. These are calculated based on exam\nresults and other requirements.\n@OutputOnly",
+ "type": "array",
+ "items": {
+ "$ref": "Certification"
+ }
+ }
+ }
+ },
+ "ListAnalyticsResponse": {
+ "id": "ListAnalyticsResponse",
+ "description": "Response message for\nListAnalytics.",
+ "type": "object",
+ "properties": {
+ "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": {
+ "description": "Current response metadata.",
+ "$ref": "ResponseMetadata"
+ },
+ "analyticsSummary": {
+ "$ref": "AnalyticsSummary",
+ "description": "Aggregated information across the response's\nanalytics."
+ }
+ }
},
"Company": {
+ "id": "Company",
"description": "A company resource in the Google Partners API. Once certified, it qualifies\nfor being searched by advertisers.",
"type": "object",
"properties": {
+ "ranks": {
+ "description": "Information related to the ranking of the company within the list of\ncompanies.",
+ "type": "array",
+ "items": {
+ "$ref": "Rank"
+ }
+ },
+ "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"
+ },
+ "specializationStatus": {
+ "description": "The list of Google Partners specialization statuses for the company.",
+ "type": "array",
+ "items": {
+ "$ref": "SpecializationStatus"
+ }
+ },
"companyTypes": {
"enumDescriptions": [
"Unchosen.",
@@ -1309,6 +2383,12 @@
"type": "string"
},
"profileStatus": {
+ "enumDescriptions": [
+ "Unchosen.",
+ "Company profile does not show up publicly.",
+ "Company profile can only be viewed by the profile's URL\nand not by Google Partner Search.",
+ "Company profile can be viewed by the profile's URL\nand by Google Partner Search."
+ ],
"enum": [
"COMPANY_PROFILE_STATUS_UNSPECIFIED",
"HIDDEN",
@@ -1316,13 +2396,7 @@
"SEARCHABLE"
],
"description": "The public viewability status of the company's profile.",
- "type": "string",
- "enumDescriptions": [
- "Unchosen.",
- "Company profile does not show up publicly.",
- "Company profile can only be viewed by the profile's URL\nand not by Google Partner Search.",
- "Company profile can be viewed by the profile's URL\nand by Google Partner Search."
- ]
+ "type": "string"
},
"locations": {
"description": "The list of all company locations.\nIf set, must include the\nprimary_location\nin the list.",
@@ -1407,12 +2481,16 @@
}
},
"publicProfile": {
- "description": "Basic information from the company's public profile.",
- "$ref": "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"
},
"primaryLocation": {
- "$ref": "Location",
- "description": "The primary location of the company."
+ "description": "The primary location of the company.",
+ "$ref": "Location"
},
"services": {
"enumDescriptions": [
@@ -1427,6 +2505,7 @@
"description": "Services the company can help with.",
"type": "array",
"items": {
+ "type": "string",
"enum": [
"SERVICE_UNSPECIFIED",
"S_ADVANCED_ADWORDS_SUPPORT",
@@ -1435,51 +2514,42 @@
"S_AN_ONLINE_MARKETING_PLAN",
"S_MOBILE_AND_VIDEO_ADS",
"S_MOBILE_WEBSITE_SERVICES"
- ],
- "type": "string"
- }
- },
- "originalMinMonthlyBudget": {
- "$ref": "Money",
- "description": "The unconverted minimum monthly budget that the company accepts for partner\nbusiness."
- },
- "ranks": {
- "description": "Information related to the ranking of the company within the list of\ncompanies.",
- "type": "array",
- "items": {
- "$ref": "Rank"
- }
- },
- "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"
- },
- "specializationStatus": {
- "description": "The list of Google Partners specialization statuses for the company.",
- "type": "array",
- "items": {
- "$ref": "SpecializationStatus"
+ ]
}
}
- },
- "id": "Company"
+ }
},
- "CreateLeadResponse": {
+ "ListLeadsResponse": {
+ "id": "ListLeadsResponse",
+ "description": "Response message for ListLeads.",
+ "type": "object",
"properties": {
"responseMetadata": {
"description": "Current response metadata.",
"$ref": "ResponseMetadata"
},
+ "totalSize": {
+ "description": "The total count of leads for the given company.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "leads": {
+ "description": "The list of leads.",
+ "type": "array",
+ "items": {
+ "$ref": "Lead"
+ }
+ },
+ "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"
+ }
+ }
+ },
+ "CreateLeadResponse": {
+ "description": "Response message for CreateLead.",
+ "type": "object",
+ "properties": {
"lead": {
"$ref": "Lead",
"description": "Lead that was created depending on the outcome of\n\u003ca href=\"https://www.google.com/recaptcha/\"\u003ereCaptcha\u003c/a\u003e validation."
@@ -1499,53 +2569,34 @@
],
"description": "The outcome of \u003ca href=\"https://www.google.com/recaptcha/\"\u003ereCaptcha\u003c/a\u003e\nvalidation.",
"type": "string"
+ },
+ "responseMetadata": {
+ "$ref": "ResponseMetadata",
+ "description": "Current response metadata."
}
},
- "id": "CreateLeadResponse",
- "description": "Response message for CreateLead.",
- "type": "object"
+ "id": "CreateLeadResponse"
},
"GetCompanyResponse": {
+ "description": "Response message for GetCompany.",
+ "type": "object",
"properties": {
- "responseMetadata": {
- "description": "Current response metadata.",
- "$ref": "ResponseMetadata"
- },
"company": {
"description": "The company.",
"$ref": "Company"
+ },
+ "responseMetadata": {
+ "description": "Current response metadata.",
+ "$ref": "ResponseMetadata"
}
},
- "id": "GetCompanyResponse",
- "description": "Response message for GetCompany.",
- "type": "object"
+ "id": "GetCompanyResponse"
},
"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": {
- "locality": {
- "description": "Generally refers to the city/town portion of an address.",
- "type": "string"
- },
- "administrativeArea": {
- "description": "Top-level administrative subdivision of this country.",
- "type": "string"
- },
- "latLng": {
- "$ref": "LatLng",
- "description": "The latitude and longitude of the location, in degrees."
- },
- "dependentLocality": {
- "description": "Dependent locality or sublocality. Used for UK dependent localities, or\nneighborhoods or boroughs in other locations.",
- "type": "string"
- },
- "address": {
- "description": "The single string version of the address.",
- "type": "string"
- },
- "regionCode": {
- "description": "CLDR (Common Locale Data Repository) region code .",
- "type": "string"
- },
"postalCode": {
"description": "Values are frequently alphanumeric.",
"type": "string"
@@ -1564,13 +2615,82 @@
"items": {
"type": "string"
}
+ },
+ "administrativeArea": {
+ "description": "Top-level administrative subdivision of this country.",
+ "type": "string"
+ },
+ "locality": {
+ "description": "Generally refers to the city/town portion of an address.",
+ "type": "string"
+ },
+ "latLng": {
+ "description": "The latitude and longitude of the location, in degrees.",
+ "$ref": "LatLng"
+ },
+ "regionCode": {
+ "description": "CLDR (Common Locale Data Repository) region code .",
+ "type": "string"
+ },
+ "dependentLocality": {
+ "description": "Dependent locality or sublocality. Used for UK dependent localities, or\nneighborhoods or boroughs in other locations.",
+ "type": "string"
+ },
+ "address": {
+ "description": "The single string version of the address.",
+ "type": "string"
}
- },
- "id": "Location",
- "description": "A location with address and geographic coordinates. May optionally contain a\ndetailed (multi-field) version of the address.",
- "type": "object"
+ }
+ },
+ "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": {
+ "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 the token belongs to.",
+ "type": "string"
+ }
+ }
},
"CertificationExamStatus": {
+ "description": "Status for a Google Partners certification exam.",
+ "type": "object",
"properties": {
"numberUsersPass": {
"description": "The number of people who have passed the certification exam.",
@@ -1608,64 +2728,13 @@
"type": "string"
}
},
- "id": "CertificationExamStatus",
- "description": "Status for a Google Partners certification exam.",
- "type": "object"
- },
- "ExamToken": {
- "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": {
- "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 the token belongs to.",
- "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."
- ]
- }
- },
- "id": "ExamToken",
- "description": "A token that allows a user to take an exam.",
- "type": "object"
+ "id": "CertificationExamStatus"
},
"OptIns": {
+ "id": "OptIns",
"description": "A set of opt-ins for a user.",
"type": "object",
"properties": {
- "performanceSuggestions": {
- "description": "An opt-in about receiving email with customized AdWords campaign management\ntips.",
- "type": "boolean"
- },
"physicalMail": {
"description": "An opt-in to receive special promotional gifts and material in the mail.",
"type": "boolean"
@@ -1681,11 +2750,17 @@
"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"
+ }
},
"Rank": {
+ "id": "Rank",
+ "description": "Information related to ranking of results.",
+ "type": "object",
"properties": {
"type": {
"enumDescriptions": [
@@ -1704,68 +2779,31 @@
"format": "double",
"type": "number"
}
- },
- "id": "Rank",
- "description": "Information related to ranking of results.",
- "type": "object"
+ }
},
"GetPartnersStatusResponse": {
- "properties": {
- "responseMetadata": {
- "description": "Current response metadata.",
- "$ref": "ResponseMetadata"
- }
- },
"id": "GetPartnersStatusResponse",
"description": "Response message for\nGetPartnersStatus.",
- "type": "object"
+ "type": "object",
+ "properties": {
+ "responseMetadata": {
+ "$ref": "ResponseMetadata",
+ "description": "Current response metadata."
+ }
+ }
},
"UserProfile": {
+ "id": "UserProfile",
"description": "The profile information of a Partners user.",
"type": "object",
"properties": {
- "phoneNumber": {
- "description": "The user's phone number.",
- "type": "string"
- },
- "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.",
- "format": "int64",
- "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"
- },
- "profilePublic": {
- "description": "Whether the user's public profile is visible to anyone with the URL.",
- "type": "boolean"
- },
- "channels": {
- "description": "A list of ids representing which channels the user selected they were in.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "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"
+ "$ref": "Location",
+ "description": "The user's mailing address, contains multiple fields."
},
"industries": {
"description": "A list of ids representing which industries the user selected.",
@@ -1799,9 +2837,43 @@
"migrateToAfa": {
"description": "Whether or not to migrate the user's exam data to Academy for Ads.",
"type": "boolean"
+ },
+ "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.",
+ "format": "int64",
+ "type": "string"
+ },
+ "phoneNumber": {
+ "description": "The user's phone number.",
+ "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"
+ }
}
- },
- "id": "UserProfile"
+ }
},
"HistoricalOffer": {
"description": "Historical information about a Google Partners Offer.",
@@ -1863,7 +2935,13 @@
"format": "google-datetime",
"type": "string"
},
+ "clientEmail": {
+ "description": "Email address for client.",
+ "type": "string"
+ },
"status": {
+ "description": "Status of the offer.",
+ "type": "string",
"enumDescriptions": [
"Unset.",
"Offer distributed.",
@@ -1877,21 +2955,47 @@
"OFFER_STATUS_REDEEMED",
"OFFER_STATUS_AWARDED",
"OFFER_STATUS_EXPIRED"
- ],
- "description": "Status of the offer.",
- "type": "string"
- },
- "clientEmail": {
- "description": "Email address for client.",
- "type": "string"
+ ]
}
},
"id": "HistoricalOffer"
},
"LogUserEventRequest": {
+ "id": "LogUserEventRequest",
"description": "Request message for\nLogUserEvent.",
"type": "object",
"properties": {
+ "url": {
+ "description": "The URL where the event occurred.",
+ "type": "string"
+ },
+ "requestMetadata": {
+ "description": "Current request metadata.",
+ "$ref": "RequestMetadata"
+ },
+ "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"
+ ]
+ },
+ "eventDatas": {
+ "description": "List of event data for the event.",
+ "type": "array",
+ "items": {
+ "$ref": "EventData"
+ }
+ },
"eventCategory": {
"enumDescriptions": [
"Unchosen.",
@@ -1933,171 +3037,10 @@
"type": "string"
},
"lead": {
- "description": "Advertiser lead information.",
- "$ref": "Lead"
+ "$ref": "Lead",
+ "description": "Advertiser lead information."
},
"eventAction": {
- "enum": [
- "EVENT_ACTION_UNSPECIFIED",
- "SMB_CLICKED_FIND_A_PARTNER_BUTTON_BOTTOM",
- "SMB_CLICKED_FIND_A_PARTNER_BUTTON_TOP",
- "AGENCY_CLICKED_JOIN_NOW_BUTTON_BOTTOM",
- "AGENCY_CLICKED_JOIN_NOW_BUTTON_TOP",
- "SMB_CANCELED_PARTNER_CONTACT_FORM",
- "SMB_CLICKED_CONTACT_A_PARTNER",
- "SMB_COMPLETED_PARTNER_CONTACT_FORM",
- "SMB_ENTERED_EMAIL_IN_CONTACT_PARTNER_FORM",
- "SMB_ENTERED_NAME_IN_CONTACT_PARTNER_FORM",
- "SMB_ENTERED_PHONE_IN_CONTACT_PARTNER_FORM",
- "SMB_FAILED_RECAPTCHA_IN_CONTACT_PARTNER_FORM",
- "PARTNER_VIEWED_BY_SMB",
- "SMB_CANCELED_PARTNER_CONTACT_FORM_ON_GPS",
- "SMB_CHANGED_A_SEARCH_PARAMETER_TOP",
- "SMB_CLICKED_CONTACT_A_PARTNER_ON_GPS",
- "SMB_CLICKED_SHOW_MORE_PARTNERS_BUTTON_BOTTOM",
- "SMB_COMPLETED_PARTNER_CONTACT_FORM_ON_GPS",
- "SMB_NO_PARTNERS_AVAILABLE_WITH_SEARCH_CRITERIA",
- "SMB_PERFORMED_SEARCH_ON_GPS",
- "SMB_VIEWED_A_PARTNER_ON_GPS",
- "SMB_CANCELED_PARTNER_CONTACT_FORM_ON_PROFILE_PAGE",
- "SMB_CLICKED_CONTACT_A_PARTNER_ON_PROFILE_PAGE",
- "SMB_CLICKED_PARTNER_WEBSITE",
- "SMB_COMPLETED_PARTNER_CONTACT_FORM_ON_PROFILE_PAGE",
- "SMB_VIEWED_A_PARTNER_PROFILE",
- "AGENCY_CLICKED_ACCEPT_TOS_BUTTON",
- "AGENCY_CHANGED_TOS_COUNTRY",
- "AGENCY_ADDED_ADDRESS_IN_MY_PROFILE_PORTAL",
- "AGENCY_ADDED_PHONE_NUMBER_IN_MY_PROFILE_PORTAL",
- "AGENCY_CHANGED_PRIMARY_ACCOUNT_ASSOCIATION",
- "AGENCY_CHANGED_PRIMARY_COUNTRY_ASSOCIATION",
- "AGENCY_CLICKED_AFFILIATE_BUTTON_IN_MY_PROFILE_IN_PORTAL",
- "AGENCY_CLICKED_GIVE_EDIT_ACCESS_IN_MY_PROFILE_PORTAL",
- "AGENCY_CLICKED_LOG_OUT_IN_MY_PROFILE_PORTAL",
- "AGENCY_CLICKED_MY_PROFILE_LEFT_NAV_IN_PORTAL",
- "AGENCY_CLICKED_SAVE_AND_CONTINUE_AT_BOT_OF_COMPLETE_PROFILE",
- "AGENCY_CLICKED_UNAFFILIATE_IN_MY_PROFILE_PORTAL",
- "AGENCY_FILLED_OUT_COMP_AFFILIATION_IN_MY_PROFILE_PORTAL",
- "AGENCY_SUCCESSFULLY_CONNECTED_WITH_COMPANY_IN_MY_PROFILE",
- "AGENCY_CLICKED_CREATE_MCC_IN_MY_PROFILE_PORTAL",
- "AGENCY_DIDNT_HAVE_AN_MCC_ASSOCIATED_ON_COMPLETE_PROFILE",
- "AGENCY_HAD_AN_MCC_ASSOCIATED_ON_COMPLETE_PROFILE",
- "AGENCY_ADDED_JOB_FUNCTION_IN_MY_PROFILE_PORTAL",
- "AGENCY_LOOKED_AT_JOB_FUNCTION_DROP_DOWN",
- "AGENCY_SELECTED_ACCOUNT_MANAGER_AS_JOB_FUNCTION",
- "AGENCY_SELECTED_ACCOUNT_PLANNER_AS_JOB_FUNCTION",
- "AGENCY_SELECTED_ANALYTICS_AS_JOB_FUNCTION",
- "AGENCY_SELECTED_CREATIVE_AS_JOB_FUNCTION",
- "AGENCY_SELECTED_MEDIA_BUYER_AS_JOB_FUNCTION",
- "AGENCY_SELECTED_MEDIA_PLANNER_AS_JOB_FUNCTION",
- "AGENCY_SELECTED_OTHER_AS_JOB_FUNCTION",
- "AGENCY_SELECTED_PRODUCTION_AS_JOB_FUNCTION",
- "AGENCY_SELECTED_SEO_AS_JOB_FUNCTION",
- "AGENCY_SELECTED_SALES_REP_AS_JOB_FUNCTION",
- "AGENCY_SELECTED_SEARCH_SPECIALIST_AS_JOB_FUNCTION",
- "AGENCY_ADDED_CHANNELS_IN_MY_PROFILE_PORTAL",
- "AGENCY_LOOKED_AT_ADD_CHANNEL_DROP_DOWN",
- "AGENCY_SELECTED_CROSS_CHANNEL_FROM_ADD_CHANNEL",
- "AGENCY_SELECTED_DISPLAY_FROM_ADD_CHANNEL",
- "AGENCY_SELECTED_MOBILE_FROM_ADD_CHANNEL",
- "AGENCY_SELECTED_SEARCH_FROM_ADD_CHANNEL",
- "AGENCY_SELECTED_SOCIAL_FROM_ADD_CHANNEL",
- "AGENCY_SELECTED_TOOLS_FROM_ADD_CHANNEL",
- "AGENCY_SELECTED_YOUTUBE_FROM_ADD_CHANNEL",
- "AGENCY_ADDED_INDUSTRIES_IN_MY_PROFILE_PORTAL",
- "AGENCY_CHANGED_ADD_INDUSTRIES_DROP_DOWN",
- "AGENCY_ADDED_MARKETS_IN_MY_PROFILE_PORTAL",
- "AGENCY_CHANGED_ADD_MARKETS_DROP_DOWN",
- "AGENCY_CHECKED_RECIEVE_MAIL_PROMOTIONS_MYPROFILE",
- "AGENCY_CHECKED_RECIEVE_MAIL_PROMOTIONS_SIGNUP",
- "AGENCY_SELECTED_OPT_IN_BETA_TESTS_AND_MKT_RESEARCH",
- "AGENCY_SELECTED_OPT_IN_BETA_TESTS_IN_MY_PROFILE_PORTAL",
- "AGENCY_SELECTED_OPT_IN_NEWS_IN_MY_PROFILE_PORTAL",
- "AGENCY_SELECTED_OPT_IN_NEWS_INVITATIONS_AND_PROMOS",
- "AGENCY_SELECTED_OPT_IN_PERFORMANCE_SUG_IN_MY_PROFILE_PORTAL",
- "AGENCY_SELECTED_OPT_IN_PERFORMANCE_SUGGESTIONS",
- "AGENCY_SELECTED_OPT_IN_SELECT_ALL_EMAIL_NOTIFICATIONS",
- "AGENCY_SELECTED_SELECT_ALL_OPT_INS_IN_MY_PROFILE_PORTAL",
- "AGENCY_CLICKED_BACK_BUTTON_ON_CONNECT_WITH_COMPANY",
- "AGENCY_CLICKED_CONTINUE_TO_OVERVIEW_ON_CONNECT_WITH_COMPANY",
- "AGECNY_CLICKED_CREATE_MCC_CONNECT_WITH_COMPANY_NOT_FOUND",
- "AGECNY_CLICKED_GIVE_EDIT_ACCESS_CONNECT_WITH_COMPANY_NOT_FOUND",
- "AGECNY_CLICKED_LOG_OUT_CONNECT_WITH_COMPANY_NOT_FOUND",
- "AGENCY_CLICKED_SKIP_FOR_NOW_ON_CONNECT_WITH_COMPANY_PAGE",
- "AGENCY_CLOSED_CONNECTED_TO_COMPANY_X_BUTTON_WRONG_COMPANY",
- "AGENCY_COMPLETED_FIELD_CONNECT_WITH_COMPANY",
- "AGECNY_FOUND_COMPANY_TO_CONNECT_WITH",
- "AGENCY_SUCCESSFULLY_CREATED_COMPANY",
- "AGENCY_ADDED_NEW_COMPANY_LOCATION",
- "AGENCY_CLICKED_COMMUNITY_JOIN_NOW_LINK_IN_PORTAL_NOTIFICATIONS",
- "AGENCY_CLICKED_CONNECT_TO_COMPANY_LINK_IN_PORTAL_NOTIFICATIONS",
- "AGENCY_CLICKED_GET_CERTIFIED_LINK_IN_PORTAL_NOTIFICATIONS",
- "AGENCY_CLICKED_GET_VIDEO_ADS_CERTIFIED_LINK_IN_PORTAL_NOTIFICATIONS",
- "AGENCY_CLICKED_LINK_TO_MCC_LINK_IN_PORTAL_NOTIFICATIONS",
- "AGENCY_CLICKED_INSIGHT_CONTENT_IN_PORTAL",
- "AGENCY_CLICKED_INSIGHTS_VIEW_NOW_PITCH_DECKS_IN_PORTAL",
- "AGENCY_CLICKED_INSIGHTS_LEFT_NAV_IN_PORTAL",
- "AGENCY_CLICKED_INSIGHTS_UPLOAD_CONTENT",
- "AGENCY_CLICKED_INSIGHTS_VIEWED_DEPRECATED",
- "AGENCY_CLICKED_COMMUNITY_LEFT_NAV_IN_PORTAL",
- "AGENCY_CLICKED_JOIN_COMMUNITY_BUTTON_COMMUNITY_PORTAL",
- "AGENCY_CLICKED_CERTIFICATIONS_LEFT_NAV_IN_PORTAL",
- "AGENCY_CLICKED_CERTIFICATIONS_PRODUCT_LEFT_NAV_IN_PORTAL",
- "AGENCY_CLICKED_PARTNER_STATUS_LEFT_NAV_IN_PORTAL",
- "AGENCY_CLICKED_PARTNER_STATUS_PRODUCT_LEFT_NAV_IN_PORTAL",
- "AGENCY_CLICKED_OFFERS_LEFT_NAV_IN_PORTAL",
- "AGENCY_CLICKED_SEND_BUTTON_ON_OFFERS_PAGE",
- "AGENCY_CLICKED_EXAM_DETAILS_ON_CERT_ADWORDS_PAGE",
- "AGENCY_CLICKED_SEE_EXAMS_CERTIFICATION_MAIN_PAGE",
- "AGENCY_CLICKED_TAKE_EXAM_ON_CERT_EXAM_PAGE",
- "AGENCY_OPENED_LAST_ADMIN_DIALOG",
- "AGENCY_OPENED_DIALOG_WITH_NO_USERS",
- "AGENCY_PROMOTED_USER_TO_ADMIN",
- "AGENCY_UNAFFILIATED",
- "AGENCY_CHANGED_ROLES",
- "SMB_CLICKED_COMPANY_NAME_LINK_TO_PROFILE",
- "SMB_VIEWED_ADWORDS_CERTIFICATE",
- "SMB_VIEWED_ADWORDS_SEARCH_CERTIFICATE",
- "SMB_VIEWED_ADWORDS_DISPLAY_CERTIFICATE",
- "SMB_CLICKED_ADWORDS_CERTIFICATE_HELP_ICON",
- "SMB_VIEWED_ANALYTICS_CERTIFICATE",
- "SMB_VIEWED_DOUBLECLICK_CERTIFICATE",
- "SMB_VIEWED_MOBILE_SITES_CERTIFICATE",
- "SMB_VIEWED_VIDEO_ADS_CERTIFICATE",
- "SMB_VIEWED_SHOPPING_CERTIFICATE",
- "SMB_CLICKED_VIDEO_ADS_CERTIFICATE_HELP_ICON",
- "SMB_VIEWED_DIGITAL_SALES_CERTIFICATE",
- "CLICKED_HELP_AT_BOTTOM",
- "CLICKED_HELP_AT_TOP",
- "CLIENT_ERROR",
- "AGENCY_CLICKED_LEFT_NAV_STORIES",
- "CLICKED",
- "SMB_VIEWED_MOBILE_CERTIFICATE",
- "AGENCY_FAILED_COMPANY_VERIFICATION",
- "VISITED_LANDING",
- "VISITED_GPS",
- "VISITED_AGENCY_PORTAL",
- "CANCELLED_INDIVIDUAL_SIGN_UP",
- "CANCELLED_COMPANY_SIGN_UP",
- "AGENCY_CLICKED_SIGN_IN_BUTTON_TOP",
- "AGENCY_CLICKED_SAVE_AND_CONTINUE_AT_BOT_OF_INCOMPLETE_PROFILE",
- "AGENCY_UNSELECTED_OPT_IN_NEWS_INVITATIONS_AND_PROMOS",
- "AGENCY_UNSELECTED_OPT_IN_BETA_TESTS_AND_MKT_RESEARCH",
- "AGENCY_UNSELECTED_OPT_IN_PERFORMANCE_SUGGESTIONS",
- "AGENCY_SELECTED_OPT_OUT_UNSELECT_ALL_EMAIL_NOTIFICATIONS",
- "AGENCY_LINKED_INDIVIDUAL_MCC",
- "AGENCY_SUGGESTED_TO_USER",
- "AGENCY_IGNORED_SUGGESTED_AGENCIES_AND_SEARCHED",
- "AGENCY_PICKED_SUGGESTED_AGENCY",
- "AGENCY_SEARCHED_FOR_AGENCIES",
- "AGENCY_PICKED_SEARCHED_AGENCY",
- "AGENCY_DISMISSED_AFFILIATION_WIDGET",
- "AGENCY_CLICKED_INSIGHTS_DOWNLOAD_CONTENT",
- "AGENCY_PROGRESS_INSIGHTS_VIEW_CONTENT",
- "AGENCY_CLICKED_CANCEL_ACCEPT_TOS_BUTTON",
- "SMB_ENTERED_WEBSITE_IN_CONTACT_PARTNER_FORM",
- "AGENCY_SELECTED_OPT_IN_AFA_MIGRATION",
- "AGENCY_SELECTED_OPT_OUT_AFA_MIGRATION"
- ],
"description": "The action that occurred.",
"type": "string",
"enumDescriptions": [
@@ -2260,43 +3203,175 @@
"Advertiser entered website in contact form.",
"Agency opted in for migrating their exams to Academy for Ads.",
"Agency opted out for migrating their exams to Academy for Ads."
- ]
- },
- "url": {
- "description": "The URL where the event occurred.",
- "type": "string"
- },
- "requestMetadata": {
- "$ref": "RequestMetadata",
- "description": "Current request metadata."
- },
- "eventDatas": {
- "description": "List of event data for the event.",
- "type": "array",
- "items": {
- "$ref": "EventData"
- }
- },
- "eventScope": {
- "enumDescriptions": [
- "Unchosen.",
- "Based on visitor.",
- "Based on session.",
- "Based on page visit."
],
"enum": [
- "EVENT_SCOPE_UNSPECIFIED",
- "VISITOR",
- "SESSION",
- "PAGE"
- ],
- "description": "The scope of the event.",
- "type": "string"
+ "EVENT_ACTION_UNSPECIFIED",
+ "SMB_CLICKED_FIND_A_PARTNER_BUTTON_BOTTOM",
+ "SMB_CLICKED_FIND_A_PARTNER_BUTTON_TOP",
+ "AGENCY_CLICKED_JOIN_NOW_BUTTON_BOTTOM",
+ "AGENCY_CLICKED_JOIN_NOW_BUTTON_TOP",
+ "SMB_CANCELED_PARTNER_CONTACT_FORM",
+ "SMB_CLICKED_CONTACT_A_PARTNER",
+ "SMB_COMPLETED_PARTNER_CONTACT_FORM",
+ "SMB_ENTERED_EMAIL_IN_CONTACT_PARTNER_FORM",
+ "SMB_ENTERED_NAME_IN_CONTACT_PARTNER_FORM",
+ "SMB_ENTERED_PHONE_IN_CONTACT_PARTNER_FORM",
+ "SMB_FAILED_RECAPTCHA_IN_CONTACT_PARTNER_FORM",
+ "PARTNER_VIEWED_BY_SMB",
+ "SMB_CANCELED_PARTNER_CONTACT_FORM_ON_GPS",
+ "SMB_CHANGED_A_SEARCH_PARAMETER_TOP",
+ "SMB_CLICKED_CONTACT_A_PARTNER_ON_GPS",
+ "SMB_CLICKED_SHOW_MORE_PARTNERS_BUTTON_BOTTOM",
+ "SMB_COMPLETED_PARTNER_CONTACT_FORM_ON_GPS",
+ "SMB_NO_PARTNERS_AVAILABLE_WITH_SEARCH_CRITERIA",
+ "SMB_PERFORMED_SEARCH_ON_GPS",
+ "SMB_VIEWED_A_PARTNER_ON_GPS",
+ "SMB_CANCELED_PARTNER_CONTACT_FORM_ON_PROFILE_PAGE",
+ "SMB_CLICKED_CONTACT_A_PARTNER_ON_PROFILE_PAGE",
+ "SMB_CLICKED_PARTNER_WEBSITE",
+ "SMB_COMPLETED_PARTNER_CONTACT_FORM_ON_PROFILE_PAGE",
+ "SMB_VIEWED_A_PARTNER_PROFILE",
+ "AGENCY_CLICKED_ACCEPT_TOS_BUTTON",
+ "AGENCY_CHANGED_TOS_COUNTRY",
+ "AGENCY_ADDED_ADDRESS_IN_MY_PROFILE_PORTAL",
+ "AGENCY_ADDED_PHONE_NUMBER_IN_MY_PROFILE_PORTAL",
+ "AGENCY_CHANGED_PRIMARY_ACCOUNT_ASSOCIATION",
+ "AGENCY_CHANGED_PRIMARY_COUNTRY_ASSOCIATION",
+ "AGENCY_CLICKED_AFFILIATE_BUTTON_IN_MY_PROFILE_IN_PORTAL",
+ "AGENCY_CLICKED_GIVE_EDIT_ACCESS_IN_MY_PROFILE_PORTAL",
+ "AGENCY_CLICKED_LOG_OUT_IN_MY_PROFILE_PORTAL",
+ "AGENCY_CLICKED_MY_PROFILE_LEFT_NAV_IN_PORTAL",
+ "AGENCY_CLICKED_SAVE_AND_CONTINUE_AT_BOT_OF_COMPLETE_PROFILE",
+ "AGENCY_CLICKED_UNAFFILIATE_IN_MY_PROFILE_PORTAL",
+ "AGENCY_FILLED_OUT_COMP_AFFILIATION_IN_MY_PROFILE_PORTAL",
+ "AGENCY_SUCCESSFULLY_CONNECTED_WITH_COMPANY_IN_MY_PROFILE",
+ "AGENCY_CLICKED_CREATE_MCC_IN_MY_PROFILE_PORTAL",
+ "AGENCY_DIDNT_HAVE_AN_MCC_ASSOCIATED_ON_COMPLETE_PROFILE",
+ "AGENCY_HAD_AN_MCC_ASSOCIATED_ON_COMPLETE_PROFILE",
+ "AGENCY_ADDED_JOB_FUNCTION_IN_MY_PROFILE_PORTAL",
+ "AGENCY_LOOKED_AT_JOB_FUNCTION_DROP_DOWN",
+ "AGENCY_SELECTED_ACCOUNT_MANAGER_AS_JOB_FUNCTION",
+ "AGENCY_SELECTED_ACCOUNT_PLANNER_AS_JOB_FUNCTION",
+ "AGENCY_SELECTED_ANALYTICS_AS_JOB_FUNCTION",
+ "AGENCY_SELECTED_CREATIVE_AS_JOB_FUNCTION",
+ "AGENCY_SELECTED_MEDIA_BUYER_AS_JOB_FUNCTION",
+ "AGENCY_SELECTED_MEDIA_PLANNER_AS_JOB_FUNCTION",
+ "AGENCY_SELECTED_OTHER_AS_JOB_FUNCTION",
+ "AGENCY_SELECTED_PRODUCTION_AS_JOB_FUNCTION",
+ "AGENCY_SELECTED_SEO_AS_JOB_FUNCTION",
+ "AGENCY_SELECTED_SALES_REP_AS_JOB_FUNCTION",
+ "AGENCY_SELECTED_SEARCH_SPECIALIST_AS_JOB_FUNCTION",
+ "AGENCY_ADDED_CHANNELS_IN_MY_PROFILE_PORTAL",
+ "AGENCY_LOOKED_AT_ADD_CHANNEL_DROP_DOWN",
+ "AGENCY_SELECTED_CROSS_CHANNEL_FROM_ADD_CHANNEL",
+ "AGENCY_SELECTED_DISPLAY_FROM_ADD_CHANNEL",
+ "AGENCY_SELECTED_MOBILE_FROM_ADD_CHANNEL",
+ "AGENCY_SELECTED_SEARCH_FROM_ADD_CHANNEL",
+ "AGENCY_SELECTED_SOCIAL_FROM_ADD_CHANNEL",
+ "AGENCY_SELECTED_TOOLS_FROM_ADD_CHANNEL",
+ "AGENCY_SELECTED_YOUTUBE_FROM_ADD_CHANNEL",
+ "AGENCY_ADDED_INDUSTRIES_IN_MY_PROFILE_PORTAL",
+ "AGENCY_CHANGED_ADD_INDUSTRIES_DROP_DOWN",
+ "AGENCY_ADDED_MARKETS_IN_MY_PROFILE_PORTAL",
+ "AGENCY_CHANGED_ADD_MARKETS_DROP_DOWN",
+ "AGENCY_CHECKED_RECIEVE_MAIL_PROMOTIONS_MYPROFILE",
+ "AGENCY_CHECKED_RECIEVE_MAIL_PROMOTIONS_SIGNUP",
+ "AGENCY_SELECTED_OPT_IN_BETA_TESTS_AND_MKT_RESEARCH",
+ "AGENCY_SELECTED_OPT_IN_BETA_TESTS_IN_MY_PROFILE_PORTAL",
+ "AGENCY_SELECTED_OPT_IN_NEWS_IN_MY_PROFILE_PORTAL",
+ "AGENCY_SELECTED_OPT_IN_NEWS_INVITATIONS_AND_PROMOS",
+ "AGENCY_SELECTED_OPT_IN_PERFORMANCE_SUG_IN_MY_PROFILE_PORTAL",
+ "AGENCY_SELECTED_OPT_IN_PERFORMANCE_SUGGESTIONS",
+ "AGENCY_SELECTED_OPT_IN_SELECT_ALL_EMAIL_NOTIFICATIONS",
+ "AGENCY_SELECTED_SELECT_ALL_OPT_INS_IN_MY_PROFILE_PORTAL",
+ "AGENCY_CLICKED_BACK_BUTTON_ON_CONNECT_WITH_COMPANY",
+ "AGENCY_CLICKED_CONTINUE_TO_OVERVIEW_ON_CONNECT_WITH_COMPANY",
+ "AGECNY_CLICKED_CREATE_MCC_CONNECT_WITH_COMPANY_NOT_FOUND",
+ "AGECNY_CLICKED_GIVE_EDIT_ACCESS_CONNECT_WITH_COMPANY_NOT_FOUND",
+ "AGECNY_CLICKED_LOG_OUT_CONNECT_WITH_COMPANY_NOT_FOUND",
+ "AGENCY_CLICKED_SKIP_FOR_NOW_ON_CONNECT_WITH_COMPANY_PAGE",
+ "AGENCY_CLOSED_CONNECTED_TO_COMPANY_X_BUTTON_WRONG_COMPANY",
+ "AGENCY_COMPLETED_FIELD_CONNECT_WITH_COMPANY",
+ "AGECNY_FOUND_COMPANY_TO_CONNECT_WITH",
+ "AGENCY_SUCCESSFULLY_CREATED_COMPANY",
+ "AGENCY_ADDED_NEW_COMPANY_LOCATION",
+ "AGENCY_CLICKED_COMMUNITY_JOIN_NOW_LINK_IN_PORTAL_NOTIFICATIONS",
+ "AGENCY_CLICKED_CONNECT_TO_COMPANY_LINK_IN_PORTAL_NOTIFICATIONS",
+ "AGENCY_CLICKED_GET_CERTIFIED_LINK_IN_PORTAL_NOTIFICATIONS",
+ "AGENCY_CLICKED_GET_VIDEO_ADS_CERTIFIED_LINK_IN_PORTAL_NOTIFICATIONS",
+ "AGENCY_CLICKED_LINK_TO_MCC_LINK_IN_PORTAL_NOTIFICATIONS",
+ "AGENCY_CLICKED_INSIGHT_CONTENT_IN_PORTAL",
+ "AGENCY_CLICKED_INSIGHTS_VIEW_NOW_PITCH_DECKS_IN_PORTAL",
+ "AGENCY_CLICKED_INSIGHTS_LEFT_NAV_IN_PORTAL",
+ "AGENCY_CLICKED_INSIGHTS_UPLOAD_CONTENT",
+ "AGENCY_CLICKED_INSIGHTS_VIEWED_DEPRECATED",
+ "AGENCY_CLICKED_COMMUNITY_LEFT_NAV_IN_PORTAL",
+ "AGENCY_CLICKED_JOIN_COMMUNITY_BUTTON_COMMUNITY_PORTAL",
+ "AGENCY_CLICKED_CERTIFICATIONS_LEFT_NAV_IN_PORTAL",
+ "AGENCY_CLICKED_CERTIFICATIONS_PRODUCT_LEFT_NAV_IN_PORTAL",
+ "AGENCY_CLICKED_PARTNER_STATUS_LEFT_NAV_IN_PORTAL",
+ "AGENCY_CLICKED_PARTNER_STATUS_PRODUCT_LEFT_NAV_IN_PORTAL",
+ "AGENCY_CLICKED_OFFERS_LEFT_NAV_IN_PORTAL",
+ "AGENCY_CLICKED_SEND_BUTTON_ON_OFFERS_PAGE",
+ "AGENCY_CLICKED_EXAM_DETAILS_ON_CERT_ADWORDS_PAGE",
+ "AGENCY_CLICKED_SEE_EXAMS_CERTIFICATION_MAIN_PAGE",
+ "AGENCY_CLICKED_TAKE_EXAM_ON_CERT_EXAM_PAGE",
+ "AGENCY_OPENED_LAST_ADMIN_DIALOG",
+ "AGENCY_OPENED_DIALOG_WITH_NO_USERS",
+ "AGENCY_PROMOTED_USER_TO_ADMIN",
+ "AGENCY_UNAFFILIATED",
+ "AGENCY_CHANGED_ROLES",
+ "SMB_CLICKED_COMPANY_NAME_LINK_TO_PROFILE",
+ "SMB_VIEWED_ADWORDS_CERTIFICATE",
+ "SMB_VIEWED_ADWORDS_SEARCH_CERTIFICATE",
+ "SMB_VIEWED_ADWORDS_DISPLAY_CERTIFICATE",
+ "SMB_CLICKED_ADWORDS_CERTIFICATE_HELP_ICON",
+ "SMB_VIEWED_ANALYTICS_CERTIFICATE",
+ "SMB_VIEWED_DOUBLECLICK_CERTIFICATE",
+ "SMB_VIEWED_MOBILE_SITES_CERTIFICATE",
+ "SMB_VIEWED_VIDEO_ADS_CERTIFICATE",
+ "SMB_VIEWED_SHOPPING_CERTIFICATE",
+ "SMB_CLICKED_VIDEO_ADS_CERTIFICATE_HELP_ICON",
+ "SMB_VIEWED_DIGITAL_SALES_CERTIFICATE",
+ "CLICKED_HELP_AT_BOTTOM",
+ "CLICKED_HELP_AT_TOP",
+ "CLIENT_ERROR",
+ "AGENCY_CLICKED_LEFT_NAV_STORIES",
+ "CLICKED",
+ "SMB_VIEWED_MOBILE_CERTIFICATE",
+ "AGENCY_FAILED_COMPANY_VERIFICATION",
+ "VISITED_LANDING",
+ "VISITED_GPS",
+ "VISITED_AGENCY_PORTAL",
+ "CANCELLED_INDIVIDUAL_SIGN_UP",
+ "CANCELLED_COMPANY_SIGN_UP",
+ "AGENCY_CLICKED_SIGN_IN_BUTTON_TOP",
+ "AGENCY_CLICKED_SAVE_AND_CONTINUE_AT_BOT_OF_INCOMPLETE_PROFILE",
+ "AGENCY_UNSELECTED_OPT_IN_NEWS_INVITATIONS_AND_PROMOS",
+ "AGENCY_UNSELECTED_OPT_IN_BETA_TESTS_AND_MKT_RESEARCH",
+ "AGENCY_UNSELECTED_OPT_IN_PERFORMANCE_SUGGESTIONS",
+ "AGENCY_SELECTED_OPT_OUT_UNSELECT_ALL_EMAIL_NOTIFICATIONS",
+ "AGENCY_LINKED_INDIVIDUAL_MCC",
+ "AGENCY_SUGGESTED_TO_USER",
+ "AGENCY_IGNORED_SUGGESTED_AGENCIES_AND_SEARCHED",
+ "AGENCY_PICKED_SUGGESTED_AGENCY",
+ "AGENCY_SEARCHED_FOR_AGENCIES",
+ "AGENCY_PICKED_SEARCHED_AGENCY",
+ "AGENCY_DISMISSED_AFFILIATION_WIDGET",
+ "AGENCY_CLICKED_INSIGHTS_DOWNLOAD_CONTENT",
+ "AGENCY_PROGRESS_INSIGHTS_VIEW_CONTENT",
+ "AGENCY_CLICKED_CANCEL_ACCEPT_TOS_BUTTON",
+ "SMB_ENTERED_WEBSITE_IN_CONTACT_PARTNER_FORM",
+ "AGENCY_SELECTED_OPT_IN_AFA_MIGRATION",
+ "AGENCY_SELECTED_OPT_OUT_AFA_MIGRATION"
+ ]
}
- },
- "id": "LogUserEventRequest"
+ }
},
"UserOverrides": {
+ "id": "UserOverrides",
+ "description": "Values to use instead of the user's respective defaults. These are only\nhonored by whitelisted products.",
+ "type": "object",
"properties": {
"userId": {
"description": "Logged-in user ID to impersonate instead of the user's ID.",
@@ -2306,70 +3381,53 @@
"description": "IP address to use instead of the user's geo-located IP address.",
"type": "string"
}
- },
- "id": "UserOverrides",
- "description": "Values to use instead of the user's respective defaults. These are only\nhonored by whitelisted products.",
- "type": "object"
+ }
},
"AnalyticsDataPoint": {
+ "id": "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"
}
- },
- "eventCount": {
- "description": "Number of times the type of event occurred.\nMeaning depends on context (e.g. profile views, contacts, etc.).",
- "format": "int32",
- "type": "integer"
}
- },
- "id": "AnalyticsDataPoint"
+ }
},
"Analytics": {
+ "description": "Analytics data for a `Company` within a single day.",
+ "type": "object",
"properties": {
+ "contacts": {
+ "description": "Instances of users contacting the `Company`\non the specified date.",
+ "$ref": "AnalyticsDataPoint"
+ },
"eventDate": {
"$ref": "Date",
"description": "Date on which these events occurred."
},
"profileViews": {
- "$ref": "AnalyticsDataPoint",
- "description": "Instances of users viewing the `Company` profile\non the specified date."
+ "description": "Instances of users viewing the `Company` profile\non the specified date.",
+ "$ref": "AnalyticsDataPoint"
},
"searchViews": {
"$ref": "AnalyticsDataPoint",
"description": "Instances of users seeing the `Company` in Google Partners Search results\non the specified date."
- },
- "contacts": {
- "description": "Instances of users contacting the `Company`\non the specified date.",
- "$ref": "AnalyticsDataPoint"
}
},
- "id": "Analytics",
- "description": "Analytics data for a `Company` within a single day.",
- "type": "object"
- },
- "AdWordsManagerAccountInfo": {
- "properties": {
- "id": {
- "description": "The AdWords Manager Account id.",
- "format": "int64",
- "type": "string"
- },
- "customerName": {
- "description": "Name of the customer this account represents.",
- "type": "string"
- }
- },
- "id": "AdWordsManagerAccountInfo",
- "description": "Information about a particular AdWords Manager Account.\nRead more at https://support.google.com/adwords/answer/6139186",
- "type": "object"
+ "id": "Analytics"
},
"PublicProfile": {
+ "description": "Basic information from a public profile.",
+ "type": "object",
"properties": {
"profileImage": {
"description": "The URL to the main profile image of the public profile.",
@@ -2392,81 +3450,54 @@
"type": "string"
}
},
- "id": "PublicProfile",
- "description": "Basic information from a public profile.",
- "type": "object"
+ "id": "PublicProfile"
+ },
+ "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": "AdWordsManagerAccountInfo"
},
"ResponseMetadata": {
+ "id": "ResponseMetadata",
+ "description": "Common data that is in each API response.",
+ "type": "object",
"properties": {
"debugInfo": {
"$ref": "DebugInfo",
"description": "Debug information about this request."
}
- },
- "id": "ResponseMetadata",
- "description": "Common data that is in each API response.",
- "type": "object"
+ }
},
"RecaptchaChallenge": {
+ "description": "\u003ca href=\"https://www.google.com/recaptcha/\"\u003ereCaptcha\u003c/a\u003e challenge info.",
+ "type": "object",
"properties": {
- "response": {
- "description": "The response to the reCaptcha challenge.",
- "type": "string"
- },
"id": {
"description": "The ID of the reCaptcha challenge.",
"type": "string"
+ },
+ "response": {
+ "description": "The response to the reCaptcha challenge.",
+ "type": "string"
}
},
- "id": "RecaptchaChallenge",
- "description": "\u003ca href=\"https://www.google.com/recaptcha/\"\u003ereCaptcha\u003c/a\u003e challenge info.",
- "type": "object"
+ "id": "RecaptchaChallenge"
},
"AvailableOffer": {
"description": "Available Offers to be distributed.",
"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.",
- "type": "string"
- },
- "maxAccountAge": {
- "description": "The maximum age of an account [in days] to be eligible.",
- "format": "int32",
- "type": "integer"
- },
- "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"
@@ -2514,28 +3545,72 @@
"items": {
"$ref": "CountryOfferInfo"
}
+ },
+ "offerType": {
+ "enumDescriptions": [
+ "Unset.",
+ "AdWords spend X get Y.",
+ "Youtube video.",
+ "Spend Match up to Y."
+ ],
+ "enum": [
+ "OFFER_TYPE_UNSPECIFIED",
+ "OFFER_TYPE_SPEND_X_GET_Y",
+ "OFFER_TYPE_VIDEO",
+ "OFFER_TYPE_SPEND_MATCH"
+ ],
+ "description": "Type of offer.",
+ "type": "string"
+ },
+ "maxAccountAge": {
+ "description": "The maximum age of an account [in days] to be eligible.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "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"
}
},
"id": "AvailableOffer"
},
"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",
- "description": "An object representing a latitude/longitude pair. This is expressed as a pair\nof doubles representing degrees latitude and degrees longitude. Unless\nspecified otherwise, this must conform to the\n\u003ca href=\"http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf\"\u003eWGS84\nstandard\u003c/a\u003e. Values must be within normalized ranges.",
- "type": "object"
+ }
},
"Money": {
+ "id": "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.",
@@ -2551,1082 +3626,13 @@
"format": "int32",
"type": "integer"
}
- },
- "id": "Money",
- "description": "Represents an amount of money with its currency type.",
- "type": "object"
- },
- "AnalyticsSummary": {
- "description": "Analytics aggregated data for a `Company` for a given date range.",
- "type": "object",
- "properties": {
- "searchViewsCount": {
- "description": "Aggregated number of times users saw the `Company`\nin Google Partners Search results for given date range.",
- "format": "int32",
- "type": "integer"
- },
- "contactsCount": {
- "description": "Aggregated number of times users contacted the `Company`\nfor given date range.",
- "format": "int32",
- "type": "integer"
- },
- "profileViewsCount": {
- "description": "Aggregated number of profile views for the `Company` for given date range.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "AnalyticsSummary"
- },
- "LogMessageRequest": {
- "description": "Request message for\nLogClientMessage.",
- "type": "object",
- "properties": {
- "clientInfo": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "Map of client info, such as URL, browser navigator, browser platform, etc.",
- "type": "object"
- },
- "requestMetadata": {
- "description": "Current request metadata.",
- "$ref": "RequestMetadata"
- },
- "level": {
- "enumDescriptions": [
- "Unchosen.",
- "Message level for tracing information.",
- "Message level for informational messages.",
- "Message level for potential problems.",
- "Message level for serious failures."
- ],
- "enum": [
- "MESSAGE_LEVEL_UNSPECIFIED",
- "ML_FINE",
- "ML_INFO",
- "ML_WARNING",
- "ML_SEVERE"
- ],
- "description": "Message level of client message.",
- "type": "string"
- },
- "details": {
- "description": "Details about the client message.",
- "type": "string"
- }
- },
- "id": "LogMessageRequest"
- },
- "Lead": {
- "properties": {
- "websiteUrl": {
- "description": "Website URL of lead source.",
- "type": "string"
- },
- "languageCode": {
- "description": "Language code of the lead's language preference, as defined by\n\u003ca href=\"https://tools.ietf.org/html/bcp47\"\u003eBCP 47\u003c/a\u003e\n(IETF BCP 47, \"Tags for Identifying Languages\").",
- "type": "string"
- },
- "state": {
- "enum": [
- "LEAD_STATE_UNSPECIFIED",
- "LEAD",
- "CONTACTED",
- "CLIENT",
- "OTHER"
- ],
- "description": "The lead's state in relation to the company.",
- "type": "string",
- "enumDescriptions": [
- "Unchosen.",
- "Lead not yet contacted.",
- "Lead has been contacted.",
- "Lead has become a client.",
- "Lead in a state not covered by other options."
- ]
- },
- "gpsMotivations": {
- "description": "List of reasons for using Google Partner Search and creating a lead.",
- "type": "array",
- "items": {
- "enum": [
- "GPS_MOTIVATION_UNSPECIFIED",
- "GPSM_HELP_WITH_ADVERTISING",
- "GPSM_HELP_WITH_WEBSITE",
- "GPSM_NO_WEBSITE"
- ],
- "type": "string"
- },
- "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.",
- "type": "string"
- },
- "familyName": {
- "description": "Last name of lead source.",
- "type": "string"
- },
- "comments": {
- "description": "Comments lead source gave.",
- "type": "string"
- },
- "id": {
- "description": "ID of the lead.",
- "type": "string"
- },
- "phoneNumber": {
- "description": "Phone number of lead source.",
- "type": "string"
- },
- "adwordsCustomerId": {
- "description": "The AdWords Customer ID of the lead.",
- "format": "int64",
- "type": "string"
- },
- "createTime": {
- "description": "Timestamp of when this lead was created.",
- "format": "google-datetime",
- "type": "string"
- },
- "marketingOptIn": {
- "description": "Whether or not the lead signed up for marketing emails",
- "type": "boolean"
- },
- "type": {
- "enumDescriptions": [
- "Unchosen.",
- "Google Partner Search."
- ],
- "enum": [
- "LEAD_TYPE_UNSPECIFIED",
- "LT_GPS"
- ],
- "description": "Type of lead.",
- "type": "string"
- },
- "givenName": {
- "description": "First name of lead source.",
- "type": "string"
- },
- "minMonthlyBudget": {
- "description": "The minimum monthly budget lead source is willing to spend.",
- "$ref": "Money"
- }
- },
- "id": "Lead",
- "description": "A lead resource that represents an advertiser contact for a `Company`. These\nare usually generated via Google Partner Search (the advertiser portal).",
- "type": "object"
- },
- "DebugInfo": {
- "properties": {
- "serverInfo": {
- "description": "Info about the server that serviced this request.",
- "type": "string"
- },
- "serverTraceInfo": {
- "description": "Server-side debug stack trace.",
- "type": "string"
- },
- "serviceUrl": {
- "description": "URL of the service that handled this request.",
- "type": "string"
- }
- },
- "id": "DebugInfo",
- "description": "Debug information about this request.",
- "type": "object"
- },
- "ListUserStatesResponse": {
- "description": "Response message for\nListUserStates.",
- "type": "object",
- "properties": {
- "userStates": {
- "enumDescriptions": [
- "Unchosen.",
- "User must pass \u003ca href=\"https://www.google.com/recaptcha/\"\u003ereCaptcha\u003c/a\u003e to\ncontact a Partner via Google Partner Search."
- ],
- "description": "User's states.",
- "type": "array",
- "items": {
- "enum": [
- "USER_STATE_UNSPECIFIED",
- "US_REQUIRES_RECAPTCHA_FOR_GPS_CONTACT"
- ],
- "type": "string"
- }
- },
- "responseMetadata": {
- "$ref": "ResponseMetadata",
- "description": "Current response metadata."
- }
- },
- "id": "ListUserStatesResponse"
- },
- "CompanyRelation": {
- "properties": {
- "primaryAddress": {
- "description": "The primary location of the company.",
- "$ref": "Location"
- },
- "state": {
- "enumDescriptions": [
- "Default unspecified value.",
- "User has filled in a request to be associated with an company.\nNow waiting email confirmation.",
- "Pending approval from company.\nEmail confirmation will not approve this one.",
- "Approved by company."
- ],
- "enum": [
- "USER_COMPANY_REATION_STATE_NONE_SPECIFIED",
- "USER_COMPANY_RELATION_STATE_AWAIT_EMAIL",
- "USER_COMPANY_RELATION_STATE_AWAIT_ADMIN",
- "USER_COMPANY_RELATION_STATE_APPROVED"
- ],
- "description": "The state of relationship, in terms of approvals.",
- "type": "string"
- },
- "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": {
- "enum": [
- "COMPANY_SEGMENT_UNKNOWN",
- "COMPANY_SEGMENT_NAL",
- "COMPANY_SEGMENT_PSP",
- "COMPANY_SEGMENT_PPSP"
- ],
- "type": "string"
- },
- "enumDescriptions": [
- "Default segment indicates an unknown.",
- "Segment representing a selected group of Partners",
- "Segment representing Premier SMB Partners, an AdWords partnership program.",
- "A segment of Premier SMB Partners that have relationship with Google."
- ]
- },
- "internalCompanyId": {
- "description": "The internal company ID.\nOnly available for a whitelisted set of api clients.",
- "type": "string"
- },
- "badgeTier": {
- "enum": [
- "BADGE_TIER_NONE",
- "BADGE_TIER_REGULAR",
- "BADGE_TIER_PREMIER"
- ],
- "description": "Whether the company is a Partner.",
- "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"
- }
- },
- "phoneNumber": {
- "description": "The phone number for the company's primary address.",
- "type": "string"
- },
- "website": {
- "description": "The website URL for this company.",
- "type": "string"
- },
- "primaryCountryCode": {
- "description": "The primary country code of the company.",
- "type": "string"
- },
- "companyId": {
- "description": "The ID of the company. There may be no id if this is a\npending company.5",
- "type": "string"
- },
- "primaryLanguageCode": {
- "description": "The primary language code of the company.",
- "type": "string"
- },
- "logoUrl": {
- "description": "A URL to a profile photo, e.g. a G+ profile photo.",
- "type": "string"
- },
- "resolvedTimestamp": {
- "description": "The timestamp when the user was approved.\n@OutputOnly",
- "format": "google-datetime",
- "type": "string"
- },
- "companyAdmin": {
- "description": "Indicates if the user is an admin for this company.",
- "type": "boolean"
- },
- "address": {
- "description": "The primary address for this company.",
- "type": "string"
- },
- "isPending": {
- "description": "The flag that indicates if the company is pending verification.",
- "type": "boolean"
- },
- "creationTime": {
- "description": "The timestamp of when affiliation was requested.\n@OutputOnly",
- "format": "google-datetime",
- "type": "string"
- }
- },
- "id": "CompanyRelation",
- "description": "A CompanyRelation resource representing information about a user's\naffiliation and standing with a company in Partners.",
- "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"
- },
- "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": {
- "properties": {
- "trafficSourceId": {
- "description": "Identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.",
- "type": "string"
- },
- "trafficSubId": {
- "description": "Second level identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.",
- "type": "string"
- }
- },
- "id": "TrafficSource",
- "description": "Source of traffic for the current request.",
- "type": "object"
- },
- "RequestMetadata": {
- "description": "Common data that is in each API request.",
- "type": "object",
- "properties": {
- "experimentIds": {
- "description": "Experiment IDs the current request belongs to.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "trafficSource": {
- "description": "Source of traffic for the current request.",
- "$ref": "TrafficSource"
- },
- "locale": {
- "description": "Locale to use for the current request.",
- "type": "string"
- },
- "userOverrides": {
- "description": "Values to use instead of the user's respective defaults for the current\nrequest. These are only honored by whitelisted products.",
- "$ref": "UserOverrides"
- },
- "partnersSessionId": {
- "description": "Google Partners session ID.",
- "type": "string"
- }
- },
- "id": "RequestMetadata"
- },
- "CreateLeadRequest": {
- "properties": {
- "requestMetadata": {
- "$ref": "RequestMetadata",
- "description": "Current request metadata."
- },
- "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",
- "description": "Request message for CreateLead.",
- "type": "object"
- },
- "EventData": {
- "description": "Key value data pair for an event.",
- "type": "object",
- "properties": {
- "key": {
- "enumDescriptions": [
- "Unchosen.",
- "Action data.",
- "Agency ID data.",
- "Agency name data.",
- "Agency phone number data.",
- "Agency website data.",
- "Budget data.",
- "Center-point data.",
- "Certification data.",
- "Comment data.",
- "Country data.",
- "Currency data.",
- "Currently viewed agency ID data.",
- "Distance data.",
- "Distance type data.",
- "Exam data.",
- "History token data.",
- "Identifier data.",
- "Industry data.",
- "Insight tag data.",
- "Language data.",
- "Location data.",
- "Marketing opt-in data.",
- "Query data.",
- "Search start index data.",
- "Service data.",
- "Show vow data.",
- "Solution data.",
- "Traffic source ID data.",
- "Traffic sub ID data.",
- "Viewport data.",
- "Website data.",
- "Details data.",
- "Experiment ID data.",
- "Google Partner Search motivation data.",
- "URL data.",
- "Element we wanted user to focus on.",
- "Progress when viewing an item \\[0-100\\]."
- ],
- "enum": [
- "EVENT_DATA_TYPE_UNSPECIFIED",
- "ACTION",
- "AGENCY_ID",
- "AGENCY_NAME",
- "AGENCY_PHONE_NUMBER",
- "AGENCY_WEBSITE",
- "BUDGET",
- "CENTER_POINT",
- "CERTIFICATION",
- "COMMENT",
- "COUNTRY",
- "CURRENCY",
- "CURRENTLY_VIEWED_AGENCY_ID",
- "DISTANCE",
- "DISTANCE_TYPE",
- "EXAM",
- "HISTORY_TOKEN",
- "ID",
- "INDUSTRY",
- "INSIGHT_TAG",
- "LANGUAGE",
- "LOCATION",
- "MARKETING_OPT_IN",
- "QUERY",
- "SEARCH_START_INDEX",
- "SERVICE",
- "SHOW_VOW",
- "SOLUTION",
- "TRAFFIC_SOURCE_ID",
- "TRAFFIC_SUB_ID",
- "VIEW_PORT",
- "WEBSITE",
- "DETAILS",
- "EXPERIMENT_ID",
- "GPS_MOTIVATION",
- "URL",
- "ELEMENT_FOCUS",
- "PROGRESS"
- ],
- "description": "Data type.",
- "type": "string"
- },
- "values": {
- "description": "Data values.",
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "id": "EventData"
- },
- "ExamStatus": {
- "description": "A user's information on a specific exam.",
- "type": "object",
- "properties": {
- "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": {
- "enum": [
- "CERTIFICATION_EXAM_TYPE_UNSPECIFIED",
- "CET_ADWORDS_FUNDAMENTALS",
- "CET_ADWORDS_ADVANCED_SEARCH",
- "CET_ADWORDS_ADVANCED_DISPLAY",
- "CET_VIDEO_ADS",
- "CET_DOUBLECLICK",
- "CET_ANALYTICS",
- "CET_SHOPPING",
- "CET_MOBILE",
- "CET_DIGITAL_SALES",
- "CET_MOBILE_SITES"
- ],
- "description": "The type of the exam.",
- "type": "string",
- "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."
- ]
- },
- "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": {
- "properties": {
- "availableOffers": {
- "description": "Available Offers to be distributed.",
- "type": "array",
- "items": {
- "$ref": "AvailableOffer"
- }
- },
- "responseMetadata": {
- "$ref": "ResponseMetadata",
- "description": "Current response metadata."
- },
- "noOfferReason": {
- "enumDescriptions": [
- "Unset.",
- "Not an MCC.",
- "Offer limit has been reached.",
- "Ineligible for offers."
- ],
- "enum": [
- "NO_OFFER_REASON_UNSPECIFIED",
- "NO_OFFER_REASON_NO_MCC",
- "NO_OFFER_REASON_LIMIT_REACHED",
- "NO_OFFER_REASON_INELIGIBLE"
- ],
- "description": "Reason why no Offers are available.",
- "type": "string"
- }
- },
- "id": "ListOffersResponse",
- "description": "Response for ListOffer.",
- "type": "object"
- },
- "CountryOfferInfo": {
- "description": "Offer info by country.",
- "type": "object",
- "properties": {
- "offerCountryCode": {
- "description": "Country code for which offer codes may be requested.",
- "type": "string"
- },
- "spendXAmount": {
- "description": "(localized) Spend X amount for that country's offer.",
- "type": "string"
- },
- "offerType": {
- "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",
- "enumDescriptions": [
- "Unset.",
- "AdWords spend X get Y.",
- "Youtube video.",
- "Spend Match up to Y."
- ]
- },
- "getYAmount": {
- "description": "(localized) Get Y amount for that country's offer.",
- "type": "string"
- }
- },
- "id": "CountryOfferInfo"
- },
- "ListCompaniesResponse": {
- "properties": {
- "nextPageToken": {
- "description": "A token to retrieve next page of results.\nPass this value in the `ListCompaniesRequest.page_token` field in the\nsubsequent call to\nListCompanies to retrieve the\nnext page of results.",
- "type": "string"
- },
- "responseMetadata": {
- "description": "Current response metadata.",
- "$ref": "ResponseMetadata"
- },
- "companies": {
- "description": "The list of companies.",
- "type": "array",
- "items": {
- "$ref": "Company"
- }
- }
- },
- "id": "ListCompaniesResponse",
- "description": "Response message for\nListCompanies.",
- "type": "object"
- },
- "OfferCustomer": {
- "properties": {
- "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"
- },
- "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 the offer",
- "type": "string"
- },
- "externalCid": {
- "description": "External CID for the customer.",
- "format": "int64",
- "type": "string"
- },
- "countryCode": {
- "description": "Country code of the customer.",
- "type": "string"
- },
- "creationTime": {
- "description": "Time the customer was created.",
- "format": "google-datetime",
- "type": "string"
- },
- "eligibilityDaysLeft": {
- "description": "Days the customer is still eligible.",
- "format": "int32",
- "type": "integer"
- },
- "getYAmount": {
- "description": "Formatted Get Y amount with currency code.",
- "type": "string"
- }
- },
- "id": "OfferCustomer",
- "description": "Customers qualified for an offer.",
- "type": "object"
- },
- "CertificationStatus": {
- "properties": {
- "userCount": {
- "description": "Number of people who are certified,",
- "format": "int32",
- "type": "integer"
- },
- "isCertified": {
- "description": "Whether certification is passing.",
- "type": "boolean"
- },
- "examStatuses": {
- "description": "List of certification exam statuses.",
- "type": "array",
- "items": {
- "$ref": "CertificationExamStatus"
- }
- },
- "type": {
- "enum": [
- "CERTIFICATION_TYPE_UNSPECIFIED",
- "CT_ADWORDS",
- "CT_YOUTUBE",
- "CT_VIDEOADS",
- "CT_ANALYTICS",
- "CT_DOUBLECLICK",
- "CT_SHOPPING",
- "CT_MOBILE",
- "CT_DIGITAL_SALES",
- "CT_ADWORDS_SEARCH",
- "CT_ADWORDS_DISPLAY",
- "CT_MOBILE_SITES"
- ],
- "description": "The type of the certification.",
- "type": "string",
- "enumDescriptions": [
- "Unchosen.",
- "AdWords certified.",
- "YouTube certified.",
- "VideoAds certified.",
- "Analytics certified.",
- "DoubleClick certified.",
- "Shopping certified.",
- "Mobile certified.",
- "Digital sales certified.",
- "AdWords Search certified.",
- "AdWords Display certified.",
- "Mobile Sites certified."
- ]
- }
- },
- "id": "CertificationStatus",
- "description": "Google Partners certification status.",
- "type": "object"
- },
- "LocalizedCompanyInfo": {
- "properties": {
- "countryCodes": {
- "description": "List of country codes for the localized company info.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "overview": {
- "description": "Localized brief description that the company uses to advertise themselves.",
- "type": "string"
- },
- "displayName": {
- "description": "Localized display name.",
- "type": "string"
- },
- "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"
- }
- },
- "id": "LocalizedCompanyInfo",
- "description": "The localized company information.",
- "type": "object"
- },
- "LogUserEventResponse": {
- "description": "Response message for\nLogUserEvent.",
- "type": "object",
- "properties": {
- "responseMetadata": {
- "description": "Current response metadata.",
- "$ref": "ResponseMetadata"
- }
- },
- "id": "LogUserEventResponse"
- },
- "ListOffersHistoryResponse": {
- "description": "Response for ListOfferHistory.",
- "type": "object",
- "properties": {
- "canShowEntireCompany": {
- "description": "True if the user has the option to show entire company history.",
- "type": "boolean"
- },
- "totalResults": {
- "description": "Number of results across all pages.",
- "format": "int32",
- "type": "integer"
- },
- "showingEntireCompany": {
- "description": "True if this response is showing entire company history.",
- "type": "boolean"
- },
- "offers": {
- "description": "Historical offers meeting request.",
- "type": "array",
- "items": {
- "$ref": "HistoricalOffer"
- }
- },
- "nextPageToken": {
- "description": "Supply this token in a ListOffersHistoryRequest to retrieve the next page.",
- "type": "string"
- },
- "responseMetadata": {
- "$ref": "ResponseMetadata",
- "description": "Current response metadata."
- }
- },
- "id": "ListOffersHistoryResponse"
- },
- "LogMessageResponse": {
- "description": "Response message for\nLogClientMessage.",
- "type": "object",
- "properties": {
- "responseMetadata": {
- "$ref": "ResponseMetadata",
- "description": "Current response metadata."
- }
- },
- "id": "LogMessageResponse"
- },
- "SpecializationStatus": {
- "description": "Agency specialization status",
- "type": "object",
- "properties": {
- "badgeSpecializationState": {
- "enumDescriptions": [
- "Unknown state",
- "Specialization passed",
- "Specialization not passed",
- "Specialization in grace"
- ],
- "enum": [
- "BADGE_SPECIALIZATION_STATE_UNKNOWN",
- "BADGE_SPECIALIZATION_STATE_PASSED",
- "BADGE_SPECIALIZATION_STATE_NOT_PASSED",
- "BADGE_SPECIALIZATION_STATE_IN_GRACE"
- ],
- "description": "State of agency specialization.",
- "type": "string"
- },
- "badgeSpecialization": {
- "enum": [
- "BADGE_SPECIALIZATION_UNKNOWN",
- "BADGE_SPECIALIZATION_ADWORDS_SEARCH",
- "BADGE_SPECIALIZATION_ADWORDS_DISPLAY",
- "BADGE_SPECIALIZATION_ADWORDS_MOBILE",
- "BADGE_SPECIALIZATION_ADWORDS_VIDEO",
- "BADGE_SPECIALIZATION_ADWORDS_SHOPPING"
- ],
- "description": "The specialization this status is for.",
- "type": "string",
- "enumDescriptions": [
- "Unknown specialization",
- "AdWords Search specialization",
- "AdWords Display specialization",
- "AdWords Mobile specialization",
- "AdWords Video specialization",
- "AdWords Shopping specialization"
- ]
- }
- },
- "id": "SpecializationStatus"
- },
- "Certification": {
- "properties": {
- "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": {
- "enum": [
- "CERTIFICATION_TYPE_UNSPECIFIED",
- "CT_ADWORDS",
- "CT_YOUTUBE",
- "CT_VIDEOADS",
- "CT_ANALYTICS",
- "CT_DOUBLECLICK",
- "CT_SHOPPING",
- "CT_MOBILE",
- "CT_DIGITAL_SALES",
- "CT_ADWORDS_SEARCH",
- "CT_ADWORDS_DISPLAY",
- "CT_MOBILE_SITES"
- ],
- "description": "The type of certification, the area of expertise.",
- "type": "string",
- "enumDescriptions": [
- "Unchosen.",
- "AdWords certified.",
- "YouTube certified.",
- "VideoAds certified.",
- "Analytics certified.",
- "DoubleClick certified.",
- "Shopping certified.",
- "Mobile certified.",
- "Digital sales certified.",
- "AdWords Search certified.",
- "AdWords Display certified.",
- "Mobile Sites certified."
- ]
- },
- "lastAchieved": {
- "description": "The date the user last achieved certification.",
- "format": "google-datetime",
- "type": "string"
- }
- },
- "id": "Certification",
- "description": "A user's information on a specific certification.",
- "type": "object"
- },
- "User": {
- "description": "A resource representing a user of the Partners platform.",
- "type": "object",
- "properties": {
- "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"
- }
- },
- "id": {
- "description": "The ID of the user.",
- "type": "string"
- },
- "publicProfile": {
- "$ref": "PublicProfile",
- "description": "Information about a user's external public profile outside Google Partners."
- },
- "companyVerificationEmail": {
- "description": "The email address used by the user used for company verification.\n@OutputOnly",
- "type": "string"
- },
- "certificationStatus": {
- "description": "The list of achieved certifications. These are calculated based on exam\nresults and other requirements.\n@OutputOnly",
- "type": "array",
- "items": {
- "$ref": "Certification"
- }
- },
- "profile": {
- "$ref": "UserProfile",
- "description": "The profile information of a Partners user, contains all the directly\neditable user information."
- },
- "company": {
- "$ref": "CompanyRelation",
- "description": "The company that the user is associated with.\nIf not present, the user is not associated with any company."
- },
- "lastAccessTime": {
- "description": "The most recent time the user interacted with the Partners site.\n@OutputOnly",
- "format": "google-datetime",
- "type": "string"
- },
- "availableAdwordsManagerAccounts": {
- "description": "This is the list of AdWords Manager Accounts the user has edit access to.\nIf the user has edit access to multiple accounts, the user can choose the\npreferred account and we use this when a personal account is needed. Can\nbe empty meaning the user has access to no accounts.\n@OutputOnly",
- "type": "array",
- "items": {
- "$ref": "AdWordsManagerAccountInfo"
- }
- },
- "primaryEmails": {
- "description": "The list of emails the user has access to/can select as primary.\n@OutputOnly",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "internalId": {
- "description": "The internal user ID.\nOnly available for a whitelisted set of api clients.",
- "type": "string"
- }
- },
- "id": "User"
- },
- "ListAnalyticsResponse": {
- "description": "Response message for\nListAnalytics.",
- "type": "object",
- "properties": {
- "nextPageToken": {
- "description": "A token to retrieve next page of results.\nPass this value in the `ListAnalyticsRequest.page_token` field in the\nsubsequent call to\nListAnalytics to retrieve the\nnext page of results.",
- "type": "string"
- },
- "responseMetadata": {
- "$ref": "ResponseMetadata",
- "description": "Current response metadata."
- },
- "analyticsSummary": {
- "description": "Aggregated information across the response's\nanalytics.",
- "$ref": "AnalyticsSummary"
- },
- "analytics": {
- "description": "The list of analytics.\nSorted in ascending order of\nAnalytics.event_date.",
- "type": "array",
- "items": {
- "$ref": "Analytics"
- }
- }
- },
- "id": "ListAnalyticsResponse"
+ }
}
},
"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": "v2",
"baseUrl": "https://partners.googleapis.com/",
@@ -3636,11 +3642,5 @@
"kind": "discovery#restDescription",
"rootUrl": "https://partners.googleapis.com/",
"basePath": "",
- "ownerDomain": "google.com",
- "name": "partners",
- "batchPath": "batch",
- "revision": "20171211",
- "documentationLink": "https://developers.google.com/partners/",
- "id": "partners:v2",
- "title": "Google Partners API"
+ "ownerDomain": "google.com"
}
diff --git a/people/v1/people-api.json b/people/v1/people-api.json
index ce912f1..755177f 100644
--- a/people/v1/people-api.json
+++ b/people/v1/people-api.json
@@ -1,565 +1,332 @@
{
- "title": "Google People API",
- "ownerName": "Google",
- "resources": {
- "people": {
- "methods": {
- "getBatchGet": {
- "response": {
- "$ref": "GetPeopleResponse"
- },
- "parameterOrder": [],
- "httpMethod": "GET",
- "parameters": {
- "personFields": {
- "description": "**Required.** A field mask to restrict which fields on each person are\nreturned. Valid values are:\n\n* addresses\n* ageRanges\n* biographies\n* birthdays\n* braggingRights\n* coverPhotos\n* emailAddresses\n* events\n* genders\n* imClients\n* locales\n* memberships\n* metadata\n* names\n* nicknames\n* occupations\n* organizations\n* phoneNumbers\n* photos\n* relations\n* relationshipInterests\n* relationshipStatuses\n* residences\n* skills\n* taglines\n* urls",
- "format": "google-fieldmask",
- "type": "string",
- "location": "query"
- },
- "requestMask.includeField": {
- "description": "**Required.** Comma-separated list of person fields to be included in the\nresponse. Each path should start with `person.`: for example,\n`person.names` or `person.photos`.",
- "format": "google-fieldmask",
- "type": "string",
- "location": "query"
- },
- "resourceNames": {
- "location": "query",
- "description": "The resource names of the people to provide information about.\n\n- To get information about the authenticated user, specify `people/me`.\n- To get information about a google account, specify\n `people/`\u003cvar\u003eaccount_id\u003c/var\u003e.\n- To get information about a contact, specify the resource name that\n identifies the contact as returned by\n[`people.connections.list`](/people/api/rest/v1/people.connections/list).\n\nYou can include up to 50 resource names in one request.",
- "type": "string",
- "repeated": true
- }
- },
- "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",
- "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",
- "parameters": {
- "resourceName": {
- "pattern": "^people/[^/]+$",
- "location": "path",
- "description": "The resource name of the person to provide information about.\n\n- To get information about the authenticated user, specify `people/me`.\n- To get information about a google account, specify\n `people/`\u003cvar\u003eaccount_id\u003c/var\u003e.\n- To get information about a contact, specify the resource name that\n identifies the contact as returned by\n[`people.connections.list`](/people/api/rest/v1/people.connections/list).",
- "required": true,
- "type": "string"
- },
- "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": {
- "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"
- }
- },
- "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": {
- "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": {
- "description": "The resource name for the person, assigned by the server. An ASCII string\nwith a max length of 27 characters, in the form of\n`people/`\u003cvar\u003eperson_id\u003c/var\u003e.",
- "required": true,
- "type": "string",
- "pattern": "^people/[^/]+$",
- "location": "path"
- },
- "updatePersonFields": {
- "description": "**Required.** A field mask to restrict which fields on the person are\nupdated. Valid values are:\n\n* addresses\n* biographies\n* birthdays\n* braggingRights\n* emailAddresses\n* events\n* genders\n* imClients\n* locales\n* names\n* nicknames\n* occupations\n* organizations\n* phoneNumbers\n* relations\n* residences\n* skills\n* urls",
- "format": "google-fieldmask",
- "type": "string",
- "location": "query"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/contacts"
- ],
- "flatPath": "v1/people/{peopleId}:updateContact",
- "id": "people.people.updateContact",
- "path": "v1/{+resourceName}:updateContact"
- },
- "createContact": {
- "description": "Create a new contact and return the person resource for that contact.",
- "request": {
- "$ref": "Person"
- },
- "response": {
- "$ref": "Person"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/contacts"
- ],
- "parameters": {
- "parent": {
- "location": "query",
- "description": "The resource name of the owning person resource.",
- "type": "string"
- }
- },
- "flatPath": "v1/people:createContact",
- "path": "v1/people:createContact",
- "id": "people.people.createContact"
- },
- "deleteContact": {
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "resourceName"
- ],
- "httpMethod": "DELETE",
- "parameters": {
- "resourceName": {
- "description": "The resource name of the contact to delete.",
- "required": true,
- "type": "string",
- "pattern": "^people/[^/]+$",
- "location": "path"
- }
- },
- "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."
- }
- },
- "resources": {
- "connections": {
- "methods": {
- "list": {
- "response": {
- "$ref": "ListConnectionsResponse"
- },
- "parameterOrder": [
- "resourceName"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/contacts",
- "https://www.googleapis.com/auth/contacts.readonly"
- ],
- "parameters": {
- "personFields": {
- "description": "**Required.** A field mask to restrict which fields on each person are\nreturned. Valid values are:\n\n* addresses\n* ageRanges\n* biographies\n* birthdays\n* braggingRights\n* coverPhotos\n* emailAddresses\n* events\n* genders\n* imClients\n* locales\n* memberships\n* metadata\n* names\n* nicknames\n* occupations\n* organizations\n* phoneNumbers\n* photos\n* relations\n* relationshipInterests\n* relationshipStatuses\n* residences\n* skills\n* taglines\n* urls",
- "format": "google-fieldmask",
- "type": "string",
- "location": "query"
- },
- "sortOrder": {
- "location": "query",
- "enum": [
- "LAST_MODIFIED_ASCENDING",
- "FIRST_NAME_ASCENDING",
- "LAST_NAME_ASCENDING"
- ],
- "description": "The order in which the connections should be sorted. Defaults to\n`LAST_MODIFIED_ASCENDING`.",
- "type": "string"
- },
- "requestSyncToken": {
- "location": "query",
- "description": "Whether the response should include a sync token, which can be used to get\nall changes since the last request.",
- "type": "boolean"
- },
- "pageToken": {
- "location": "query",
- "description": "The token of the page to be returned.",
- "type": "string"
- },
- "resourceName": {
- "pattern": "^people/[^/]+$",
- "location": "path",
- "description": "The resource name to return connections for. Only `people/me` is valid.",
- "required": true,
- "type": "string"
- },
- "pageSize": {
- "description": "The number of connections to include in the response. Valid values are\nbetween 1 and 2000, inclusive. Defaults to 100.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- },
- "requestMask.includeField": {
- "location": "query",
- "description": "**Required.** Comma-separated list of person fields to be included in the\nresponse. Each path should start with `person.`: for example,\n`person.names` or `person.photos`.",
- "format": "google-fieldmask",
- "type": "string"
- },
- "syncToken": {
- "location": "query",
- "description": "A sync token, returned by a previous call to `people.connections.list`.\nOnly resources changed since the sync token was created will be returned.",
- "type": "string"
- }
- },
- "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."
- }
- }
- }
- }
- },
- "contactGroups": {
- "resources": {
- "members": {
- "methods": {
- "modify": {
- "httpMethod": "POST",
- "parameterOrder": [
- "resourceName"
- ],
- "response": {
- "$ref": "ModifyContactGroupMembersResponse"
- },
- "parameters": {
- "resourceName": {
- "location": "path",
- "description": "The resource name of the contact group to modify.",
- "required": true,
- "type": "string",
- "pattern": "^contactGroups/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/contacts"
- ],
- "flatPath": "v1/contactGroups/{contactGroupsId}/members:modify",
- "id": "people.contactGroups.members.modify",
- "path": "v1/{+resourceName}/members:modify",
- "request": {
- "$ref": "ModifyContactGroupMembersRequest"
- },
- "description": "Modify the members of a contact group owned by the authenticated user."
- }
- }
- }
- },
- "methods": {
- "get": {
- "description": "Get a specific contact group owned by the authenticated user by specifying\na contact group resource name.",
- "response": {
- "$ref": "ContactGroup"
- },
- "parameterOrder": [
- "resourceName"
- ],
- "httpMethod": "GET",
- "parameters": {
- "maxMembers": {
- "description": "Specifies the maximum number of members to return.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- },
- "resourceName": {
- "pattern": "^contactGroups/[^/]+$",
- "location": "path",
- "description": "The resource name of the contact group to get.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/contacts",
- "https://www.googleapis.com/auth/contacts.readonly"
- ],
- "flatPath": "v1/contactGroups/{contactGroupsId}",
- "path": "v1/{+resourceName}",
- "id": "people.contactGroups.get"
- },
- "update": {
- "httpMethod": "PUT",
- "parameterOrder": [
- "resourceName"
- ],
- "response": {
- "$ref": "ContactGroup"
- },
- "parameters": {
- "resourceName": {
- "location": "path",
- "description": "The resource name for the contact group, assigned by the server. An ASCII\nstring, in the form of `contactGroups/`\u003cvar\u003econtact_group_id\u003c/var\u003e.",
- "required": true,
- "type": "string",
- "pattern": "^contactGroups/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/contacts"
- ],
- "flatPath": "v1/contactGroups/{contactGroupsId}",
- "id": "people.contactGroups.update",
- "path": "v1/{+resourceName}",
- "request": {
- "$ref": "UpdateContactGroupRequest"
- },
- "description": "Update the name of an existing contact group owned by the authenticated\nuser."
- },
- "batchGet": {
- "response": {
- "$ref": "BatchGetContactGroupsResponse"
- },
- "parameterOrder": [],
- "httpMethod": "GET",
- "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
- }
- },
- "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."
- },
- "delete": {
- "description": "Delete an existing contact group owned by the authenticated user by\nspecifying a contact group resource name.",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "resourceName"
- ],
- "httpMethod": "DELETE",
- "parameters": {
- "deleteContacts": {
- "description": "Set to true to also delete the contacts in the specified group.",
- "type": "boolean",
- "location": "query"
- },
- "resourceName": {
- "description": "The resource name of the contact group to delete.",
- "required": true,
- "type": "string",
- "pattern": "^contactGroups/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/contacts"
- ],
- "flatPath": "v1/contactGroups/{contactGroupsId}",
- "path": "v1/{+resourceName}",
- "id": "people.contactGroups.delete"
- },
- "list": {
- "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.",
- "httpMethod": "GET",
- "parameterOrder": [],
- "response": {
- "$ref": "ListContactGroupsResponse"
- },
- "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": {
- "description": "The next_page_token value returned from a previous call to\n[ListContactGroups](/people/api/rest/v1/contactgroups/list).\nRequests the next page of resources.",
- "type": "string",
- "location": "query"
- },
- "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"
- },
- "create": {
- "request": {
- "$ref": "CreateContactGroupRequest"
- },
- "description": "Create a new contact group owned by the authenticated user.",
- "response": {
- "$ref": "ContactGroup"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "parameters": {},
- "scopes": [
- "https://www.googleapis.com/auth/contacts"
- ],
- "flatPath": "v1/contactGroups",
- "path": "v1/contactGroups",
- "id": "people.contactGroups.create"
- }
- }
- }
- },
- "parameters": {
- "upload_protocol": {
- "location": "query",
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string"
- },
- "prettyPrint": {
- "location": "query",
- "description": "Returns response with indentations and line breaks.",
- "type": "boolean",
- "default": "true"
- },
- "uploadType": {
- "location": "query",
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string"
- },
- "fields": {
- "location": "query",
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string"
- },
- "callback": {
- "description": "JSONP",
- "type": "string",
- "location": "query"
- },
- "$.xgafv": {
- "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": {
- "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"
- }
- },
- "version": "v1",
- "baseUrl": "https://people.googleapis.com/",
- "servicePath": "",
- "kind": "discovery#restDescription",
- "description": "Provides access to information about profiles and contacts.",
"basePath": "",
+ "id": "people:v1",
"revision": "20171229",
"documentationLink": "https://developers.google.com/people/",
- "id": "people:v1",
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
+ "Name": {
+ "description": "A person's name. If the name is a mononym, the family name is empty.",
+ "type": "object",
+ "properties": {
+ "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"
+ },
+ "phoneticGivenName": {
+ "description": "The given name spelled as it sounds.",
+ "type": "string"
+ },
+ "phoneticFamilyName": {
+ "description": "The family name spelled as it sounds.",
+ "type": "string"
+ },
+ "familyName": {
+ "description": "The family name.",
+ "type": "string"
+ },
+ "phoneticMiddleName": {
+ "description": "The middle name(s) spelled as they sound.",
+ "type": "string"
+ },
+ "metadata": {
+ "description": "Metadata about the name.",
+ "$ref": "FieldMetadata"
+ },
+ "phoneticFullName": {
+ "description": "The full name spelled as it sounds.",
+ "type": "string"
+ },
+ "displayNameLastFirst": {
+ "description": "The read-only display name with the last name first formatted according to\nthe locale specified by the viewer's account or the\n`Accept-Language` HTTP header.",
+ "type": "string"
+ },
+ "displayName": {
+ "description": "The read-only display name formatted according to the locale specified by\nthe viewer's account or the `Accept-Language` HTTP header.",
+ "type": "string"
+ },
+ "honorificSuffix": {
+ "description": "The honorific suffixes, such as `Jr.`",
+ "type": "string"
+ },
+ "honorificPrefix": {
+ "description": "The honorific prefixes, such as `Mrs.` or `Dr.`",
+ "type": "string"
+ }
+ },
+ "id": "Name"
+ },
+ "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": {
+ "description": "Metadata about the locale.",
+ "$ref": "FieldMetadata"
+ }
+ },
+ "id": "Locale"
+ },
+ "Empty": {
+ "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
+ "type": "object",
+ "properties": {},
+ "id": "Empty"
+ },
+ "UserDefined": {
+ "description": "Arbitrary user data that is populated by the end users.",
+ "type": "object",
+ "properties": {
+ "key": {
+ "description": "The end user specified key of the user defined data.",
+ "type": "string"
+ },
+ "metadata": {
+ "$ref": "FieldMetadata",
+ "description": "Metadata about the user defined data."
+ },
+ "value": {
+ "description": "The end user specified value of the user defined data.",
+ "type": "string"
+ }
+ },
+ "id": "UserDefined"
+ },
+ "Biography": {
+ "description": "A person's short biography.",
+ "type": "object",
+ "properties": {
+ "contentType": {
+ "enumDescriptions": [
+ "Unspecified.",
+ "Plain text.",
+ "HTML text."
+ ],
+ "enum": [
+ "CONTENT_TYPE_UNSPECIFIED",
+ "TEXT_PLAIN",
+ "TEXT_HTML"
+ ],
+ "description": "The content type of the biography.",
+ "type": "string"
+ },
+ "metadata": {
+ "description": "Metadata about the biography.",
+ "$ref": "FieldMetadata"
+ },
+ "value": {
+ "description": "The short biography.",
+ "type": "string"
+ }
+ },
+ "id": "Biography"
+ },
+ "FieldMetadata": {
+ "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"
+ },
+ "source": {
+ "$ref": "Source",
+ "description": "The source of the field."
+ }
+ },
+ "id": "FieldMetadata",
+ "description": "Metadata about a field.",
+ "type": "object"
+ },
+ "RelationshipInterest": {
+ "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": {
+ "description": "Metadata about the relationship interest.",
+ "$ref": "FieldMetadata"
+ }
+ },
+ "id": "RelationshipInterest",
+ "description": "A person's read-only relationship interest .",
+ "type": "object"
+ },
+ "Source": {
+ "description": "The source of a field.",
+ "type": "object",
+ "properties": {
+ "type": {
+ "enumDescriptions": [
+ "Unspecified.",
+ "[Google Account](https://accounts.google.com).",
+ "[Google profile](https://profiles.google.com). You can view the\nprofile at https://profiles.google.com/\u003cvar\u003eid\u003c/var\u003e where\n\u003cvar\u003eid\u003c/var\u003e is the source id.",
+ "[Google Apps domain profile](https://admin.google.com).",
+ "[Google contact](https://contacts.google.com). You can view the\ncontact at https://contact.google.com/\u003cvar\u003eid\u003c/var\u003e where \u003cvar\u003eid\u003c/var\u003e\nis the source id."
+ ],
+ "enum": [
+ "SOURCE_TYPE_UNSPECIFIED",
+ "ACCOUNT",
+ "PROFILE",
+ "DOMAIN_PROFILE",
+ "CONTACT"
+ ],
+ "description": "The source type.",
+ "type": "string"
+ },
+ "etag": {
+ "description": "**Only populated in `person.metadata.sources`.**\n\nThe [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the\nsource. Used for web cache validation.",
+ "type": "string"
+ },
+ "id": {
+ "description": "The unique identifier within the source type generated by the server.",
+ "type": "string"
+ },
+ "profileMetadata": {
+ "description": "**Only populated in `person.metadata.sources`.**\n\nMetadata about a source of type PROFILE.",
+ "$ref": "ProfileMetadata"
+ },
+ "updateTime": {
+ "description": "**Only populated in `person.metadata.sources`.**\n\nLast update timestamp of this source.",
+ "format": "google-datetime",
+ "type": "string"
+ }
+ },
+ "id": "Source"
+ },
+ "GetPeopleResponse": {
+ "type": "object",
+ "properties": {
+ "responses": {
+ "description": "The response for each requested resource name.",
+ "type": "array",
+ "items": {
+ "$ref": "PersonResponse"
+ }
+ }
+ },
+ "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": {
+ "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"
+ },
+ "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"
+ }
+ },
+ "id": "Photo"
+ },
+ "PhoneNumber": {
+ "description": "A person's phone number.",
+ "type": "object",
+ "properties": {
+ "formattedType": {
+ "description": "The read-only type of the phone number translated and formatted in the\nviewer's account locale or the `Accept-Language` HTTP header locale.",
+ "type": "string"
+ },
+ "canonicalForm": {
+ "description": "The read-only canonicalized [ITU-T E.164](https://law.resource.org/pub/us/cfr/ibr/004/itu-t.E.164.1.2008.pdf)\nform of the phone number.",
+ "type": "string"
+ },
+ "metadata": {
+ "description": "Metadata about the phone number.",
+ "$ref": "FieldMetadata"
+ },
+ "type": {
+ "description": "The type of the phone number. The type can be custom or predefined.\nPossible values include, but are not limited to, the following:\n\n* `home`\n* `work`\n* `mobile`\n* `homeFax`\n* `workFax`\n* `otherFax`\n* `pager`\n* `workMobile`\n* `workPager`\n* `main`\n* `googleVoice`\n* `other`",
+ "type": "string"
+ },
+ "value": {
+ "description": "The phone number.",
+ "type": "string"
+ }
+ },
+ "id": "PhoneNumber"
+ },
+ "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"
+ },
+ "connections": {
+ "description": "The list of people that the requestor is connected to.",
+ "type": "array",
+ "items": {
+ "$ref": "Person"
+ }
+ },
+ "nextSyncToken": {
+ "description": "The token that can be used to retrieve changes since the last request.",
+ "type": "string"
+ },
+ "totalItems": {
+ "description": "The total number of items in the list without pagination.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "ListConnectionsResponse"
+ },
+ "Birthday": {
+ "properties": {
+ "metadata": {
+ "$ref": "FieldMetadata",
+ "description": "Metadata about the birthday."
+ },
+ "text": {
+ "description": "A free-form string representing the user's birthday.",
+ "type": "string"
+ },
+ "date": {
+ "description": "The date of the birthday.",
+ "$ref": "Date"
+ }
+ },
+ "id": "Birthday",
+ "description": "A person's birthday. At least one of the `date` and `text` fields are\nspecified. The `date` and `text` fields typically represent the same\ndate, but are not guaranteed to.",
+ "type": "object"
+ },
"CreateContactGroupRequest": {
"properties": {
"contactGroup": {
@@ -572,7 +339,17 @@
"type": "object"
},
"Address": {
+ "description": "A person's physical address. May be a P.O. box or street address. All fields\nare optional.",
+ "type": "object",
"properties": {
+ "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"
@@ -612,57 +389,47 @@
"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",
- "description": "A person's physical address. May be a P.O. box or street address. All fields\nare optional.",
- "type": "object"
- },
- "Status": {
- "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
- "type": "object",
- "properties": {
- "message": {
- "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
- "type": "string"
- },
- "details": {
- "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.",
- "type": "array",
- "items": {
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- },
- "type": "object"
- }
- },
- "code": {
- "description": "The status code, which should be an enum value of google.rpc.Code.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "Status"
+ "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"
+ "id": "ContactGroupMembership",
+ "description": "A Google contact group membership.",
+ "type": "object"
+ },
+ "Status": {
+ "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
+ "type": "object",
+ "properties": {
+ "details": {
+ "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.",
+ "type": "array",
+ "items": {
+ "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"
},
"PersonMetadata": {
"description": "The read-only metadata about a person.",
@@ -736,8 +503,8 @@
"type": "object",
"properties": {
"contactGroup": {
- "$ref": "ContactGroup",
- "description": "The contact group."
+ "description": "The contact group.",
+ "$ref": "ContactGroup"
},
"status": {
"$ref": "Status",
@@ -755,8 +522,8 @@
"type": "object",
"properties": {
"metadata": {
- "description": "Metadata about the URL.",
- "$ref": "FieldMetadata"
+ "$ref": "FieldMetadata",
+ "description": "Metadata about the URL."
},
"type": {
"description": "The type of the URL. The type can be custom or predefined.\nPossible values include, but are not limited to, the following:\n\n* `home`\n* `work`\n* `blog`\n* `profile`\n* `homePage`\n* `ftp`\n* `reservations`\n* `appInstallPage`: website for a Google+ application.\n* `other`",
@@ -774,65 +541,46 @@
"id": "Url"
},
"ImClient": {
+ "description": "A person's instant messaging client.",
+ "type": "object",
"properties": {
+ "formattedProtocol": {
+ "description": "The read-only protocol of the IM client formatted in the viewer's account\nlocale or the `Accept-Language` HTTP header locale.",
+ "type": "string"
+ },
"formattedType": {
"description": "The read-only type of the IM client translated and formatted in the\nviewer's account locale or the `Accept-Language` HTTP header locale.",
"type": "string"
},
+ "metadata": {
+ "description": "Metadata about the IM client.",
+ "$ref": "FieldMetadata"
+ },
+ "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`",
+ "type": "string"
+ },
"protocol": {
"description": "The protocol of the IM client. The protocol can be custom or predefined.\nPossible values include, but are not limited to, the following:\n\n* `aim`\n* `msn`\n* `yahoo`\n* `skype`\n* `qq`\n* `googleTalk`\n* `icq`\n* `jabber`\n* `netMeeting`",
"type": "string"
},
- "metadata": {
- "$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`",
- "type": "string"
- },
"username": {
"description": "The user name used in the IM client.",
"type": "string"
- },
- "formattedProtocol": {
- "description": "The read-only protocol of the IM client formatted in the viewer's account\nlocale or the `Accept-Language` HTTP header locale.",
- "type": "string"
}
},
- "id": "ImClient",
- "description": "A person's instant messaging client.",
- "type": "object"
+ "id": "ImClient"
},
"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",
- "description": "A Google Apps Domain membership.",
- "type": "object"
- },
- "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": {
- "$ref": "FieldMetadata",
- "description": "Metadata about the membership."
- }
- },
- "id": "Membership"
+ "id": "DomainMembership"
},
"BatchGetContactGroupsResponse": {
"description": "The response to a batch get contact groups request.",
@@ -848,21 +596,40 @@
},
"id": "BatchGetContactGroupsResponse"
},
+ "Membership": {
+ "description": "A person's read-only membership in a group.",
+ "type": "object",
+ "properties": {
+ "metadata": {
+ "description": "Metadata about the membership.",
+ "$ref": "FieldMetadata"
+ },
+ "contactGroupMembership": {
+ "$ref": "ContactGroupMembership",
+ "description": "The contact group membership."
+ },
+ "domainMembership": {
+ "$ref": "DomainMembership",
+ "description": "The domain membership."
+ }
+ },
+ "id": "Membership"
+ },
"RelationshipStatus": {
"description": "A person's read-only relationship status.",
"type": "object",
"properties": {
- "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"
},
"metadata": {
- "description": "Metadata about the relationship status.",
- "$ref": "FieldMetadata"
+ "$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"
@@ -871,13 +638,13 @@
"description": "A person's bragging rights.",
"type": "object",
"properties": {
- "value": {
- "description": "The bragging rights; for example, `climbed mount everest`.",
- "type": "string"
- },
"metadata": {
"$ref": "FieldMetadata",
"description": "Metadata about the bragging rights."
+ },
+ "value": {
+ "description": "The bragging rights; for example, `climbed mount everest`.",
+ "type": "string"
}
},
"id": "BraggingRights"
@@ -886,6 +653,22 @@
"description": "A person's past or current organization. Overlapping date ranges are\npermitted.",
"type": "object",
"properties": {
+ "startDate": {
+ "description": "The start date when the person joined the organization.",
+ "$ref": "Date"
+ },
+ "formattedType": {
+ "description": "The read-only type of the organization translated and formatted in the\nviewer's account locale or the `Accept-Language` HTTP header locale.",
+ "type": "string"
+ },
+ "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"
@@ -911,45 +694,33 @@
"type": "string"
},
"metadata": {
- "$ref": "FieldMetadata",
- "description": "Metadata about the organization."
- },
- "location": {
- "description": "The location of the organization office the person works at.",
- "type": "string"
+ "description": "Metadata about the organization.",
+ "$ref": "FieldMetadata"
},
"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"
}
},
"id": "Organization"
},
"AgeRangeType": {
- "description": "A person's age range.",
- "type": "object",
"properties": {
"ageRange": {
+ "enum": [
+ "AGE_RANGE_UNSPECIFIED",
+ "LESS_THAN_EIGHTEEN",
+ "EIGHTEEN_TO_TWENTY",
+ "TWENTY_ONE_OR_OLDER"
+ ],
"description": "The age range.",
"type": "string",
"enumDescriptions": [
@@ -957,12 +728,6 @@
"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"
]
},
"metadata": {
@@ -970,9 +735,13 @@
"description": "Metadata about the age range."
}
},
- "id": "AgeRangeType"
+ "id": "AgeRangeType",
+ "description": "A person's age range.",
+ "type": "object"
},
"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.",
@@ -995,21 +764,19 @@
"type": "string"
}
},
- "id": "ListContactGroupsResponse",
- "description": "The response to a list contact groups request.",
- "type": "object"
+ "id": "ListContactGroupsResponse"
},
"PersonResponse": {
"description": "The response for a single person",
"type": "object",
"properties": {
"person": {
- "description": "The person.",
- "$ref": "Person"
+ "$ref": "Person",
+ "description": "The person."
},
"status": {
- "description": "The status of the response.",
- "$ref": "Status"
+ "$ref": "Status",
+ "description": "The status of the response."
},
"httpStatusCode": {
"description": "**DEPRECATED** (Please use status instead)\n\n[HTTP 1.1 status code]\n(http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html).",
@@ -1028,8 +795,8 @@
"type": "object",
"properties": {
"metadata": {
- "$ref": "FieldMetadata",
- "description": "Metadata about the relation."
+ "description": "Metadata about the relation.",
+ "$ref": "FieldMetadata"
},
"type": {
"description": "The person's relation to the other person. The type can be custom or predefined.\nPossible values include, but are not limited to, the following values:\n\n* `spouse`\n* `child`\n* `mother`\n* `father`\n* `parent`\n* `brother`\n* `sister`\n* `friend`\n* `relative`\n* `domesticPartner`\n* `manager`\n* `assistant`\n* `referredBy`\n* `partner`",
@@ -1055,8 +822,8 @@
"type": "string"
},
"metadata": {
- "$ref": "FieldMetadata",
- "description": "Metadata about the occupation."
+ "description": "Metadata about the occupation.",
+ "$ref": "FieldMetadata"
}
},
"id": "Occupation"
@@ -1065,8 +832,12 @@
"description": "A contact group.",
"type": "object",
"properties": {
- "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.",
+ "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"
},
"groupType": {
@@ -1083,6 +854,10 @@
"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.",
+ "type": "string"
+ },
"name": {
"description": "The contact group name set by the group owner or a system provided name\nfor system groups.",
"type": "string"
@@ -1094,99 +869,23 @@
"type": "string"
}
},
- "metadata": {
- "description": "Metadata about the contact group.",
- "$ref": "ContactGroupMetadata"
- },
"memberCount": {
"description": "The total number of contacts in the group irrespective of max members in\nspecified in the request.",
"format": "int32",
"type": "integer"
},
- "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"
+ "metadata": {
+ "description": "Metadata about the contact group.",
+ "$ref": "ContactGroupMetadata"
}
},
"id": "ContactGroup"
},
"Person": {
- "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": {
- "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.",
@@ -1198,9 +897,7 @@
"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.",
@@ -1300,13 +997,6 @@
"$ref": "Nickname"
}
},
- "names": {
- "description": "The person's names.",
- "type": "array",
- "items": {
- "$ref": "Name"
- }
- },
"relations": {
"description": "The person's relations.",
"type": "array",
@@ -1314,6 +1004,13 @@
"$ref": "Relation"
}
},
+ "names": {
+ "description": "The person's names.",
+ "type": "array",
+ "items": {
+ "$ref": "Name"
+ }
+ },
"occupations": {
"description": "The person's occupations.",
"type": "array",
@@ -1334,17 +1031,87 @@
"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"
+ }
+ },
+ "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"
+ }
}
},
- "id": "Person"
+ "id": "Person",
+ "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"
},
"UpdateContactGroupRequest": {
"description": "A request to update an existing contact group. Only the name can be updated.",
"type": "object",
"properties": {
"contactGroup": {
- "description": "The contact group to update.",
- "$ref": "ContactGroup"
+ "$ref": "ContactGroup",
+ "description": "The contact group to update."
}
},
"id": "UpdateContactGroupRequest"
@@ -1366,13 +1133,7 @@
"id": "ContactGroupMetadata"
},
"Residence": {
- "description": "A person's past or current residence.",
- "type": "object",
"properties": {
- "value": {
- "description": "The address of the residence.",
- "type": "string"
- },
"metadata": {
"$ref": "FieldMetadata",
"description": "Metadata about the residence."
@@ -1380,20 +1141,20 @@
"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"
+ "id": "Residence",
+ "description": "A person's past or current residence.",
+ "type": "object"
},
"Event": {
+ "description": "An event related to the person.",
+ "type": "object",
"properties": {
- "metadata": {
- "$ref": "FieldMetadata",
- "description": "Metadata about the event."
- },
- "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": {
"description": "The date of the event.",
"$ref": "Date"
@@ -1401,11 +1162,17 @@
"formattedType": {
"description": "The read-only type of the event translated and formatted in the\nviewer's account locale or the `Accept-Language` HTTP header locale.",
"type": "string"
+ },
+ "metadata": {
+ "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"
}
},
- "id": "Event",
- "description": "An event related to the person.",
- "type": "object"
+ "id": "Event"
},
"ModifyContactGroupMembersResponse": {
"description": "The response to a modify contact group members request.",
@@ -1425,6 +1192,25 @@
"description": "The read-only metadata about a profile.",
"type": "object",
"properties": {
+ "userTypes": {
+ "enumDescriptions": [
+ "The user type is not known.",
+ "The user is a Google user.",
+ "The user is a Google+ user.",
+ "The user is a Google Apps for Work user."
+ ],
+ "description": "The user types.",
+ "type": "array",
+ "items": {
+ "enum": [
+ "USER_TYPE_UNKNOWN",
+ "GOOGLE_USER",
+ "GPLUS_USER",
+ "GOOGLE_APPS_USER"
+ ],
+ "type": "string"
+ }
+ },
"objectType": {
"description": "The profile object type.",
"type": "string",
@@ -1438,25 +1224,6 @@
"PERSON",
"PAGE"
]
- },
- "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."
- ]
}
},
"id": "ProfileMetadata"
@@ -1484,17 +1251,17 @@
"description": "A person's read-only cover photo. A large image shown on the person's\nprofile page that represents who they are or what they care about.",
"type": "object",
"properties": {
- "url": {
- "description": "The URL of the cover photo.",
- "type": "string"
- },
"metadata": {
- "$ref": "FieldMetadata",
- "description": "Metadata about the cover photo."
+ "description": "Metadata about the cover photo.",
+ "$ref": "FieldMetadata"
},
"default": {
"description": "True if the cover photo is the default cover photo;\nfalse if the cover photo is a user-provided cover photo.",
"type": "boolean"
+ },
+ "url": {
+ "description": "The URL of the cover photo.",
+ "type": "string"
}
},
"id": "CoverPhoto"
@@ -1518,18 +1285,6 @@
"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"
@@ -1537,6 +1292,18 @@
"formattedType": {
"description": "The read-only type of the email address translated and formatted in the\nviewer's account locale or the `Accept-Language` HTTP header locale.",
"type": "string"
+ },
+ "displayName": {
+ "description": "The display name of the email.",
+ "type": "string"
+ },
+ "metadata": {
+ "$ref": "FieldMetadata",
+ "description": "Metadata about the email address."
+ },
+ "type": {
+ "description": "The type of the email address. The type can be custom or predefined.\nPossible values include, but are not limited to, the following:\n\n* `home`\n* `work`\n* `other`",
+ "type": "string"
}
},
"id": "EmailAddress"
@@ -1545,15 +1312,13 @@
"description": "A person's nickname.",
"type": "object",
"properties": {
- "value": {
- "description": "The nickname.",
- "type": "string"
- },
"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.",
@@ -1567,8 +1332,10 @@
"INITIALS",
"GPLUS",
"OTHER_NAME"
- ],
- "description": "The type of the nickname.",
+ ]
+ },
+ "value": {
+ "description": "The nickname.",
"type": "string"
}
},
@@ -1578,18 +1345,35 @@
"description": "A skill that the person has.",
"type": "object",
"properties": {
+ "metadata": {
+ "$ref": "FieldMetadata",
+ "description": "Metadata about the skill."
+ },
"value": {
"description": "The skill; for example, `underwater basket weaving`.",
"type": "string"
- },
- "metadata": {
- "description": "Metadata about the skill.",
- "$ref": "FieldMetadata"
}
},
"id": "Skill"
},
+ "Tagline": {
+ "description": "A read-only brief one-line description of the person.",
+ "type": "object",
+ "properties": {
+ "metadata": {
+ "$ref": "FieldMetadata",
+ "description": "Metadata about the tagline."
+ },
+ "value": {
+ "description": "The tagline.",
+ "type": "string"
+ }
+ },
+ "id": "Tagline"
+ },
"Date": {
+ "description": "Represents a whole calendar date, for example a date of birth. The time\nof day and time zone are either specified elsewhere or are not\nsignificant. The date is relative to the\n[Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar).\nThe day may be 0 to represent a year and month where the day is not\nsignificant. The year may be 0 to represent a month and day independent\nof year; for example, anniversary date.",
+ "type": "object",
"properties": {
"year": {
"description": "Year of date. Must be from 1 to 9999, or 0 if specifying a date without\na year.",
@@ -1607,382 +1391,44 @@
"type": "integer"
}
},
- "id": "Date",
- "description": "Represents a whole calendar date, for example a date of birth. The time\nof day and time zone are either specified elsewhere or are not\nsignificant. The date is relative to the\n[Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar).\nThe day may be 0 to represent a year and month where the day is not\nsignificant. The year may be 0 to represent a month and day independent\nof year; for example, anniversary date.",
- "type": "object"
- },
- "Tagline": {
- "description": "A read-only brief one-line description of the person.",
- "type": "object",
- "properties": {
- "metadata": {
- "$ref": "FieldMetadata",
- "description": "Metadata about the tagline."
- },
- "value": {
- "description": "The tagline.",
- "type": "string"
- }
- },
- "id": "Tagline"
- },
- "Name": {
- "description": "A person's name. If the name is a mononym, the family name is empty.",
- "type": "object",
- "properties": {
- "phoneticHonorificPrefix": {
- "description": "The honorific prefixes spelled as they sound.",
- "type": "string"
- },
- "phoneticGivenName": {
- "description": "The given name spelled as it sounds.",
- "type": "string"
- },
- "phoneticFamilyName": {
- "description": "The family name spelled as it sounds.",
- "type": "string"
- },
- "familyName": {
- "description": "The family name.",
- "type": "string"
- },
- "phoneticMiddleName": {
- "description": "The middle name(s) spelled as they sound.",
- "type": "string"
- },
- "metadata": {
- "description": "Metadata about the name.",
- "$ref": "FieldMetadata"
- },
- "phoneticFullName": {
- "description": "The full name spelled as it sounds.",
- "type": "string"
- },
- "displayNameLastFirst": {
- "description": "The read-only display name with the last name first formatted according to\nthe locale specified by the viewer's account or the\n`Accept-Language` HTTP header.",
- "type": "string"
- },
- "displayName": {
- "description": "The read-only display name formatted according to the locale specified by\nthe viewer's account or the `Accept-Language` HTTP header.",
- "type": "string"
- },
- "honorificSuffix": {
- "description": "The honorific suffixes, such as `Jr.`",
- "type": "string"
- },
- "honorificPrefix": {
- "description": "The honorific prefixes, such as `Mrs.` or `Dr.`",
- "type": "string"
- },
- "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": "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.",
- "type": "string"
- }
- },
- "id": "Locale",
- "description": "A person's locale preference.",
- "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"
- },
- "UserDefined": {
- "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"
- },
- "key": {
- "description": "The end user specified key of the user defined data.",
- "type": "string"
- }
- },
- "id": "UserDefined",
- "description": "Arbitrary user data that is populated by the end users.",
- "type": "object"
- },
- "Biography": {
- "description": "A person's short biography.",
- "type": "object",
- "properties": {
- "contentType": {
- "enumDescriptions": [
- "Unspecified.",
- "Plain text.",
- "HTML text."
- ],
- "enum": [
- "CONTENT_TYPE_UNSPECIFIED",
- "TEXT_PLAIN",
- "TEXT_HTML"
- ],
- "description": "The content type of the biography.",
- "type": "string"
- },
- "metadata": {
- "$ref": "FieldMetadata",
- "description": "Metadata about the biography."
- },
- "value": {
- "description": "The short biography.",
- "type": "string"
- }
- },
- "id": "Biography"
- },
- "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"
- },
- "source": {
- "$ref": "Source",
- "description": "The source of the field."
- }
- },
- "id": "FieldMetadata"
- },
- "Source": {
- "description": "The source of a field.",
- "type": "object",
- "properties": {
- "profileMetadata": {
- "$ref": "ProfileMetadata",
- "description": "**Only populated in `person.metadata.sources`.**\n\nMetadata about a source of type PROFILE."
- },
- "updateTime": {
- "description": "**Only populated in `person.metadata.sources`.**\n\nLast update timestamp of this source.",
- "format": "google-datetime",
- "type": "string"
- },
- "type": {
- "enumDescriptions": [
- "Unspecified.",
- "[Google Account](https://accounts.google.com).",
- "[Google profile](https://profiles.google.com). You can view the\nprofile at https://profiles.google.com/\u003cvar\u003eid\u003c/var\u003e where\n\u003cvar\u003eid\u003c/var\u003e is the source id.",
- "[Google Apps domain profile](https://admin.google.com).",
- "[Google contact](https://contacts.google.com). You can view the\ncontact at https://contact.google.com/\u003cvar\u003eid\u003c/var\u003e where \u003cvar\u003eid\u003c/var\u003e\nis the source id."
- ],
- "enum": [
- "SOURCE_TYPE_UNSPECIFIED",
- "ACCOUNT",
- "PROFILE",
- "DOMAIN_PROFILE",
- "CONTACT"
- ],
- "description": "The source type.",
- "type": "string"
- },
- "etag": {
- "description": "**Only populated in `person.metadata.sources`.**\n\nThe [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the\nsource. Used for web cache validation.",
- "type": "string"
- },
- "id": {
- "description": "The unique identifier within the source type generated by the server.",
- "type": "string"
- }
- },
- "id": "Source"
- },
- "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": {
- "$ref": "FieldMetadata",
- "description": "Metadata about the relationship interest."
- },
- "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"
- },
- "GetPeopleResponse": {
- "type": "object",
- "properties": {
- "responses": {
- "description": "The response for each requested resource name.",
- "type": "array",
- "items": {
- "$ref": "PersonResponse"
- }
- }
- },
- "id": "GetPeopleResponse"
- },
- "PhoneNumber": {
- "description": "A person's phone number.",
- "type": "object",
- "properties": {
- "value": {
- "description": "The phone number.",
- "type": "string"
- },
- "formattedType": {
- "description": "The read-only type of the phone number translated and formatted in the\nviewer's account locale or the `Accept-Language` HTTP header locale.",
- "type": "string"
- },
- "canonicalForm": {
- "description": "The read-only canonicalized [ITU-T E.164](https://law.resource.org/pub/us/cfr/ibr/004/itu-t.E.164.1.2008.pdf)\nform of the phone number.",
- "type": "string"
- },
- "metadata": {
- "description": "Metadata about the phone number.",
- "$ref": "FieldMetadata"
- },
- "type": {
- "description": "The type of the phone number. The type can be custom or predefined.\nPossible values include, but are not limited to, the following:\n\n* `home`\n* `work`\n* `mobile`\n* `homeFax`\n* `workFax`\n* `otherFax`\n* `pager`\n* `workMobile`\n* `workPager`\n* `main`\n* `googleVoice`\n* `other`",
- "type": "string"
- }
- },
- "id": "PhoneNumber"
- },
- "Photo": {
- "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": {
- "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",
- "description": "A person's read-only photo. A picture shown next to the person's name to\nhelp others recognize the person.",
- "type": "object"
- },
- "ListConnectionsResponse": {
- "type": "object",
- "properties": {
- "nextPageToken": {
- "description": "The token that can be used to retrieve the next page of results.",
- "type": "string"
- },
- "connections": {
- "description": "The list of people that the requestor is connected to.",
- "type": "array",
- "items": {
- "$ref": "Person"
- }
- },
- "nextSyncToken": {
- "description": "The token that can be used to retrieve changes since the last request.",
- "type": "string"
- },
- "totalItems": {
- "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"
- },
- "Birthday": {
- "description": "A person's birthday. At least one of the `date` and `text` fields are\nspecified. The `date` and `text` fields typically represent the same\ndate, but are not guaranteed to.",
- "type": "object",
- "properties": {
- "metadata": {
- "$ref": "FieldMetadata",
- "description": "Metadata about the birthday."
- },
- "text": {
- "description": "A free-form string representing the user's birthday.",
- "type": "string"
- },
- "date": {
- "description": "The date of the birthday.",
- "$ref": "Date"
- }
- },
- "id": "Birthday"
+ "id": "Date"
}
},
- "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": "People Service",
"auth": {
"oauth2": {
"scopes": {
- "https://www.googleapis.com/auth/user.addresses.read": {
- "description": "View your street addresses"
- },
- "https://www.googleapis.com/auth/contacts": {
- "description": "Manage your contacts"
- },
- "https://www.googleapis.com/auth/user.emails.read": {
- "description": "View your email 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.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"
},
- "https://www.googleapis.com/auth/user.birthday.read": {
- "description": "View your complete date of birth"
- },
"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"
}
}
}
@@ -1990,5 +1436,559 @@
"rootUrl": "https://people.googleapis.com/",
"ownerDomain": "google.com",
"name": "people",
- "batchPath": "batch"
+ "batchPath": "batch",
+ "title": "Google People API",
+ "ownerName": "Google",
+ "resources": {
+ "people": {
+ "methods": {
+ "getBatchGet": {
+ "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.",
+ "response": {
+ "$ref": "GetPeopleResponse"
+ },
+ "parameterOrder": [],
+ "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"
+ },
+ "resourceNames": {
+ "location": "query",
+ "description": "The resource names of the people to provide information about.\n\n- To get information about the authenticated user, specify `people/me`.\n- To get information about a google account, specify\n `people/`\u003cvar\u003eaccount_id\u003c/var\u003e.\n- To get information about a contact, specify the resource name that\n identifies the contact as returned by\n[`people.connections.list`](/people/api/rest/v1/people.connections/list).\n\nYou can include up to 50 resource names in one request.",
+ "type": "string",
+ "repeated": true
+ },
+ "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"
+ }
+ },
+ "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"
+ ]
+ },
+ "get": {
+ "description": "Provides information about a person by specifying a resource name. Use\n`people/me` to indicate the authenticated user.\n\u003cbr\u003e\nThe request throws a 400 error if 'personFields' is not specified.",
+ "response": {
+ "$ref": "Person"
+ },
+ "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": {
+ "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"
+ },
+ "requestMask.includeField": {
+ "description": "**Required.** Comma-separated list of person fields to be included in the\nresponse. Each path should start with `person.`: for example,\n`person.names` or `person.photos`.",
+ "format": "google-fieldmask",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "flatPath": "v1/people/{peopleId}",
+ "path": "v1/{+resourceName}",
+ "id": "people.people.get"
+ },
+ "updateContact": {
+ "path": "v1/{+resourceName}:updateContact",
+ "id": "people.people.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.",
+ "response": {
+ "$ref": "Person"
+ },
+ "parameterOrder": [
+ "resourceName"
+ ],
+ "httpMethod": "PATCH",
+ "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": {
+ "description": "The resource name for the person, assigned by the server. An ASCII string\nwith a max length of 27 characters, in the form of\n`people/`\u003cvar\u003eperson_id\u003c/var\u003e.",
+ "required": true,
+ "type": "string",
+ "pattern": "^people/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/contacts"
+ ],
+ "flatPath": "v1/people/{peopleId}:updateContact"
+ },
+ "createContact": {
+ "request": {
+ "$ref": "Person"
+ },
+ "description": "Create a new contact and return the person resource for that contact.",
+ "httpMethod": "POST",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "Person"
+ },
+ "parameters": {
+ "parent": {
+ "description": "The resource name of the owning person resource.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/contacts"
+ ],
+ "flatPath": "v1/people:createContact",
+ "id": "people.people.createContact",
+ "path": "v1/people:createContact"
+ },
+ "deleteContact": {
+ "httpMethod": "DELETE",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "resourceName"
+ ],
+ "parameters": {
+ "resourceName": {
+ "description": "The resource name of the contact to delete.",
+ "required": true,
+ "type": "string",
+ "pattern": "^people/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/contacts"
+ ],
+ "flatPath": "v1/people/{peopleId}:deleteContact",
+ "id": "people.people.deleteContact",
+ "path": "v1/{+resourceName}:deleteContact",
+ "description": "Delete a contact person. Any non-contact data will not be deleted."
+ }
+ },
+ "resources": {
+ "connections": {
+ "methods": {
+ "list": {
+ "response": {
+ "$ref": "ListConnectionsResponse"
+ },
+ "parameterOrder": [
+ "resourceName"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "requestSyncToken": {
+ "description": "Whether the response should include a sync token, which can be used to get\nall changes since the last request.",
+ "type": "boolean",
+ "location": "query"
+ },
+ "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": {
+ "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"
+ },
+ "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": {
+ "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": {
+ "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",
+ "location": "query"
+ },
+ "sortOrder": {
+ "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",
+ "location": "query"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/contacts",
+ "https://www.googleapis.com/auth/contacts.readonly"
+ ],
+ "flatPath": "v1/people/{peopleId}/connections",
+ "path": "v1/{+resourceName}/connections",
+ "id": "people.people.connections.list",
+ "description": "Provides a list of the authenticated user's contacts merged with any\nconnected profiles.\n\u003cbr\u003e\nThe request throws a 400 error if 'personFields' is not specified."
+ }
+ }
+ }
+ }
+ },
+ "contactGroups": {
+ "methods": {
+ "get": {
+ "description": "Get a specific contact group owned by the authenticated user by specifying\na contact group resource name.",
+ "response": {
+ "$ref": "ContactGroup"
+ },
+ "parameterOrder": [
+ "resourceName"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/contacts",
+ "https://www.googleapis.com/auth/contacts.readonly"
+ ],
+ "parameters": {
+ "maxMembers": {
+ "location": "query",
+ "description": "Specifies the maximum number of members to return.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "resourceName": {
+ "description": "The resource name of the contact group to get.",
+ "required": true,
+ "type": "string",
+ "pattern": "^contactGroups/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/contactGroups/{contactGroupsId}",
+ "path": "v1/{+resourceName}",
+ "id": "people.contactGroups.get"
+ },
+ "update": {
+ "httpMethod": "PUT",
+ "parameterOrder": [
+ "resourceName"
+ ],
+ "response": {
+ "$ref": "ContactGroup"
+ },
+ "parameters": {
+ "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.",
+ "required": true,
+ "type": "string",
+ "pattern": "^contactGroups/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/contacts"
+ ],
+ "flatPath": "v1/contactGroups/{contactGroupsId}",
+ "id": "people.contactGroups.update",
+ "path": "v1/{+resourceName}",
+ "request": {
+ "$ref": "UpdateContactGroupRequest"
+ },
+ "description": "Update the name of an existing contact group owned by the authenticated\nuser."
+ },
+ "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",
+ "parameters": {
+ "resourceNames": {
+ "description": "The resource names of the contact groups to get.",
+ "type": "string",
+ "repeated": true,
+ "location": "query"
+ },
+ "maxMembers": {
+ "description": "Specifies the maximum number of members to return for each group.",
+ "format": "int32",
+ "type": "integer",
+ "location": "query"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/contacts",
+ "https://www.googleapis.com/auth/contacts.readonly"
+ ],
+ "flatPath": "v1/contactGroups:batchGet",
+ "path": "v1/contactGroups:batchGet",
+ "id": "people.contactGroups.batchGet"
+ },
+ "delete": {
+ "description": "Delete an existing contact group owned by the authenticated user by\nspecifying a contact group resource name.",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "resourceName"
+ ],
+ "httpMethod": "DELETE",
+ "parameters": {
+ "resourceName": {
+ "location": "path",
+ "description": "The resource name of the contact group to delete.",
+ "required": true,
+ "type": "string",
+ "pattern": "^contactGroups/[^/]+$"
+ },
+ "deleteContacts": {
+ "description": "Set to true to also delete the contacts in the specified group.",
+ "type": "boolean",
+ "location": "query"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/contacts"
+ ],
+ "flatPath": "v1/contactGroups/{contactGroupsId}",
+ "path": "v1/{+resourceName}",
+ "id": "people.contactGroups.delete"
+ },
+ "list": {
+ "response": {
+ "$ref": "ListContactGroupsResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/contacts",
+ "https://www.googleapis.com/auth/contacts.readonly"
+ ],
+ "parameters": {
+ "pageSize": {
+ "description": "The maximum number of resources to return.",
+ "format": "int32",
+ "type": "integer",
+ "location": "query"
+ },
+ "syncToken": {
+ "location": "query",
+ "description": "A sync token, returned by a previous call to `contactgroups.list`.\nOnly resources changed since the sync token was created will be returned.",
+ "type": "string"
+ },
+ "pageToken": {
+ "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"
+ }
+ },
+ "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."
+ },
+ "create": {
+ "request": {
+ "$ref": "CreateContactGroupRequest"
+ },
+ "description": "Create a new contact group owned by the authenticated user.",
+ "httpMethod": "POST",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "ContactGroup"
+ },
+ "parameters": {},
+ "scopes": [
+ "https://www.googleapis.com/auth/contacts"
+ ],
+ "flatPath": "v1/contactGroups",
+ "id": "people.contactGroups.create",
+ "path": "v1/contactGroups"
+ }
+ },
+ "resources": {
+ "members": {
+ "methods": {
+ "modify": {
+ "request": {
+ "$ref": "ModifyContactGroupMembersRequest"
+ },
+ "description": "Modify the members of a contact group owned by the authenticated user.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "resourceName"
+ ],
+ "response": {
+ "$ref": "ModifyContactGroupMembersResponse"
+ },
+ "parameters": {
+ "resourceName": {
+ "description": "The resource name of the contact group to modify.",
+ "required": true,
+ "type": "string",
+ "pattern": "^contactGroups/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/contacts"
+ ],
+ "flatPath": "v1/contactGroups/{contactGroupsId}/members:modify",
+ "id": "people.contactGroups.members.modify",
+ "path": "v1/{+resourceName}/members:modify"
+ }
+ }
+ }
+ }
+ }
+ },
+ "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"
+ },
+ "$.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": {
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "type": "string",
+ "location": "query"
+ },
+ "access_token": {
+ "description": "OAuth access token.",
+ "type": "string",
+ "location": "query"
+ },
+ "quotaUser": {
+ "location": "query",
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "type": "string"
+ },
+ "pp": {
+ "description": "Pretty-print response.",
+ "type": "boolean",
+ "default": "true",
+ "location": "query"
+ },
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string",
+ "location": "query"
+ },
+ "bearer_token": {
+ "description": "OAuth bearer token.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "version": "v1",
+ "baseUrl": "https://people.googleapis.com/",
+ "kind": "discovery#restDescription",
+ "description": "Provides access to information about profiles and contacts.",
+ "servicePath": ""
}
diff --git a/poly/v1/poly-api.json b/poly/v1/poly-api.json
index 0275c3e..90f7031 100644
--- a/poly/v1/poly-api.json
+++ b/poly/v1/poly-api.json
@@ -48,36 +48,36 @@
"location": "query"
},
"curated": {
- "location": "query",
"description": "Return only assets that have been curated by the Poly team.",
- "type": "boolean"
+ "type": "boolean",
+ "location": "query"
},
"category": {
"description": "Filter assets based on the specified category. Supported values are:\n`animals`, `architecture`, `art`, `food`, `nature`, `objects`, `people`, `scenes`,\n`technology`, and `transport`.",
"type": "string",
"location": "query"
},
+ "maxComplexity": {
+ "enum": [
+ "COMPLEXITY_UNSPECIFIED",
+ "COMPLEX",
+ "MEDIUM",
+ "SIMPLE"
+ ],
+ "description": "Returns assets that are of the specified complexity or less. Defaults to\nCOMPLEX. For example, a request for\nMEDIUM assets also includes\nSIMPLE assets.",
+ "type": "string",
+ "location": "query"
+ },
"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 next_page_token.",
"type": "string"
},
- "maxComplexity": {
- "location": "query",
- "enum": [
- "COMPLEXITY_UNSPECIFIED",
- "COMPLEX",
- "MEDIUM",
- "SIMPLE"
- ],
- "description": "Returns assets that are of the specified complexity or less. Defaults to\nCOMPLEX. For example, a request for\nMEDIUM assets also includes\nSIMPLE assets.",
- "type": "string"
- },
"pageSize": {
+ "location": "query",
"description": "The maximum number of assets to be returned. This value must be between `1`\nand `100`. Defaults to `20`.",
"format": "int32",
- "type": "integer",
- "location": "query"
+ "type": "integer"
}
},
"flatPath": "v1/assets",
@@ -89,76 +89,17 @@
},
"users": {
"resources": {
- "assets": {
- "methods": {
- "list": {
- "description": "Lists assets authored by the given user. Only the value 'me', representing\nthe currently-authenticated user, is supported. May include assets with an\naccess level of PRIVATE or\nUNLISTED and assets which are\nAll Rights Reserved for the\ncurrently-authenticated user.",
- "response": {
- "$ref": "ListUserAssetsResponse"
- },
- "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": {
- "description": "Specifies an ordering for assets. Acceptable values are:\n`BEST`, `NEWEST`, `OLDEST`. Defaults to `BEST`, which ranks assets\nbased on a combination of popularity and other features.",
- "type": "string",
- "location": "query"
- },
- "format": {
- "description": "Return only assets with the matching format. Acceptable values are:\n`BLOCKS`, `FBX`, `GLTF`, `GLTF2`, `OBJ`, and `TILT`.",
- "type": "string",
- "location": "query"
- },
- "pageToken": {
- "description": "Specifies a continuation token from a previous search whose results were\nsplit into multiple pages. To get the next page, submit the same request\nspecifying the value from\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": {
- "enum": [
- "VISIBILITY_UNSPECIFIED",
- "PUBLISHED",
- "PRIVATE"
- ],
- "description": "The visibility of the assets to be returned.\nDefaults to VISIBILITY_UNSPECIFIED which returns all assets.",
- "type": "string",
- "location": "query"
- }
- },
- "flatPath": "v1/users/{usersId}/assets",
- "path": "v1/{+name}/assets",
- "id": "poly.users.assets.list"
- }
- }
- },
"likedassets": {
"methods": {
"list": {
- "id": "poly.users.likedassets.list",
- "path": "v1/{+name}/likedassets",
"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.",
- "httpMethod": "GET",
"response": {
"$ref": "ListLikedAssetsResponse"
},
"parameterOrder": [
"name"
],
+ "httpMethod": "GET",
"parameters": {
"name": {
"description": "A valid user id. Currently, only the special value 'me', representing the\ncurrently-authenticated user is supported. To use 'me', you must pass\nan OAuth token with the request.",
@@ -178,18 +119,77 @@
"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",
+ "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"
+ }
+ },
+ "flatPath": "v1/users/{usersId}/likedassets",
+ "path": "v1/{+name}/likedassets",
+ "id": "poly.users.likedassets.list"
+ }
+ }
+ },
+ "assets": {
+ "methods": {
+ "list": {
+ "path": "v1/{+name}/assets",
+ "id": "poly.users.assets.list",
+ "description": "Lists assets authored by the given user. Only the value 'me', representing\nthe currently-authenticated user, is supported. May include assets with an\naccess level of PRIVATE or\nUNLISTED and assets which are\nAll Rights Reserved for the\ncurrently-authenticated user.",
+ "response": {
+ "$ref": "ListUserAssetsResponse"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "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": {
+ "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": {
+ "description": "Specifies an ordering for assets. Acceptable values are:\n`BEST`, `NEWEST`, `OLDEST`. Defaults to `BEST`, which ranks assets\nbased on a combination of popularity and other features.",
+ "type": "string",
"location": "query"
},
"format": {
"location": "query",
- "description": "Return only assets with the matching format. Acceptable values are:\n`BLOCKS`, `FBX`, `GLTF`, `GLTF2`, `OBJ`, `TILT`.",
+ "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"
}
},
- "flatPath": "v1/users/{usersId}/likedassets"
+ "flatPath": "v1/users/{usersId}/assets"
}
}
}
@@ -197,9 +197,46 @@
}
},
"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"
+ },
+ "$.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",
@@ -211,84 +248,47 @@
"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": {
"description": "Available 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"
+ "default": "true",
+ "location": "query"
},
"oauth_token": {
"description": "OAuth 2.0 token for the current user.",
"type": "string",
"location": "query"
},
- "upload_protocol": {
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string",
- "location": "query"
- },
- "prettyPrint": {
- "description": "Returns response with indentations and line breaks.",
- "type": "boolean",
- "default": "true",
- "location": "query"
- },
- "uploadType": {
+ "bearer_token": {
"location": "query",
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "description": "OAuth bearer token.",
"type": "string"
- },
- "fields": {
- "location": "query",
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string"
- },
- "callback": {
- "location": "query",
- "description": "JSONP",
- "type": "string"
- },
- "$.xgafv": {
- "enum": [
- "1",
- "2"
- ],
- "description": "V1 error format.",
- "type": "string",
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query"
}
},
"version": "v1",
"baseUrl": "https://poly.googleapis.com/",
- "servicePath": "",
- "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",
"kind": "discovery#restDescription",
+ "description": "The Poly API provides read-only access to assets hosted on \u003ca href=\"https://poly.google.com\"\u003epoly.google.com\u003c/a\u003e.\n",
+ "servicePath": "",
"basePath": "",
"revision": "20171218",
"documentationLink": "https://developers.google.com/poly/",
@@ -296,21 +296,115 @@
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
+ "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": {
+ "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.",
+ "$ref": "Quaternion"
+ }
+ },
+ "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": {
+ "w": {
+ "description": "The scalar component.",
+ "format": "double",
+ "type": "number"
+ },
+ "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"
+ }
+ },
+ "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": {
+ "description": "The estimated number of triangles.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "id": "FormatComplexity",
+ "description": "Information on the complexity of this Format.",
+ "type": "object"
+ },
+ "ListUserAssetsResponse": {
+ "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"
+ },
+ "totalSize": {
+ "description": "The total number of assets in the list, without pagination.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "userAssets": {
+ "description": "A list of UserAssets matching the request.",
+ "type": "array",
+ "items": {
+ "$ref": "UserAsset"
+ }
+ }
+ },
+ "id": "ListUserAssetsResponse",
+ "description": "A response message from a request to list.",
+ "type": "object"
+ },
"UserAsset": {
+ "description": "Data about the user's asset.",
+ "type": "object",
"properties": {
"asset": {
"$ref": "Asset",
"description": "An Asset."
}
},
- "id": "UserAsset",
- "description": "Data about the user's asset.",
- "type": "object"
+ "id": "UserAsset"
},
"File": {
- "description": "Represents a file in Poly, which can be a root,\nresource, or thumbnail file.",
- "type": "object",
"properties": {
+ "url": {
+ "description": "The URL where the file data can be retrieved.",
+ "type": "string"
+ },
"contentType": {
"description": "The MIME content-type, such as `image/png`.\nFor more information, see\n[MIME types](//developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types).",
"type": "string"
@@ -318,15 +412,15 @@
"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"
+ "id": "File",
+ "description": "Represents a file in Poly, which can be a root,\nresource, or thumbnail file.",
+ "type": "object"
},
"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.",
@@ -345,9 +439,7 @@
"type": "integer"
}
},
- "id": "ListLikedAssetsResponse",
- "description": "A response message from a request to list.",
- "type": "object"
+ "id": "ListLikedAssetsResponse"
},
"ListAssetsResponse": {
"properties": {
@@ -382,12 +474,12 @@
}
},
"formatComplexity": {
- "$ref": "FormatComplexity",
- "description": "Complexity stats about this representation of the asset."
+ "description": "Complexity stats about this representation of the asset.",
+ "$ref": "FormatComplexity"
},
"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."
+ "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`.",
@@ -402,6 +494,49 @@
"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": {
+ "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": {
+ "$ref": "File",
+ "description": "The thumbnail image for the asset."
+ },
+ "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"
@@ -433,151 +568,16 @@
"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"
}
},
"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": {
- "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.",
- "$ref": "Quaternion"
- }
- },
- "id": "PresentationParams"
- },
- "Quaternion": {
- "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",
- "description": "A [Quaternion](//en.wikipedia.org/wiki/Quaternion). Please note: if in the\nresponse you see \"w: 1\" and nothing else this is the default value of\n[0, 0, 0, 1] where x,y, and z are 0.",
- "type": "object"
- },
- "FormatComplexity": {
- "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": {
- "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"
- },
- "totalSize": {
- "description": "The total number of assets in the list, without pagination.",
- "format": "int32",
- "type": "integer"
- },
- "userAssets": {
- "description": "A list of UserAssets matching the request.",
- "type": "array",
- "items": {
- "$ref": "UserAsset"
- }
- }
- },
- "id": "ListUserAssetsResponse",
- "description": "A response message from a request to list.",
- "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",
+ "icons": {
+ "x16": "http://www.google.com/images/icons/product/search-16.gif",
+ "x32": "http://www.google.com/images/icons/product/search-32.gif"
+ },
"canonicalName": "Poly Service",
"rootUrl": "https://poly.googleapis.com/",
"ownerDomain": "google.com",
diff --git a/proximitybeacon/v1beta1/proximitybeacon-api.json b/proximitybeacon/v1beta1/proximitybeacon-api.json
index 2edee05..54f3d85 100644
--- a/proximitybeacon/v1beta1/proximitybeacon-api.json
+++ b/proximitybeacon/v1beta1/proximitybeacon-api.json
@@ -1,4 +1,595 @@
{
+ "parameters": {
+ "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": {
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "type": "string",
+ "location": "query"
+ },
+ "pp": {
+ "description": "Pretty-print response.",
+ "type": "boolean",
+ "default": "true",
+ "location": "query"
+ },
+ "oauth_token": {
+ "location": "query",
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string"
+ },
+ "bearer_token": {
+ "description": "OAuth bearer token.",
+ "type": "string",
+ "location": "query"
+ },
+ "upload_protocol": {
+ "location": "query",
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "type": "string"
+ },
+ "prettyPrint": {
+ "description": "Returns response with indentations and line breaks.",
+ "type": "boolean",
+ "default": "true",
+ "location": "query"
+ },
+ "uploadType": {
+ "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": {
+ "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"
+ }
+ },
+ "schemas": {
+ "GetInfoForObservedBeaconsRequest": {
+ "type": "object",
+ "properties": {
+ "observations": {
+ "description": "The beacons that the client has encountered.\nAt least one must be given.",
+ "type": "array",
+ "items": {
+ "$ref": "Observation"
+ }
+ },
+ "namespacedTypes": {
+ "description": "Specifies what kind of attachments to include in the response.\nWhen given, the response will include only attachments of the given types.\nWhen empty, no attachments will be returned. Must be in the format\n\u003cvar\u003enamespace/type\u003c/var\u003e. Accepts `*` to specify all types in\nall namespaces owned by the client.\nOptional.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "id": "GetInfoForObservedBeaconsRequest",
+ "description": "Request for beacon and attachment information about beacons that\na mobile client has encountered \"in the wild\"."
+ },
+ "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 `{}`."
+ },
+ "BeaconAttachment": {
+ "description": "Project-specific data associated with a beacon.",
+ "type": "object",
+ "properties": {
+ "creationTimeMs": {
+ "description": "The UTC time when this attachment was created, in milliseconds since the\nUNIX epoch.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "maxDistanceMeters": {
+ "description": "The distance away from the beacon at which this attachment should be\ndelivered to a mobile app.\n\nSetting this to a value greater than zero indicates that the app should\nbehave as if the beacon is \"seen\" when the mobile device is less than this\ndistance away from the beacon.\n\nDifferent attachments on the same beacon can have different max distances.\n\nNote that even though this value is expressed with fractional meter\nprecision, real-world behavior is likley to be much less precise than one\nmeter, due to the nature of current Bluetooth radio technology.\n\nOptional. When not set or zero, the attachment should be delivered at the\nbeacon's outer limit of detection.\n\nNegative values are invalid and return an error.",
+ "format": "double",
+ "type": "number"
+ },
+ "attachmentName": {
+ "description": "Resource name of this attachment. Attachment names have the format:\n\u003ccode\u003ebeacons/\u003cvar\u003ebeacon_id\u003c/var\u003e/attachments/\u003cvar\u003eattachment_id\u003c/var\u003e\u003c/code\u003e.\nLeave this empty on creation.",
+ "type": "string"
+ },
+ "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",
+ "type": "string"
+ }
+ },
+ "id": "BeaconAttachment"
+ },
+ "EphemeralIdRegistration": {
+ "properties": {
+ "rotationPeriodExponent": {
+ "description": "Indicates the nominal period between each rotation of the beacon's\nephemeral ID. \"Nominal\" because the beacon should randomize the\nactual interval. See [the spec at github](https://github.com/google/eddystone/tree/master/eddystone-eid)\nfor details. This value corresponds to a power-of-two scaler on the\nbeacon's clock: when the scaler value is K, the beacon will begin\nbroadcasting a new ephemeral ID on average every 2^K seconds.",
+ "format": "uint32",
+ "type": "integer"
+ },
+ "serviceEcdhPublicKey": {
+ "description": "The service's public key used for the Elliptic curve Diffie-Hellman\nkey exchange. When this field is populated, `beacon_ecdh_public_key`\nmust also be populated, and `beacon_identity_key` must not be.",
+ "format": "byte",
+ "type": "string"
+ },
+ "beaconIdentityKey": {
+ "description": "The private key of the beacon. If this field is populated,\n`beacon_ecdh_public_key` and `service_ecdh_public_key` must not be\npopulated.",
+ "format": "byte",
+ "type": "string"
+ },
+ "initialEid": {
+ "type": "string",
+ "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"
+ },
+ "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"
+ }
+ },
+ "id": "EphemeralIdRegistration",
+ "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"
+ },
+ "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": {
+ "type": "number",
+ "description": "The longitude in degrees. It must be in the range [-180.0, +180.0].",
+ "format": "double"
+ },
+ "latitude": {
+ "description": "The latitude in degrees. It must be in the range [-90.0, +90.0].",
+ "format": "double",
+ "type": "number"
+ }
+ },
+ "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": {
+ "id": "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": {
+ "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."
+ ]
+ }
+ }
+ },
+ "BeaconInfo": {
+ "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",
+ "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"
+ },
+ "AttachmentInfo": {
+ "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": {
+ "type": "string",
+ "description": "An opaque data container for client-provided data.",
+ "format": "byte"
+ }
+ },
+ "id": "AttachmentInfo",
+ "description": "A subset of attachment information served via the\n`beaconinfo.getforobserved` method, used when your users encounter your\nbeacons."
+ },
+ "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": {
+ "id": "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"
+ }
+ }
+ },
+ "Observation": {
+ "id": "Observation",
+ "description": "Represents one beacon observed once.",
+ "type": "object",
+ "properties": {
+ "telemetry": {
+ "description": "The array of telemetry bytes received from the beacon. The server is\nresponsible for parsing it. This field may frequently be empty, as\nwith a beacon that transmits telemetry only occasionally.",
+ "format": "byte",
+ "type": "string"
+ },
+ "timestampMs": {
+ "description": "Time when the beacon was observed.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "advertisedId": {
+ "$ref": "AdvertisedId",
+ "description": "The ID advertised by the beacon the client has encountered.\n\nIf the submitted `advertised_id` type is Eddystone-EID, then the client\nmust be authorized to resolve the given beacon. Otherwise no data will be\nreturned for that beacon.\nRequired."
+ }
+ }
+ },
+ "ListDiagnosticsResponse": {
+ "properties": {
+ "diagnostics": {
+ "description": "The diagnostics matching the given request.",
+ "type": "array",
+ "items": {
+ "$ref": "Diagnostics"
+ }
+ },
+ "nextPageToken": {
+ "description": "Token that can be used for pagination. Returned only if the\nrequest matches more beacons than can be returned in this response.",
+ "type": "string"
+ }
+ },
+ "id": "ListDiagnosticsResponse",
+ "description": "Response that contains the requested diagnostics.",
+ "type": "object"
+ },
+ "GetInfoForObservedBeaconsResponse": {
+ "properties": {
+ "beacons": {
+ "description": "Public information about beacons.\nMay be empty if the request matched no beacons.",
+ "type": "array",
+ "items": {
+ "$ref": "BeaconInfo"
+ }
+ }
+ },
+ "id": "GetInfoForObservedBeaconsResponse",
+ "description": "Information about the requested beacons, optionally including attachment\ndata.",
+ "type": "object"
+ },
+ "Beacon": {
+ "description": "Details of a beacon device.",
+ "type": "object",
+ "properties": {
+ "expectedStability": {
+ "description": "Expected location stability. This is set when the beacon is registered or\nupdated, not automatically detected in any way.\nOptional.",
+ "type": "string",
+ "enumDescriptions": [
+ "Do not use this value.",
+ "Not expected to move, for example a store's front door.",
+ "Usually stable but may move rarely, usually within a single place,\nfor example a store display.",
+ "Moves frequently, for example a personal item or food truck.",
+ "Moves continuously in service, for example a bus or train."
+ ],
+ "enum": [
+ "STABILITY_UNSPECIFIED",
+ "STABLE",
+ "PORTABLE",
+ "MOBILE",
+ "ROVING"
+ ]
+ },
+ "advertisedId": {
+ "$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": {
+ "description": "Write-only registration parameters for beacons using Eddystone-EID\n(remotely resolved ephemeral ID) format. This information will not be\npopulated in API responses. When submitting this data, the `advertised_id`\nfield must contain an ID of type Eddystone-UID. Any other ID type will\nresult in an error.",
+ "$ref": "EphemeralIdRegistration"
+ },
+ "provisioningKey": {
+ "description": "Some beacons may require a user to provide an authorization key before\nchanging any of its configuration (e.g. broadcast frames, transmit power).\nThis field provides a place to store and control access to that key.\nThis field is populated in responses to `GET /v1beta1/beacons/3!beaconId`\nfrom users with write access to the given beacon. That is to say: If the\nuser is authorized to write the beacon's confidential data in the service,\nthe service considers them authorized to configure the beacon. Note\nthat this key grants nothing on the service, only on the beacon itself.",
+ "format": "byte",
+ "type": "string"
+ },
+ "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."
+ },
+ "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": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Properties of the beacon device, for example battery type or firmware\nversion.\nOptional.",
+ "type": "object"
+ },
+ "indoorLevel": {
+ "$ref": "IndoorLevel",
+ "description": "The indoor level information for this beacon, if known. As returned by the\nGoogle Maps API.\nOptional."
+ },
+ "status": {
+ "enumDescriptions": [
+ "Do not use this value.",
+ "The \"normal\" in-use state of a beacon.",
+ "Beacon should no longer be used for any purpose. This is irreversible.",
+ "The beacon should not be visible to mobile devices. This is reversible."
+ ],
+ "enum": [
+ "STATUS_UNSPECIFIED",
+ "ACTIVE",
+ "DECOMMISSIONED",
+ "INACTIVE"
+ ],
+ "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.",
+ "type": "string"
+ }
+ },
+ "id": "Beacon"
+ },
+ "AdvertisedId": {
+ "description": "Defines a unique identifier of a beacon as broadcast by the device.",
+ "type": "object",
+ "properties": {
+ "type": {
+ "enum": [
+ "TYPE_UNSPECIFIED",
+ "EDDYSTONE",
+ "IBEACON",
+ "ALTBEACON",
+ "EDDYSTONE_EID"
+ ],
+ "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",
+ "Apple iBeacon compatible beacon",
+ "See http://altbeacon.org and/or https://github.com/AltBeacon/spec.",
+ "Eddystone Ephemeral ID"
+ ]
+ },
+ "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.",
+ "format": "byte",
+ "type": "string"
+ }
+ },
+ "id": "AdvertisedId"
+ },
+ "IndoorLevel": {
+ "id": "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"
+ }
+ }
+ },
+ "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.",
+ "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"
+ }
+ }
+ },
+ "ListNamespacesResponse": {
+ "description": "Response to ListNamespacesRequest that contains all the project's namespaces.",
+ "type": "object",
+ "properties": {
+ "namespaces": {
+ "description": "The attachments that corresponded to the request params.",
+ "type": "array",
+ "items": {
+ "$ref": "Namespace"
+ }
+ }
+ },
+ "id": "ListNamespacesResponse"
+ },
+ "ListBeaconsResponse": {
+ "description": "Response that contains list beacon results and pagination help.",
+ "type": "object",
+ "properties": {
+ "nextPageToken": {
+ "description": "An opaque pagination token that the client may provide in their next\nrequest to retrieve the next page of results.",
+ "type": "string"
+ },
+ "beacons": {
+ "description": "The beacons that matched the search criteria.",
+ "type": "array",
+ "items": {
+ "$ref": "Beacon"
+ }
+ },
+ "totalCount": {
+ "description": "Estimate of the total number of beacons matched by the query. Higher\nvalues may be less accurate.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "id": "ListBeaconsResponse"
+ },
+ "Diagnostics": {
+ "properties": {
+ "estimatedLowBatteryDate": {
+ "$ref": "Date",
+ "description": "The date when the battery is expected to be low. If the value is missing\nthen there is no estimate for when the battery will be low.\nThis value is only an estimate, not an exact date."
+ },
+ "beaconName": {
+ "description": "Resource name of the beacon. For Eddystone-EID beacons, this may\nbe the beacon's current EID, or the beacon's \"stable\" Eddystone-UID.",
+ "type": "string"
+ },
+ "alerts": {
+ "enumDescriptions": [
+ "Invalid value. Should never appear.",
+ "The beacon has been reported far from its expected location (the beacon's\nlat_lng field if populated, otherwise, if the beacon's place_id field is\npresent, the center of that place). This may indicate that the beacon has\nbeen moved. This signal is not 100% accurate, but indicates that further\ninvestigation is worthwhile.",
+ "The battery level for the beacon is low enough that, given the beacon's\ncurrent use, its battery will run out with in the next 60 days. This\nindicates that the battery should be replaced soon.",
+ "The beacon has been reported at a very low rate or not at all. This may\nindicate that the beacon is broken or just that no one has gone near the\nbeacon in recent days. If this status appears unexpectedly, the beacon\nowner should investigate further."
+ ],
+ "description": "An unordered list of Alerts that the beacon has.",
+ "type": "array",
+ "items": {
+ "enum": [
+ "ALERT_UNSPECIFIED",
+ "WRONG_LOCATION",
+ "LOW_BATTERY",
+ "LOW_ACTIVITY"
+ ],
+ "type": "string"
+ }
+ }
+ },
+ "id": "Diagnostics",
+ "description": "Diagnostics for a single beacon.",
+ "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",
+ "version": "v1beta1",
"baseUrl": "https://proximitybeacon.googleapis.com/",
"auth": {
"oauth2": {
@@ -9,153 +600,121 @@
}
}
},
- "kind": "discovery#restDescription",
- "description": "Registers, manages, indexes, and searches beacons.",
"servicePath": "",
+ "description": "Registers, manages, indexes, and searches beacons.",
+ "kind": "discovery#restDescription",
"rootUrl": "https://proximitybeacon.googleapis.com/",
"basePath": "",
"ownerDomain": "google.com",
"name": "proximitybeacon",
"batchPath": "batch",
- "id": "proximitybeacon:v1beta1",
- "documentationLink": "https://developers.google.com/beacons/proximity/",
"revision": "20171112",
+ "documentationLink": "https://developers.google.com/beacons/proximity/",
+ "id": "proximitybeacon:v1beta1",
"title": "Google Proximity Beacon API",
- "ownerName": "Google",
"discoveryVersion": "v1",
+ "ownerName": "Google",
"version_module": true,
"resources": {
- "v1beta1": {
+ "beaconinfo": {
"methods": {
- "getEidparams": {
- "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": [],
+ "getforobserved": {
"response": {
- "$ref": "EphemeralIdRegistrationParams"
+ "$ref": "GetInfoForObservedBeaconsResponse"
},
+ "parameterOrder": [],
+ "httpMethod": "POST",
"parameters": {},
+ "flatPath": "v1beta1/beaconinfo:getforobserved",
+ "path": "v1beta1/beaconinfo:getforobserved",
+ "id": "proximitybeacon.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."
+ }
+ }
+ },
+ "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"
+ },
+ "parameterOrder": [],
+ "httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/userlocation.beacon.registry"
],
- "flatPath": "v1beta1/eidparams"
+ "parameters": {
+ "projectId": {
+ "description": "The project id to list namespaces under.\nOptional.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "flatPath": "v1beta1/namespaces",
+ "path": "v1beta1/namespaces",
+ "id": "proximitybeacon.namespaces.list"
+ },
+ "update": {
+ "description": "Updates the information about the specified namespace. Only the namespace\nvisibility can be updated.",
+ "request": {
+ "$ref": "Namespace"
+ },
+ "httpMethod": "PUT",
+ "parameterOrder": [
+ "namespaceName"
+ ],
+ "response": {
+ "$ref": "Namespace"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/userlocation.beacon.registry"
+ ],
+ "parameters": {
+ "namespaceName": {
+ "description": "Resource name of this namespace. Namespaces names have the format:\n\u003ccode\u003enamespaces/\u003cvar\u003enamespace\u003c/var\u003e\u003c/code\u003e.",
+ "required": true,
+ "type": "string",
+ "pattern": "^namespaces/[^/]+$",
+ "location": "path"
+ },
+ "projectId": {
+ "description": "The project id of the namespace to update. If the project id is not\nspecified then the project making the request is used. The project id\nmust match the project that owns the beacon.\nOptional.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "flatPath": "v1beta1/namespaces/{namespacesId}",
+ "id": "proximitybeacon.namespaces.update",
+ "path": "v1beta1/{+namespaceName}"
+ }
+ }
+ },
+ "v1beta1": {
+ "methods": {
+ "getEidparams": {
+ "flatPath": "v1beta1/eidparams",
+ "path": "v1beta1/eidparams",
+ "id": "proximitybeacon.getEidparams",
+ "description": "Gets the Proximity Beacon API's current public key and associated\nparameters used to initiate the Diffie-Hellman key exchange required to\nregister a beacon that broadcasts the Eddystone-EID format. This key\nchanges periodically; clients may cache it and re-use the same public key\nto provision and register multiple beacons. However, clients should be\nprepared to refresh this key when they encounter an error registering an\nEddystone-EID beacon.",
+ "response": {
+ "$ref": "EphemeralIdRegistrationParams"
+ },
+ "parameterOrder": [],
+ "httpMethod": "GET",
+ "parameters": {},
+ "scopes": [
+ "https://www.googleapis.com/auth/userlocation.beacon.registry"
+ ]
}
}
},
"beacons": {
"methods": {
- "register": {
- "parameters": {
- "projectId": {
- "type": "string",
- "location": "query",
- "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."
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/userlocation.beacon.registry"
- ],
- "flatPath": "v1beta1/beacons:register",
- "path": "v1beta1/beacons:register",
- "id": "proximitybeacon.beacons.register",
- "request": {
- "$ref": "Beacon"
- },
- "description": "Registers a previously unregistered beacon given its `advertisedId`.\nThese IDs are unique within the system. An ID can be registered only once.\n\nAuthenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2)\nfrom a signed-in user with **Is owner** or **Can edit** permissions in the\nGoogle Developers Console project.",
- "response": {
- "$ref": "Beacon"
- },
- "parameterOrder": [],
- "httpMethod": "POST"
- },
- "list": {
- "scopes": [
- "https://www.googleapis.com/auth/userlocation.beacon.registry"
- ],
- "parameters": {
- "pageToken": {
- "location": "query",
- "description": "A pagination token obtained from a previous request to list beacons.",
- "type": "string"
- },
- "q": {
- "location": "query",
- "description": "Filter query string that supports the following field filters:\n\n* **description:`\"\u003cstring\u003e\"`**\n For example: **description:\"Room 3\"**\n Returns beacons whose description matches tokens in the string \"Room 3\"\n (not necessarily that exact string).\n The string must be double-quoted.\n* **status:`\u003cenum\u003e`**\n For example: **status:active**\n Returns beacons whose status matches the given value. Values must be\n one of the Beacon.Status enum values (case insensitive). Accepts\n multiple filters which will be combined with OR logic.\n* **stability:`\u003cenum\u003e`**\n For example: **stability:mobile**\n Returns beacons whose expected stability matches the given value.\n Values must be one of the Beacon.Stability enum values (case\n insensitive). Accepts multiple filters which will be combined with\n OR logic.\n* **place\\_id:`\"\u003cstring\u003e\"`**\n For example: **place\\_id:\"ChIJVSZzVR8FdkgRXGmmm6SslKw=\"**\n Returns beacons explicitly registered at the given place, expressed as\n a Place ID obtained from [Google Places API](/places/place-id). Does not\n match places inside the given place. Does not consider the beacon's\n actual location (which may be different from its registered place).\n Accepts multiple filters that will be combined with OR logic. The place\n ID must be double-quoted.\n* **registration\\_time`[\u003c|\u003e|\u003c=|\u003e=]\u003cinteger\u003e`**\n For example: **registration\\_time\u003e=1433116800**\n Returns beacons whose registration time matches the given filter.\n Supports the operators: \u003c, \u003e, \u003c=, and \u003e=. Timestamp must be expressed as\n an integer number of seconds since midnight January 1, 1970 UTC. Accepts\n at most two filters that will be combined with AND logic, to support\n \"between\" semantics. If more than two are supplied, the latter ones are\n ignored.\n* **lat:`\u003cdouble\u003e lng:\u003cdouble\u003e radius:\u003cinteger\u003e`**\n For example: **lat:51.1232343 lng:-1.093852 radius:1000**\n Returns beacons whose registered location is within the given circle.\n When any of these fields are given, all are required. Latitude and\n longitude must be decimal degrees between -90.0 and 90.0 and between\n -180.0 and 180.0 respectively. Radius must be an integer number of\n meters between 10 and 1,000,000 (1000 km).\n* **property:`\"\u003cstring\u003e=\u003cstring\u003e\"`**\n For example: **property:\"battery-type=CR2032\"**\n Returns beacons which have a property of the given name and value.\n Supports multiple filters which will be combined with OR logic.\n The entire name=value string must be double-quoted as one string.\n* **attachment\\_type:`\"\u003cstring\u003e\"`**\n For example: **attachment_type:\"my-namespace/my-type\"**\n Returns beacons having at least one attachment of the given namespaced\n type. Supports \"any within this namespace\" via the partial wildcard\n syntax: \"my-namespace/*\". Supports multiple filters which will be\n combined with OR logic. The string must be double-quoted.\n* **indoor\\_level:`\"\u003cstring\u003e\"`**\n For example: **indoor\\_level:\"1\"**\n Returns beacons which are located on the given indoor level. Accepts\n multiple filters that will be combined with OR logic.\n\nMultiple filters on the same field are combined with OR logic (except\nregistration_time which is combined with AND logic).\nMultiple filters on different fields are combined with AND logic.\nFilters should be separated by spaces.\n\nAs with any HTTP query string parameter, the whole filter expression must\nbe URL-encoded.\n\nExample REST request:\n`GET /v1beta1/beacons?q=status:active%20lat:51.123%20lng:-1.095%20radius:1000`",
- "type": "string"
- },
- "pageSize": {
- "location": "query",
- "description": "The maximum number of records to return for this request, up to a\nserver-defined upper limit.",
- "format": "int32",
- "type": "integer"
- },
- "projectId": {
- "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"
- }
- },
- "flatPath": "v1beta1/beacons",
- "path": "v1beta1/beacons",
- "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.",
- "response": {
- "$ref": "ListBeaconsResponse"
- },
- "parameterOrder": [],
- "httpMethod": "GET"
- },
- "activate": {
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "beaconName"
- ],
- "httpMethod": "POST",
- "parameters": {
- "beaconName": {
- "required": true,
- "type": "string",
- "pattern": "^beacons/[^/]+$",
- "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."
- },
- "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"
- }
- },
- "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": {
- "scopes": [
- "https://www.googleapis.com/auth/userlocation.beacon.registry"
- ],
- "parameters": {
- "beaconName": {
- "description": "Resource name of this beacon. A beacon name has the format\n\"beacons/N!beaconId\" where the beaconId is the base16 ID broadcast by\nthe beacon and N is a code for the beacon's type. Possible values are\n`3` for Eddystone-UID, `4` for Eddystone-EID, `1` for iBeacon, or `5`\nfor AltBeacon. For Eddystone-EID beacons, you may use either the\ncurrent EID or the beacon's \"stable\" UID.\nRequired.",
- "required": true,
- "type": "string",
- "pattern": "^beacons/[^/]+$",
- "location": "path"
- },
- "projectId": {
- "type": "string",
- "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."
- }
- },
- "flatPath": "v1beta1/beacons/{beaconsId}",
"path": "v1beta1/{+beaconName}",
"id": "proximitybeacon.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.",
@@ -165,34 +724,19 @@
"parameterOrder": [
"beaconName"
],
- "httpMethod": "GET"
- },
- "update": {
- "path": "v1beta1/{+beaconName}",
- "id": "proximitybeacon.beacons.update",
- "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.",
- "response": {
- "$ref": "Beacon"
- },
- "parameterOrder": [
- "beaconName"
- ],
- "httpMethod": "PUT",
+ "httpMethod": "GET",
"parameters": {
"beaconName": {
- "required": true,
- "type": "string",
"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."
+ "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"
},
"projectId": {
- "description": "The project id of the beacon to update. If the project id is not\nspecified then the project making the request is used. The project id\nmust match the project that owns the beacon.\nOptional.",
- "type": "string",
- "location": "query"
+ "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": [
@@ -200,68 +744,70 @@
],
"flatPath": "v1beta1/beacons/{beaconsId}"
},
- "decommission": {
- "flatPath": "v1beta1/beacons/{beaconsId}:decommission",
- "id": "proximitybeacon.beacons.decommission",
- "path": "v1beta1/{+beaconName}:decommission",
- "description": "Decommissions the specified beacon in the service. This beacon will no\nlonger be returned from `beaconinfo.getforobserved`. This operation is\npermanent -- you will not be able to re-register a beacon with this ID\nagain.\n\nAuthenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2)\nfrom a signed-in user with **Is owner** or **Can edit** permissions in the\nGoogle Developers Console project.",
- "httpMethod": "POST",
+ "update": {
+ "httpMethod": "PUT",
"parameterOrder": [
"beaconName"
],
"response": {
- "$ref": "Empty"
+ "$ref": "Beacon"
},
"parameters": {
- "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/[^/]+$"
- },
"projectId": {
+ "description": "The project id of the beacon to update. If the project id is not\nspecified then the project making the request is used. The project id\nmust match the project that owns the beacon.\nOptional.",
"type": "string",
- "location": "query",
- "description": "The project id of the beacon to decommission. If the project id is not\nspecified then the project making the request is used. The project id\nmust match the project that owns the beacon.\nOptional."
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/userlocation.beacon.registry"
- ]
- },
- "deactivate": {
- "description": "Deactivates a beacon. Once deactivated, the API will not return\ninformation nor attachment data for the beacon when queried via\n`beaconinfo.getforobserved`. Calling this method on an already inactive\nbeacon will do nothing (but will return a successful response code).\n\nAuthenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2)\nfrom a signed-in user with **Is owner** or **Can edit** permissions in the\nGoogle Developers Console project.",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "beaconName"
- ],
- "httpMethod": "POST",
- "parameters": {
+ "location": "query"
+ },
"beaconName": {
- "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.",
+ "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"
- },
- "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"
+ "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."
+ },
+ "decommission": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "beaconName"
+ ],
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameters": {
+ "projectId": {
+ "location": "query",
+ "description": "The project id of the beacon to decommission. If the project id is not\nspecified then the project making the request is used. The project id\nmust match the project that owns the beacon.\nOptional.",
+ "type": "string"
+ },
+ "beaconName": {
+ "pattern": "^beacons/[^/]+$",
+ "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"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/userlocation.beacon.registry"
+ ],
+ "flatPath": "v1beta1/beacons/{beaconsId}:decommission",
+ "id": "proximitybeacon.beacons.decommission",
+ "path": "v1beta1/{+beaconName}: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."
},
"delete": {
- "description": "Deletes the specified beacon including all diagnostics data for the beacon\nas well as any attachments on the beacon (including those belonging to\nother projects). This operation cannot be undone.\n\nAuthenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2)\nfrom a signed-in user with **Is owner** or **Can edit** permissions in the\nGoogle Developers Console project.",
"response": {
"$ref": "Empty"
},
@@ -270,17 +816,17 @@
],
"httpMethod": "DELETE",
"parameters": {
+ "projectId": {
+ "description": "The project id of the beacon to delete. If not provided, the project\nthat is making the request is used.\nOptional.",
+ "type": "string",
+ "location": "query"
+ },
"beaconName": {
"description": "Beacon that should be deleted. A beacon name has the format\n\"beacons/N!beaconId\" where the beaconId is the base16 ID broadcast by\nthe beacon and N is a code for the beacon's type. Possible values are\n`3` for Eddystone-UID, `4` for Eddystone-EID, `1` for iBeacon, or `5`\nfor AltBeacon. For Eddystone-EID beacons, you may use either the\ncurrent EID or the beacon's \"stable\" UID.\nRequired.",
"required": true,
"type": "string",
"pattern": "^beacons/[^/]+$",
"location": "path"
- },
- "projectId": {
- "location": "query",
- "description": "The project id of the beacon to delete. If not provided, the project\nthat is making the request is used.\nOptional.",
- "type": "string"
}
},
"scopes": [
@@ -288,44 +834,157 @@
],
"flatPath": "v1beta1/beacons/{beaconsId}",
"path": "v1beta1/{+beaconName}",
- "id": "proximitybeacon.beacons.delete"
+ "id": "proximitybeacon.beacons.delete",
+ "description": "Deletes the specified beacon including all diagnostics data for the beacon\nas well as any attachments on the beacon (including those belonging to\nother projects). This operation cannot be undone.\n\nAuthenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2)\nfrom a signed-in user with **Is owner** or **Can edit** permissions in the\nGoogle Developers Console project."
+ },
+ "deactivate": {
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "beaconName"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "beaconName": {
+ "location": "path",
+ "description": "Beacon that should be deactivated. A beacon name has the format\n\"beacons/N!beaconId\" where the beaconId is the base16 ID broadcast by\nthe beacon and N is a code for the beacon's type. Possible values are\n`3` for Eddystone-UID, `4` for Eddystone-EID, `1` for iBeacon, or `5`\nfor AltBeacon. For Eddystone-EID beacons, you may use either the\ncurrent EID or the beacon's \"stable\" UID.\nRequired.",
+ "required": true,
+ "type": "string",
+ "pattern": "^beacons/[^/]+$"
+ },
+ "projectId": {
+ "type": "string",
+ "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."
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/userlocation.beacon.registry"
+ ],
+ "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."
+ },
+ "register": {
+ "request": {
+ "$ref": "Beacon"
+ },
+ "description": "Registers a previously unregistered beacon given its `advertisedId`.\nThese IDs are unique within the system. An ID can be registered only once.\n\nAuthenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2)\nfrom a signed-in user with **Is owner** or **Can edit** permissions in the\nGoogle Developers Console project.",
+ "httpMethod": "POST",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "Beacon"
+ },
+ "parameters": {
+ "projectId": {
+ "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",
+ "location": "query"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/userlocation.beacon.registry"
+ ],
+ "flatPath": "v1beta1/beacons:register",
+ "id": "proximitybeacon.beacons.register",
+ "path": "v1beta1/beacons:register"
+ },
+ "list": {
+ "path": "v1beta1/beacons",
+ "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.",
+ "response": {
+ "$ref": "ListBeaconsResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/userlocation.beacon.registry"
+ ],
+ "parameters": {
+ "pageToken": {
+ "description": "A pagination token obtained from a previous request to list beacons.",
+ "type": "string",
+ "location": "query"
+ },
+ "q": {
+ "location": "query",
+ "description": "Filter query string that supports the following field filters:\n\n* **description:`\"\u003cstring\u003e\"`**\n For example: **description:\"Room 3\"**\n Returns beacons whose description matches tokens in the string \"Room 3\"\n (not necessarily that exact string).\n The string must be double-quoted.\n* **status:`\u003cenum\u003e`**\n For example: **status:active**\n Returns beacons whose status matches the given value. Values must be\n one of the Beacon.Status enum values (case insensitive). Accepts\n multiple filters which will be combined with OR logic.\n* **stability:`\u003cenum\u003e`**\n For example: **stability:mobile**\n Returns beacons whose expected stability matches the given value.\n Values must be one of the Beacon.Stability enum values (case\n insensitive). Accepts multiple filters which will be combined with\n OR logic.\n* **place\\_id:`\"\u003cstring\u003e\"`**\n For example: **place\\_id:\"ChIJVSZzVR8FdkgRXGmmm6SslKw=\"**\n Returns beacons explicitly registered at the given place, expressed as\n a Place ID obtained from [Google Places API](/places/place-id). Does not\n match places inside the given place. Does not consider the beacon's\n actual location (which may be different from its registered place).\n Accepts multiple filters that will be combined with OR logic. The place\n ID must be double-quoted.\n* **registration\\_time`[\u003c|\u003e|\u003c=|\u003e=]\u003cinteger\u003e`**\n For example: **registration\\_time\u003e=1433116800**\n Returns beacons whose registration time matches the given filter.\n Supports the operators: \u003c, \u003e, \u003c=, and \u003e=. Timestamp must be expressed as\n an integer number of seconds since midnight January 1, 1970 UTC. Accepts\n at most two filters that will be combined with AND logic, to support\n \"between\" semantics. If more than two are supplied, the latter ones are\n ignored.\n* **lat:`\u003cdouble\u003e lng:\u003cdouble\u003e radius:\u003cinteger\u003e`**\n For example: **lat:51.1232343 lng:-1.093852 radius:1000**\n Returns beacons whose registered location is within the given circle.\n When any of these fields are given, all are required. Latitude and\n longitude must be decimal degrees between -90.0 and 90.0 and between\n -180.0 and 180.0 respectively. Radius must be an integer number of\n meters between 10 and 1,000,000 (1000 km).\n* **property:`\"\u003cstring\u003e=\u003cstring\u003e\"`**\n For example: **property:\"battery-type=CR2032\"**\n Returns beacons which have a property of the given name and value.\n Supports multiple filters which will be combined with OR logic.\n The entire name=value string must be double-quoted as one string.\n* **attachment\\_type:`\"\u003cstring\u003e\"`**\n For example: **attachment_type:\"my-namespace/my-type\"**\n Returns beacons having at least one attachment of the given namespaced\n type. Supports \"any within this namespace\" via the partial wildcard\n syntax: \"my-namespace/*\". Supports multiple filters which will be\n combined with OR logic. The string must be double-quoted.\n* **indoor\\_level:`\"\u003cstring\u003e\"`**\n For example: **indoor\\_level:\"1\"**\n Returns beacons which are located on the given indoor level. Accepts\n multiple filters that will be combined with OR logic.\n\nMultiple filters on the same field are combined with OR logic (except\nregistration_time which is combined with AND logic).\nMultiple filters on different fields are combined with AND logic.\nFilters should be separated by spaces.\n\nAs with any HTTP query string parameter, the whole filter expression must\nbe URL-encoded.\n\nExample REST request:\n`GET /v1beta1/beacons?q=status:active%20lat:51.123%20lng:-1.095%20radius:1000`",
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "The maximum number of records to return for this request, up to a\nserver-defined upper limit.",
+ "format": "int32",
+ "type": "integer",
+ "location": "query"
+ },
+ "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"
+ }
+ },
+ "flatPath": "v1beta1/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",
+ "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": {
+ "pattern": "^beacons/[^/]+$",
+ "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"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/userlocation.beacon.registry"
+ ],
+ "flatPath": "v1beta1/beacons/{beaconsId}:activate",
+ "path": "v1beta1/{+beaconName}:activate",
+ "id": "proximitybeacon.beacons.activate"
}
},
"resources": {
"diagnostics": {
"methods": {
"list": {
+ "flatPath": "v1beta1/beacons/{beaconsId}/diagnostics",
+ "path": "v1beta1/{+beaconName}/diagnostics",
+ "id": "proximitybeacon.beacons.diagnostics.list",
"description": "List the diagnostics for a single beacon. You can also list diagnostics for\nall the beacons owned by your Google Developers Console project by using\nthe beacon name `beacons/-`.\n\nAuthenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2)\nfrom a signed-in user with **viewer**, **Is owner** or **Can edit**\npermissions in the Google Developers Console project.",
- "httpMethod": "GET",
- "parameterOrder": [
- "beaconName"
- ],
"response": {
"$ref": "ListDiagnosticsResponse"
},
+ "parameterOrder": [
+ "beaconName"
+ ],
+ "httpMethod": "GET",
"parameters": {
- "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"
},
"pageSize": {
- "location": "query",
"description": "Specifies the maximum number of results to return. Defaults to\n10. Maximum 1000. Optional.",
"format": "int32",
- "type": "integer"
+ "type": "integer",
+ "location": "query"
},
"alertFilter": {
"location": "query",
@@ -337,21 +996,29 @@
],
"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": {
+ "location": "path",
+ "description": "Beacon that the diagnostics are for.",
+ "required": true,
+ "type": "string",
+ "pattern": "^beacons/[^/]+$"
}
},
"scopes": [
"https://www.googleapis.com/auth/userlocation.beacon.registry"
- ],
- "flatPath": "v1beta1/beacons/{beaconsId}/diagnostics",
- "id": "proximitybeacon.beacons.diagnostics.list",
- "path": "v1beta1/{+beaconName}/diagnostics"
+ ]
}
}
},
"attachments": {
"methods": {
"create": {
- "flatPath": "v1beta1/beacons/{beaconsId}/attachments",
"path": "v1beta1/{+beaconName}/attachments",
"id": "proximitybeacon.beacons.attachments.create",
"description": "Associates the given data with the specified beacon. Attachment data must\ncontain two parts:\n\u003cul\u003e\n\u003cli\u003eA namespaced type.\u003c/li\u003e\n\u003cli\u003eThe actual attachment data itself.\u003c/li\u003e\n\u003c/ul\u003e\nThe namespaced type consists of two parts, the namespace and the type.\nThe namespace must be one of the values returned by the `namespaces`\nendpoint, while the type can be a string of any characters except for the\nforward slash (`/`) up to 100 characters in length.\n\nAttachment data can be up to 1024 bytes long.\n\nAuthenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2)\nfrom a signed-in user with **Is owner** or **Can edit** permissions in the\nGoogle Developers Console project.",
@@ -381,42 +1048,43 @@
"pattern": "^beacons/[^/]+$",
"location": "path"
}
- }
+ },
+ "flatPath": "v1beta1/beacons/{beaconsId}/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.",
+ "httpMethod": "POST",
"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": {
+ "pattern": "^beacons/[^/]+$",
"location": "path",
"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/[^/]+$"
- },
- "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"
+ "type": "string"
}
},
"scopes": [
"https://www.googleapis.com/auth/userlocation.beacon.registry"
],
"flatPath": "v1beta1/beacons/{beaconsId}/attachments:batchDelete",
+ "id": "proximitybeacon.beacons.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."
},
"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.",
@@ -427,6 +1095,9 @@
"attachmentName"
],
"httpMethod": "DELETE",
+ "scopes": [
+ "https://www.googleapis.com/auth/userlocation.beacon.registry"
+ ],
"parameters": {
"attachmentName": {
"pattern": "^beacons/[^/]+/attachments/[^/]+$",
@@ -436,29 +1107,27 @@
"type": "string"
},
"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",
- "description": "The project id of the attachment to delete. If not provided, the project\nthat is making the request is used.\nOptional."
+ "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"
},
"list": {
- "path": "v1beta1/{+beaconName}/attachments",
+ "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.",
- "response": {
- "$ref": "ListBeaconAttachmentsResponse"
- },
+ "httpMethod": "GET",
"parameterOrder": [
"beaconName"
],
- "httpMethod": "GET",
+ "response": {
+ "$ref": "ListBeaconAttachmentsResponse"
+ },
"parameters": {
"projectId": {
"location": "query",
@@ -471,689 +1140,20 @@
"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\"."
},
"beaconName": {
- "location": "path",
"description": "Beacon whose attachments should be fetched. A beacon name has the\nformat \"beacons/N!beaconId\" where the beaconId is the base16 ID broadcast\nby the beacon and N is a code for the beacon's type. Possible values are\n`3` for Eddystone-UID, `4` for Eddystone-EID, `1` for iBeacon, or `5`\nfor AltBeacon. For Eddystone-EID beacons, you may use either the\ncurrent EID or the beacon's \"stable\" UID.\nRequired.",
"required": true,
"type": "string",
- "pattern": "^beacons/[^/]+$"
+ "pattern": "^beacons/[^/]+$",
+ "location": "path"
}
},
"scopes": [
"https://www.googleapis.com/auth/userlocation.beacon.registry"
- ],
- "flatPath": "v1beta1/beacons/{beaconsId}/attachments"
+ ]
}
}
}
}
- },
- "beaconinfo": {
- "methods": {
- "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.",
- "response": {
- "$ref": "GetInfoForObservedBeaconsResponse"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "parameters": {},
- "flatPath": "v1beta1/beaconinfo:getforobserved",
- "path": "v1beta1/beaconinfo:getforobserved",
- "id": "proximitybeacon.beaconinfo.getforobserved"
- }
- }
- },
- "namespaces": {
- "methods": {
- "list": {
- "response": {
- "$ref": "ListNamespacesResponse"
- },
- "parameterOrder": [],
- "httpMethod": "GET",
- "parameters": {
- "projectId": {
- "location": "query",
- "description": "The project id to list namespaces under.\nOptional.",
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/userlocation.beacon.registry"
- ],
- "flatPath": "v1beta1/namespaces",
- "path": "v1beta1/namespaces",
- "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.",
- "request": {
- "$ref": "Namespace"
- },
- "response": {
- "$ref": "Namespace"
- },
- "parameterOrder": [
- "namespaceName"
- ],
- "httpMethod": "PUT",
- "scopes": [
- "https://www.googleapis.com/auth/userlocation.beacon.registry"
- ],
- "parameters": {
- "namespaceName": {
- "pattern": "^namespaces/[^/]+$",
- "location": "path",
- "description": "Resource name of this namespace. Namespaces names have the format:\n\u003ccode\u003enamespaces/\u003cvar\u003enamespace\u003c/var\u003e\u003c/code\u003e.",
- "required": true,
- "type": "string"
- },
- "projectId": {
- "description": "The project id of the namespace to update. If the project id is not\nspecified then the project making the request is used. The project id\nmust match the project that owns the beacon.\nOptional.",
- "type": "string",
- "location": "query"
- }
- },
- "flatPath": "v1beta1/namespaces/{namespacesId}",
- "path": "v1beta1/{+namespaceName}",
- "id": "proximitybeacon.namespaces.update"
- }
- }
}
- },
- "parameters": {
- "quotaUser": {
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string",
- "location": "query"
- },
- "pp": {
- "description": "Pretty-print response.",
- "type": "boolean",
- "default": "true",
- "location": "query"
- },
- "oauth_token": {
- "location": "query",
- "description": "OAuth 2.0 token for the current user.",
- "type": "string"
- },
- "bearer_token": {
- "location": "query",
- "description": "OAuth bearer token.",
- "type": "string"
- },
- "upload_protocol": {
- "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": {
- "type": "string",
- "location": "query",
- "description": "Selector specifying which fields to include in a partial response."
- },
- "$.xgafv": {
- "enum": [
- "1",
- "2"
- ],
- "description": "V1 error format.",
- "type": "string",
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query"
- },
- "callback": {
- "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"
- }
- },
- "schemas": {
- "GetInfoForObservedBeaconsResponse": {
- "description": "Information about the requested beacons, optionally including attachment\ndata.",
- "type": "object",
- "properties": {
- "beacons": {
- "description": "Public information about beacons.\nMay be empty if the request matched no beacons.",
- "type": "array",
- "items": {
- "$ref": "BeaconInfo"
- }
- }
- },
- "id": "GetInfoForObservedBeaconsResponse"
- },
- "Beacon": {
- "description": "Details of a beacon device.",
- "type": "object",
- "properties": {
- "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"
- },
- "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"
- },
- "properties": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "Properties of the beacon device, for example battery type or firmware\nversion.\nOptional.",
- "type": "object"
- },
- "status": {
- "description": "Current status of the beacon.\nRequired.",
- "type": "string",
- "enumDescriptions": [
- "Do not use this value.",
- "The \"normal\" in-use state of a beacon.",
- "Beacon should no longer be used for any purpose. This is irreversible.",
- "The beacon should not be visible to mobile devices. This is reversible."
- ],
- "enum": [
- "STATUS_UNSPECIFIED",
- "ACTIVE",
- "DECOMMISSIONED",
- "INACTIVE"
- ]
- },
- "indoorLevel": {
- "$ref": "IndoorLevel",
- "description": "The indoor level information for this beacon, if known. As returned by the\nGoogle Maps API.\nOptional."
- },
- "beaconName": {
- "description": "Resource name of this beacon. A beacon name has the format\n\"beacons/N!beaconId\" where the beaconId is the base16 ID broadcast by\nthe beacon and N is a code for the beacon's type. Possible values are\n`3` for Eddystone, `1` for iBeacon, or `5` for AltBeacon.\n\nThis field must be left empty when registering. After reading a beacon,\nclients can use the name for future operations.",
- "type": "string"
- },
- "expectedStability": {
- "enum": [
- "STABILITY_UNSPECIFIED",
- "STABLE",
- "PORTABLE",
- "MOBILE",
- "ROVING"
- ],
- "description": "Expected location stability. This is set when the beacon is registered or\nupdated, not automatically detected in any way.\nOptional.",
- "type": "string",
- "enumDescriptions": [
- "Do not use this value.",
- "Not expected to move, for example a store's front door.",
- "Usually stable but may move rarely, usually within a single place,\nfor example a store display.",
- "Moves frequently, for example a personal item or food truck.",
- "Moves continuously in service, for example a bus or train."
- ]
- },
- "advertisedId": {
- "description": "The identifier of a beacon as advertised by it. This field must be\npopulated when registering. It may be empty when updating a beacon\nrecord because it is ignored in updates.\n\nWhen registering a beacon that broadcasts Eddystone-EID, this field\nshould contain a \"stable\" Eddystone-UID that identifies the beacon and\nlinks it to its attachments. The stable Eddystone-UID is only used for\nadministering the beacon.",
- "$ref": "AdvertisedId"
- },
- "ephemeralIdRegistration": {
- "$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": {
- "type": "string",
- "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"
- }
- },
- "id": "Beacon"
- },
- "AdvertisedId": {
- "description": "Defines a unique identifier of a beacon as broadcast by the device.",
- "type": "object",
- "properties": {
- "id": {
- "type": "string",
- "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.",
- "format": "byte"
- },
- "type": {
- "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",
- "Apple iBeacon compatible beacon",
- "See http://altbeacon.org and/or https://github.com/AltBeacon/spec.",
- "Eddystone Ephemeral ID"
- ],
- "enum": [
- "TYPE_UNSPECIFIED",
- "EDDYSTONE",
- "IBEACON",
- "ALTBEACON",
- "EDDYSTONE_EID"
- ],
- "description": "Specifies the identifier type.\nRequired.",
- "type": "string"
- }
- },
- "id": "AdvertisedId"
- },
- "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"
- }
- },
- "id": "Date"
- },
- "IndoorLevel": {
- "type": "object",
- "properties": {
- "name": {
- "description": "The name of this level.",
- "type": "string"
- }
- },
- "id": "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."
- },
- "ListNamespacesResponse": {
- "type": "object",
- "properties": {
- "namespaces": {
- "description": "The attachments that corresponded to the request params.",
- "type": "array",
- "items": {
- "$ref": "Namespace"
- }
- }
- },
- "id": "ListNamespacesResponse",
- "description": "Response to ListNamespacesRequest that contains all the project's namespaces."
- },
- "ListBeaconsResponse": {
- "type": "object",
- "properties": {
- "nextPageToken": {
- "description": "An opaque pagination token that the client may provide in their next\nrequest to retrieve the next page of results.",
- "type": "string"
- },
- "beacons": {
- "description": "The beacons that matched the search criteria.",
- "type": "array",
- "items": {
- "$ref": "Beacon"
- }
- },
- "totalCount": {
- "description": "Estimate of the total number of beacons matched by the query. Higher\nvalues may be less accurate.",
- "format": "int64",
- "type": "string"
- }
- },
- "id": "ListBeaconsResponse",
- "description": "Response that contains list beacon results and pagination help."
- },
- "Diagnostics": {
- "type": "object",
- "properties": {
- "estimatedLowBatteryDate": {
- "description": "The date when the battery is expected to be low. If the value is missing\nthen there is no estimate for when the battery will be low.\nThis value is only an estimate, not an exact date.",
- "$ref": "Date"
- },
- "beaconName": {
- "description": "Resource name of the beacon. For Eddystone-EID beacons, this may\nbe the beacon's current EID, or the beacon's \"stable\" Eddystone-UID.",
- "type": "string"
- },
- "alerts": {
- "enumDescriptions": [
- "Invalid value. Should never appear.",
- "The beacon has been reported far from its expected location (the beacon's\nlat_lng field if populated, otherwise, if the beacon's place_id field is\npresent, the center of that place). This may indicate that the beacon has\nbeen moved. This signal is not 100% accurate, but indicates that further\ninvestigation is worthwhile.",
- "The battery level for the beacon is low enough that, given the beacon's\ncurrent use, its battery will run out with in the next 60 days. This\nindicates that the battery should be replaced soon.",
- "The beacon has been reported at a very low rate or not at all. This may\nindicate that the beacon is broken or just that no one has gone near the\nbeacon in recent days. If this status appears unexpectedly, the beacon\nowner should investigate further."
- ],
- "description": "An unordered list of Alerts that the beacon has.",
- "type": "array",
- "items": {
- "type": "string",
- "enum": [
- "ALERT_UNSPECIFIED",
- "WRONG_LOCATION",
- "LOW_BATTERY",
- "LOW_ACTIVITY"
- ]
- }
- }
- },
- "id": "Diagnostics",
- "description": "Diagnostics for a single beacon."
- },
- "Empty": {
- "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
- "type": "object",
- "properties": {},
- "id": "Empty"
- },
- "GetInfoForObservedBeaconsRequest": {
- "description": "Request for beacon and attachment information about beacons that\na mobile client has encountered \"in the wild\".",
- "type": "object",
- "properties": {
- "observations": {
- "type": "array",
- "items": {
- "$ref": "Observation"
- },
- "description": "The beacons that the client has encountered.\nAt least one must be given."
- },
- "namespacedTypes": {
- "description": "Specifies what kind of attachments to include in the response.\nWhen given, the response will include only attachments of the given types.\nWhen empty, no attachments will be returned. Must be in the format\n\u003cvar\u003enamespace/type\u003c/var\u003e. Accepts `*` to specify all types in\nall namespaces owned by the client.\nOptional.",
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "id": "GetInfoForObservedBeaconsRequest"
- },
- "BeaconAttachment": {
- "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",
- "type": "string"
- },
- "creationTimeMs": {
- "description": "The UTC time when this attachment was created, in milliseconds since the\nUNIX epoch.",
- "format": "google-datetime",
- "type": "string"
- },
- "maxDistanceMeters": {
- "description": "The distance away from the beacon at which this attachment should be\ndelivered to a mobile app.\n\nSetting this to a value greater than zero indicates that the app should\nbehave as if the beacon is \"seen\" when the mobile device is less than this\ndistance away from the beacon.\n\nDifferent attachments on the same beacon can have different max distances.\n\nNote that even though this value is expressed with fractional meter\nprecision, real-world behavior is likley to be much less precise than one\nmeter, due to the nature of current Bluetooth radio technology.\n\nOptional. When not set or zero, the attachment should be delivered at the\nbeacon's outer limit of detection.\n\nNegative values are invalid and return an error.",
- "format": "double",
- "type": "number"
- }
- },
- "id": "BeaconAttachment"
- },
- "EphemeralIdRegistration": {
- "description": "Write-only registration parameters for beacons using Eddystone-EID format.\nTwo ways of securely registering an Eddystone-EID beacon with the service\nare supported:\n\n1. Perform an ECDH key exchange via this API, including a previous call\n to `GET /v1beta1/eidparams`. In this case the fields\n `beacon_ecdh_public_key` and `service_ecdh_public_key` should be\n populated and `beacon_identity_key` should not be populated. This\n method ensures that only the two parties in the ECDH key exchange can\n compute the identity key, which becomes a secret between them.\n2. Derive or obtain the beacon's identity key via other secure means\n (perhaps an ECDH key exchange between the beacon and a mobile device\n or any other secure method), and then submit the resulting identity key\n to the service. In this case `beacon_identity_key` field should be\n populated, and neither of `beacon_ecdh_public_key` nor\n `service_ecdh_public_key` fields should be. The security of this method\n depends on how securely the parties involved (in particular the\n bluetooth client) handle the identity key, and obviously on how\n securely the identity key was generated.\n\nSee [the Eddystone specification](https://github.com/google/eddystone/tree/master/eddystone-eid) at GitHub.",
- "type": "object",
- "properties": {
- "rotationPeriodExponent": {
- "description": "Indicates the nominal period between each rotation of the beacon's\nephemeral ID. \"Nominal\" because the beacon should randomize the\nactual interval. See [the spec at github](https://github.com/google/eddystone/tree/master/eddystone-eid)\nfor details. This value corresponds to a power-of-two scaler on the\nbeacon's clock: when the scaler value is K, the beacon will begin\nbroadcasting a new ephemeral ID on average every 2^K seconds.",
- "format": "uint32",
- "type": "integer"
- },
- "serviceEcdhPublicKey": {
- "description": "The service's public key used for the Elliptic curve Diffie-Hellman\nkey exchange. When this field is populated, `beacon_ecdh_public_key`\nmust also be populated, and `beacon_identity_key` must not be.",
- "format": "byte",
- "type": "string"
- },
- "beaconIdentityKey": {
- "description": "The private key of the beacon. If this field is populated,\n`beacon_ecdh_public_key` and `service_ecdh_public_key` must not be\npopulated.",
- "format": "byte",
- "type": "string"
- },
- "initialEid": {
- "type": "string",
- "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"
- },
- "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": {
- "type": "string",
- "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"
- }
- },
- "id": "EphemeralIdRegistration"
- },
- "LatLng": {
- "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",
- "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."
- },
- "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": {
- "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"
- },
- "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": {
- "id": "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": {
- "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"
- }
- }
- }
- },
- "AttachmentInfo": {
- "type": "object",
- "properties": {
- "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"
- },
- "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"
- }
- },
- "id": "AttachmentInfo",
- "description": "A subset of attachment information served via the\n`beaconinfo.getforobserved` method, used when your users encounter your\nbeacons."
- },
- "DeleteAttachmentsResponse": {
- "description": "Response for a request to delete attachments.",
- "type": "object",
- "properties": {
- "numDeleted": {
- "type": "integer",
- "description": "The number of attachments that were deleted.",
- "format": "int32"
- }
- },
- "id": "DeleteAttachmentsResponse"
- },
- "EphemeralIdRegistrationParams": {
- "description": "Information a client needs to provision and register beacons that\nbroadcast Eddystone-EID format beacon IDs, using Elliptic curve\nDiffie-Hellman key exchange. See\n[the Eddystone specification](https://github.com/google/eddystone/tree/master/eddystone-eid) at GitHub.",
- "type": "object",
- "properties": {
- "minRotationPeriodExponent": {
- "description": "Indicates the minimum rotation period supported by the service.\nSee EddystoneEidRegistration.rotation_period_exponent",
- "format": "uint32",
- "type": "integer"
- },
- "maxRotationPeriodExponent": {
- "description": "Indicates the maximum rotation period supported by the service.\nSee EddystoneEidRegistration.rotation_period_exponent",
- "format": "uint32",
- "type": "integer"
- },
- "serviceEcdhPublicKey": {
- "description": "The beacon service's public key for use by a beacon to derive its\nIdentity Key using Elliptic Curve Diffie-Hellman key exchange.",
- "format": "byte",
- "type": "string"
- }
- },
- "id": "EphemeralIdRegistrationParams"
- },
- "Observation": {
- "description": "Represents one beacon observed once.",
- "type": "object",
- "properties": {
- "telemetry": {
- "description": "The array of telemetry bytes received from the beacon. The server is\nresponsible for parsing it. This field may frequently be empty, as\nwith a beacon that transmits telemetry only occasionally.",
- "format": "byte",
- "type": "string"
- },
- "timestampMs": {
- "description": "Time when the beacon was observed.",
- "format": "google-datetime",
- "type": "string"
- },
- "advertisedId": {
- "$ref": "AdvertisedId",
- "description": "The ID advertised by the beacon the client has encountered.\n\nIf the submitted `advertised_id` type is Eddystone-EID, then the client\nmust be authorized to resolve the given beacon. Otherwise no data will be\nreturned for that beacon.\nRequired."
- }
- },
- "id": "Observation"
- },
- "ListDiagnosticsResponse": {
- "properties": {
- "diagnostics": {
- "description": "The diagnostics matching the given request.",
- "type": "array",
- "items": {
- "$ref": "Diagnostics"
- }
- },
- "nextPageToken": {
- "description": "Token that can be used for pagination. Returned only if the\nrequest matches more beacons than can be returned in this response.",
- "type": "string"
- }
- },
- "id": "ListDiagnosticsResponse",
- "description": "Response that contains the requested diagnostics.",
- "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",
- "version": "v1beta1"
+ }
}
diff --git a/pubsub/v1/pubsub-api.json b/pubsub/v1/pubsub-api.json
index ac23987..627017d 100644
--- a/pubsub/v1/pubsub-api.json
+++ b/pubsub/v1/pubsub-api.json
@@ -1,920 +1,4 @@
{
- "discoveryVersion": "v1",
- "ownerName": "Google",
- "resources": {
- "projects": {
- "resources": {
- "subscriptions": {
- "methods": {
- "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": {
- "description": "The name of the subscription. It must have the format\n`\"projects/{project}/subscriptions/{subscription}\"`. `{subscription}` must\nstart with a letter, and contain only letters (`[A-Za-z]`), numbers\n(`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`),\nplus (`+`) or percent signs (`%`). It must be between 3 and 255 characters\nin length, and it must not start with `\"goog\"`.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/subscriptions/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1/projects/{projectsId}/subscriptions/{subscriptionsId}",
- "path": "v1/{+name}",
- "id": "pubsub.projects.subscriptions.create"
- },
- "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"
- },
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "subscription"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "parameters": {
- "subscription": {
- "pattern": "^projects/[^/]+/subscriptions/[^/]+$",
- "location": "path",
- "description": "The subscription whose message is being acknowledged.\nFormat is `projects/{project}/subscriptions/{sub}`.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1/projects/{projectsId}/subscriptions/{subscriptionsId}:acknowledge"
- },
- "get": {
- "response": {
- "$ref": "Subscription"
- },
- "parameterOrder": [
- "subscription"
- ],
- "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.\nFormat is `projects/{project}/subscriptions/{sub}`.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1/projects/{projectsId}/subscriptions/{subscriptionsId}",
- "path": "v1/{+subscription}",
- "id": "pubsub.projects.subscriptions.get",
- "description": "Gets the configuration details of a subscription."
- },
- "patch": {
- "response": {
- "$ref": "Subscription"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "PATCH",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "parameters": {
- "name": {
- "description": "The name of the subscription. It must have the format\n`\"projects/{project}/subscriptions/{subscription}\"`. `{subscription}` must\nstart with a letter, and contain only letters (`[A-Za-z]`), numbers\n(`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`),\nplus (`+`) or percent signs (`%`). It must be between 3 and 255 characters\nin length, and it must not start with `\"goog\"`.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/subscriptions/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1/projects/{projectsId}/subscriptions/{subscriptionsId}",
- "path": "v1/{+name}",
- "id": "pubsub.projects.subscriptions.patch",
- "description": "Updates an existing subscription. Note that certain properties of a\nsubscription, such as its topic, are not modifiable.",
- "request": {
- "$ref": "UpdateSubscriptionRequest"
- }
- },
- "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."
- },
- "seek": {
- "path": "v1/{+subscription}:seek",
- "id": "pubsub.projects.subscriptions.seek",
- "description": "Seeks an existing subscription to a point in time or to a given snapshot,\nwhichever is provided in the request.",
- "request": {
- "$ref": "SeekRequest"
- },
- "response": {
- "$ref": "SeekResponse"
- },
- "parameterOrder": [
- "subscription"
- ],
- "httpMethod": "POST",
- "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 affect.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1/projects/{projectsId}/subscriptions/{subscriptionsId}:seek"
- },
- "modifyPushConfig": {
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "subscription"
- ],
- "httpMethod": "POST",
- "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.\nFormat is `projects/{project}/subscriptions/{sub}`.",
- "required": true,
- "type": "string"
- }
- },
- "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": {
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "subscription"
- ],
- "httpMethod": "DELETE",
- "parameters": {
- "subscription": {
- "pattern": "^projects/[^/]+/subscriptions/[^/]+$",
- "location": "path",
- "description": "The subscription to delete.\nFormat is `projects/{project}/subscriptions/{sub}`.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "flatPath": "v1/projects/{projectsId}/subscriptions/{subscriptionsId}",
- "path": "v1/{+subscription}",
- "id": "pubsub.projects.subscriptions.delete",
- "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."
- },
- "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": {
- "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": "v1/projects/{projectsId}/subscriptions/{subscriptionsId}:setIamPolicy",
- "path": "v1/{+resource}:setIamPolicy",
- "id": "pubsub.projects.subscriptions.setIamPolicy"
- },
- "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"
- ],
- "response": {
- "$ref": "Empty"
- },
- "parameters": {
- "subscription": {
- "pattern": "^projects/[^/]+/subscriptions/[^/]+$",
- "location": "path",
- "description": "The name of the subscription.\nFormat is `projects/{project}/subscriptions/{sub}`.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "flatPath": "v1/projects/{projectsId}/subscriptions/{subscriptionsId}:modifyAckDeadline"
- },
- "getIamPolicy": {
- "description": "Gets the access control policy for a resource.\nReturns an empty policy if the resource exists and does not have a policy\nset.",
- "response": {
- "$ref": "Policy"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "GET",
- "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 is being requested.\nSee the operation documentation for the appropriate value for this field.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1/projects/{projectsId}/subscriptions/{subscriptionsId}:getIamPolicy",
- "path": "v1/{+resource}:getIamPolicy",
- "id": "pubsub.projects.subscriptions.getIamPolicy"
- },
- "pull": {
- "description": "Pulls messages from the server. Returns an empty list if there are no\nmessages available in the backlog. The server may return `UNAVAILABLE` if\nthere are too many concurrent pull requests pending for the given\nsubscription.",
- "request": {
- "$ref": "PullRequest"
- },
- "response": {
- "$ref": "PullResponse"
- },
- "parameterOrder": [
- "subscription"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "parameters": {
- "subscription": {
- "description": "The subscription from which messages should be pulled.\nFormat is `projects/{project}/subscriptions/{sub}`.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/subscriptions/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1/projects/{projectsId}/subscriptions/{subscriptionsId}:pull",
- "path": "v1/{+subscription}:pull",
- "id": "pubsub.projects.subscriptions.pull"
- },
- "list": {
- "httpMethod": "GET",
- "response": {
- "$ref": "ListSubscriptionsResponse"
- },
- "parameterOrder": [
- "project"
- ],
- "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.\nFormat is `projects/{project}`.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "flatPath": "v1/projects/{projectsId}/subscriptions",
- "id": "pubsub.projects.subscriptions.list",
- "path": "v1/{+project}/subscriptions",
- "description": "Lists matching subscriptions."
- }
- }
- },
- "snapshots": {
- "methods": {
- "delete": {
- "httpMethod": "DELETE",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "snapshot"
- ],
- "parameters": {
- "snapshot": {
- "pattern": "^projects/[^/]+/snapshots/[^/]+$",
- "location": "path",
- "description": "The name of the snapshot to delete.\nFormat is `projects/{project}/snapshots/{snap}`.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "flatPath": "v1/projects/{projectsId}/snapshots/{snapshotsId}",
- "id": "pubsub.projects.snapshots.delete",
- "path": "v1/{+snapshot}",
- "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."
- },
- "list": {
- "path": "v1/{+project}/snapshots",
- "id": "pubsub.projects.snapshots.list",
- "description": "Lists the existing snapshots.",
- "response": {
- "$ref": "ListSnapshotsResponse"
- },
- "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 `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",
- "location": "query"
- },
- "pageSize": {
- "location": "query",
- "description": "Maximum number of snapshots to return.",
- "format": "int32",
- "type": "integer"
- },
- "project": {
- "description": "The name of the cloud project that snapshots belong to.\nFormat is `projects/{project}`.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1/projects/{projectsId}/snapshots"
- },
- "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"
- },
- "create": {
- "response": {
- "$ref": "Snapshot"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "PUT",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/snapshots/[^/]+$",
- "location": "path",
- "description": "Optional user-provided name for this snapshot.\nIf the name is not provided in the request, the server will assign a random\nname for this snapshot on the same project as the subscription.\nNote that for REST API requests, you must specify a name.\nFormat is `projects/{project}/snapshots/{snap}`.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1/projects/{projectsId}/snapshots/{snapshotsId}",
- "path": "v1/{+name}",
- "id": "pubsub.projects.snapshots.create",
- "description": "Creates a snapshot from the requested subscription.\nIf the snapshot already exists, returns `ALREADY_EXISTS`.\nIf the requested subscription doesn't exist, returns `NOT_FOUND`.\nIf the backlog in the subscription is too old -- and the resulting snapshot\nwould expire in less than 1 hour -- then `FAILED_PRECONDITION` is returned.\nSee also the `Snapshot.expire_time` field.\n\nIf the name is not provided in the request, the server will assign a random\nname for this snapshot on the same project as the subscription, conforming\nto the\n[resource name\nformat](https://cloud.google.com/pubsub/docs/overview#names). The generated\nname is populated in the returned Snapshot object. Note that for REST API\nrequests, you must specify a name in the request.",
- "request": {
- "$ref": "CreateSnapshotRequest"
- }
- },
- "getIamPolicy": {
- "httpMethod": "GET",
- "response": {
- "$ref": "Policy"
- },
- "parameterOrder": [
- "resource"
- ],
- "parameters": {
- "resource": {
- "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/snapshots/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "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."
- },
- "patch": {
- "response": {
- "$ref": "Snapshot"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "PATCH",
- "parameters": {
- "name": {
- "description": "The name of the snapshot.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/snapshots/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "flatPath": "v1/projects/{projectsId}/snapshots/{snapshotsId}",
- "path": "v1/{+name}",
- "id": "pubsub.projects.snapshots.patch",
- "request": {
- "$ref": "UpdateSnapshotRequest"
- },
- "description": "Updates an existing snapshot. Note that certain properties of a\nsnapshot are not modifiable."
- },
- "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": {
- "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/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1/projects/{projectsId}/snapshots/{snapshotsId}:testIamPermissions",
- "path": "v1/{+resource}:testIamPermissions",
- "id": "pubsub.projects.snapshots.testIamPermissions"
- }
- }
- },
- "topics": {
- "methods": {
- "setIamPolicy": {
- "response": {
- "$ref": "Policy"
- },
- "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 is being specified.\nSee the operation documentation for the appropriate value for this field.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1/projects/{projectsId}/topics/{topicsId}:setIamPolicy",
- "path": "v1/{+resource}:setIamPolicy",
- "id": "pubsub.projects.topics.setIamPolicy",
- "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.",
- "request": {
- "$ref": "SetIamPolicyRequest"
- }
- },
- "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": {
- "description": "Gets the access control policy for a resource.\nReturns an empty policy if the resource exists and does not have a policy\nset.",
- "response": {
- "$ref": "Policy"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "GET",
- "parameters": {
- "resource": {
- "pattern": "^projects/[^/]+/topics/[^/]+$",
- "location": "path",
- "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "flatPath": "v1/projects/{projectsId}/topics/{topicsId}:getIamPolicy",
- "path": "v1/{+resource}:getIamPolicy",
- "id": "pubsub.projects.topics.getIamPolicy"
- },
- "get": {
- "description": "Gets the configuration of a topic.",
- "httpMethod": "GET",
- "response": {
- "$ref": "Topic"
- },
- "parameterOrder": [
- "topic"
- ],
- "parameters": {
- "topic": {
- "pattern": "^projects/[^/]+/topics/[^/]+$",
- "location": "path",
- "description": "The name of the topic to get.\nFormat is `projects/{project}/topics/{topic}`.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "flatPath": "v1/projects/{projectsId}/topics/{topicsId}",
- "id": "pubsub.projects.topics.get",
- "path": "v1/{+topic}"
- },
- "publish": {
- "id": "pubsub.projects.topics.publish",
- "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"
- },
- "parameters": {
- "topic": {
- "pattern": "^projects/[^/]+/topics/[^/]+$",
- "location": "path",
- "description": "The messages in the request will be published on this topic.\nFormat is `projects/{project}/topics/{topic}`.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "flatPath": "v1/projects/{projectsId}/topics/{topicsId}:publish"
- },
- "testIamPermissions": {
- "path": "v1/{+resource}:testIamPermissions",
- "id": "pubsub.projects.topics.testIamPermissions",
- "request": {
- "$ref": "TestIamPermissionsRequest"
- },
- "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning.",
- "response": {
- "$ref": "TestIamPermissionsResponse"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
- "parameters": {
- "resource": {
- "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/topics/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "flatPath": "v1/projects/{projectsId}/topics/{topicsId}:testIamPermissions"
- },
- "delete": {
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "topic"
- ],
- "httpMethod": "DELETE",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "parameters": {
- "topic": {
- "pattern": "^projects/[^/]+/topics/[^/]+$",
- "location": "path",
- "description": "Name of the topic to delete.\nFormat is `projects/{project}/topics/{topic}`.",
- "required": true,
- "type": "string"
- }
- },
- "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_`."
- },
- "list": {
- "response": {
- "$ref": "ListTopicsResponse"
- },
- "parameterOrder": [
- "project"
- ],
- "httpMethod": "GET",
- "parameters": {
- "pageToken": {
- "description": "The value returned by the last `ListTopicsResponse`; indicates that this is\na continuation of a prior `ListTopics` call, and that the system should\nreturn the next page of data.",
- "type": "string",
- "location": "query"
- },
- "pageSize": {
- "location": "query",
- "description": "Maximum number of topics to return.",
- "format": "int32",
- "type": "integer"
- },
- "project": {
- "description": "The name of the cloud project that topics belong to.\nFormat is `projects/{project}`.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+$",
- "location": "path"
- }
- },
- "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."
- }
- },
- "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": {
- "location": "query",
- "description": "The value returned by the last `ListTopicSubscriptionsResponse`; indicates\nthat this is a continuation of a prior `ListTopicSubscriptions` call, and\nthat the system should return the next page of data.",
- "type": "string"
- },
- "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.\nFormat is `projects/{project}/topics/{topic}`.",
- "required": true,
- "type": "string",
- "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": {
- "httpMethod": "GET",
- "response": {
- "$ref": "ListTopicSnapshotsResponse"
- },
- "parameterOrder": [
- "topic"
- ],
- "parameters": {
- "pageToken": {
- "location": "query",
- "description": "The value returned by the last `ListTopicSnapshotsResponse`; indicates\nthat this is a continuation of a prior `ListTopicSnapshots` call, and\nthat the system should return the next page of data.",
- "type": "string"
- },
- "pageSize": {
- "description": "Maximum number of snapshot names to return.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- },
- "topic": {
- "pattern": "^projects/[^/]+/topics/[^/]+$",
- "location": "path",
- "description": "The name of the topic that snapshots are attached to.\nFormat is `projects/{project}/topics/{topic}`.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "flatPath": "v1/projects/{projectsId}/topics/{topicsId}/snapshots",
- "id": "pubsub.projects.topics.snapshots.list",
- "path": "v1/{+topic}/snapshots",
- "description": "Lists the names of the snapshots on this topic."
- }
- }
- }
- }
- }
- }
- }
- },
"parameters": {
"upload_protocol": {
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
@@ -922,25 +6,25 @@
"location": "query"
},
"prettyPrint": {
- "location": "query",
- "description": "Returns response with indentations and line breaks.",
"type": "boolean",
- "default": "true"
- },
- "uploadType": {
+ "default": "true",
"location": "query",
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string"
+ "description": "Returns response with indentations and line breaks."
},
"fields": {
"description": "Selector specifying which fields to include in a partial response.",
"type": "string",
"location": "query"
},
- "callback": {
+ "uploadType": {
+ "type": "string",
"location": "query",
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")."
+ },
+ "callback": {
"description": "JSONP",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"$.xgafv": {
"enum": [
@@ -956,36 +40,36 @@
"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"
+ "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": {
+ "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",
@@ -993,9 +77,9 @@
"location": "query"
},
"bearer_token": {
+ "location": "query",
"description": "OAuth bearer token.",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"oauth_token": {
"location": "query",
@@ -1004,379 +88,8 @@
}
},
"schemas": {
- "Binding": {
- "properties": {
- "members": {
- "description": "Specifies the identities requesting access for a Cloud Platform resource.\n`members` can have the following values:\n\n* `allUsers`: A special identifier that represents anyone who is\n on the internet; with or without a Google account.\n\n* `allAuthenticatedUsers`: A special identifier that represents anyone\n who is authenticated with a Google account or a service account.\n\n* `user:{emailid}`: An email address that represents a specific Google\n account. For example, `alice@gmail.com` or `joe@example.com`.\n\n\n* `serviceAccount:{emailid}`: An email address that represents a service\n account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{emailid}`: An email address that represents a Google group.\n For example, `admins@example.com`.\n\n\n* `domain:{domain}`: A Google Apps domain name that represents all the\n users of that domain. For example, `google.com` or `example.com`.\n\n",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "role": {
- "description": "Role that is assigned to `members`.\nFor example, `roles/viewer`, `roles/editor`, or `roles/owner`.\nRequired",
- "type": "string"
- }
- },
- "id": "Binding",
- "description": "Associates `members` with a `role`.",
- "type": "object"
- },
- "SeekRequest": {
- "properties": {
- "time": {
- "description": "The time to seek to.\nMessages retained in the subscription that were published before this\ntime are marked as acknowledged, and messages retained in the\nsubscription that were published after this time are marked as\nunacknowledged. Note that this operation affects only those messages\nretained in the subscription (configured by the combination of\n`message_retention_duration` and `retain_acked_messages`). For example,\nif `time` corresponds to a point before the message retention\nwindow (or to a point before the system's notion of the subscription\ncreation time), only retained messages will be marked as unacknowledged,\nand already-expunged messages will not be restored.",
- "format": "google-datetime",
- "type": "string"
- },
- "snapshot": {
- "description": "The snapshot to seek to. The snapshot's topic must be the same as that of\nthe provided subscription.\nFormat is `projects/{project}/snapshots/{snap}`.",
- "type": "string"
- }
- },
- "id": "SeekRequest",
- "description": "Request for the `Seek` method.",
- "type": "object"
- },
- "ReceivedMessage": {
- "properties": {
- "message": {
- "description": "The message.",
- "$ref": "PubsubMessage"
- },
- "ackId": {
- "description": "This ID can be used to acknowledge the received message.",
- "type": "string"
- }
- },
- "id": "ReceivedMessage",
- "description": "A message and its corresponding acknowledgment ID.",
- "type": "object"
- },
- "PushConfig": {
- "description": "Configuration for a push delivery endpoint.",
- "type": "object",
- "properties": {
- "pushEndpoint": {
- "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": {
- "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"
- },
- "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"
- },
- "PullRequest": {
- "properties": {
- "maxMessages": {
- "description": "The maximum number of messages returned for this request. The Pub/Sub\nsystem may return fewer than the number specified.",
- "format": "int32",
- "type": "integer"
- },
- "returnImmediately": {
- "description": "If this field set to true, the system will respond immediately even if\nit there are no messages available to return in the `Pull` response.\nOtherwise, the system may wait (for a bounded amount of time) until at\nleast one message is available, rather than returning no messages. The\nclient may cancel the request if it does not wish to wait any longer for\nthe response.",
- "type": "boolean"
- }
- },
- "id": "PullRequest",
- "description": "Request for the `Pull` method.",
- "type": "object"
- },
- "PublishRequest": {
- "properties": {
- "messages": {
- "description": "The messages to publish.",
- "type": "array",
- "items": {
- "$ref": "PubsubMessage"
- }
- }
- },
- "id": "PublishRequest",
- "description": "Request for the Publish method.",
- "type": "object"
- },
- "UpdateSubscriptionRequest": {
- "description": "Request for the UpdateSubscription method.",
- "type": "object",
- "properties": {
- "subscription": {
- "$ref": "Subscription",
- "description": "The updated subscription object."
- },
- "updateMask": {
- "description": "Indicates which fields in the provided subscription to update.\nMust be specified and non-empty.",
- "format": "google-fieldmask",
- "type": "string"
- }
- },
- "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.",
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "id": "PublishResponse"
- },
- "Subscription": {
- "description": "A subscription resource.",
- "type": "object",
- "properties": {
- "retainAckedMessages": {
- "description": "Indicates whether to retain acknowledged messages. If true, then\nmessages are not expunged from the subscription's backlog, even if they are\nacknowledged, until they fall out of the `message_retention_duration`\nwindow.",
- "type": "boolean"
- },
- "name": {
- "description": "The name of the subscription. It must have the format\n`\"projects/{project}/subscriptions/{subscription}\"`. `{subscription}` must\nstart with a letter, and contain only letters (`[A-Za-z]`), numbers\n(`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`),\nplus (`+`) or percent signs (`%`). It must be between 3 and 255 characters\nin length, and it must not start with `\"goog\"`.",
- "type": "string"
- },
- "topic": {
- "description": "The name of the topic from which this subscription is receiving messages.\nFormat is `projects/{project}/topics/{topic}`.\nThe value of this field will be `_deleted-topic_` if the topic has been\ndeleted.",
- "type": "string"
- },
- "pushConfig": {
- "description": "If push delivery is used with this subscription, this field is\nused to configure it. An empty `pushConfig` signifies that the subscriber\nwill pull and ack messages using API methods.",
- "$ref": "PushConfig"
- },
- "ackDeadlineSeconds": {
- "description": "This value is the maximum time after a subscriber receives a message\nbefore the subscriber should acknowledge the message. After message\ndelivery but before the ack deadline expires and before the message is\nacknowledged, it is an outstanding message and will not be delivered\nagain during that time (on a best-effort basis).\n\nFor pull subscriptions, this value is used as the initial value for the ack\ndeadline. To override this value for a given message, call\n`ModifyAckDeadline` with the corresponding `ack_id` if using\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": {
- "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",
- "type": "string"
- }
- },
- "id": "Subscription"
- },
- "SeekResponse": {
- "properties": {},
- "id": "SeekResponse",
- "type": "object"
- },
- "ModifyAckDeadlineRequest": {
- "properties": {
- "ackDeadlineSeconds": {
- "description": "The new ack deadline with respect to the time this request was sent to\nthe Pub/Sub system. For example, if the value is 10, the new\nack deadline will expire 10 seconds after the `ModifyAckDeadline` call\nwas made. Specifying zero may immediately make the message available for\nanother pull request.\nThe minimum deadline you can specify is 0 seconds.\nThe maximum deadline you can specify is 600 seconds (10 minutes).",
- "format": "int32",
- "type": "integer"
- },
- "ackIds": {
- "description": "List of acknowledgment IDs.",
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "id": "ModifyAckDeadlineRequest",
- "description": "Request for the ModifyAckDeadline method.",
- "type": "object"
- },
- "Snapshot": {
- "description": "A snapshot resource.",
- "type": "object",
- "properties": {
- "name": {
- "description": "The name of the snapshot.",
- "type": "string"
- },
- "topic": {
- "description": "The name of the topic from which this snapshot is retaining messages.",
- "type": "string"
- },
- "expireTime": {
- "description": "The snapshot is guaranteed to exist up until this time.\nA newly-created snapshot expires no later than 7 days from the time of its\ncreation. Its exact lifetime is determined at creation by the existing\nbacklog in the source subscription. Specifically, the lifetime of the\nsnapshot is `7 days - (age of oldest unacked message in the subscription)`.\nFor example, consider a subscription whose oldest unacked message is 3 days\nold. If a snapshot is created from this subscription, the snapshot -- which\nwill always capture this 3-day-old backlog as long as the snapshot\nexists -- will expire in 4 days. The service will refuse to create a\nsnapshot that would expire in less than 1 hour after creation.",
- "format": "google-datetime",
- "type": "string"
- }
- },
- "id": "Snapshot"
- },
- "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"
- },
- "PubsubMessage": {
- "properties": {
- "attributes": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "Optional attributes for this message.",
- "type": "object"
- },
- "messageId": {
- "description": "ID of this message, assigned by the server when the message is published.\nGuaranteed to be unique within the topic. This value may be read by a\nsubscriber that receives a `PubsubMessage` via a `Pull` call or a push\ndelivery. It must not be populated by the publisher in a `Publish` call.",
- "type": "string"
- },
- "publishTime": {
- "description": "The time at which the message was published, populated by the server when\nit receives the `Publish` call. It must not be populated by the\npublisher in a `Publish` call.",
- "format": "google-datetime",
- "type": "string"
- },
- "data": {
- "description": "The message payload.",
- "format": "byte",
- "type": "string"
- }
- },
- "id": "PubsubMessage",
- "description": "A message data and its attributes. The message payload must not be empty;\nit must contain either a non-empty data field, or at least one attribute.",
- "type": "object"
- },
- "ModifyPushConfigRequest": {
- "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` or `StreamingPull` is not called."
- }
- },
- "id": "ModifyPushConfigRequest",
- "description": "Request for the ModifyPushConfig method.",
- "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"
- },
- "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"
- },
- "AcknowledgeRequest": {
- "description": "Request for the Acknowledge method.",
- "type": "object",
- "properties": {
- "ackIds": {
- "description": "The acknowledgment ID for the messages being acknowledged that was returned\nby the Pub/Sub system in the `Pull` response. Must not be empty.",
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "id": "AcknowledgeRequest"
- },
- "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"
- }
- }
- },
- "id": "ListTopicSubscriptionsResponse",
- "description": "Response for the `ListTopicSubscriptions` method.",
- "type": "object"
- },
- "PullResponse": {
- "properties": {
- "receivedMessages": {
- "description": "Received Pub/Sub messages. The Pub/Sub system will return zero messages if\nthere are no more available in the backlog. The Pub/Sub system may return\nfewer than the `maxMessages` requested even if there are more messages\navailable in the backlog.",
- "type": "array",
- "items": {
- "$ref": "ReceivedMessage"
- }
- }
- },
- "id": "PullResponse",
- "description": "Response for the `Pull` method.",
- "type": "object"
- },
- "UpdateSnapshotRequest": {
- "description": "Request for the UpdateSnapshot method.",
- "type": "object",
- "properties": {
- "updateMask": {
- "description": "Indicates which fields in the provided snapshot to update.\nMust be specified and non-empty.",
- "format": "google-fieldmask",
- "type": "string"
- },
- "snapshot": {
- "$ref": "Snapshot",
- "description": "The updated snpashot object."
- }
- },
- "id": "UpdateSnapshotRequest"
- },
- "ListSubscriptionsResponse": {
- "properties": {
- "nextPageToken": {
- "description": "If not empty, indicates that there may be more subscriptions that match\nthe request; this value should be passed in a new\n`ListSubscriptionsRequest` to get more subscriptions.",
- "type": "string"
- },
- "subscriptions": {
- "description": "The subscriptions that match the request.",
- "type": "array",
- "items": {
- "$ref": "Subscription"
- }
- }
- },
- "id": "ListSubscriptionsResponse",
- "description": "Response for the `ListSubscriptions` method.",
- "type": "object"
- },
"ListSnapshotsResponse": {
+ "id": "ListSnapshotsResponse",
"description": "Response for the `ListSnapshots` method.",
"type": "object",
"properties": {
@@ -1391,10 +104,40 @@
"$ref": "Snapshot"
}
}
+ }
+ },
+ "ListSubscriptionsResponse": {
+ "type": "object",
+ "properties": {
+ "nextPageToken": {
+ "description": "If not empty, indicates that there may be more subscriptions that match\nthe request; this value should be passed in a new\n`ListSubscriptionsRequest` to get more subscriptions.",
+ "type": "string"
+ },
+ "subscriptions": {
+ "description": "The subscriptions that match the request.",
+ "type": "array",
+ "items": {
+ "$ref": "Subscription"
+ }
+ }
},
- "id": "ListSnapshotsResponse"
+ "id": "ListSubscriptionsResponse",
+ "description": "Response for the `ListSubscriptions` method."
+ },
+ "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": {
+ "description": "Response for the `ListTopicSnapshots` method.",
+ "type": "object",
"properties": {
"nextPageToken": {
"description": "If not empty, indicates that there may be more snapshots that match\nthe request; this value should be passed in a new\n`ListTopicSnapshotsRequest` to get more snapshots.",
@@ -1408,22 +151,10 @@
}
}
},
- "id": "ListTopicSnapshotsResponse",
- "description": "Response for the `ListTopicSnapshots` 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"
+ "id": "ListTopicSnapshotsResponse"
},
"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).",
@@ -1434,12 +165,9 @@
}
},
"id": "TestIamPermissionsRequest",
- "description": "Request message for `TestIamPermissions` method.",
- "type": "object"
+ "description": "Request message for `TestIamPermissions` method."
},
"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.",
@@ -1459,18 +187,374 @@
}
}
},
- "id": "Policy"
+ "id": "Policy",
+ "description": "Defines an Identity and Access Management (IAM) policy. It is used to\nspecify access control policies for Cloud Platform resources.\n\n\nA `Policy` consists of a list of `bindings`. A `Binding` binds a list of\n`members` to a `role`, where the members can be user accounts, Google groups,\nGoogle domains, and service accounts. A `role` is a named list of permissions\ndefined by IAM.\n\n**Example**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/owner\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-other-app@appspot.gserviceaccount.com\",\n ]\n },\n {\n \"role\": \"roles/viewer\",\n \"members\": [\"user:sean@example.com\"]\n }\n ]\n }\n\nFor a description of IAM and its features, see the\n[IAM developer's guide](https://cloud.google.com/iam).",
+ "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",
- "description": "A topic resource.",
+ "id": "Topic"
+ },
+ "Binding": {
+ "type": "object",
+ "properties": {
+ "members": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "Specifies the identities requesting access for a Cloud Platform resource.\n`members` can have the following values:\n\n* `allUsers`: A special identifier that represents anyone who is\n on the internet; with or without a Google account.\n\n* `allAuthenticatedUsers`: A special identifier that represents anyone\n who is authenticated with a Google account or a service account.\n\n* `user:{emailid}`: An email address that represents a specific Google\n account. For example, `alice@gmail.com` or `joe@example.com`.\n\n\n* `serviceAccount:{emailid}`: An email address that represents a service\n account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{emailid}`: An email address that represents a Google group.\n For example, `admins@example.com`.\n\n\n* `domain:{domain}`: A Google Apps domain name that represents all the\n users of that domain. For example, `google.com` or `example.com`.\n\n"
+ },
+ "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`."
+ },
+ "SeekRequest": {
+ "id": "SeekRequest",
+ "description": "Request for the `Seek` method.",
+ "type": "object",
+ "properties": {
+ "time": {
+ "description": "The time to seek to.\nMessages retained in the subscription that were published before this\ntime are marked as acknowledged, and messages retained in the\nsubscription that were published after this time are marked as\nunacknowledged. Note that this operation affects only those messages\nretained in the subscription (configured by the combination of\n`message_retention_duration` and `retain_acked_messages`). For example,\nif `time` corresponds to a point before the message retention\nwindow (or to a point before the system's notion of the subscription\ncreation time), only retained messages will be marked as unacknowledged,\nand already-expunged messages will not be restored.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "snapshot": {
+ "description": "The snapshot to seek to. The snapshot's topic must be the same as that of\nthe provided subscription.\nFormat is `projects/{project}/snapshots/{snap}`.",
+ "type": "string"
+ }
+ }
+ },
+ "ReceivedMessage": {
+ "type": "object",
+ "properties": {
+ "message": {
+ "$ref": "PubsubMessage",
+ "description": "The message."
+ },
+ "ackId": {
+ "description": "This ID can be used to acknowledge the received message.",
+ "type": "string"
+ }
+ },
+ "id": "ReceivedMessage",
+ "description": "A message and its corresponding acknowledgment ID."
+ },
+ "PushConfig": {
+ "type": "object",
+ "properties": {
+ "pushEndpoint": {
+ "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"
+ }
+ }
+ },
+ "id": "PushConfig",
+ "description": "Configuration for a push delivery endpoint."
+ },
+ "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"
+ },
+ "PullRequest": {
+ "description": "Request for the `Pull` method.",
+ "type": "object",
+ "properties": {
+ "returnImmediately": {
+ "description": "If this field set to true, the system will respond immediately even if\nit there are no messages available to return in the `Pull` response.\nOtherwise, the system may wait (for a bounded amount of time) until at\nleast one message is available, rather than returning no messages. The\nclient may cancel the request if it does not wish to wait any longer for\nthe response.",
+ "type": "boolean"
+ },
+ "maxMessages": {
+ "description": "The maximum number of messages returned for this request. The Pub/Sub\nsystem may return fewer than the number specified.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "PullRequest"
+ },
+ "PublishRequest": {
+ "description": "Request for the Publish method.",
+ "type": "object",
+ "properties": {
+ "messages": {
+ "type": "array",
+ "items": {
+ "$ref": "PubsubMessage"
+ },
+ "description": "The messages to publish."
+ }
+ },
+ "id": "PublishRequest"
+ },
+ "UpdateSubscriptionRequest": {
+ "properties": {
+ "subscription": {
+ "description": "The updated subscription object.",
+ "$ref": "Subscription"
+ },
+ "updateMask": {
+ "description": "Indicates which fields in the provided subscription to update.\nMust be specified and non-empty.",
+ "format": "google-fieldmask",
+ "type": "string"
+ }
+ },
+ "id": "UpdateSubscriptionRequest",
+ "description": "Request for the UpdateSubscription 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.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "id": "PublishResponse"
+ },
+ "Subscription": {
+ "description": "A subscription resource.",
+ "type": "object",
+ "properties": {
+ "topic": {
+ "description": "The name of the topic from which this subscription is receiving messages.\nFormat is `projects/{project}/topics/{topic}`.\nThe value of this field will be `_deleted-topic_` if the topic has been\ndeleted.",
+ "type": "string"
+ },
+ "pushConfig": {
+ "$ref": "PushConfig",
+ "description": "If push delivery is used with this subscription, this field is\nused to configure it. An empty `pushConfig` signifies that the subscriber\nwill pull and ack messages using API methods."
+ },
+ "ackDeadlineSeconds": {
+ "description": "This value is the maximum time after a subscriber receives a message\nbefore the subscriber should acknowledge the message. After message\ndelivery but before the ack deadline expires and before the message is\nacknowledged, it is an outstanding message and will not be delivered\nagain during that time (on a best-effort basis).\n\nFor pull subscriptions, this value is used as the initial value for the ack\ndeadline. To override this value for a given message, call\n`ModifyAckDeadline` with the corresponding `ack_id` if using\nnon-streaming pull or send the `ack_id` in a\n`StreamingModifyAckDeadlineRequest` if using streaming pull.\nThe minimum custom deadline you can specify is 10 seconds.\nThe maximum custom deadline you can specify is 600 seconds (10 minutes).\nIf this parameter is 0, a default value of 10 seconds is used.\n\nFor push delivery, this value is also used to set the request timeout for\nthe call to the push endpoint.\n\nIf the subscriber never acknowledges the message, the Pub/Sub\nsystem will eventually redeliver the message.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "messageRetentionDuration": {
+ "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",
+ "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"
+ },
+ "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"
+ }
+ },
+ "id": "Subscription"
+ },
+ "SeekResponse": {
+ "type": "object",
+ "properties": {},
+ "id": "SeekResponse"
+ },
+ "ModifyAckDeadlineRequest": {
+ "description": "Request for the ModifyAckDeadline method.",
+ "type": "object",
+ "properties": {
+ "ackDeadlineSeconds": {
+ "description": "The new ack deadline with respect to the time this request was sent to\nthe Pub/Sub system. For example, if the value is 10, the new\nack deadline will expire 10 seconds after the `ModifyAckDeadline` call\nwas made. Specifying zero may immediately make the message available for\nanother pull request.\nThe minimum deadline you can specify is 0 seconds.\nThe maximum deadline you can specify is 600 seconds (10 minutes).",
+ "format": "int32",
+ "type": "integer"
+ },
+ "ackIds": {
+ "description": "List of acknowledgment IDs.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "id": "ModifyAckDeadlineRequest"
+ },
+ "Snapshot": {
+ "type": "object",
+ "properties": {
+ "expireTime": {
+ "description": "The snapshot is guaranteed to exist up until this time.\nA newly-created snapshot expires no later than 7 days from the time of its\ncreation. Its exact lifetime is determined at creation by the existing\nbacklog in the source subscription. Specifically, the lifetime of the\nsnapshot is `7 days - (age of oldest unacked message in the subscription)`.\nFor example, consider a subscription whose oldest unacked message is 3 days\nold. If a snapshot is created from this subscription, the snapshot -- which\nwill always capture this 3-day-old backlog as long as the snapshot\nexists -- will expire in 4 days. The service will refuse to create a\nsnapshot that would expire in less than 1 hour after creation.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "name": {
+ "type": "string",
+ "description": "The name of the snapshot."
+ },
+ "topic": {
+ "description": "The name of the topic from which this snapshot is retaining messages.",
+ "type": "string"
+ }
+ },
+ "id": "Snapshot",
+ "description": "A snapshot resource."
+ },
+ "SetIamPolicyRequest": {
+ "description": "Request message for `SetIamPolicy` method.",
+ "type": "object",
+ "properties": {
+ "policy": {
+ "description": "REQUIRED: The complete policy to be applied to the `resource`. The size of\nthe policy is limited to a few 10s of KB. An empty policy is a\nvalid policy but certain Cloud Platform services (such as Projects)\nmight reject them.",
+ "$ref": "Policy"
+ }
+ },
+ "id": "SetIamPolicyRequest"
+ },
+ "PubsubMessage": {
+ "type": "object",
+ "properties": {
+ "attributes": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Optional attributes for this message."
+ },
+ "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": {
+ "type": "string",
+ "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"
+ },
+ "data": {
+ "description": "The message payload.",
+ "format": "byte",
+ "type": "string"
+ }
+ },
+ "id": "PubsubMessage",
+ "description": "A message data and its attributes. The message payload must not be empty;\nit must contain either a non-empty data field, or at least one attribute."
+ },
+ "ModifyPushConfigRequest": {
+ "description": "Request for the ModifyPushConfig method.",
+ "type": "object",
+ "properties": {
+ "pushConfig": {
+ "description": "The push configuration for future deliveries.\n\nAn empty `pushConfig` indicates that the Pub/Sub system should\nstop pushing messages from the given subscription and allow\nmessages to be pulled and acknowledged - effectively pausing\nthe subscription if `Pull` or `StreamingPull` is not called.",
+ "$ref": "PushConfig"
+ }
+ },
+ "id": "ModifyPushConfigRequest"
+ },
+ "AcknowledgeRequest": {
+ "description": "Request for the Acknowledge method.",
+ "type": "object",
+ "properties": {
+ "ackIds": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "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."
+ }
+ },
+ "id": "AcknowledgeRequest"
+ },
+ "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 `{}`."
+ },
+ "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"
+ },
+ "ListTopicSubscriptionsResponse": {
+ "description": "Response for the `ListTopicSubscriptions` method.",
+ "type": "object",
+ "properties": {
+ "nextPageToken": {
+ "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.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "id": "ListTopicSubscriptionsResponse"
+ },
+ "PullResponse": {
+ "description": "Response for the `Pull` method.",
+ "type": "object",
+ "properties": {
+ "receivedMessages": {
+ "description": "Received Pub/Sub messages. The Pub/Sub system will return zero messages if\nthere are no more available in the backlog. The Pub/Sub system may return\nfewer than the `maxMessages` requested even if there are more messages\navailable in the backlog.",
+ "type": "array",
+ "items": {
+ "$ref": "ReceivedMessage"
+ }
+ }
+ },
+ "id": "PullResponse"
+ },
+ "UpdateSnapshotRequest": {
+ "description": "Request for the UpdateSnapshot method.",
+ "type": "object",
+ "properties": {
+ "snapshot": {
+ "$ref": "Snapshot",
+ "description": "The updated snpashot object."
+ },
+ "updateMask": {
+ "description": "Indicates which fields in the provided snapshot to update.\nMust be specified and non-empty.",
+ "format": "google-fieldmask",
+ "type": "string"
+ }
+ },
+ "id": "UpdateSnapshotRequest"
}
},
"icons": {
@@ -1501,8 +585,924 @@
"ownerDomain": "google.com",
"name": "pubsub",
"batchPath": "batch",
- "revision": "20171213",
- "documentationLink": "https://cloud.google.com/pubsub/docs",
"id": "pubsub:v1",
- "title": "Google Cloud Pub/Sub API"
+ "documentationLink": "https://cloud.google.com/pubsub/docs",
+ "revision": "20171213",
+ "title": "Google Cloud Pub/Sub API",
+ "ownerName": "Google",
+ "discoveryVersion": "v1",
+ "resources": {
+ "projects": {
+ "resources": {
+ "topics": {
+ "methods": {
+ "getIamPolicy": {
+ "description": "Gets the access control policy for a resource.\nReturns an empty policy if the resource exists and does not have a policy\nset.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "resource"
+ ],
+ "response": {
+ "$ref": "Policy"
+ },
+ "parameters": {
+ "resource": {
+ "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/topics/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
+ "flatPath": "v1/projects/{projectsId}/topics/{topicsId}:getIamPolicy",
+ "id": "pubsub.projects.topics.getIamPolicy",
+ "path": "v1/{+resource}:getIamPolicy"
+ },
+ "get": {
+ "description": "Gets the configuration of a topic.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "topic"
+ ],
+ "response": {
+ "$ref": "Topic"
+ },
+ "parameters": {
+ "topic": {
+ "location": "path",
+ "description": "The name of the topic to get.\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}",
+ "id": "pubsub.projects.topics.get",
+ "path": "v1/{+topic}"
+ },
+ "publish": {
+ "path": "v1/{+topic}:publish",
+ "id": "pubsub.projects.topics.publish",
+ "description": "Adds one or more messages to the topic. Returns `NOT_FOUND` if the topic\ndoes not exist. The message payload must not be empty; it must contain\n either a non-empty data field, or at least one attribute.",
+ "request": {
+ "$ref": "PublishRequest"
+ },
+ "response": {
+ "$ref": "PublishResponse"
+ },
+ "parameterOrder": [
+ "topic"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
+ "parameters": {
+ "topic": {
+ "description": "The messages in the request will be published on this topic.\nFormat is `projects/{project}/topics/{topic}`.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/topics/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/topics/{topicsId}:publish"
+ },
+ "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/[^/]+/topics/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
+ "flatPath": "v1/projects/{projectsId}/topics/{topicsId}:testIamPermissions",
+ "path": "v1/{+resource}:testIamPermissions",
+ "id": "pubsub.projects.topics.testIamPermissions"
+ },
+ "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": {
+ "location": "path",
+ "description": "Name of the topic to delete.\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}",
+ "path": "v1/{+topic}",
+ "id": "pubsub.projects.topics.delete"
+ },
+ "list": {
+ "description": "Lists matching topics.",
+ "response": {
+ "$ref": "ListTopicsResponse"
+ },
+ "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 `ListTopicsResponse`; indicates that this is\na continuation of a prior `ListTopics` call, and that the system should\nreturn the next page of data.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageSize": {
+ "type": "integer",
+ "location": "query",
+ "description": "Maximum number of topics to return.",
+ "format": "int32"
+ },
+ "project": {
+ "pattern": "^projects/[^/]+$",
+ "location": "path",
+ "description": "The name of the cloud project that topics belong to.\nFormat is `projects/{project}`.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/topics",
+ "path": "v1/{+project}/topics",
+ "id": "pubsub.projects.topics.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": {
+ "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/[^/]+/topics/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
+ "flatPath": "v1/projects/{projectsId}/topics/{topicsId}:setIamPolicy",
+ "id": "pubsub.projects.topics.setIamPolicy",
+ "path": "v1/{+resource}:setIamPolicy"
+ },
+ "create": {
+ "request": {
+ "$ref": "Topic"
+ },
+ "description": "Creates the given topic with the given name.",
+ "response": {
+ "$ref": "Topic"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "PUT",
+ "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"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
+ "flatPath": "v1/projects/{projectsId}/topics/{topicsId}",
+ "path": "v1/{+name}",
+ "id": "pubsub.projects.topics.create"
+ }
+ },
+ "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": {
+ "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/[^/]+$"
+ }
+ },
+ "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": {
+ "flatPath": "v1/projects/{projectsId}/topics/{topicsId}/snapshots",
+ "path": "v1/{+topic}/snapshots",
+ "id": "pubsub.projects.topics.snapshots.list",
+ "description": "Lists the names of the snapshots on this topic.",
+ "response": {
+ "$ref": "ListTopicSnapshotsResponse"
+ },
+ "parameterOrder": [
+ "topic"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "pageToken": {
+ "location": "query",
+ "description": "The value returned by the last `ListTopicSnapshotsResponse`; indicates\nthat this is a continuation of a prior `ListTopicSnapshots` call, and\nthat the system should return the next page of data.",
+ "type": "string"
+ },
+ "pageSize": {
+ "location": "query",
+ "description": "Maximum number of snapshot names to return.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "topic": {
+ "location": "path",
+ "description": "The name of the topic that snapshots are attached to.\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"
+ ]
+ }
+ }
+ }
+ }
+ },
+ "subscriptions": {
+ "methods": {
+ "create": {
+ "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.",
+ "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/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ]
+ },
+ "acknowledge": {
+ "response": {
+ "$ref": "Empty"
+ },
+ "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 whose message is being acknowledged.\nFormat is `projects/{project}/subscriptions/{sub}`.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/subscriptions/[^/]+$"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/subscriptions/{subscriptionsId}:acknowledge",
+ "path": "v1/{+subscription}:acknowledge",
+ "id": "pubsub.projects.subscriptions.acknowledge",
+ "description": "Acknowledges the messages associated with the `ack_ids` in the\n`AcknowledgeRequest`. The Pub/Sub system can remove the relevant messages\nfrom the subscription.\n\nAcknowledging a message whose ack deadline has expired may succeed,\nbut such a message may be redelivered later. Acknowledging a message more\nthan once will not result in an error.",
+ "request": {
+ "$ref": "AcknowledgeRequest"
+ }
+ },
+ "get": {
+ "response": {
+ "$ref": "Subscription"
+ },
+ "parameterOrder": [
+ "subscription"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "subscription": {
+ "description": "The name of the subscription to get.\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}",
+ "path": "v1/{+subscription}",
+ "id": "pubsub.projects.subscriptions.get",
+ "description": "Gets the configuration details of a subscription."
+ },
+ "patch": {
+ "httpMethod": "PATCH",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Subscription"
+ },
+ "parameters": {
+ "name": {
+ "required": true,
+ "type": "string",
+ "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\"`."
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
+ "flatPath": "v1/projects/{projectsId}/subscriptions/{subscriptionsId}",
+ "id": "pubsub.projects.subscriptions.patch",
+ "path": "v1/{+name}",
+ "request": {
+ "$ref": "UpdateSubscriptionRequest"
+ },
+ "description": "Updates an existing subscription. Note that certain properties of a\nsubscription, such as its topic, are not modifiable."
+ },
+ "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.",
+ "response": {
+ "$ref": "TestIamPermissionsResponse"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "resource": {
+ "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/subscriptions/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
+ "flatPath": "v1/projects/{projectsId}/subscriptions/{subscriptionsId}:testIamPermissions"
+ },
+ "seek": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "subscription"
+ ],
+ "response": {
+ "$ref": "SeekResponse"
+ },
+ "parameters": {
+ "subscription": {
+ "description": "The subscription to affect.",
+ "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}:seek",
+ "id": "pubsub.projects.subscriptions.seek",
+ "path": "v1/{+subscription}:seek",
+ "request": {
+ "$ref": "SeekRequest"
+ },
+ "description": "Seeks an existing subscription to a point in time or to a given snapshot,\nwhichever is provided in the request."
+ },
+ "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`.",
+ "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}:modifyPushConfig",
+ "id": "pubsub.projects.subscriptions.modifyPushConfig",
+ "path": "v1/{+subscription}:modifyPushConfig"
+ },
+ "delete": {
+ "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.",
+ "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.\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.delete"
+ },
+ "setIamPolicy": {
+ "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": "v1/projects/{projectsId}/subscriptions/{subscriptionsId}:setIamPolicy",
+ "id": "pubsub.projects.subscriptions.setIamPolicy",
+ "path": "v1/{+resource}:setIamPolicy",
+ "request": {
+ "$ref": "SetIamPolicyRequest"
+ },
+ "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy."
+ },
+ "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.",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "subscription"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "subscription": {
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/subscriptions/[^/]+$",
+ "location": "path",
+ "description": "The name of the subscription.\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}:modifyAckDeadline",
+ "path": "v1/{+subscription}:modifyAckDeadline",
+ "id": "pubsub.projects.subscriptions.modifyAckDeadline"
+ },
+ "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/[^/]+/subscriptions/[^/]+$",
+ "location": "path"
+ }
+ },
+ "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."
+ },
+ "pull": {
+ "response": {
+ "$ref": "PullResponse"
+ },
+ "parameterOrder": [
+ "subscription"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "subscription": {
+ "description": "The subscription from which messages should be pulled.\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}:pull",
+ "path": "v1/{+subscription}:pull",
+ "id": "pubsub.projects.subscriptions.pull",
+ "request": {
+ "$ref": "PullRequest"
+ },
+ "description": "Pulls messages from the server. Returns an empty list if there are no\nmessages available in the backlog. The server may return `UNAVAILABLE` if\nthere are too many concurrent pull requests pending for the given\nsubscription."
+ },
+ "list": {
+ "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": {
+ "pattern": "^projects/[^/]+$",
+ "location": "path",
+ "description": "The name of the cloud project that subscriptions belong to.\nFormat is `projects/{project}`.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "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",
+ "description": "Lists matching subscriptions."
+ }
+ }
+ },
+ "snapshots": {
+ "methods": {
+ "patch": {
+ "flatPath": "v1/projects/{projectsId}/snapshots/{snapshotsId}",
+ "path": "v1/{+name}",
+ "id": "pubsub.projects.snapshots.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.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/snapshots/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ]
+ },
+ "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": {
+ "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/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/snapshots/{snapshotsId}:testIamPermissions",
+ "path": "v1/{+resource}:testIamPermissions",
+ "id": "pubsub.projects.snapshots.testIamPermissions"
+ },
+ "delete": {
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "snapshot"
+ ],
+ "httpMethod": "DELETE",
+ "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/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
+ "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."
+ },
+ "list": {
+ "description": "Lists the existing snapshots.",
+ "response": {
+ "$ref": "ListSnapshotsResponse"
+ },
+ "parameterOrder": [
+ "project"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
+ "parameters": {
+ "project": {
+ "description": "The name of the cloud project that snapshots belong to.\nFormat is `projects/{project}`.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+$",
+ "location": "path"
+ },
+ "pageToken": {
+ "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",
+ "location": "query"
+ },
+ "pageSize": {
+ "location": "query",
+ "description": "Maximum number of snapshots to return.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/snapshots",
+ "path": "v1/{+project}/snapshots",
+ "id": "pubsub.projects.snapshots.list"
+ },
+ "setIamPolicy": {
+ "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.",
+ "request": {
+ "$ref": "SetIamPolicyRequest"
+ },
+ "response": {
+ "$ref": "Policy"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
+ "parameters": {
+ "resource": {
+ "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/snapshots/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/snapshots/{snapshotsId}:setIamPolicy",
+ "path": "v1/{+resource}:setIamPolicy",
+ "id": "pubsub.projects.snapshots.setIamPolicy"
+ },
+ "create": {
+ "response": {
+ "$ref": "Snapshot"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "PUT",
+ "parameters": {
+ "name": {
+ "description": "Optional user-provided name for this snapshot.\nIf the name is not provided in the request, the server will assign a random\nname for this snapshot on the same project as the subscription.\nNote that for REST API requests, you must specify a name.\nFormat is `projects/{project}/snapshots/{snap}`.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/snapshots/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
+ "flatPath": "v1/projects/{projectsId}/snapshots/{snapshotsId}",
+ "path": "v1/{+name}",
+ "id": "pubsub.projects.snapshots.create",
+ "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."
+ },
+ "getIamPolicy": {
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "resource"
+ ],
+ "response": {
+ "$ref": "Policy"
+ },
+ "parameters": {
+ "resource": {
+ "required": true,
+ "type": "string",
+ "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."
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
+ "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."
+ }
+ }
+ }
+ }
+ }
+ }
}
diff --git a/pubsub/v1beta1a/pubsub-api.json b/pubsub/v1beta1a/pubsub-api.json
index f785efa..20be41c 100644
--- a/pubsub/v1beta1a/pubsub-api.json
+++ b/pubsub/v1beta1a/pubsub-api.json
@@ -1,38 +1,175 @@
{
+ "baseUrl": "https://pubsub.googleapis.com/",
+ "canonicalName": "Pubsub",
+ "auth": {
+ "oauth2": {
+ "scopes": {
+ "https://www.googleapis.com/auth/cloud-platform": {
+ "description": "View and manage your data across Google Cloud Platform services"
+ },
+ "https://www.googleapis.com/auth/pubsub": {
+ "description": "View and manage Pub/Sub topics and subscriptions"
+ }
+ }
+ }
+ },
+ "kind": "discovery#restDescription",
+ "servicePath": "",
+ "description": "Provides reliable, many-to-many, asynchronous messaging between applications.\n",
+ "rootUrl": "https://pubsub.googleapis.com/",
+ "basePath": "",
+ "ownerDomain": "google.com",
+ "name": "pubsub",
+ "batchPath": "batch",
+ "revision": "20171213",
+ "documentationLink": "https://cloud.google.com/pubsub/docs",
+ "id": "pubsub:v1beta1a",
+ "title": "Google Cloud Pub/Sub API",
+ "discoveryVersion": "v1",
+ "ownerName": "Google",
"resources": {
- "topics": {
+ "subscriptions": {
"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.",
+ "modifyPushConfig": {
+ "httpMethod": "POST",
+ "parameterOrder": [],
"response": {
- "$ref": "Topic"
+ "$ref": "Empty"
},
- "parameterOrder": [
- "topic"
- ],
- "httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/pubsub"
],
- "parameters": {
- "topic": {
- "required": true,
- "type": "string",
- "pattern": "^.+$",
- "location": "path",
- "description": "The name of the topic to get."
- }
+ "parameters": {},
+ "flatPath": "v1beta1a/subscriptions/modifyPushConfig",
+ "id": "pubsub.subscriptions.modifyPushConfig",
+ "path": "v1beta1a/subscriptions/modifyPushConfig",
+ "description": "Modifies the \u003ccode\u003ePushConfig\u003c/code\u003e for a specified subscription.\nThis method can be used to suspend the flow of messages to an endpoint\nby clearing the \u003ccode\u003ePushConfig\u003c/code\u003e field in the request. Messages\nwill be accumulated for delivery even if no push configuration is\ndefined or while the configuration is modified.",
+ "request": {
+ "$ref": "ModifyPushConfigRequest"
}
},
- "publish": {
- "request": {
- "$ref": "PublishRequest"
+ "delete": {
+ "httpMethod": "DELETE",
+ "parameterOrder": [
+ "subscription"
+ ],
+ "response": {
+ "$ref": "Empty"
},
- "description": "Adds a message to the topic. Returns NOT_FOUND if the topic does not\nexist.",
+ "parameters": {
+ "subscription": {
+ "pattern": "^.+$",
+ "location": "path",
+ "description": "The subscription to delete.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
+ "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."
+ },
+ "pull": {
+ "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",
+ "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)."
+ },
+ "list": {
+ "flatPath": "v1beta1a/subscriptions",
+ "id": "pubsub.subscriptions.list",
+ "path": "v1beta1a/subscriptions",
+ "description": "Lists matching subscriptions.",
+ "httpMethod": "GET",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "ListSubscriptionsResponse"
+ },
+ "parameters": {
+ "pageToken": {
+ "location": "query",
+ "description": "The value obtained in the last \u003ccode\u003eListSubscriptionsResponse\u003c/code\u003e\nfor continuation.",
+ "type": "string"
+ },
+ "query": {
+ "type": "string",
+ "location": "query",
+ "description": "A valid label query expression."
+ },
+ "maxResults": {
+ "location": "query",
+ "description": "Maximum number of subscriptions to return.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ]
+ },
+ "create": {
+ "path": "v1beta1a/subscriptions",
+ "id": "pubsub.subscriptions.create",
+ "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.",
+ "response": {
+ "$ref": "Subscription"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "parameters": {},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
+ "flatPath": "v1beta1a/subscriptions"
+ },
+ "acknowledge": {
+ "request": {
+ "$ref": "AcknowledgeRequest"
+ },
+ "description": "Acknowledges a particular received message: the Pub/Sub system can remove\nthe given message from the subscription. Acknowledging a message whose\nAck deadline has expired may succeed, but the message could have been\nalready redelivered. Acknowledging a message more than once will not\nresult in an error. This is only used for messages received via pull.",
+ "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": {
+ "request": {
+ "$ref": "ModifyAckDeadlineRequest"
+ },
+ "description": "Modifies the Ack deadline for a message received from a pull request.",
"response": {
"$ref": "Empty"
},
@@ -43,9 +180,103 @@
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/pubsub"
],
+ "flatPath": "v1beta1a/subscriptions/modifyAckDeadline",
+ "path": "v1beta1a/subscriptions/modifyAckDeadline",
+ "id": "pubsub.subscriptions.modifyAckDeadline"
+ },
+ "get": {
+ "response": {
+ "$ref": "Subscription"
+ },
+ "parameterOrder": [
+ "subscription"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "subscription": {
+ "pattern": "^.+$",
+ "location": "path",
+ "description": "The name of the subscription to get.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
+ "flatPath": "v1beta1a/subscriptions/{subscriptionsId}",
+ "path": "v1beta1a/subscriptions/{+subscription}",
+ "id": "pubsub.subscriptions.get",
+ "description": "Gets the configuration details of a subscription."
+ },
+ "pullBatch": {
+ "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",
+ "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."
+ }
+ }
+ },
+ "topics": {
+ "methods": {
+ "get": {
+ "description": "Gets the configuration of a topic. Since the topic only has the name\nattribute, this method is only useful to check the existence of a topic.\nIf other attributes are added in the future, they will be returned here.",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "Topic"
+ },
+ "parameterOrder": [
+ "topic"
+ ],
+ "parameters": {
+ "topic": {
+ "required": true,
+ "type": "string",
+ "pattern": "^.+$",
+ "location": "path",
+ "description": "The name of the topic to get."
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
+ "flatPath": "v1beta1a/topics/{topicsId}",
+ "id": "pubsub.topics.get",
+ "path": "v1beta1a/topics/{+topic}"
+ },
+ "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",
- "path": "v1beta1a/topics/publish",
- "id": "pubsub.topics.publish"
+ "id": "pubsub.topics.publish",
+ "path": "v1beta1a/topics/publish"
},
"delete": {
"response": {
@@ -74,283 +305,96 @@
"description": "Deletes the topic with the given name. Returns NOT_FOUND if the topic does\nnot exist. After a topic is deleted, a new topic may be created with the\nsame name."
},
"publishBatch": {
- "flatPath": "v1beta1a/topics/publishBatch",
- "path": "v1beta1a/topics/publishBatch",
- "id": "pubsub.topics.publishBatch",
- "description": "Adds one or more messages to the topic. Returns NOT_FOUND if the topic does\nnot exist.",
- "request": {
- "$ref": "PublishBatchRequest"
- },
"response": {
"$ref": "PublishBatchResponse"
},
"parameterOrder": [],
"httpMethod": "POST",
+ "parameters": {},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/pubsub"
],
- "parameters": {}
+ "flatPath": "v1beta1a/topics/publishBatch",
+ "path": "v1beta1a/topics/publishBatch",
+ "id": "pubsub.topics.publishBatch",
+ "request": {
+ "$ref": "PublishBatchRequest"
+ },
+ "description": "Adds one or more messages to the topic. Returns NOT_FOUND if the topic does\nnot exist."
},
"list": {
- "id": "pubsub.topics.list",
- "path": "v1beta1a/topics",
- "description": "Lists matching topics.",
- "httpMethod": "GET",
- "parameterOrder": [],
"response": {
"$ref": "ListTopicsResponse"
},
+ "parameterOrder": [],
+ "httpMethod": "GET",
"parameters": {
- "query": {
- "location": "query",
- "description": "A valid label query expression.",
- "type": "string"
- },
- "maxResults": {
- "description": "Maximum number of topics to return.",
- "format": "int32",
- "type": "integer",
+ "pageToken": {
+ "description": "The value obtained in the last \u003ccode\u003eListTopicsResponse\u003c/code\u003e\nfor continuation.",
+ "type": "string",
"location": "query"
},
- "pageToken": {
+ "query": {
+ "type": "string",
"location": "query",
- "description": "The value obtained in the last \u003ccode\u003eListTopicsResponse\u003c/code\u003e\nfor continuation.",
- "type": "string"
+ "description": "A valid label query expression."
+ },
+ "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"
- },
- "create": {
"flatPath": "v1beta1a/topics",
"path": "v1beta1a/topics",
- "id": "pubsub.topics.create",
+ "id": "pubsub.topics.list",
+ "description": "Lists matching topics."
+ },
+ "create": {
"request": {
"$ref": "Topic"
},
"description": "Creates the given topic with the given name.",
+ "httpMethod": "POST",
+ "parameterOrder": [],
"response": {
"$ref": "Topic"
},
- "parameterOrder": [],
- "httpMethod": "POST",
- "parameters": {},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ]
- }
- }
- },
- "subscriptions": {
- "methods": {
- "modifyPushConfig": {
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "parameters": {},
- "flatPath": "v1beta1a/subscriptions/modifyPushConfig",
- "path": "v1beta1a/subscriptions/modifyPushConfig",
- "id": "pubsub.subscriptions.modifyPushConfig",
- "description": "Modifies the \u003ccode\u003ePushConfig\u003c/code\u003e for a specified subscription.\nThis method can be used to suspend the flow of messages to an endpoint\nby clearing the \u003ccode\u003ePushConfig\u003c/code\u003e field in the request. Messages\nwill be accumulated for delivery even if no push configuration is\ndefined or while the configuration is modified.",
- "request": {
- "$ref": "ModifyPushConfigRequest"
- }
- },
- "pull": {
- "description": "Pulls a single message from the server.\nIf return_immediately is true, and no messages are available in the\nsubscription, this method returns FAILED_PRECONDITION. The system is free\nto return an UNAVAILABLE error if no messages are available in a\nreasonable amount of time (to reduce system load).",
- "request": {
- "$ref": "PullRequest"
- },
- "response": {
- "$ref": "PullResponse"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "parameters": {},
- "flatPath": "v1beta1a/subscriptions/pull",
- "path": "v1beta1a/subscriptions/pull",
- "id": "pubsub.subscriptions.pull"
- },
- "delete": {
- "path": "v1beta1a/subscriptions/{+subscription}",
- "id": "pubsub.subscriptions.delete",
- "description": "Deletes an existing subscription. All pending messages in the subscription\nare immediately dropped. Calls to Pull after deletion will return\nNOT_FOUND.",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "subscription"
- ],
- "httpMethod": "DELETE",
- "parameters": {
- "subscription": {
- "pattern": "^.+$",
- "location": "path",
- "description": "The subscription to delete.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "flatPath": "v1beta1a/subscriptions/{subscriptionsId}"
- },
- "list": {
- "parameters": {
- "pageToken": {
- "location": "query",
- "description": "The value obtained in the last \u003ccode\u003eListSubscriptionsResponse\u003c/code\u003e\nfor continuation.",
- "type": "string"
- },
- "query": {
- "description": "A valid label query expression.",
- "type": "string",
- "location": "query"
- },
- "maxResults": {
- "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",
- "description": "Lists matching subscriptions.",
- "response": {
- "$ref": "ListSubscriptionsResponse"
- },
- "parameterOrder": [],
- "httpMethod": "GET"
- },
- "create": {
- "flatPath": "v1beta1a/subscriptions",
- "path": "v1beta1a/subscriptions",
- "id": "pubsub.subscriptions.create",
- "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.",
- "response": {
- "$ref": "Subscription"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "parameters": {},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ]
- },
- "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"
- ]
- },
- "acknowledge": {
- "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"
- },
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "parameters": {}
- },
- "get": {
- "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"
- ],
- "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"
- }
- },
- "pullBatch": {
- "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",
- "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."
+ "flatPath": "v1beta1a/topics",
+ "id": "pubsub.topics.create",
+ "path": "v1beta1a/topics"
}
}
}
},
"parameters": {
+ "pp": {
+ "description": "Pretty-print response.",
+ "type": "boolean",
+ "default": "true",
+ "location": "query"
+ },
+ "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": {
"location": "query",
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
@@ -363,9 +407,9 @@
"location": "query"
},
"uploadType": {
- "location": "query",
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"fields": {
"location": "query",
@@ -378,25 +422,19 @@
"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"
- ],
- "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",
@@ -404,12 +442,18 @@
],
"location": "query",
"description": "Data format for response.",
- "default": "json"
+ "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",
- "location": "query"
+ "type": "string"
},
"access_token": {
"location": "query",
@@ -420,27 +464,134 @@
"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"
}
},
"schemas": {
+ "Label": {
+ "type": "object",
+ "properties": {
+ "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"
+ },
+ "strValue": {
+ "description": "A string value.",
+ "type": "string"
+ },
+ "numValue": {
+ "type": "string",
+ "description": "An integer value.",
+ "format": "int64"
+ }
+ },
+ "id": "Label",
+ "description": "A key-value pair applied to a given object."
+ },
+ "ModifyAckDeadlineRequest": {
+ "description": "Request for the ModifyAckDeadline method.",
+ "type": "object",
+ "properties": {
+ "subscription": {
+ "description": "Next Index: 5\nThe name of the subscription from which messages are being pulled.",
+ "type": "string"
+ },
+ "ackId": {
+ "type": "string",
+ "description": "The acknowledgment ID. Either this or ack_ids must be populated,\nnot both."
+ },
+ "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"
+ },
+ "PullBatchRequest": {
+ "description": "Request for the PullBatch method.",
+ "type": "object",
+ "properties": {
+ "maxEvents": {
+ "description": "The maximum number of PubsubEvents returned for this request. The Pub/Sub\nsystem may return fewer than the number of events specified.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "subscription": {
+ "description": "The subscription from which messages should be pulled.",
+ "type": "string"
+ },
+ "returnImmediately": {
+ "description": "If this is specified as true the system will respond immediately even if\nit is not able to return a message in the Pull response. Otherwise the\nsystem is allowed to wait until at least one message is available rather\nthan returning no messages. The client may cancel the request if it does\nnot wish to wait any longer for the response.",
+ "type": "boolean"
+ }
+ },
+ "id": "PullBatchRequest"
+ },
+ "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": {
+ "type": "array",
+ "items": {
+ "$ref": "Label"
+ },
+ "description": "Optional list of labels for this message. Keys in this collection must\nbe unique."
+ },
+ "publishTime": {
+ "description": "The time at which the message was published.\nThe time is milliseconds since the UNIX epoch.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "id": "PubsubMessage"
+ },
+ "ModifyPushConfigRequest": {
+ "properties": {
+ "pushConfig": {
+ "description": "An empty \u003ccode\u003epush_config\u003c/code\u003e indicates that the Pub/Sub system should\npause pushing messages from the given subscription.",
+ "$ref": "PushConfig"
+ },
+ "subscription": {
+ "description": "The name of the subscription.",
+ "type": "string"
+ }
+ },
+ "id": "ModifyPushConfigRequest",
+ "description": "Request for the ModifyPushConfig method.",
+ "type": "object"
+ },
+ "PullBatchResponse": {
+ "properties": {
+ "pullResponses": {
+ "description": "Received Pub/Sub messages or status events. The Pub/Sub system will return\nzero messages if there are no more messages available in the backlog. The\nPub/Sub system may return fewer than the max_events requested even if\nthere are more messages available in the backlog.",
+ "type": "array",
+ "items": {
+ "$ref": "PullResponse"
+ }
+ }
+ },
+ "id": "PullBatchResponse",
+ "description": "Response for the PullBatch method.",
+ "type": "object"
+ },
"AcknowledgeRequest": {
- "id": "AcknowledgeRequest",
"description": "Request for the Acknowledge method.",
"type": "object",
"properties": {
@@ -455,27 +606,14 @@
"type": "string"
}
}
- }
- },
- "PullBatchResponse": {
- "id": "PullBatchResponse",
- "description": "Response for the PullBatch method.",
- "type": "object",
- "properties": {
- "pullResponses": {
- "description": "Received Pub/Sub messages or status events. The Pub/Sub system will return\nzero messages if there are no more messages available in the backlog. The\nPub/Sub system may return fewer than the max_events requested even if\nthere are more messages available in the backlog.",
- "type": "array",
- "items": {
- "$ref": "PullResponse"
- }
- }
- }
+ },
+ "id": "AcknowledgeRequest"
},
"Empty": {
- "properties": {},
- "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"
+ "type": "object",
+ "properties": {},
+ "id": "Empty"
},
"PublishBatchRequest": {
"id": "PublishBatchRequest",
@@ -496,24 +634,25 @@
}
},
"ListTopicsResponse": {
+ "id": "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"
}
+ },
+ "nextPageToken": {
+ "description": "If not empty, indicates that there are more topics that match the request,\nand this value should be passed to the next \u003ccode\u003eListTopicsRequest\u003c/code\u003e\nto continue.",
+ "type": "string"
}
- },
- "id": "ListTopicsResponse"
+ }
},
"PullResponse": {
+ "description": "Either a \u003ccode\u003ePubsubMessage\u003c/code\u003e or a truncation event. One of these two\nmust be populated.",
"type": "object",
"properties": {
"ackId": {
@@ -521,12 +660,11 @@
"type": "string"
},
"pubsubEvent": {
- "description": "A pubsub message or truncation event.",
- "$ref": "PubsubEvent"
+ "$ref": "PubsubEvent",
+ "description": "A pubsub message or truncation event."
}
},
- "id": "PullResponse",
- "description": "Either a \u003ccode\u003ePubsubMessage\u003c/code\u003e or a truncation event. One of these two\nmust be populated."
+ "id": "PullResponse"
},
"PushConfig": {
"description": "Configuration for a push delivery endpoint.",
@@ -548,14 +686,13 @@
"type": "string"
},
"returnImmediately": {
- "type": "boolean",
- "description": "If this is specified as true the system will respond immediately even if\nit is not able to return a message in the Pull response. Otherwise the\nsystem is allowed to wait until at least one message is available rather\nthan returning FAILED_PRECONDITION. The client may cancel the request if\nit does not wish to wait any longer for the response."
+ "description": "If this is specified as true the system will respond immediately even if\nit is not able to return a message in the Pull response. Otherwise the\nsystem is allowed to wait until at least one message is available rather\nthan returning FAILED_PRECONDITION. The client may cancel the request if\nit does not wish to wait any longer for the response.",
+ "type": "boolean"
}
},
"id": "PullRequest"
},
"ListSubscriptionsResponse": {
- "description": "Response for the ListSubscriptions method.",
"type": "object",
"properties": {
"subscription": {
@@ -570,49 +707,60 @@
"type": "string"
}
},
- "id": "ListSubscriptionsResponse"
+ "id": "ListSubscriptionsResponse",
+ "description": "Response for the ListSubscriptions method."
},
"PubsubEvent": {
+ "description": "An event indicating a received message or truncation event.",
+ "type": "object",
"properties": {
+ "truncated": {
+ "description": "Indicates that this subscription has been truncated.",
+ "type": "boolean"
+ },
+ "deleted": {
+ "type": "boolean",
+ "description": "Indicates that this subscription has been deleted. (Note that pull\nsubscribers will always receive NOT_FOUND in response in their pull\nrequest on the subscription, rather than seeing this boolean.)"
+ },
"message": {
- "$ref": "PubsubMessage",
- "description": "A received message."
+ "description": "A received message.",
+ "$ref": "PubsubMessage"
},
"subscription": {
"description": "The subscription that received the event.",
"type": "string"
- },
- "truncated": {
- "type": "boolean",
- "description": "Indicates that this subscription has been truncated."
- },
- "deleted": {
- "description": "Indicates that this subscription has been deleted. (Note that pull\nsubscribers will always receive NOT_FOUND in response in their pull\nrequest on the subscription, rather than seeing this boolean.)",
- "type": "boolean"
}
},
- "id": "PubsubEvent",
- "description": "An event indicating a received message or truncation event.",
- "type": "object"
+ "id": "PubsubEvent"
},
"PublishRequest": {
+ "description": "Request for the Publish method.",
+ "type": "object",
"properties": {
"topic": {
"description": "The message in the request will be published on this topic.",
"type": "string"
},
"message": {
- "description": "The message to publish.",
- "$ref": "PubsubMessage"
+ "$ref": "PubsubMessage",
+ "description": "The message to publish."
}
},
- "id": "PublishRequest",
- "description": "Request for the Publish method.",
- "type": "object"
+ "id": "PublishRequest"
},
"Subscription": {
+ "description": "A subscription resource.",
"type": "object",
"properties": {
+ "ackDeadlineSeconds": {
+ "type": "integer",
+ "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"
+ },
+ "name": {
+ "description": "Name of the subscription.",
+ "type": "string"
+ },
"topic": {
"description": "The name of the topic from which this subscription is receiving messages.",
"type": "string"
@@ -620,21 +768,13 @@
"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",
- "type": "integer"
- },
- "name": {
- "description": "Name of the subscription.",
- "type": "string"
}
},
- "id": "Subscription",
- "description": "A subscription resource."
+ "id": "Subscription"
},
"PublishBatchResponse": {
+ "description": "Response for the PublishBatch method.",
+ "type": "object",
"properties": {
"messageIds": {
"description": "The server-assigned ID of each published message, in the same order as\nthe messages in the request. IDs are guaranteed to be unique within\nthe topic.",
@@ -644,9 +784,7 @@
}
}
},
- "id": "PublishBatchResponse",
- "description": "Response for the PublishBatch method.",
- "type": "object"
+ "id": "PublishBatchResponse"
},
"Topic": {
"id": "Topic",
@@ -658,116 +796,6 @@
"type": "string"
}
}
- },
- "Label": {
- "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",
- "description": "A key-value pair applied to a given object."
- },
- "ModifyAckDeadlineRequest": {
- "description": "Request for the ModifyAckDeadline method.",
- "type": "object",
- "properties": {
- "subscription": {
- "type": "string",
- "description": "Next Index: 5\nThe name of the subscription from which messages are being pulled."
- },
- "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": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "description": "List of acknowledgment IDs. Either this field or ack_id\nshould be populated, not both."
- }
- },
- "id": "ModifyAckDeadlineRequest"
- },
- "PullBatchRequest": {
- "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.",
- "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"
- },
- "subscription": {
- "description": "The subscription from which messages should be pulled.",
- "type": "string"
- }
- },
- "id": "PullBatchRequest",
- "description": "Request for the PullBatch method."
- },
- "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": {
- "messageId": {
- "type": "string",
- "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."
- },
- "label": {
- "description": "Optional list of labels for this message. Keys in this collection must\nbe unique.",
- "type": "array",
- "items": {
- "$ref": "Label"
- }
- },
- "publishTime": {
- "description": "The time at which the message was published.\nThe time is milliseconds since the UNIX epoch.",
- "format": "int64",
- "type": "string"
- },
- "data": {
- "description": "The message payload.",
- "format": "byte",
- "type": "string"
- }
- },
- "id": "PubsubMessage"
}
},
"icons": {
@@ -775,33 +803,5 @@
"x32": "http://www.google.com/images/icons/product/search-32.gif"
},
"protocol": "rest",
- "version": "v1beta1a",
- "baseUrl": "https://pubsub.googleapis.com/",
- "canonicalName": "Pubsub",
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/pubsub": {
- "description": "View and manage Pub/Sub topics and subscriptions"
- },
- "https://www.googleapis.com/auth/cloud-platform": {
- "description": "View and manage your data across Google Cloud Platform services"
- }
- }
- }
- },
- "description": "Provides reliable, many-to-many, asynchronous messaging between applications.\n",
- "servicePath": "",
- "kind": "discovery#restDescription",
- "rootUrl": "https://pubsub.googleapis.com/",
- "basePath": "",
- "ownerDomain": "google.com",
- "name": "pubsub",
- "batchPath": "batch",
- "revision": "20171213",
- "documentationLink": "https://cloud.google.com/pubsub/docs",
- "id": "pubsub:v1beta1a",
- "title": "Google Cloud Pub/Sub API",
- "discoveryVersion": "v1",
- "ownerName": "Google"
+ "version": "v1beta1a"
}
diff --git a/pubsub/v1beta2/pubsub-api.json b/pubsub/v1beta2/pubsub-api.json
index 38681f2..6a9e9c4 100644
--- a/pubsub/v1beta2/pubsub-api.json
+++ b/pubsub/v1beta2/pubsub-api.json
@@ -1,133 +1,31 @@
{
- "ownerName": "Google",
+ "basePath": "",
+ "ownerDomain": "google.com",
+ "name": "pubsub",
+ "batchPath": "batch",
+ "revision": "20171213",
+ "documentationLink": "https://cloud.google.com/pubsub/docs",
+ "id": "pubsub:v1beta2",
+ "title": "Google Cloud Pub/Sub API",
"discoveryVersion": "v1",
+ "ownerName": "Google",
"resources": {
"projects": {
"resources": {
"subscriptions": {
"methods": {
- "getIamPolicy": {
- "id": "pubsub.projects.subscriptions.getIamPolicy",
- "path": "v1beta2/{+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/[^/]+/subscriptions/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "flatPath": "v1beta2/projects/{projectsId}/subscriptions/{subscriptionsId}:getIamPolicy"
- },
- "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.",
- "httpMethod": "POST",
- "parameterOrder": [
- "subscription"
- ],
- "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"
- },
- "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.",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "subscription"
- ],
- "httpMethod": "POST",
- "parameters": {
- "subscription": {
- "location": "path",
- "description": "The subscription whose message is being acknowledged.",
- "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}:acknowledge",
- "path": "v1beta2/{+subscription}:acknowledge",
- "id": "pubsub.projects.subscriptions.acknowledge"
- },
- "get": {
- "flatPath": "v1beta2/projects/{projectsId}/subscriptions/{subscriptionsId}",
- "path": "v1beta2/{+subscription}",
- "id": "pubsub.projects.subscriptions.get",
- "description": "Gets the configuration details of a subscription.",
- "response": {
- "$ref": "Subscription"
- },
- "parameterOrder": [
- "subscription"
- ],
- "httpMethod": "GET",
- "parameters": {
- "subscription": {
- "pattern": "^projects/[^/]+/subscriptions/[^/]+$",
- "location": "path",
- "description": "The name of the subscription to get.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ]
- },
"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"
- },
+ "httpMethod": "POST",
"parameterOrder": [
"resource"
],
- "httpMethod": "POST",
+ "response": {
+ "$ref": "TestIamPermissionsResponse"
+ },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/pubsub"
@@ -142,14 +40,10 @@
}
},
"flatPath": "v1beta2/projects/{projectsId}/subscriptions/{subscriptionsId}:testIamPermissions",
- "path": "v1beta2/{+resource}:testIamPermissions",
- "id": "pubsub.projects.subscriptions.testIamPermissions"
+ "id": "pubsub.projects.subscriptions.testIamPermissions",
+ "path": "v1beta2/{+resource}:testIamPermissions"
},
"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"
},
@@ -157,28 +51,32 @@
"subscription"
],
"httpMethod": "POST",
- "parameters": {
- "subscription": {
- "description": "The name of the subscription.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/subscriptions/[^/]+$",
- "location": "path"
- }
- },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/pubsub"
],
+ "parameters": {
+ "subscription": {
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/subscriptions/[^/]+$",
+ "location": "path",
+ "description": "The name of the subscription."
+ }
+ },
"flatPath": "v1beta2/projects/{projectsId}/subscriptions/{subscriptionsId}:modifyPushConfig",
"path": "v1beta2/{+subscription}:modifyPushConfig",
- "id": "pubsub.projects.subscriptions.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"
+ }
},
"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"
},
+ "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"
},
@@ -186,24 +84,25 @@
"subscription"
],
"httpMethod": "POST",
+ "parameters": {
+ "subscription": {
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/subscriptions/[^/]+$",
+ "location": "path",
+ "description": "The subscription from which messages should be pulled."
+ }
+ },
"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.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/subscriptions/[^/]+$"
- }
- },
"flatPath": "v1beta2/projects/{projectsId}/subscriptions/{subscriptionsId}:pull",
"path": "v1beta2/{+subscription}:pull",
"id": "pubsub.projects.subscriptions.pull"
},
"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"
},
@@ -211,73 +110,79 @@
"subscription"
],
"httpMethod": "DELETE",
+ "parameters": {
+ "subscription": {
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/subscriptions/[^/]+$",
+ "location": "path",
+ "description": "The subscription to delete."
+ }
+ },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/pubsub"
],
- "parameters": {
- "subscription": {
- "location": "path",
- "description": "The subscription to delete.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/subscriptions/[^/]+$"
- }
- },
"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."
+ "id": "pubsub.projects.subscriptions.delete"
},
"list": {
- "flatPath": "v1beta2/projects/{projectsId}/subscriptions",
- "id": "pubsub.projects.subscriptions.list",
- "path": "v1beta2/{+project}/subscriptions",
- "description": "Lists matching subscriptions.",
- "httpMethod": "GET",
"response": {
"$ref": "ListSubscriptionsResponse"
},
"parameterOrder": [
"project"
],
- "parameters": {
- "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",
- "pattern": "^projects/[^/]+$",
- "location": "path"
- },
- "pageToken": {
- "type": "string",
- "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."
- }
- },
+ "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": {
+ "description": "Maximum number of subscriptions to return.",
+ "format": "int32",
+ "type": "integer",
+ "location": "query"
+ },
+ "project": {
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+$",
+ "location": "path",
+ "description": "The name of the cloud project that subscriptions belong to."
+ }
+ },
+ "flatPath": "v1beta2/projects/{projectsId}/subscriptions",
+ "path": "v1beta2/{+project}/subscriptions",
+ "id": "pubsub.projects.subscriptions.list",
+ "description": "Lists matching subscriptions."
},
"create": {
+ "response": {
+ "$ref": "Subscription"
+ },
+ "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 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",
- "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\"`."
+ "location": "path"
}
},
"flatPath": "v1beta2/projects/{projectsId}/subscriptions/{subscriptionsId}",
@@ -286,34 +191,20 @@
"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"
- },
- "response": {
- "$ref": "Subscription"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "PUT"
+ }
},
"setIamPolicy": {
- "response": {
- "$ref": "Policy"
- },
- "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 is being specified.\nSee the operation documentation for the appropriate value for this field.",
"required": true,
"type": "string",
- "pattern": "^projects/[^/]+/subscriptions/[^/]+$"
+ "pattern": "^projects/[^/]+/subscriptions/[^/]+$",
+ "location": "path"
}
},
"flatPath": "v1beta2/projects/{projectsId}/subscriptions/{subscriptionsId}:setIamPolicy",
@@ -322,17 +213,16 @@
"description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.",
"request": {
"$ref": "SetIamPolicyRequest"
- }
- }
- }
- },
- "topics": {
- "methods": {
+ },
+ "response": {
+ "$ref": "Policy"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "POST"
+ },
"getIamPolicy": {
- "flatPath": "v1beta2/projects/{projectsId}/topics/{topicsId}:getIamPolicy",
- "path": "v1beta2/{+resource}:getIamPolicy",
- "id": "pubsub.projects.topics.getIamPolicy",
- "description": "Gets the access control policy for a resource.\nReturns an empty policy if the resource exists and does not have a policy\nset.",
"response": {
"$ref": "Policy"
},
@@ -342,20 +232,111 @@
"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/[^/]+/topics/[^/]+$",
+ "pattern": "^projects/[^/]+/subscriptions/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
+ "flatPath": "v1beta2/projects/{projectsId}/subscriptions/{subscriptionsId}:getIamPolicy",
+ "path": "v1beta2/{+resource}:getIamPolicy",
+ "id": "pubsub.projects.subscriptions.getIamPolicy",
+ "description": "Gets the access control policy for a resource.\nReturns an empty policy if the resource exists and does not have a policy\nset."
+ },
+ "modifyAckDeadline": {
+ "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}:modifyAckDeadline",
+ "path": "v1beta2/{+subscription}:modifyAckDeadline",
+ "id": "pubsub.projects.subscriptions.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": {
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "subscription"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "subscription": {
+ "description": "The subscription whose message is being acknowledged.",
+ "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}:acknowledge",
+ "path": "v1beta2/{+subscription}:acknowledge",
+ "id": "pubsub.projects.subscriptions.acknowledge",
+ "request": {
+ "$ref": "AcknowledgeRequest"
+ },
+ "description": "Acknowledges the messages associated with the `ack_ids` in the\n`AcknowledgeRequest`. The Pub/Sub system can remove the relevant messages\nfrom the subscription.\n\nAcknowledging a message whose ack deadline has expired may succeed,\nbut such a message may be redelivered later. Acknowledging a message more\nthan once will not result in an error."
},
"get": {
- "description": "Gets the configuration of a topic.",
+ "flatPath": "v1beta2/projects/{projectsId}/subscriptions/{subscriptionsId}",
+ "path": "v1beta2/{+subscription}",
+ "id": "pubsub.projects.subscriptions.get",
+ "description": "Gets the configuration details of a subscription.",
+ "response": {
+ "$ref": "Subscription"
+ },
+ "parameterOrder": [
+ "subscription"
+ ],
+ "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.",
+ "required": true,
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "topics": {
+ "methods": {
+ "get": {
"response": {
"$ref": "Topic"
},
@@ -363,28 +344,25 @@
"topic"
],
"httpMethod": "GET",
- "parameters": {
- "topic": {
- "description": "The name of the topic to get.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/topics/[^/]+$",
- "location": "path"
- }
- },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/pubsub"
],
+ "parameters": {
+ "topic": {
+ "pattern": "^projects/[^/]+/topics/[^/]+$",
+ "location": "path",
+ "description": "The name of the topic to get.",
+ "required": true,
+ "type": "string"
+ }
+ },
"flatPath": "v1beta2/projects/{projectsId}/topics/{topicsId}",
"path": "v1beta2/{+topic}",
- "id": "pubsub.projects.topics.get"
+ "id": "pubsub.projects.topics.get",
+ "description": "Gets the configuration of a topic."
},
"publish": {
- "description": "Adds one or more messages to the topic. Returns `NOT_FOUND` if the topic\ndoes not exist. The message payload must not be empty; it must contain\n either a non-empty data field, or at least one attribute.",
- "request": {
- "$ref": "PublishRequest"
- },
"response": {
"$ref": "PublishResponse"
},
@@ -392,24 +370,34 @@
"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"
+ }
+ },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/pubsub"
],
- "parameters": {
- "topic": {
- "pattern": "^projects/[^/]+/topics/[^/]+$",
- "location": "path",
- "description": "The messages in the request will be published on this topic.",
- "required": true,
- "type": "string"
- }
- },
"flatPath": "v1beta2/projects/{projectsId}/topics/{topicsId}:publish",
"path": "v1beta2/{+topic}:publish",
- "id": "pubsub.projects.topics.publish"
+ "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": {
+ "path": "v1beta2/{+resource}:testIamPermissions",
+ "id": "pubsub.projects.topics.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"
},
@@ -417,54 +405,52 @@
"resource"
],
"httpMethod": "POST",
+ "parameters": {
+ "resource": {
+ "pattern": "^projects/[^/]+/topics/[^/]+$",
+ "location": "path",
+ "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
+ "required": true,
+ "type": "string"
+ }
+ },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/pubsub"
],
- "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"
- }
+ "flatPath": "v1beta2/projects/{projectsId}/topics/{topicsId}:testIamPermissions"
},
"delete": {
+ "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_`.",
- "httpMethod": "DELETE",
- "parameterOrder": [
- "topic"
- ],
"response": {
"$ref": "Empty"
},
- "parameters": {
- "topic": {
- "description": "Name of the topic to delete.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/topics/[^/]+$",
- "location": "path"
- }
- },
+ "parameterOrder": [
+ "topic"
+ ],
+ "httpMethod": "DELETE",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/pubsub"
],
- "flatPath": "v1beta2/projects/{projectsId}/topics/{topicsId}",
- "id": "pubsub.projects.topics.delete",
- "path": "v1beta2/{+topic}"
+ "parameters": {
+ "topic": {
+ "location": "path",
+ "description": "Name of the topic to delete.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/topics/[^/]+$"
+ }
+ },
+ "flatPath": "v1beta2/projects/{projectsId}/topics/{topicsId}"
},
"list": {
+ "flatPath": "v1beta2/projects/{projectsId}/topics",
+ "path": "v1beta2/{+project}/topics",
+ "id": "pubsub.projects.topics.list",
+ "description": "Lists matching topics.",
"response": {
"$ref": "ListTopicsResponse"
},
@@ -472,63 +458,30 @@
"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 `ListTopicsResponse`; indicates that this is\na continuation of a prior `ListTopics` call, and that the system should\nreturn the next page of data.",
+ "project": {
+ "required": true,
"type": "string",
- "location": "query"
+ "pattern": "^projects/[^/]+$",
+ "location": "path",
+ "description": "The name of the cloud project that topics belong to."
+ },
+ "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": {
"type": "integer",
"location": "query",
"description": "Maximum number of topics to return.",
"format": "int32"
- },
- "project": {
- "location": "path",
- "description": "The name of the cloud project that topics belong to.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+$"
}
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "flatPath": "v1beta2/projects/{projectsId}/topics",
- "path": "v1beta2/{+project}/topics",
- "id": "pubsub.projects.topics.list",
- "description": "Lists matching topics."
- },
- "setIamPolicy": {
- "path": "v1beta2/{+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",
- "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": "v1beta2/projects/{projectsId}/topics/{topicsId}:setIamPolicy"
+ }
},
"create": {
"response": {
@@ -544,11 +497,11 @@
],
"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"
+ "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\"`."
}
},
"flatPath": "v1beta2/projects/{projectsId}/topics/{topicsId}",
@@ -558,12 +511,71 @@
"request": {
"$ref": "Topic"
}
+ },
+ "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": {
+ "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": "v1beta2/projects/{projectsId}/topics/{topicsId}:setIamPolicy",
+ "path": "v1beta2/{+resource}:setIamPolicy",
+ "id": "pubsub.projects.topics.setIamPolicy"
+ },
+ "getIamPolicy": {
+ "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 is being requested.\nSee the operation documentation for the appropriate value for this field.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1beta2/projects/{projectsId}/topics/{topicsId}:getIamPolicy",
+ "path": "v1beta2/{+resource}:getIamPolicy",
+ "id": "pubsub.projects.topics.getIamPolicy",
+ "description": "Gets the access control policy for a resource.\nReturns an empty policy if the resource exists and does not have a policy\nset.",
+ "response": {
+ "$ref": "Policy"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "GET"
}
},
"resources": {
"subscriptions": {
"methods": {
"list": {
+ "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.",
"response": {
"$ref": "ListTopicSubscriptionsResponse"
},
@@ -571,10 +583,6 @@
"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.",
@@ -582,23 +590,23 @@
"location": "query"
},
"pageSize": {
- "description": "Maximum number of subscription names to return.",
- "format": "int32",
"type": "integer",
- "location": "query"
+ "location": "query",
+ "description": "Maximum number of subscription names to return.",
+ "format": "int32"
},
"topic": {
- "required": true,
- "type": "string",
"pattern": "^projects/[^/]+/topics/[^/]+$",
"location": "path",
- "description": "The name of the topic that subscriptions are attached to."
+ "description": "The name of the topic that subscriptions are attached to.",
+ "required": true,
+ "type": "string"
}
},
- "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"
+ ]
}
}
}
@@ -608,10 +616,26 @@
}
},
"parameters": {
- "upload_protocol": {
+ "pp": {
"location": "query",
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string"
+ "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": {
+ "type": "string",
+ "location": "query",
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")."
},
"prettyPrint": {
"description": "Returns response with indentations and line breaks.",
@@ -648,6 +672,12 @@
"type": "string"
},
"alt": {
+ "default": "json",
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
"type": "string",
"enumDescriptions": [
"Responses with Content-Type of application/json",
@@ -655,18 +685,12 @@
"Responses with Content-Type of application/x-protobuf"
],
"location": "query",
- "description": "Data format for response.",
- "default": "json",
- "enum": [
- "json",
- "media",
- "proto"
- ]
+ "description": "Data format for response."
},
"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": {
"location": "query",
@@ -677,87 +701,9 @@
"description": "Available 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": {
- "type": "string",
- "location": "query",
- "description": "OAuth 2.0 token for the current user."
}
},
"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"
- },
- "PullRequest": {
- "description": "Request for the `Pull` method.",
- "type": "object",
- "properties": {
- "returnImmediately": {
- "type": "boolean",
- "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."
- },
- "maxMessages": {
- "type": "integer",
- "description": "The maximum number of messages returned for this request. The Pub/Sub\nsystem may return fewer than the number specified.",
- "format": "int32"
- }
- },
- "id": "PullRequest"
- },
- "ListSubscriptionsResponse": {
- "id": "ListSubscriptionsResponse",
- "description": "Response for the `ListSubscriptions` method.",
- "type": "object",
- "properties": {
- "nextPageToken": {
- "description": "If not empty, indicates that there may be more subscriptions that match\nthe request; this value should be passed in a new\n`ListSubscriptionsRequest` to get more subscriptions.",
- "type": "string"
- },
- "subscriptions": {
- "description": "The subscriptions that match the request.",
- "type": "array",
- "items": {
- "$ref": "Subscription"
- }
- }
- }
- },
- "PublishRequest": {
- "description": "Request for the Publish method.",
- "type": "object",
- "properties": {
- "messages": {
- "description": "The messages to publish.",
- "type": "array",
- "items": {
- "$ref": "PubsubMessage"
- }
- }
- },
- "id": "PublishRequest"
- },
"PublishResponse": {
"description": "Response for the `Publish` method.",
"type": "object",
@@ -797,7 +743,6 @@
"id": "Subscription"
},
"TestIamPermissionsRequest": {
- "id": "TestIamPermissionsRequest",
"description": "Request message for `TestIamPermissions` method.",
"type": "object",
"properties": {
@@ -808,10 +753,10 @@
"type": "string"
}
}
- }
+ },
+ "id": "TestIamPermissionsRequest"
},
"Topic": {
- "id": "Topic",
"description": "A topic resource.",
"type": "object",
"properties": {
@@ -819,11 +764,10 @@
"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"
},
"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.",
@@ -843,10 +787,11 @@
}
}
},
- "id": "Policy"
+ "id": "Policy",
+ "description": "Defines an Identity and Access Management (IAM) policy. It is used to\nspecify access control policies for Cloud Platform resources.\n\n\nA `Policy` consists of a list of `bindings`. A `Binding` binds a list of\n`members` to a `role`, where the members can be user accounts, Google groups,\nGoogle domains, and service accounts. A `role` is a named list of permissions\ndefined by IAM.\n\n**Example**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/owner\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-other-app@appspot.gserviceaccount.com\",\n ]\n },\n {\n \"role\": \"roles/viewer\",\n \"members\": [\"user:sean@example.com\"]\n }\n ]\n }\n\nFor a description of IAM and its features, see the\n[IAM developer's guide](https://cloud.google.com/iam).",
+ "type": "object"
},
"ModifyAckDeadlineRequest": {
- "type": "object",
"properties": {
"ackIds": {
"description": "List of acknowledgment IDs.",
@@ -866,46 +811,19 @@
}
},
"id": "ModifyAckDeadlineRequest",
- "description": "Request for the ModifyAckDeadline method."
+ "description": "Request for the ModifyAckDeadline method.",
+ "type": "object"
},
"SetIamPolicyRequest": {
+ "id": "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"
- },
- "PubsubMessage": {
- "description": "A message data and its attributes. The message payload must not be empty;\nit must contain either a non-empty data field, or at least one attribute.",
- "type": "object",
- "properties": {
- "data": {
- "description": "The message payload. For JSON requests, the value of this field must be\n[base64-encoded](https://tools.ietf.org/html/rfc4648).",
- "format": "byte",
- "type": "string"
- },
- "attributes": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "Optional attributes for this message.",
- "type": "object"
- },
- "messageId": {
- "description": "ID of this message, assigned by the server when the message is published.\nGuaranteed to be unique within the topic. This value may be read by a\nsubscriber that receives a `PubsubMessage` via a `Pull` call or a push\ndelivery. It must not be populated by the publisher in a `Publish` call.",
- "type": "string"
- },
- "publishTime": {
- "description": "The time at which the message was published, populated by the server when\nit receives the `Publish` call. It must not be populated by the\npublisher in a `Publish` call.",
- "format": "google-datetime",
- "type": "string"
- }
- },
- "id": "PubsubMessage"
+ }
},
"ModifyPushConfigRequest": {
"description": "Request for the ModifyPushConfig method.",
@@ -918,37 +836,65 @@
},
"id": "ModifyPushConfigRequest"
},
+ "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": {
+ "attributes": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Optional attributes for this message.",
+ "type": "object"
+ },
+ "messageId": {
+ "type": "string",
+ "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."
+ },
+ "publishTime": {
+ "type": "string",
+ "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"
+ },
+ "data": {
+ "description": "The message payload. For JSON requests, the value of this field must be\n[base64-encoded](https://tools.ietf.org/html/rfc4648).",
+ "format": "byte",
+ "type": "string"
+ }
+ },
+ "id": "PubsubMessage"
+ },
"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"
},
"AcknowledgeRequest": {
- "description": "Request for the Acknowledge method.",
"type": "object",
"properties": {
"ackIds": {
- "description": "The acknowledgment ID for the messages being acknowledged that was returned\nby the Pub/Sub system in the `Pull` response. Must not be empty.",
"type": "array",
"items": {
"type": "string"
- }
+ },
+ "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."
}
},
- "id": "AcknowledgeRequest"
+ "id": "AcknowledgeRequest",
+ "description": "Request for the Acknowledge 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 `{}`.",
@@ -957,7 +903,6 @@
"id": "Empty"
},
"ListTopicsResponse": {
- "id": "ListTopicsResponse",
"description": "Response for the `ListTopics` method.",
"type": "object",
"properties": {
@@ -972,11 +917,10 @@
"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"
},
"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.",
@@ -990,10 +934,11 @@
}
}
},
- "id": "ListTopicSubscriptionsResponse"
+ "id": "ListTopicSubscriptionsResponse",
+ "description": "Response for the `ListTopicSubscriptions` method.",
+ "type": "object"
},
"PullResponse": {
- "id": "PullResponse",
"description": "Response for the `Pull` method.",
"type": "object",
"properties": {
@@ -1004,24 +949,27 @@
"$ref": "ReceivedMessage"
}
}
- }
+ },
+ "id": "PullResponse"
},
"ReceivedMessage": {
- "id": "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": {
+ "description": "The message.",
+ "$ref": "PubsubMessage"
}
- }
+ },
+ "id": "ReceivedMessage"
},
"PushConfig": {
+ "id": "PushConfig",
+ "description": "Configuration for a push delivery endpoint.",
"type": "object",
"properties": {
"pushEndpoint": {
@@ -1029,22 +977,82 @@
"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"
+ }
+ }
+ },
+ "TestIamPermissionsResponse": {
+ "type": "object",
+ "properties": {
+ "permissions": {
+ "description": "A subset of `TestPermissionsRequest.permissions` that the caller is\nallowed.",
+ "type": "array",
+ "items": {
+ "type": "string"
}
}
},
- "id": "PushConfig",
- "description": "Configuration for a push delivery endpoint."
+ "id": "TestIamPermissionsResponse",
+ "description": "Response message for `TestIamPermissions` method."
+ },
+ "PullRequest": {
+ "description": "Request for the `Pull` method.",
+ "type": "object",
+ "properties": {
+ "maxMessages": {
+ "description": "The maximum number of messages returned for this request. The Pub/Sub\nsystem may return fewer than the number specified.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "returnImmediately": {
+ "description": "If this 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": "PullRequest"
+ },
+ "ListSubscriptionsResponse": {
+ "description": "Response for the `ListSubscriptions` method.",
+ "type": "object",
+ "properties": {
+ "nextPageToken": {
+ "description": "If not empty, indicates that there may be more subscriptions that match\nthe request; this value should be passed in a new\n`ListSubscriptionsRequest` to get more subscriptions.",
+ "type": "string"
+ },
+ "subscriptions": {
+ "description": "The subscriptions that match the request.",
+ "type": "array",
+ "items": {
+ "$ref": "Subscription"
+ }
+ }
+ },
+ "id": "ListSubscriptionsResponse"
+ },
+ "PublishRequest": {
+ "description": "Request for the Publish method.",
+ "type": "object",
+ "properties": {
+ "messages": {
+ "description": "The messages to publish.",
+ "type": "array",
+ "items": {
+ "$ref": "PubsubMessage"
+ }
+ }
+ },
+ "id": "PublishRequest"
}
},
+ "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": "v1beta2",
"baseUrl": "https://pubsub.googleapis.com/",
"canonicalName": "Pubsub",
@@ -1063,13 +1071,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",
- "id": "pubsub:v1beta2",
- "documentationLink": "https://cloud.google.com/pubsub/docs",
- "revision": "20171213",
- "title": "Google Cloud Pub/Sub API"
+ "rootUrl": "https://pubsub.googleapis.com/"
}
diff --git a/runtimeconfig/v1/runtimeconfig-api.json b/runtimeconfig/v1/runtimeconfig-api.json
index 2c7e65c..38b354b 100644
--- a/runtimeconfig/v1/runtimeconfig-api.json
+++ b/runtimeconfig/v1/runtimeconfig-api.json
@@ -1,69 +1,39 @@
{
- "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": "",
- "basePath": "",
- "revision": "20171219",
- "documentationLink": "https://cloud.google.com/deployment-manager/runtime-configurator/",
- "id": "runtimeconfig:v1",
- "discoveryVersion": "v1",
- "version_module": true,
"schemas": {
- "CancelOperationRequest": {
- "description": "The request message for Operations.CancelOperation.",
- "type": "object",
- "properties": {},
- "id": "CancelOperationRequest"
- },
- "Status": {
- "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
- "type": "object",
- "properties": {
- "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"
- },
"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"
- }
+ },
+ "description": "A list of operations that matches the specified filter in the request."
+ },
+ "nextPageToken": {
+ "description": "The standard List next-page token.",
+ "type": "string"
}
- },
- "id": "ListOperationsResponse"
+ }
},
"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": {
+ "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."
@@ -79,29 +49,48 @@
"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"
},
"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"
+ },
+ "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": {
+ "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",
+ "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"
}
},
"protocol": "rest",
@@ -140,39 +129,10 @@
"name"
],
"httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudruntimeconfig"
- ],
"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": "runtimeconfig.operations.cancel",
- "description": "Starts asynchronous cancellation on a long-running operation. The server\nmakes a best effort to cancel the operation, but success is not\nguaranteed. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`. Clients can use\nOperations.GetOperation or\nother methods to check whether the cancellation succeeded or whether the\noperation completed despite cancellation. On successful cancellation,\nthe operation is not deleted; instead, it becomes an operation with\nan Operation.error value with a google.rpc.Status.code of 1,\ncorresponding to `Code.CANCELLED`.",
- "request": {
- "$ref": "CancelOperationRequest"
- }
- },
- "delete": {
- "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"
@@ -182,13 +142,41 @@
"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": {
+ "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/cloudruntimeconfig"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The name of the operation resource to be deleted.",
+ "required": true,
+ "type": "string",
+ "pattern": "^operations/.+$",
+ "location": "path"
+ }
+ },
"flatPath": "v1/operations/{operationsId}",
"path": "v1/{+name}",
- "id": "runtimeconfig.operations.delete",
- "description": "Deletes a long-running operation. This method indicates that the client is\nno longer interested in the operation result. It does not cancel the\noperation. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`."
+ "id": "runtimeconfig.operations.delete"
},
"list": {
- "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"
},
@@ -198,16 +186,16 @@
"httpMethod": "GET",
"parameters": {
"name": {
- "pattern": "^operations$",
"location": "path",
"description": "The name of the operation's parent resource.",
"required": true,
- "type": "string"
+ "type": "string",
+ "pattern": "^operations$"
},
"pageToken": {
- "description": "The standard list page token.",
"type": "string",
- "location": "query"
+ "location": "query",
+ "description": "The standard list page token."
},
"pageSize": {
"location": "query",
@@ -227,52 +215,55 @@
],
"flatPath": "v1/operations",
"path": "v1/{+name}",
- "id": "runtimeconfig.operations.list"
+ "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": {
- "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"
- },
- "fields": {
+ "default": "true",
"location": "query",
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string"
+ "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"
+ },
+ "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"
- },
- "callback": {
"location": "query",
- "description": "JSONP",
- "type": "string"
+ "enum": [
+ "1",
+ "2"
+ ]
},
"alt": {
+ "description": "Data format for response.",
+ "default": "json",
"enum": [
"json",
"media",
@@ -284,24 +275,22 @@
"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",
- "location": "query"
+ "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"
+ "type": "string",
+ "location": "query"
},
"pp": {
"description": "Pretty-print response.",
@@ -309,15 +298,26 @@
"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"
+ },
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string",
+ "location": "query"
}
- }
+ },
+ "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": "",
+ "documentationLink": "https://cloud.google.com/deployment-manager/runtime-configurator/",
+ "id": "runtimeconfig:v1",
+ "revision": "20171219",
+ "discoveryVersion": "v1",
+ "version_module": true
}
diff --git a/runtimeconfig/v1beta1/runtimeconfig-api.json b/runtimeconfig/v1beta1/runtimeconfig-api.json
index 9973001..a27c88d 100644
--- a/runtimeconfig/v1beta1/runtimeconfig-api.json
+++ b/runtimeconfig/v1beta1/runtimeconfig-api.json
@@ -1,803 +1,145 @@
{
- "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": {
- "request": {
- "$ref": "RuntimeConfig"
- },
- "description": "Updates a RuntimeConfig resource. The configuration must exist beforehand.",
- "httpMethod": "PUT",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "RuntimeConfig"
- },
- "parameters": {
- "name": {
- "location": "path",
- "description": "The name of the RuntimeConfig resource to update, in the format:\n\n`projects/[PROJECT_ID]/configs/[CONFIG_NAME]`",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/configs/[^/]+$"
- }
- },
- "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}"
- },
- "testIamPermissions": {
- "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/[^/]+$"
- }
- },
- "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"
- }
- },
- "delete": {
- "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}",
- "path": "v1beta1/{+name}",
- "id": "runtimeconfig.projects.configs.delete",
- "description": "Deletes a RuntimeConfig resource.",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "DELETE",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudruntimeconfig"
- ],
- "parameters": {
- "name": {
- "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"
- }
- }
- },
- "list": {
- "description": "Lists all the RuntimeConfig resources within project.",
- "httpMethod": "GET",
- "parameterOrder": [
- "parent"
- ],
- "response": {
- "$ref": "ListConfigsResponse"
- },
- "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"
- },
- "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": {
- "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": {
- "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.create",
- "path": "v1beta1/{+parent}/configs"
- },
- "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": {
- "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/[^/]+/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.",
- "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/[^/]+/configs/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudruntimeconfig"
- ],
- "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}:getIamPolicy",
- "id": "runtimeconfig.projects.configs.getIamPolicy",
- "path": "v1beta1/{+resource}:getIamPolicy"
- }
- },
- "resources": {
- "variables": {
- "methods": {
- "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": {
- "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": {
- "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",
- "pattern": "^projects/[^/]+/configs/[^/]+$"
- },
- "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": {
- "description": "Specifies a page token to use. Set `pageToken` to a `nextPageToken`\nreturned by a previous list request to get the next page of results.",
- "type": "string",
- "location": "query"
- },
- "returnValues": {
- "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",
- "path": "v1beta1/{+parent}/variables",
- "id": "runtimeconfig.projects.configs.variables.list"
- },
- "create": {
- "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.",
- "response": {
- "$ref": "Variable"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "POST",
- "parameters": {
- "requestId": {
- "description": "An optional but recommended unique `request_id`. If the server\nreceives two `create()` requests with the same\n`request_id`, then the second request will be ignored and the\nfirst resource created and stored in the backend is returned.\nEmpty `request_id` fields are ignored.\n\nIt is responsibility of the client to ensure uniqueness of the\n`request_id` strings.\n\n`request_id` strings are limited to 64 characters.",
- "type": "string",
- "location": "query"
- },
- "parent": {
- "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/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudruntimeconfig"
- ]
- },
- "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": {
- "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",
- "pattern": "^projects/[^/]+/configs/[^/]+/variables/.+$"
- }
- },
- "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/variables/{variablesId}",
- "path": "v1beta1/{+name}",
- "id": "runtimeconfig.projects.configs.variables.get"
- },
- "watch": {
- "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/variables/{variablesId}:watch",
- "id": "runtimeconfig.projects.configs.variables.watch",
- "path": "v1beta1/{+name}: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": {
- "location": "path",
- "description": "The name of the variable to watch, in the format:\n\n`projects/[PROJECT_ID]/configs/[CONFIG_NAME]`",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/configs/[^/]+/variables/.+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudruntimeconfig"
- ]
- },
- "update": {
- "httpMethod": "PUT",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Variable"
- },
- "parameters": {
- "name": {
- "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",
- "pattern": "^projects/[^/]+/configs/[^/]+/variables/.+$"
- }
- },
- "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.update",
- "path": "v1beta1/{+name}",
- "request": {
- "$ref": "Variable"
- },
- "description": "Updates an existing variable with a new value."
- },
- "testIamPermissions": {
- "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/variables/{variablesId}:testIamPermissions",
- "id": "runtimeconfig.projects.configs.variables.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"
- },
- "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/.+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudruntimeconfig"
- ]
- },
- "delete": {
- "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/variables/{variablesId}",
- "path": "v1beta1/{+name}",
- "id": "runtimeconfig.projects.configs.variables.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.",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "DELETE",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudruntimeconfig"
- ],
- "parameters": {
- "recursive": {
- "description": "Set to `true` to recursively delete multiple variables with the same\nprefix.",
- "type": "boolean",
- "location": "query"
- },
- "name": {
- "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/.+$",
- "location": "path"
- }
- }
- }
- }
- },
- "operations": {
- "methods": {
- "get": {
- "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/operations/{operationsId}",
- "path": "v1beta1/{+name}",
- "id": "runtimeconfig.projects.configs.operations.get",
- "description": "Gets the latest state of a long-running operation. Clients can use this\nmethod to poll the operation result at intervals as recommended by the API\nservice.",
- "response": {
- "$ref": "Operation"
- },
- "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"
- }
- }
- },
- "testIamPermissions": {
- "httpMethod": "POST",
- "parameterOrder": [
- "resource"
- ],
- "response": {
- "$ref": "TestIamPermissionsResponse"
- },
- "parameters": {
- "resource": {
- "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/configs/[^/]+/operations/.+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudruntimeconfig"
- ],
- "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/operations/{operationsId}:testIamPermissions",
- "id": "runtimeconfig.projects.configs.operations.testIamPermissions",
- "path": "v1beta1/{+resource}:testIamPermissions",
- "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."
- }
- }
- },
- "waiters": {
- "methods": {
- "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"
- }
- },
- "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/waiters/{waitersId}:testIamPermissions",
- "path": "v1beta1/{+resource}:testIamPermissions",
- "id": "runtimeconfig.projects.configs.waiters.testIamPermissions"
- },
- "delete": {
- "description": "Deletes the waiter with the specified name.",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "DELETE",
- "parameters": {
- "name": {
- "location": "path",
- "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/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudruntimeconfig"
- ],
- "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/waiters/{waitersId}",
- "path": "v1beta1/{+name}",
- "id": "runtimeconfig.projects.configs.waiters.delete"
- },
- "list": {
- "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/waiters",
- "path": "v1beta1/{+parent}/waiters",
- "id": "runtimeconfig.projects.configs.waiters.list",
- "description": "List waiters within the given configuration.",
- "response": {
- "$ref": "ListWaitersResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "GET",
- "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": {
- "description": "The path to the configuration for which you want to get a list of waiters.\nThe configuration must exist beforehand; the path must be in the format:\n\n`projects/[PROJECT_ID]/configs/[CONFIG_NAME]`",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/configs/[^/]+$",
- "location": "path"
- },
- "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"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudruntimeconfig"
- ]
- },
- "get": {
- "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/waiters/{waitersId}",
- "path": "v1beta1/{+name}",
- "id": "runtimeconfig.projects.configs.waiters.get",
- "description": "Gets information about a single waiter.",
- "response": {
- "$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/[^/]+$"
- }
- }
- },
- "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.",
- "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": {
- "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"
- ],
- "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/waiters",
- "path": "v1beta1/{+parent}/waiters",
- "id": "runtimeconfig.projects.configs.waiters.create"
- }
- }
- }
- }
- }
- }
- }
- },
- "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": {
- "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": {
- "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"
- }
- },
- "version": "v1beta1",
- "baseUrl": "https://runtimeconfig.googleapis.com/",
- "servicePath": "",
- "description": "The Runtime Configurator allows you to dynamically configure and expose variables through Google Cloud Platform. In addition, you can also set Watchers and Waiters that will watch for changes to your data and return based on certain conditions.",
- "kind": "discovery#restDescription",
- "basePath": "",
- "id": "runtimeconfig:v1beta1",
- "documentationLink": "https://cloud.google.com/deployment-manager/runtime-configurator/",
- "revision": "20171219",
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
+ "Operation": {
+ "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
+ "type": "object",
+ "properties": {
+ "error": {
+ "$ref": "Status",
+ "description": "The error result of the operation in case of failure or cancellation."
+ },
+ "metadata": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "description": "Service-specific metadata associated with the operation. It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata. Any method that returns a\nlong-running operation should document the metadata type, if any.",
+ "type": "object"
+ },
+ "done": {
+ "description": "If the value is `false`, it means the operation is still in progress.\nIf `true`, the operation is completed, and either `error` or `response` is\navailable.",
+ "type": "boolean"
+ },
+ "response": {
+ "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"
+ },
+ "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"
+ },
+ "Status": {
+ "properties": {
+ "details": {
+ "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.",
+ "type": "array",
+ "items": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "type": "object"
+ }
+ },
+ "code": {
+ "description": "The status code, which should be an enum value of google.rpc.Code.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "message": {
+ "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
+ "type": "string"
+ }
+ },
+ "id": "Status",
+ "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
+ "type": "object"
+ },
+ "Binding": {
+ "description": "Associates `members` with a `role`.",
+ "type": "object",
+ "properties": {
+ "members": {
+ "description": "Specifies the identities requesting access for a Cloud Platform resource.\n`members` can have the following values:\n\n* `allUsers`: A special identifier that represents anyone who is\n on the internet; with or without a Google account.\n\n* `allAuthenticatedUsers`: A special identifier that represents anyone\n who is authenticated with a Google account or a service account.\n\n* `user:{emailid}`: An email address that represents a specific Google\n account. For example, `alice@gmail.com` or `joe@example.com`.\n\n\n* `serviceAccount:{emailid}`: An email address that represents a service\n account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{emailid}`: An email address that represents a Google group.\n For example, `admins@example.com`.\n\n\n* `domain:{domain}`: A Google Apps domain name that represents all the\n users of that domain. For example, `google.com` or `example.com`.\n\n",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "role": {
+ "description": "Role that is assigned to `members`.\nFor example, `roles/viewer`, `roles/editor`, or `roles/owner`.\nRequired",
+ "type": "string"
+ }
+ },
+ "id": "Binding"
+ },
+ "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"
+ },
+ "Cardinality": {
+ "properties": {
+ "path": {
+ "description": "The root of the variable subtree to monitor. For example, `/foo`.",
+ "type": "string"
+ },
+ "number": {
+ "description": "The number variables under the `path` that must exist to meet this\ncondition. Defaults to 1 if not specified.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "Cardinality",
+ "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"
+ },
+ "ListConfigsResponse": {
+ "description": "`ListConfigs()` returns the following response. The order of returned\nobjects is arbitrary; that is, it is not ordered in any particular way.",
+ "type": "object",
+ "properties": {
+ "nextPageToken": {
+ "description": "This token allows you to get the next page of results for list requests.\nIf the number of results is larger than `pageSize`, use the `nextPageToken`\nas a value for the query parameter `pageToken` in the next list request.\nSubsequent list requests will have their own `nextPageToken` to continue\npaging through the results",
+ "type": "string"
+ },
+ "configs": {
+ "description": "A list of the configurations in the project. The order of returned\nobjects is arbitrary; that is, it is not ordered in any particular way.",
+ "type": "array",
+ "items": {
+ "$ref": "RuntimeConfig"
+ }
+ }
+ },
+ "id": "ListConfigsResponse"
+ },
"EndCondition": {
"description": "The condition that a Waiter resource is waiting for.",
"type": "object",
"properties": {
"cardinality": {
- "$ref": "Cardinality",
- "description": "The cardinality of the `EndCondition`."
+ "description": "The cardinality of the `EndCondition`.",
+ "$ref": "Cardinality"
}
},
"id": "EndCondition"
@@ -835,19 +177,19 @@
"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 the\n`[0-9A-Za-z](?:[_.A-Za-z0-9-]{0,62}[_.A-Za-z0-9])?` regular expression.\nThe length of `[CONFIG_NAME]` must be less than 64 characters.\n\nYou pick the RuntimeConfig resource name, but the server will validate that\nthe name adheres to this format. After you create the resource, you cannot\nchange the resource's name.",
"type": "string"
+ },
+ "description": {
+ "description": "An optional description of the RuntimeConfig object.",
+ "type": "string"
}
},
- "id": "RuntimeConfig"
+ "id": "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"
},
"WatchVariableRequest": {
"description": "Request for the `WatchVariable()` method.",
@@ -865,57 +207,20 @@
"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"
}
+ },
+ "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": {
- "$ref": "Status",
- "description": "[Output Only] If the waiter ended due to a failure or timeout, this value\nwill be set."
- },
- "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."
- },
- "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",
@@ -930,10 +235,69 @@
},
"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).",
+ "Waiter": {
+ "properties": {
+ "error": {
+ "description": "[Output Only] If the waiter ended due to a failure or timeout, this value\nwill be set.",
+ "$ref": "Status"
+ },
+ "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": {
+ "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"
+ },
+ "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",
+ "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"
+ },
+ "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": {
+ "properties": {
"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"
@@ -967,162 +331,9 @@
"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": {
- "description": "Associates a list of `members` to a `role`.\n`bindings` with no members will result in an error.",
- "type": "array",
- "items": {
- "$ref": "Binding"
- }
- }
- },
- "id": "Policy"
- },
- "Operation": {
- "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
- "type": "object",
- "properties": {
- "done": {
- "description": "If the value is `false`, it means the operation is still in progress.\nIf `true`, the operation is completed, and either `error` or `response` is\navailable.",
- "type": "boolean"
- },
- "response": {
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- },
- "description": "The normal response of the operation in case of success. If the original\nmethod returns no data on success, such as `Delete`, the response is\n`google.protobuf.Empty`. If the original method is standard\n`Get`/`Create`/`Update`, the response should be the resource. For other\nmethods, the response should have the type `XxxResponse`, where `Xxx`\nis the original method name. For example, if the original method name\nis `TakeSnapshot()`, the inferred response type is\n`TakeSnapshotResponse`.",
- "type": "object"
- },
- "name": {
- "description": "The server-assigned name, which is only unique within the same service that\noriginally returns it. If you use the default HTTP mapping, the\n`name` should have the format of `operations/some/unique/name`.",
- "type": "string"
- },
- "error": {
- "$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"
- },
- "SetIamPolicyRequest": {
- "description": "Request message for `SetIamPolicy` method.",
- "type": "object",
- "properties": {
- "policy": {
- "description": "REQUIRED: The complete policy to be applied to the `resource`. The size of\nthe policy is limited to a few 10s of KB. An empty policy is a\nvalid policy but certain Cloud Platform services (such as Projects)\nmight reject them.",
- "$ref": "Policy"
- }
- },
- "id": "SetIamPolicyRequest"
- },
- "Status": {
- "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
- "type": "object",
- "properties": {
- "code": {
- "description": "The status code, which should be an enum value of google.rpc.Code.",
- "format": "int32",
- "type": "integer"
- },
- "message": {
- "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
- "type": "string"
- },
- "details": {
- "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.",
- "type": "array",
- "items": {
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- },
- "type": "object"
- }
- }
- },
- "id": "Status"
- },
- "Binding": {
- "description": "Associates `members` with a `role`.",
- "type": "object",
- "properties": {
- "members": {
- "description": "Specifies the identities requesting access for a Cloud Platform resource.\n`members` can have the following values:\n\n* `allUsers`: A special identifier that represents anyone who is\n on the internet; with or without a Google account.\n\n* `allAuthenticatedUsers`: A special identifier that represents anyone\n who is authenticated with a Google account or a service account.\n\n* `user:{emailid}`: An email address that represents a specific Google\n account. For example, `alice@gmail.com` or `joe@example.com`.\n\n\n* `serviceAccount:{emailid}`: An email address that represents a service\n account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{emailid}`: An email address that represents a Google group.\n For example, `admins@example.com`.\n\n\n* `domain:{domain}`: A Google Apps domain name that represents all the\n users of that domain. For example, `google.com` or `example.com`.\n\n",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "role": {
- "description": "Role that is assigned to `members`.\nFor example, `roles/viewer`, `roles/editor`, or `roles/owner`.\nRequired",
- "type": "string"
- }
- },
- "id": "Binding"
- },
- "Cardinality": {
- "description": "A Cardinality condition for the Waiter resource. A cardinality condition is\nmet when the number of variables under a specified path prefix reaches a\npredefined number. For example, if you set a Cardinality condition where\nthe `path` is set to `/foo` and the number of paths is set to 2, the\nfollowing variables would meet the condition in a RuntimeConfig resource:\n\n+ `/foo/variable1 = \"value1\"`\n+ `/foo/variable2 = \"value2\"`\n+ `/bar/variable3 = \"value3\"`\n\nIt would not would not satisify the same condition with the `number` set to\n3, however, because there is only 2 paths that start with `/foo`.\nCardinality conditions are recursive; all subtrees under the specific\npath prefix are counted.",
- "type": "object",
- "properties": {
- "path": {
- "description": "The root of the variable subtree to monitor. For example, `/foo`.",
- "type": "string"
- },
- "number": {
- "description": "The number variables under the `path` that must exist to meet this\ncondition. Defaults to 1 if not specified.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "Cardinality"
- },
- "Empty": {
- "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
- "type": "object",
- "properties": {},
- "id": "Empty"
- },
- "ListConfigsResponse": {
- "description": "`ListConfigs()` returns the following response. The order of returned\nobjects is arbitrary; that is, it is not ordered in any particular way.",
- "type": "object",
- "properties": {
- "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"
+ "id": "Variable",
+ "description": "Describes a single variable within a RuntimeConfig resource.\nThe name denotes the hierarchical variable name. For example,\n`ports/serving_port` is a valid variable name. The variable value is an\nopaque string and only leaf variables can have values (that is, variables\nthat do not have any child variables).",
+ "type": "object"
}
},
"protocol": "rest",
@@ -1134,11 +345,11 @@
"auth": {
"oauth2": {
"scopes": {
- "https://www.googleapis.com/auth/cloudruntimeconfig": {
- "description": "Manage your Google Cloud Platform services' runtime configuration"
- },
"https://www.googleapis.com/auth/cloud-platform": {
"description": "View and manage your data across Google Cloud Platform services"
+ },
+ "https://www.googleapis.com/auth/cloudruntimeconfig": {
+ "description": "Manage your Google Cloud Platform services' runtime configuration"
}
}
}
@@ -1149,5 +360,794 @@
"batchPath": "batch",
"fullyEncodeReservedExpansion": true,
"title": "Google Cloud Runtime Configuration API",
- "ownerName": "Google"
+ "ownerName": "Google",
+ "resources": {
+ "projects": {
+ "resources": {
+ "configs": {
+ "methods": {
+ "delete": {
+ "path": "v1beta1/{+name}",
+ "id": "runtimeconfig.projects.configs.delete",
+ "description": "Deletes a RuntimeConfig resource.",
+ "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}"
+ },
+ "list": {
+ "description": "Lists all the RuntimeConfig resources within project.",
+ "response": {
+ "$ref": "ListConfigsResponse"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudruntimeconfig"
+ ],
+ "parameters": {
+ "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/[^/]+$"
+ },
+ "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"
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectsId}/configs",
+ "path": "v1beta1/{+parent}/configs",
+ "id": "runtimeconfig.projects.configs.list"
+ },
+ "create": {
+ "path": "v1beta1/{+parent}/configs",
+ "id": "runtimeconfig.projects.configs.create",
+ "description": "Creates a new RuntimeConfig resource. The configuration name must be\nunique within project.",
+ "request": {
+ "$ref": "RuntimeConfig"
+ },
+ "response": {
+ "$ref": "RuntimeConfig"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudruntimeconfig"
+ ],
+ "parameters": {
+ "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"
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectsId}/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"
+ }
+ },
+ "getIamPolicy": {
+ "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}:getIamPolicy",
+ "path": "v1beta1/{+resource}:getIamPolicy",
+ "id": "runtimeconfig.projects.configs.getIamPolicy",
+ "description": "Gets the access control policy for a resource.\nReturns an empty policy if the resource exists and does not have a policy\nset.",
+ "response": {
+ "$ref": "Policy"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "GET",
+ "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"
+ }
+ }
+ },
+ "get": {
+ "description": "Gets information about a RuntimeConfig resource.",
+ "response": {
+ "$ref": "RuntimeConfig"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudruntimeconfig"
+ ],
+ "parameters": {
+ "name": {
+ "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",
+ "pattern": "^projects/[^/]+/configs/[^/]+$"
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}",
+ "path": "v1beta1/{+name}",
+ "id": "runtimeconfig.projects.configs.get"
+ },
+ "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": {
+ "pattern": "^projects/[^/]+/configs/[^/]+$",
+ "location": "path",
+ "description": "The name of the RuntimeConfig resource to update, in the format:\n\n`projects/[PROJECT_ID]/configs/[CONFIG_NAME]`",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudruntimeconfig"
+ ],
+ "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}"
+ },
+ "testIamPermissions": {
+ "request": {
+ "$ref": "TestIamPermissionsRequest"
+ },
+ "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning.",
+ "response": {
+ "$ref": "TestIamPermissionsResponse"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "resource": {
+ "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/configs/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudruntimeconfig"
+ ],
+ "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}:testIamPermissions",
+ "path": "v1beta1/{+resource}:testIamPermissions",
+ "id": "runtimeconfig.projects.configs.testIamPermissions"
+ }
+ },
+ "resources": {
+ "variables": {
+ "methods": {
+ "list": {
+ "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.",
+ "response": {
+ "$ref": "ListVariablesResponse"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudruntimeconfig"
+ ],
+ "parameters": {
+ "parent": {
+ "pattern": "^projects/[^/]+/configs/[^/]+$",
+ "location": "path",
+ "description": "The path to the RuntimeConfig resource for which you want to list variables.\nThe configuration must exist beforehand; the path must be in the format:\n\n`projects/[PROJECT_ID]/configs/[CONFIG_NAME]`",
+ "required": true,
+ "type": "string"
+ },
+ "filter": {
+ "description": "Filters variables by matching the specified filter. For example:\n\n`projects/example-project/config/[CONFIG_NAME]/variables/example-variable`.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageToken": {
+ "description": "Specifies a page token to use. Set `pageToken` to a `nextPageToken`\nreturned by a previous list request to get the next page of results.",
+ "type": "string",
+ "location": "query"
+ },
+ "returnValues": {
+ "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"
+ },
+ "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"
+ }
+ }
+ },
+ "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": {
+ "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"
+ }
+ },
+ "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",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudruntimeconfig"
+ ],
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+/configs/[^/]+/variables/.+$",
+ "location": "path",
+ "description": "The name of the variable to return, in the format:\n\n`projects/[PROJECT_ID]/configs/[CONFIG_NAME]/variables/[VARIBLE_NAME]`",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/variables/{variablesId}",
+ "path": "v1beta1/{+name}",
+ "id": "runtimeconfig.projects.configs.variables.get",
+ "description": "Gets information about a single variable."
+ },
+ "watch": {
+ "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": {
+ "location": "path",
+ "description": "The name of the variable to watch, in the format:\n\n`projects/[PROJECT_ID]/configs/[CONFIG_NAME]`",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/configs/[^/]+/variables/.+$"
+ }
+ },
+ "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"
+ },
+ "update": {
+ "httpMethod": "PUT",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Variable"
+ },
+ "parameters": {
+ "name": {
+ "description": "The name of the variable to update, in the format:\n\n`projects/[PROJECT_ID]/configs/[CONFIG_NAME]/variables/[VARIABLE_NAME]`",
+ "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}",
+ "id": "runtimeconfig.projects.configs.variables.update",
+ "path": "v1beta1/{+name}",
+ "request": {
+ "$ref": "Variable"
+ },
+ "description": "Updates an existing variable with a new value."
+ },
+ "testIamPermissions": {
+ "request": {
+ "$ref": "TestIamPermissionsRequest"
+ },
+ "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning.",
+ "response": {
+ "$ref": "TestIamPermissionsResponse"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "resource": {
+ "pattern": "^projects/[^/]+/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"
+ },
+ "delete": {
+ "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/variables/{variablesId}",
+ "path": "v1beta1/{+name}",
+ "id": "runtimeconfig.projects.configs.variables.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.",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "DELETE",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudruntimeconfig"
+ ],
+ "parameters": {
+ "recursive": {
+ "location": "query",
+ "description": "Set to `true` to recursively delete multiple variables with the same\nprefix.",
+ "type": "boolean"
+ },
+ "name": {
+ "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/.+$",
+ "location": "path"
+ }
+ }
+ }
+ }
+ },
+ "operations": {
+ "methods": {
+ "get": {
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudruntimeconfig"
+ ],
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+/configs/[^/]+/operations/.+$",
+ "location": "path",
+ "description": "The name of the operation resource.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/operations/{operationsId}",
+ "path": "v1beta1/{+name}",
+ "id": "runtimeconfig.projects.configs.operations.get",
+ "description": "Gets the latest state of a long-running operation. Clients can use this\nmethod to poll the operation result at intervals as recommended by the API\nservice."
+ },
+ "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": {
+ "pattern": "^projects/[^/]+/configs/[^/]+/operations/.+$",
+ "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}/operations/{operationsId}:testIamPermissions",
+ "id": "runtimeconfig.projects.configs.operations.testIamPermissions",
+ "path": "v1beta1/{+resource}:testIamPermissions"
+ }
+ }
+ },
+ "waiters": {
+ "methods": {
+ "delete": {
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "DELETE",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudruntimeconfig"
+ ],
+ "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"
+ }
+ },
+ "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": {
+ "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/waiters",
+ "path": "v1beta1/{+parent}/waiters",
+ "id": "runtimeconfig.projects.configs.waiters.list",
+ "description": "List waiters within the given configuration.",
+ "response": {
+ "$ref": "ListWaitersResponse"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudruntimeconfig"
+ ],
+ "parameters": {
+ "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": {
+ "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"
+ }
+ }
+ },
+ "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": {
+ "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"
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/waiters/{waitersId}",
+ "path": "v1beta1/{+name}",
+ "id": "runtimeconfig.projects.configs.waiters.get"
+ },
+ "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": {
+ "location": "query",
+ "description": "An optional but recommended unique `request_id`. If the server\nreceives two `create()` requests with the same\n`request_id`, then the second request will be ignored and the\nfirst resource created and stored in the backend is returned.\nEmpty `request_id` fields are ignored.\n\nIt is responsibility of the client to ensure uniqueness of the\n`request_id` strings.\n\n`request_id` strings are limited to 64 characters.",
+ "type": "string"
+ },
+ "parent": {
+ "pattern": "^projects/[^/]+/configs/[^/]+$",
+ "location": "path",
+ "description": "The path to the configuration that will own the waiter.\nThe configuration must exist beforehand; the path must be in the format:\n\n`projects/[PROJECT_ID]/configs/[CONFIG_NAME]`.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudruntimeconfig"
+ ]
+ },
+ "testIamPermissions": {
+ "response": {
+ "$ref": "TestIamPermissionsResponse"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudruntimeconfig"
+ ],
+ "parameters": {
+ "resource": {
+ "pattern": "^projects/[^/]+/configs/[^/]+/waiters/[^/]+$",
+ "location": "path",
+ "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/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"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": {
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string",
+ "location": "query"
+ },
+ "bearer_token": {
+ "description": "OAuth bearer token.",
+ "type": "string",
+ "location": "query"
+ },
+ "upload_protocol": {
+ "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"
+ },
+ "$.xgafv": {
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query",
+ "enum": [
+ "1",
+ "2"
+ ],
+ "description": "V1 error format.",
+ "type": "string"
+ },
+ "callback": {
+ "location": "query",
+ "description": "JSONP",
+ "type": "string"
+ },
+ "alt": {
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
+ "type": "string",
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query",
+ "description": "Data format for response.",
+ "default": "json"
+ },
+ "access_token": {
+ "description": "OAuth access token.",
+ "type": "string",
+ "location": "query"
+ },
+ "key": {
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "type": "string",
+ "location": "query"
+ },
+ "quotaUser": {
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "type": "string",
+ "location": "query"
+ },
+ "pp": {
+ "description": "Pretty-print response.",
+ "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": "20171219"
}
diff --git a/safebrowsing/v4/safebrowsing-api.json b/safebrowsing/v4/safebrowsing-api.json
index 20098d3..294bc4d 100644
--- a/safebrowsing/v4/safebrowsing-api.json
+++ b/safebrowsing/v4/safebrowsing-api.json
@@ -1,130 +1,23 @@
{
+ "ownerName": "Google",
+ "discoveryVersion": "v1",
"resources": {
- "threatListUpdates": {
- "methods": {
- "fetch": {
- "response": {
- "$ref": "FetchThreatListUpdatesResponse"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "parameters": {},
- "flatPath": "v4/threatListUpdates:fetch",
- "path": "v4/threatListUpdates:fetch",
- "id": "safebrowsing.threatListUpdates.fetch",
- "description": "Fetches the most recent threat list updates. A client can request updates\nfor multiple lists at once.",
- "request": {
- "$ref": "FetchThreatListUpdatesRequest"
- }
- }
- }
- },
- "threatHits": {
- "methods": {
- "create": {
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "parameters": {},
- "flatPath": "v4/threatHits",
- "path": "v4/threatHits",
- "id": "safebrowsing.threatHits.create",
- "request": {
- "$ref": "ThreatHit"
- },
- "description": "Reports a Safe Browsing threat list hit to Google. Only projects with\nTRUSTED_REPORTER visibility can use this method."
- }
- }
- },
- "encodedFullHashes": {
- "methods": {
- "get": {
- "description": "",
- "httpMethod": "GET",
- "parameterOrder": [
- "encodedRequest"
- ],
- "response": {
- "$ref": "FindFullHashesResponse"
- },
- "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}"
- }
- }
- },
- "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": {
- "httpMethod": "POST",
- "parameterOrder": [],
- "response": {
- "$ref": "FindThreatMatchesResponse"
- },
- "parameters": {},
- "flatPath": "v4/threatMatches:find",
- "id": "safebrowsing.threatMatches.find",
- "path": "v4/threatMatches:find",
- "request": {
- "$ref": "FindThreatMatchesRequest"
- },
- "description": "Finds the threat entries that match the Safe Browsing lists."
- }
- }
- },
"fullHashes": {
"methods": {
"find": {
- "id": "safebrowsing.fullHashes.find",
+ "flatPath": "v4/fullHashes:find",
"path": "v4/fullHashes:find",
+ "id": "safebrowsing.fullHashes.find",
+ "description": "Finds the full hashes that match the requested hash prefixes.",
"request": {
"$ref": "FindFullHashesRequest"
},
- "description": "Finds the full hashes that match the requested hash prefixes.",
- "httpMethod": "POST",
- "parameterOrder": [],
"response": {
"$ref": "FindFullHashesResponse"
},
- "parameters": {},
- "flatPath": "v4/fullHashes:find"
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "parameters": {}
}
}
},
@@ -141,9 +34,9 @@
"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": {
"location": "query",
@@ -151,11 +44,11 @@
"type": "string"
},
"encodedRequest": {
+ "location": "path",
"description": "A serialized FetchThreatListUpdatesRequest proto.",
"format": "byte",
"required": true,
- "type": "string",
- "location": "path"
+ "type": "string"
}
},
"flatPath": "v4/encodedUpdates/{encodedRequest}",
@@ -163,56 +56,118 @@
"id": "safebrowsing.encodedUpdates.get"
}
}
+ },
+ "threatListUpdates": {
+ "methods": {
+ "fetch": {
+ "request": {
+ "$ref": "FetchThreatListUpdatesRequest"
+ },
+ "description": "Fetches the most recent threat list updates. A client can request updates\nfor multiple lists at once.",
+ "response": {
+ "$ref": "FetchThreatListUpdatesResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "parameters": {},
+ "flatPath": "v4/threatListUpdates:fetch",
+ "path": "v4/threatListUpdates:fetch",
+ "id": "safebrowsing.threatListUpdates.fetch"
+ }
+ }
+ },
+ "threatHits": {
+ "methods": {
+ "create": {
+ "request": {
+ "$ref": "ThreatHit"
+ },
+ "description": "Reports a Safe Browsing threat list hit to Google. Only projects with\nTRUSTED_REPORTER visibility can use this method.",
+ "httpMethod": "POST",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameters": {},
+ "flatPath": "v4/threatHits",
+ "id": "safebrowsing.threatHits.create",
+ "path": "v4/threatHits"
+ }
+ }
+ },
+ "encodedFullHashes": {
+ "methods": {
+ "get": {
+ "response": {
+ "$ref": "FindFullHashesResponse"
+ },
+ "parameterOrder": [
+ "encodedRequest"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "clientVersion": {
+ "description": "The version of the client implementation.",
+ "type": "string",
+ "location": "query"
+ },
+ "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"
+ }
+ },
+ "flatPath": "v4/encodedFullHashes/{encodedRequest}",
+ "path": "v4/encodedFullHashes/{encodedRequest}",
+ "id": "safebrowsing.encodedFullHashes.get",
+ "description": ""
+ }
+ }
+ },
+ "threatLists": {
+ "methods": {
+ "list": {
+ "description": "Lists the Safe Browsing threat lists available for download.",
+ "response": {
+ "$ref": "ListThreatListsResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "GET",
+ "parameters": {},
+ "flatPath": "v4/threatLists",
+ "path": "v4/threatLists",
+ "id": "safebrowsing.threatLists.list"
+ }
+ }
+ },
+ "threatMatches": {
+ "methods": {
+ "find": {
+ "flatPath": "v4/threatMatches:find",
+ "path": "v4/threatMatches:find",
+ "id": "safebrowsing.threatMatches.find",
+ "request": {
+ "$ref": "FindThreatMatchesRequest"
+ },
+ "description": "Finds the threat entries that match the Safe Browsing lists.",
+ "response": {
+ "$ref": "FindThreatMatchesResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "parameters": {}
+ }
+ }
}
},
"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": {
- "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"
- },
- "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\").",
@@ -225,9 +180,9 @@
"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\").",
@@ -240,6 +195,8 @@
"location": "query"
},
"$.xgafv": {
+ "description": "V1 error format.",
+ "type": "string",
"enumDescriptions": [
"v1 error format",
"v2 error format"
@@ -248,72 +205,61 @@
"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"
],
- "description": "V1 error format.",
+ "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": {
+ "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"
}
},
"schemas": {
- "Constraints": {
- "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": {
- "description": "The compression types supported by the client.",
- "type": "array",
- "items": {
- "enum": [
- "COMPRESSION_TYPE_UNSPECIFIED",
- "RAW",
- "RICE"
- ],
- "type": "string"
- },
- "enumDescriptions": [
- "Unknown.",
- "Raw, uncompressed data.",
- "Rice-Golomb encoded data."
- ]
- },
- "maxUpdateEntries": {
- "description": "The maximum size in number of entries. The update will not contain more\nentries than this value. This should be a power of 2 between 2**10 and\n2**20. If zero, no update size limit is set.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "Constraints",
- "description": "The constraints for this update.",
- "type": "object"
- },
- "ListThreatListsResponse": {
- "type": "object",
- "properties": {
- "threatLists": {
- "description": "The lists available for download by the client.",
- "type": "array",
- "items": {
- "$ref": "ThreatListDescriptor"
- }
- }
- },
- "id": "ListThreatListsResponse"
- },
"RiceDeltaEncoding": {
"description": "The Rice-Golomb encoded data. Used for sending compressed 4-byte hashes or\ncompressed removal indices.",
"type": "object",
"properties": {
- "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"
- },
"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",
@@ -328,11 +274,30 @@
"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"
},
+ "ListThreatListsResponse": {
+ "type": "object",
+ "properties": {
+ "threatLists": {
+ "description": "The lists available for download by the client.",
+ "type": "array",
+ "items": {
+ "$ref": "ThreatListDescriptor"
+ }
+ }
+ },
+ "id": "ListThreatListsResponse"
+ },
"FindThreatMatchesResponse": {
+ "type": "object",
"properties": {
"matches": {
"description": "The threat list matches.",
@@ -342,10 +307,11 @@
}
}
},
- "id": "FindThreatMatchesResponse",
- "type": "object"
+ "id": "FindThreatMatchesResponse"
},
"ThreatListDescriptor": {
+ "description": "Describes an individual threat list. A list is defined by three parameters:\nthe type of threat posed, the type of platform targeted by the threat, and\nthe type of entries in the list.",
+ "type": "object",
"properties": {
"platformType": {
"enumDescriptions": [
@@ -374,22 +340,6 @@
"type": "string"
},
"threatType": {
- "enum": [
- "THREAT_TYPE_UNSPECIFIED",
- "MALWARE",
- "SOCIAL_ENGINEERING",
- "UNWANTED_SOFTWARE",
- "POTENTIALLY_HARMFUL_APPLICATION",
- "SOCIAL_ENGINEERING_INTERNAL",
- "API_ABUSE",
- "MALICIOUS_BINARY",
- "CSD_WHITELIST",
- "CSD_DOWNLOAD_WHITELIST",
- "CLIENT_INCIDENT",
- "CLIENT_INCIDENT_WHITELIST",
- "APK_MALWARE_OFFLINE",
- "SUBRESOURCE_FILTER"
- ],
"description": "The threat type posed by the list's entries.",
"type": "string",
"enumDescriptions": [
@@ -407,6 +357,22 @@
"Whitelist used when detecting client incident threats.\nThis enum was never launched and should be re-used for the next list.",
"List used for offline APK checks in PAM.",
"Patterns to be used for activating the subresource filter. Interstitial\nwill not be shown for patterns from this list."
+ ],
+ "enum": [
+ "THREAT_TYPE_UNSPECIFIED",
+ "MALWARE",
+ "SOCIAL_ENGINEERING",
+ "UNWANTED_SOFTWARE",
+ "POTENTIALLY_HARMFUL_APPLICATION",
+ "SOCIAL_ENGINEERING_INTERNAL",
+ "API_ABUSE",
+ "MALICIOUS_BINARY",
+ "CSD_WHITELIST",
+ "CSD_DOWNLOAD_WHITELIST",
+ "CLIENT_INCIDENT",
+ "CLIENT_INCIDENT_WHITELIST",
+ "APK_MALWARE_OFFLINE",
+ "SUBRESOURCE_FILTER"
]
},
"threatEntryType": {
@@ -432,11 +398,11 @@
"type": "string"
}
},
- "id": "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"
+ "id": "ThreatListDescriptor"
},
"ClientInfo": {
+ "description": "The client metadata associated with Safe Browsing API requests.",
+ "type": "object",
"properties": {
"clientId": {
"description": "A client ID that (hopefully) uniquely identifies the client implementation\nof the Safe Browsing API.",
@@ -447,11 +413,11 @@
"type": "string"
}
},
- "id": "ClientInfo",
- "description": "The client metadata associated with Safe Browsing API requests.",
- "type": "object"
+ "id": "ClientInfo"
},
"ThreatInfo": {
+ "description": "The information regarding one or more threats that a client submits when\nchecking for matches in threat lists.",
+ "type": "object",
"properties": {
"threatEntryTypes": {
"description": "The entry types to be checked.",
@@ -554,9 +520,7 @@
}
}
},
- "id": "ThreatInfo",
- "description": "The information regarding one or more threats that a client submits when\nchecking for matches in threat lists.",
- "type": "object"
+ "id": "ThreatInfo"
},
"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.",
@@ -576,29 +540,37 @@
"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": {
- "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"
- },
"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"
},
"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"
},
"FindFullHashesRequest": {
"description": "Request to return full hashes matched by the provided hash prefixes.",
"type": "object",
"properties": {
+ "client": {
+ "$ref": "ClientInfo",
+ "description": "The client metadata."
+ },
+ "threatInfo": {
+ "description": "The lists and hashes to be checked.",
+ "$ref": "ThreatInfo"
+ },
"apiClient": {
"$ref": "ClientInfo",
"description": "Client metadata associated with callers of higher-level APIs built on top\nof the client's implementation."
@@ -610,14 +582,6 @@
"format": "byte",
"type": "string"
}
- },
- "client": {
- "$ref": "ClientInfo",
- "description": "The client metadata."
- },
- "threatInfo": {
- "description": "The lists and hashes to be checked.",
- "$ref": "ThreatInfo"
}
},
"id": "FindFullHashesRequest"
@@ -641,19 +605,10 @@
"id": "FetchThreatListUpdatesRequest"
},
"ListUpdateResponse": {
+ "description": "An update to an individual list.",
+ "type": "object",
"properties": {
"platformType": {
- "enum": [
- "PLATFORM_TYPE_UNSPECIFIED",
- "WINDOWS",
- "LINUX",
- "ANDROID",
- "OSX",
- "IOS",
- "ANY_PLATFORM",
- "ALL_PLATFORMS",
- "CHROME"
- ],
"description": "The platform type for which data is returned.",
"type": "string",
"enumDescriptions": [
@@ -666,6 +621,17 @@
"Threat posed to at least one of the defined platforms.",
"Threat posed to all defined platforms.",
"Threat posed to Chrome."
+ ],
+ "enum": [
+ "PLATFORM_TYPE_UNSPECIFIED",
+ "WINDOWS",
+ "LINUX",
+ "ANDROID",
+ "OSX",
+ "IOS",
+ "ANY_PLATFORM",
+ "ALL_PLATFORMS",
+ "CHROME"
]
},
"threatEntryType": {
@@ -698,10 +664,12 @@
}
},
"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"
+ "$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": {
+ "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.",
@@ -711,9 +679,7 @@
"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"
+ ]
},
"threatType": {
"enumDescriptions": [
@@ -751,43 +717,26 @@
"description": "The threat type for which data is returned.",
"type": "string"
},
+ "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"
}
- },
- "newClientState": {
- "description": "The new client state, in encrypted format. Opaque to clients.",
- "format": "byte",
- "type": "string"
}
},
- "id": "ListUpdateResponse",
- "description": "An update to an individual list.",
- "type": "object"
+ "id": "ListUpdateResponse"
},
"ThreatMatch": {
"description": "A match when checking a threat entry in the Safe Browsing threat lists.",
"type": "object",
"properties": {
- "threat": {
- "$ref": "ThreatEntry",
- "description": "The threat matching this threat."
- },
"platformType": {
- "enum": [
- "PLATFORM_TYPE_UNSPECIFIED",
- "WINDOWS",
- "LINUX",
- "ANDROID",
- "OSX",
- "IOS",
- "ANY_PLATFORM",
- "ALL_PLATFORMS",
- "CHROME"
- ],
"description": "The platform type matching this threat.",
"type": "string",
"enumDescriptions": [
@@ -800,18 +749,20 @@
"Threat posed to at least one of the defined platforms.",
"Threat posed to all defined platforms.",
"Threat posed to Chrome."
+ ],
+ "enum": [
+ "PLATFORM_TYPE_UNSPECIFIED",
+ "WINDOWS",
+ "LINUX",
+ "ANDROID",
+ "OSX",
+ "IOS",
+ "ANY_PLATFORM",
+ "ALL_PLATFORMS",
+ "CHROME"
]
},
"threatEntryType": {
- "enum": [
- "THREAT_ENTRY_TYPE_UNSPECIFIED",
- "URL",
- "EXECUTABLE",
- "IP_RANGE",
- "CHROME_EXTENSION",
- "FILENAME",
- "CERT"
- ],
"description": "The threat entry type matching this threat.",
"type": "string",
"enumDescriptions": [
@@ -822,6 +773,15 @@
"Chrome extension.",
"Filename.",
"CERT"
+ ],
+ "enum": [
+ "THREAT_ENTRY_TYPE_UNSPECIFIED",
+ "URL",
+ "EXECUTABLE",
+ "IP_RANGE",
+ "CHROME_EXTENSION",
+ "FILENAME",
+ "CERT"
]
},
"cacheDuration": {
@@ -830,22 +790,6 @@
"type": "string"
},
"threatType": {
- "enum": [
- "THREAT_TYPE_UNSPECIFIED",
- "MALWARE",
- "SOCIAL_ENGINEERING",
- "UNWANTED_SOFTWARE",
- "POTENTIALLY_HARMFUL_APPLICATION",
- "SOCIAL_ENGINEERING_INTERNAL",
- "API_ABUSE",
- "MALICIOUS_BINARY",
- "CSD_WHITELIST",
- "CSD_DOWNLOAD_WHITELIST",
- "CLIENT_INCIDENT",
- "CLIENT_INCIDENT_WHITELIST",
- "APK_MALWARE_OFFLINE",
- "SUBRESOURCE_FILTER"
- ],
"description": "The threat type matching this threat.",
"type": "string",
"enumDescriptions": [
@@ -863,11 +807,31 @@
"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": {
- "$ref": "ThreatEntryMetadata",
- "description": "Optional metadata associated with this threat."
+ "description": "Optional metadata associated with this threat.",
+ "$ref": "ThreatEntryMetadata"
+ },
+ "threat": {
+ "description": "The threat matching this threat.",
+ "$ref": "ThreatEntry"
}
},
"id": "ThreatMatch"
@@ -894,6 +858,8 @@
"id": "ThreatEntry"
},
"MetadataEntry": {
+ "description": "A single metadata entry.",
+ "type": "object",
"properties": {
"value": {
"description": "The metadata entry value. For JSON requests, the value is base64-encoded.",
@@ -906,26 +872,26 @@
"type": "string"
}
},
- "id": "MetadataEntry",
- "description": "A single metadata entry.",
- "type": "object"
+ "id": "MetadataEntry"
},
"FindThreatMatchesRequest": {
"description": "Request to check entries against lists.",
"type": "object",
"properties": {
"client": {
- "$ref": "ClientInfo",
- "description": "The client metadata."
+ "description": "The client metadata.",
+ "$ref": "ClientInfo"
},
"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"
},
"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.",
@@ -936,16 +902,12 @@
}
}
},
- "id": "RawIndices",
- "description": "A set of raw indices to remove from a local list.",
- "type": "object"
+ "id": "RawIndices"
},
"ThreatSource": {
+ "description": "A single resource related to a threat hit.",
+ "type": "object",
"properties": {
- "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"
@@ -971,29 +933,32 @@
],
"description": "The type of source reported.",
"type": "string"
+ },
+ "url": {
+ "description": "The URL of the resource.",
+ "type": "string"
}
},
- "id": "ThreatSource",
- "description": "A single resource related to a threat hit.",
- "type": "object"
+ "id": "ThreatSource"
},
"UserInfo": {
+ "description": "Details about the user that encountered the threat.",
+ "type": "object",
"properties": {
+ "regionCode": {
+ "description": "The UN M.49 region code associated with the user's location.",
+ "type": "string"
+ },
"userId": {
"description": "Unique user identifier defined by the client.",
"format": "byte",
"type": "string"
- },
- "regionCode": {
- "description": "The UN M.49 region code associated with the user's location.",
- "type": "string"
}
},
- "id": "UserInfo",
- "description": "Details about the user that encountered the threat.",
- "type": "object"
+ "id": "UserInfo"
},
"FetchThreatListUpdatesResponse": {
+ "type": "object",
"properties": {
"listUpdateResponses": {
"description": "The list updates requested by the clients.",
@@ -1008,17 +973,23 @@
"type": "string"
}
},
- "id": "FetchThreatListUpdatesResponse",
- "type": "object"
+ "id": "FetchThreatListUpdatesResponse"
+ },
+ "Checksum": {
+ "description": "The expected state of a client's local database.",
+ "type": "object",
+ "properties": {
+ "sha256": {
+ "description": "The SHA256 hash of the client state; that is, of the sorted list of all\nhashes present in the database.",
+ "format": "byte",
+ "type": "string"
+ }
+ },
+ "id": "Checksum"
},
"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",
@@ -1030,41 +1001,56 @@
"description": "For requested entities that did not match the threat list, how long to\ncache the response.",
"format": "google-duration",
"type": "string"
+ },
+ "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"
}
},
"id": "FindFullHashesResponse"
},
- "Checksum": {
+ "ThreatEntrySet": {
+ "description": "A set of threats that should be added or removed from a client's local\ndatabase.",
+ "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",
+ "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."
+ },
+ "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": {
+ "$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."
}
},
- "id": "Checksum",
- "description": "The expected state of a client's local database.",
- "type": "object"
+ "id": "ThreatEntrySet"
},
"ThreatHit": {
+ "type": "object",
"properties": {
"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": [
@@ -1082,131 +1068,8 @@
"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": {
- "$ref": "ThreatEntry",
- "description": "The threat entry responsible for the hit. Full hash should be reported for\nhash-based hits."
- },
- "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",
- "type": "object"
- },
- "ThreatEntrySet": {
- "description": "A set of threats that should be added or removed from a client's local\ndatabase.",
- "type": "object",
- "properties": {
- "compressionType": {
- "enum": [
- "COMPRESSION_TYPE_UNSPECIFIED",
- "RAW",
- "RICE"
- ],
- "description": "The compression type for the entries in this set.",
- "type": "string",
- "enumDescriptions": [
- "Unknown.",
- "Raw, uncompressed data.",
- "Rice-Golomb encoded data."
- ]
- },
- "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": {
- "description": "The raw SHA256-formatted entries.",
- "$ref": "RawHashes"
- },
- "riceHashes": {
- "$ref": "RiceDeltaEncoding",
- "description": "The encoded 4-byte prefixes of SHA256-formatted entries, using a\nGolomb-Rice encoding. The hashes are converted to uint32, sorted in\nascending order, then delta encoded and stored as encoded_data."
- }
- },
- "id": "ThreatEntrySet"
- },
- "ListUpdateRequest": {
- "description": "A single list update request.",
- "type": "object",
- "properties": {
- "state": {
- "description": "The current state of the client for the requested list (the encrypted\nclient state that was received from the last successful list update).",
- "format": "byte",
- "type": "string"
- },
- "platformType": {
- "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."
- ]
- },
- "threatType": {
- "enum": [
"THREAT_TYPE_UNSPECIFIED",
"MALWARE",
"SOCIAL_ENGINEERING",
@@ -1221,7 +1084,87 @@
"CLIENT_INCIDENT_WHITELIST",
"APK_MALWARE_OFFLINE",
"SUBRESOURCE_FILTER"
+ ]
+ },
+ "resources": {
+ "description": "The resources related to the threat hit.",
+ "type": "array",
+ "items": {
+ "$ref": "ThreatSource"
+ }
+ },
+ "entry": {
+ "description": "The threat entry responsible for the hit. Full hash should be reported for\nhash-based hits.",
+ "$ref": "ThreatEntry"
+ },
+ "platformType": {
+ "description": "The platform type reported.",
+ "type": "string",
+ "enumDescriptions": [
+ "Unknown platform.",
+ "Threat posed to Windows.",
+ "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"
+ ]
+ },
+ "userInfo": {
+ "$ref": "UserInfo",
+ "description": "Details about the user that encountered the threat."
+ },
+ "clientInfo": {
+ "description": "Client-reported identification.",
+ "$ref": "ClientInfo"
+ }
+ },
+ "id": "ThreatHit"
+ },
+ "ListUpdateRequest": {
+ "description": "A single list update request.",
+ "type": "object",
+ "properties": {
+ "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": {
"description": "The type of threat posed by entries present in the list.",
"type": "string",
"enumDescriptions": [
@@ -1239,11 +1182,27 @@
"Whitelist used when detecting client incident threats.\nThis enum was never launched and should be re-used for the next list.",
"List used for offline APK checks in PAM.",
"Patterns to be used for activating the subresource filter. Interstitial\nwill not be shown for patterns from this list."
+ ],
+ "enum": [
+ "THREAT_TYPE_UNSPECIFIED",
+ "MALWARE",
+ "SOCIAL_ENGINEERING",
+ "UNWANTED_SOFTWARE",
+ "POTENTIALLY_HARMFUL_APPLICATION",
+ "SOCIAL_ENGINEERING_INTERNAL",
+ "API_ABUSE",
+ "MALICIOUS_BINARY",
+ "CSD_WHITELIST",
+ "CSD_DOWNLOAD_WHITELIST",
+ "CLIENT_INCIDENT",
+ "CLIENT_INCIDENT_WHITELIST",
+ "APK_MALWARE_OFFLINE",
+ "SUBRESOURCE_FILTER"
]
},
"constraints": {
- "$ref": "Constraints",
- "description": "The constraints associated with this request."
+ "description": "The constraints associated with this request.",
+ "$ref": "Constraints"
},
"threatEntryType": {
"enumDescriptions": [
@@ -1266,21 +1225,64 @@
],
"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"
}
},
"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": {
+ "enum": [
+ "COMPRESSION_TYPE_UNSPECIFIED",
+ "RAW",
+ "RICE"
+ ],
+ "type": "string"
+ }
+ },
+ "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"
}
},
"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": "v4",
"baseUrl": "https://safebrowsing.googleapis.com/",
- "servicePath": "",
- "description": "Enables client applications to check web resources (most commonly URLs) against Google-generated lists of unsafe web resources.",
"kind": "discovery#restDescription",
+ "description": "Enables client applications to check web resources (most commonly URLs) against Google-generated lists of unsafe web resources.",
+ "servicePath": "",
"rootUrl": "https://safebrowsing.googleapis.com/",
"basePath": "",
"ownerDomain": "google.com",
@@ -1289,7 +1291,5 @@
"revision": "20171212",
"documentationLink": "https://developers.google.com/safe-browsing/",
"id": "safebrowsing:v4",
- "title": "Google Safe Browsing API",
- "discoveryVersion": "v1",
- "ownerName": "Google"
+ "title": "Google Safe Browsing API"
}
diff --git a/script/v1/script-api.json b/script/v1/script-api.json
index 40a14a7..6d9f749 100644
--- a/script/v1/script-api.json
+++ b/script/v1/script-api.json
@@ -1,15 +1,274 @@
{
+ "ownerName": "Google",
+ "discoveryVersion": "v1",
+ "resources": {
+ "scripts": {
+ "methods": {
+ "run": {
+ "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"
+ }
+ },
+ "scopes": [
+ "https://mail.google.com/",
+ "https://www.google.com/calendar/feeds",
+ "https://www.google.com/m8/feeds",
+ "https://www.googleapis.com/auth/admin.directory.group",
+ "https://www.googleapis.com/auth/admin.directory.user",
+ "https://www.googleapis.com/auth/drive",
+ "https://www.googleapis.com/auth/forms",
+ "https://www.googleapis.com/auth/forms.currentonly",
+ "https://www.googleapis.com/auth/groups",
+ "https://www.googleapis.com/auth/spreadsheets",
+ "https://www.googleapis.com/auth/userinfo.email"
+ ],
+ "flatPath": "v1/scripts/{scriptId}:run",
+ "path": "v1/scripts/{scriptId}:run",
+ "id": "script.scripts.run",
+ "request": {
+ "$ref": "ExecutionRequest"
+ },
+ "description": "Runs a function in an Apps Script project. The project must be deployed\nfor use with the Apps Script API.\n\nThis method requires authorization with an OAuth 2.0 token that includes at\nleast one of the scopes listed in the [Authorization](#authorization)\nsection; script projects that do not require authorization cannot be\nexecuted through this API. To find the correct scopes to include in the\nauthentication token, open the project in the script editor, then select\n**File \u003e Project properties** and click the **Scopes** tab.",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "scriptId"
+ ],
+ "httpMethod": "POST"
+ }
+ }
+ }
+ },
+ "parameters": {
+ "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": {
+ "type": "string",
+ "location": "query",
+ "description": "JSONP"
+ },
+ "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": {
+ "location": "query",
+ "description": "OAuth access token.",
+ "type": "string"
+ },
+ "quotaUser": {
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "type": "string",
+ "location": "query"
+ },
+ "pp": {
+ "location": "query",
+ "description": "Pretty-print response.",
+ "type": "boolean",
+ "default": "true"
+ },
+ "oauth_token": {
+ "location": "query",
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string"
+ },
+ "bearer_token": {
+ "location": "query",
+ "description": "OAuth bearer token.",
+ "type": "string"
+ }
+ },
+ "schemas": {
+ "ScriptStackTraceElement": {
+ "description": "A stack trace through the script that shows where the execution failed.",
+ "type": "object",
+ "properties": {
+ "lineNumber": {
+ "description": "The line number where the script failed.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "function": {
+ "description": "The name of the function that failed.",
+ "type": "string"
+ }
+ },
+ "id": "ScriptStackTraceElement"
+ },
+ "ExecutionError": {
+ "type": "object",
+ "properties": {
+ "errorType": {
+ "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"
+ }
+ }
+ },
+ "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."
+ },
+ "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": {
+ "code": {
+ "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": {
+ "type": "string",
+ "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."
+ },
+ "details": {
+ "description": "An array that contains a single ExecutionError object that provides information about the nature of the error.",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "any",
+ "description": "Properties of the object. Contains field @type with type URL."
+ }
+ }
+ }
+ },
+ "id": "Status"
+ },
+ "ExecutionRequest": {
+ "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.",
+ "type": "object",
+ "properties": {
+ "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"
+ }
+ },
+ "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"
+ },
+ "function": {
+ "type": "string",
+ "description": "The name of the function to execute in the given script. The name does not\ninclude parentheses or parameters."
+ },
+ "devMode": {
+ "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"
+ }
+ }
+ },
+ "ExecutionResponse": {
+ "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"
+ },
+ "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": {
+ "$ref": "Status",
+ "description": "If a `run` call succeeds but the script function (or Apps Script itself) throws an exception, this field contains a Status object. The `Status` object's `details` field contains an array with a single ExecutionError object that provides information about the nature of the error."
+ },
+ "done": {
+ "type": "boolean",
+ "description": "This field indicates whether the script execution has completed. A completed execution has a populated `response` field containing the ExecutionResponse from function that was executed."
+ },
+ "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"
+ }
+ }
+ },
+ "id": "Operation"
+ }
+ },
+ "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://script.googleapis.com/",
"auth": {
"oauth2": {
"scopes": {
- "https://www.googleapis.com/auth/forms": {
- "description": "View and manage your forms in Google Drive"
- },
- "https://www.google.com/m8/feeds": {
- "description": "Manage your contacts"
- },
"https://www.googleapis.com/auth/userinfo.email": {
"description": "View your email address"
},
@@ -31,11 +290,17 @@
"https://www.googleapis.com/auth/admin.directory.group": {
"description": "View and manage the provisioning of groups on your domain"
},
+ "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/spreadsheets": {
- "description": "View and manage your spreadsheets in Google Drive"
+ "https://www.googleapis.com/auth/forms": {
+ "description": "View and manage your forms in Google Drive"
+ },
+ "https://www.google.com/m8/feeds": {
+ "description": "Manage your contacts"
}
}
}
@@ -48,274 +313,9 @@
"ownerDomain": "google.com",
"name": "script",
"batchPath": "batch",
- "documentationLink": "https://developers.google.com/apps-script/execution/rest/v1/scripts/run",
"id": "script:v1",
- "revision": "20171221",
+ "documentationLink": "https://developers.google.com/apps-script/execution/rest/v1/scripts/run",
+ "revision": "20171229",
"fullyEncodeReservedExpansion": true,
- "title": "Google Apps Script API",
- "ownerName": "Google",
- "discoveryVersion": "v1",
- "resources": {
- "scripts": {
- "methods": {
- "run": {
- "path": "v1/scripts/{scriptId}:run",
- "id": "script.scripts.run",
- "description": "Runs a function in an Apps Script project. The project must be deployed\nfor use with the Apps Script API.\n\nThis method requires authorization with an OAuth 2.0 token that includes at\nleast one of the scopes listed in the [Authorization](#authorization)\nsection; script projects that do not require authorization cannot be\nexecuted through this API. To find the correct scopes to include in the\nauthentication token, open the project in the script editor, then select\n**File \u003e Project properties** and click the **Scopes** tab.",
- "request": {
- "$ref": "ExecutionRequest"
- },
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "scriptId"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://mail.google.com/",
- "https://www.google.com/calendar/feeds",
- "https://www.google.com/m8/feeds",
- "https://www.googleapis.com/auth/admin.directory.group",
- "https://www.googleapis.com/auth/admin.directory.user",
- "https://www.googleapis.com/auth/drive",
- "https://www.googleapis.com/auth/forms",
- "https://www.googleapis.com/auth/forms.currentonly",
- "https://www.googleapis.com/auth/groups",
- "https://www.googleapis.com/auth/spreadsheets",
- "https://www.googleapis.com/auth/userinfo.email"
- ],
- "parameters": {
- "scriptId": {
- "description": "The script ID of the script to be executed. To find the script ID, open\nthe project in the script editor and select **File \u003e Project properties**.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "flatPath": "v1/scripts/{scriptId}:run"
- }
- }
- }
- },
- "parameters": {
- "quotaUser": {
- "location": "query",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string"
- },
- "pp": {
- "description": "Pretty-print response.",
- "type": "boolean",
- "default": "true",
- "location": "query"
- },
- "bearer_token": {
- "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"
- },
- "fields": {
- "location": "query",
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string"
- },
- "uploadType": {
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string",
- "location": "query"
- },
- "callback": {
- "location": "query",
- "description": "JSONP",
- "type": "string"
- },
- "$.xgafv": {
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query",
- "enum": [
- "1",
- "2"
- ],
- "description": "V1 error format.",
- "type": "string"
- },
- "alt": {
- "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"
- }
- },
- "schemas": {
- "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",
- "items": {
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- },
- "type": "object"
- }
- },
- "code": {
- "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"
- }
- },
- "id": "Status"
- },
- "ExecutionRequest": {
- "properties": {
- "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"
- },
- "function": {
- "description": "The name of the function to execute in the given script. The name does not\ninclude parentheses or parameters.",
- "type": "string"
- },
- "devMode": {
- "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"
- }
- }
- },
- "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.",
- "type": "object"
- },
- "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"
- },
- "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": {
- "done": {
- "description": "This field indicates whether the script execution has completed. A completed execution has a populated `response` field containing the ExecutionResponse from function that was executed.",
- "type": "boolean"
- },
- "response": {
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- },
- "description": "If the script function returns successfully, this field contains an ExecutionResponse object with the function's return value.",
- "type": "object"
- },
- "error": {
- "$ref": "Status",
- "description": "If a `run` call succeeds but the script function (or Apps Script itself) throws an exception, this field contains a Status object. The `Status` object's `details` field contains an array with a single ExecutionError object that provides information about the nature of the error."
- }
- },
- "id": "Operation"
- },
- "ScriptStackTraceElement": {
- "description": "A stack trace through the script that shows where the execution failed.",
- "type": "object",
- "properties": {
- "function": {
- "description": "The name of the function that failed.",
- "type": "string"
- },
- "lineNumber": {
- "description": "The line number where the script failed.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "ScriptStackTraceElement"
- },
- "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": {
- "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"
- }
- }
- },
- "id": "ExecutionError"
- }
- },
- "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"
+ "title": "Google Apps Script API"
}
diff --git a/searchconsole/v1/searchconsole-api.json b/searchconsole/v1/searchconsole-api.json
index 84af32d..c3a591e 100644
--- a/searchconsole/v1/searchconsole-api.json
+++ b/searchconsole/v1/searchconsole-api.json
@@ -1,9 +1,10 @@
{
+ "version": "v1",
"baseUrl": "https://searchconsole.googleapis.com/",
"canonicalName": "Search Console",
- "kind": "discovery#restDescription",
- "description": "Provides tools for running validation tests against single URLs",
"servicePath": "",
+ "description": "Provides tools for running validation tests against single URLs",
+ "kind": "discovery#restDescription",
"rootUrl": "https://searchconsole.googleapis.com/",
"basePath": "",
"ownerDomain": "google.com",
@@ -22,19 +23,19 @@
"mobileFriendlyTest": {
"methods": {
"run": {
- "response": {
- "$ref": "RunMobileFriendlyTestResponse"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "parameters": {},
- "flatPath": "v1/urlTestingTools/mobileFriendlyTest:run",
- "path": "v1/urlTestingTools/mobileFriendlyTest:run",
"id": "searchconsole.urlTestingTools.mobileFriendlyTest.run",
+ "path": "v1/urlTestingTools/mobileFriendlyTest:run",
"request": {
"$ref": "RunMobileFriendlyTestRequest"
},
- "description": "Runs Mobile-Friendly Test for a given URL."
+ "description": "Runs Mobile-Friendly Test for a given URL.",
+ "httpMethod": "POST",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "RunMobileFriendlyTestResponse"
+ },
+ "parameters": {},
+ "flatPath": "v1/urlTestingTools/mobileFriendlyTest:run"
}
}
}
@@ -42,48 +43,7 @@
}
},
"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"
- },
- "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",
@@ -95,17 +55,19 @@
"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"
+ "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"
+ "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.",
@@ -127,42 +89,56 @@
"description": "OAuth 2.0 token for the current user.",
"type": "string",
"location": "query"
+ },
+ "upload_protocol": {
+ "location": "query",
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "type": "string"
+ },
+ "prettyPrint": {
+ "description": "Returns response with indentations and line breaks.",
+ "type": "boolean",
+ "default": "true",
+ "location": "query"
+ },
+ "uploadType": {
+ "location": "query",
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string"
+ },
+ "fields": {
+ "location": "query",
+ "description": "Selector specifying which fields to include in a partial response.",
+ "type": "string"
+ },
+ "callback": {
+ "description": "JSONP",
+ "type": "string",
+ "location": "query"
+ },
+ "$.xgafv": {
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query",
+ "enum": [
+ "1",
+ "2"
+ ],
+ "description": "V1 error format.",
+ "type": "string"
}
},
"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).",
- "Viewsport is not specified using the meta viewport tag. [Learn more]\n(https://support.google.com/webmasters/answer/6352293#viewport_not_configured).",
- "Viewport defined to a fixed width. [Learn more]\n(https://support.google.com/webmasters/answer/6352293#fixed-width_viewport).",
- "Content not sized to viewport. [Learn more]\n(https://support.google.com/webmasters/answer/6352293#content_not_sized_to_viewport).",
- "Font size is too small for easy reading on a small screen. [Learn More]\n(https://support.google.com/webmasters/answer/6352293#small_font_size).",
- "Touch elements are too close to each other. [Learn more]\n(https://support.google.com/webmasters/answer/6352293#touch_elements_too_close)."
- ],
- "enum": [
- "MOBILE_FRIENDLY_RULE_UNSPECIFIED",
- "USES_INCOMPATIBLE_PLUGINS",
- "CONFIGURE_VIEWPORT",
- "FIXED_WIDTH_VIEWPORT",
- "SIZE_CONTENT_TO_VIEWPORT",
- "USE_LEGIBLE_FONT_SIZES",
- "TAP_TARGETS_TOO_CLOSE"
- ]
- }
- },
- "id": "MobileFriendlyIssue"
- },
"RunMobileFriendlyTestResponse": {
"description": "Mobile-friendly test response, including mobile-friendly issues and resource\nissues.",
"type": "object",
"properties": {
+ "screenshot": {
+ "description": "Screenshot of the requested URL.",
+ "$ref": "Image"
+ },
"testStatus": {
"$ref": "TestStatus",
"description": "Final state of the test, can be either complete or an error."
@@ -175,18 +151,18 @@
}
},
"mobileFriendliness": {
- "enumDescriptions": [
- "Internal error when running this test. Please try running the test again.",
- "The page is mobile friendly.",
- "The page is not mobile friendly."
- ],
"enum": [
"MOBILE_FRIENDLY_TEST_RESULT_UNSPECIFIED",
"MOBILE_FRIENDLY",
"NOT_MOBILE_FRIENDLY"
],
"description": "Test verdict, whether the page is mobile friendly or not.",
- "type": "string"
+ "type": "string",
+ "enumDescriptions": [
+ "Internal error when running this test. Please try running the test again.",
+ "The page is mobile friendly.",
+ "The page is not mobile friendly."
+ ]
},
"mobileFriendlyIssues": {
"description": "List of mobile-usability issues.",
@@ -194,10 +170,6 @@
"items": {
"$ref": "MobileFriendlyIssue"
}
- },
- "screenshot": {
- "$ref": "Image",
- "description": "Screenshot of the requested URL."
}
},
"id": "RunMobileFriendlyTestResponse"
@@ -207,30 +179,30 @@
"type": "object",
"properties": {
"blockedResource": {
- "$ref": "BlockedResource",
- "description": "Describes a blocked resource issue."
+ "description": "Describes a blocked resource issue.",
+ "$ref": "BlockedResource"
}
},
"id": "ResourceIssue"
},
"BlockedResource": {
- "description": "Blocked resource.",
- "type": "object",
"properties": {
"url": {
"description": "URL of the blocked resource.",
"type": "string"
}
},
- "id": "BlockedResource"
+ "id": "BlockedResource",
+ "description": "Blocked resource.",
+ "type": "object"
},
"TestStatus": {
- "description": "Final state of the test, including error details if necessary.",
- "type": "object",
"properties": {
+ "details": {
+ "description": "Error details if applicable.",
+ "type": "string"
+ },
"status": {
- "description": "Status of the test.",
- "type": "string",
"enumDescriptions": [
"Internal error when running this test. Please try running the test again.",
"Inspection has completed without errors.",
@@ -242,18 +214,16 @@
"COMPLETE",
"INTERNAL_ERROR",
"PAGE_UNREACHABLE"
- ]
- },
- "details": {
- "description": "Error details if applicable.",
+ ],
+ "description": "Status of the test.",
"type": "string"
}
},
- "id": "TestStatus"
+ "id": "TestStatus",
+ "description": "Final state of the test, including error details if necessary.",
+ "type": "object"
},
"RunMobileFriendlyTestRequest": {
- "description": "Mobile-friendly test request.",
- "type": "object",
"properties": {
"url": {
"description": "URL for inspection.",
@@ -264,29 +234,59 @@
"type": "boolean"
}
},
- "id": "RunMobileFriendlyTestRequest"
+ "id": "RunMobileFriendlyTestRequest",
+ "description": "Mobile-friendly test request.",
+ "type": "object"
},
"Image": {
- "description": "Describe image data.",
- "type": "object",
"properties": {
- "mimeType": {
- "description": "The mime-type of the image data.",
- "type": "string"
- },
"data": {
"description": "Image data in format determined by the mime type. Currently, the format\nwill always be \"image/png\", but this might change in the future.",
"format": "byte",
"type": "string"
+ },
+ "mimeType": {
+ "description": "The mime-type of the image data.",
+ "type": "string"
}
},
- "id": "Image"
+ "id": "Image",
+ "description": "Describe image data.",
+ "type": "object"
+ },
+ "MobileFriendlyIssue": {
+ "properties": {
+ "rule": {
+ "enum": [
+ "MOBILE_FRIENDLY_RULE_UNSPECIFIED",
+ "USES_INCOMPATIBLE_PLUGINS",
+ "CONFIGURE_VIEWPORT",
+ "FIXED_WIDTH_VIEWPORT",
+ "SIZE_CONTENT_TO_VIEWPORT",
+ "USE_LEGIBLE_FONT_SIZES",
+ "TAP_TARGETS_TOO_CLOSE"
+ ],
+ "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).",
+ "Viewsport is not specified using the meta viewport tag. [Learn more]\n(https://support.google.com/webmasters/answer/6352293#viewport_not_configured).",
+ "Viewport defined to a fixed width. [Learn more]\n(https://support.google.com/webmasters/answer/6352293#fixed-width_viewport).",
+ "Content not sized to viewport. [Learn more]\n(https://support.google.com/webmasters/answer/6352293#content_not_sized_to_viewport).",
+ "Font size is too small for easy reading on a small screen. [Learn More]\n(https://support.google.com/webmasters/answer/6352293#small_font_size).",
+ "Touch elements are too close to each other. [Learn more]\n(https://support.google.com/webmasters/answer/6352293#touch_elements_too_close)."
+ ]
+ }
+ },
+ "id": "MobileFriendlyIssue",
+ "description": "Mobile-friendly issue.",
+ "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",
- "version": "v1"
+ "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/serviceconsumermanagement/v1/serviceconsumermanagement-api.json b/serviceconsumermanagement/v1/serviceconsumermanagement-api.json
index b109891..6130931 100644
--- a/serviceconsumermanagement/v1/serviceconsumermanagement-api.json
+++ b/serviceconsumermanagement/v1/serviceconsumermanagement-api.json
@@ -1,11 +1,538 @@
{
+ "ownerName": "Google",
+ "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",
+ "https://www.googleapis.com/auth/service.management"
+ ],
+ "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": "serviceconsumermanagement.operations.cancel"
+ },
+ "delete": {
+ "description": "Deletes a long-running operation. This method indicates that the client is\nno longer interested in the operation result. It does not cancel the\noperation. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`.",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "DELETE",
+ "parameters": {
+ "name": {
+ "location": "path",
+ "description": "The name of the operation resource to be deleted.",
+ "required": true,
+ "type": "string",
+ "pattern": "^operations/.+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/service.management"
+ ],
+ "flatPath": "v1/operations/{operationsId}",
+ "path": "v1/{+name}",
+ "id": "serviceconsumermanagement.operations.delete"
+ },
+ "list": {
+ "response": {
+ "$ref": "ListOperationsResponse"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "pageSize": {
+ "description": "The standard list page size.",
+ "format": "int32",
+ "type": "integer",
+ "location": "query"
+ },
+ "filter": {
+ "description": "The standard list filter.",
+ "type": "string",
+ "location": "query"
+ },
+ "name": {
+ "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"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/service.management"
+ ],
+ "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."
+ },
+ "get": {
+ "description": "Gets the latest state of a long-running operation. Clients can use this\nmethod to poll the operation result at intervals as recommended by the API\nservice.",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "name": {
+ "description": "The name of the operation resource.",
+ "required": true,
+ "type": "string",
+ "pattern": "^operations/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/service.management"
+ ],
+ "flatPath": "v1/operations/{operationsId}",
+ "path": "v1/{+name}",
+ "id": "serviceconsumermanagement.operations.get"
+ }
+ }
+ },
+ "services": {
+ "methods": {
+ "search": {
+ "description": "Search tenancy units for a service.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "parent"
+ ],
+ "response": {
+ "$ref": "SearchTenancyUnitsResponse"
+ },
+ "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.\n\nOptional.",
+ "type": "string"
+ },
+ "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": {
+ "description": "Service for which search is performed.\nservices/{service}\n{service} the name of a service, for example 'service.googleapis.com'.",
+ "required": true,
+ "type": "string",
+ "pattern": "^services/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/services/{servicesId}:search",
+ "id": "serviceconsumermanagement.services.search",
+ "path": "v1/{+parent}:search"
+ }
+ },
+ "resources": {
+ "tenancyUnits": {
+ "methods": {
+ "list": {
+ "description": "Find tenancy unit for a service and consumer.\nThis method should not be used in producers' runtime path, e.g. finding\nthe tenant project number when creating VMs. Producers should persist\nthe tenant project information after the project is created.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "parent"
+ ],
+ "response": {
+ "$ref": "ListTenancyUnitsResponse"
+ },
+ "parameters": {
+ "filter": {
+ "description": "Filter expression over tenancy resources field. Optional.",
+ "type": "string",
+ "location": "query"
+ },
+ "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 returned by this request.",
+ "format": "int32",
+ "type": "integer",
+ "location": "query"
+ },
+ "parent": {
+ "location": "path",
+ "description": "Service and consumer. Required.\nservices/{service}/{collection id}/{resource id}\n{collection id} is the cloud resource collection type representing the\nservice consumer, for example 'projects', or 'organizations'.\n{resource id} is the consumer numeric id, such as project number: '123456'.\n{service} the name of a service, for example 'service.googleapis.com'.",
+ "required": true,
+ "type": "string",
+ "pattern": "^services/[^/]+/[^/]+/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/services/{servicesId}/{servicesId1}/{servicesId2}/tenancyUnits",
+ "id": "serviceconsumermanagement.services.tenancyUnits.list",
+ "path": "v1/{+parent}/tenancyUnits"
+ },
+ "create": {
+ "response": {
+ "$ref": "TenancyUnit"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "parent": {
+ "description": "services/{service}/{collection id}/{resource id}\n{collection id} is the cloud resource collection type representing the\nservice consumer, for example 'projects', or 'organizations'.\n{resource id} is the consumer numeric id, such as project number: '123456'.\n{service} the name of a service, for example 'service.googleapis.com'.\nEnabled service binding using the new tenancy unit.",
+ "required": true,
+ "type": "string",
+ "pattern": "^services/[^/]+/[^/]+/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "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."
+ },
+ "removeProject": {
+ "flatPath": "v1/services/{servicesId}/{servicesId1}/{servicesId2}/tenancyUnits/{tenancyUnitsId}:removeProject",
+ "path": "v1/{+name}:removeProject",
+ "id": "serviceconsumermanagement.services.tenancyUnits.removeProject",
+ "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": "RemoveTenantProjectRequest"
+ },
+ "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/[^/]+$"
+ }
+ }
+ },
+ "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"
+ },
+ "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"
+ ]
+ },
+ "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"
+ }
+ }
+ }
+ }
+ }
+ },
+ "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": {
+ "location": "query",
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string"
+ },
+ "bearer_token": {
+ "location": "query",
+ "description": "OAuth bearer token.",
+ "type": "string"
+ },
+ "upload_protocol": {
+ "location": "query",
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "type": "string"
+ },
+ "prettyPrint": {
+ "description": "Returns response with indentations and line breaks.",
+ "type": "boolean",
+ "default": "true",
+ "location": "query"
+ },
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
+ "type": "string",
+ "location": "query"
+ },
+ "uploadType": {
+ "location": "query",
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string"
+ },
+ "$.xgafv": {
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query",
+ "enum": [
+ "1",
+ "2"
+ ],
+ "description": "V1 error format.",
+ "type": "string"
+ },
+ "callback": {
+ "location": "query",
+ "description": "JSONP",
+ "type": "string"
+ },
+ "alt": {
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query",
+ "description": "Data format for response.",
+ "default": "json",
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
+ "type": "string"
+ }
+ },
+ "version": "v1",
+ "baseUrl": "https://serviceconsumermanagement.googleapis.com/",
+ "kind": "discovery#restDescription",
+ "description": "Provides management methods for configuring service producer resources on Google Cloud.",
+ "servicePath": "",
"basePath": "",
- "revision": "20171221",
- "documentationLink": "https://cloud.google.com/service-consumer-management/docs/overview",
+ "revision": "20180103",
"id": "serviceconsumermanagement:v1",
+ "documentationLink": "https://cloud.google.com/service-consumer-management/docs/overview",
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
+ "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"
+ },
+ "BillingConfig": {
+ "description": "Describes billing configuration for new a Tenant Project",
+ "type": "object",
+ "properties": {
+ "billingAccount": {
+ "description": "Name of the billing account.\nFor example `billingAccounts/012345-567890-ABCDEF`.",
+ "type": "string"
+ }
+ },
+ "id": "BillingConfig"
+ },
+ "RemoveTenantProjectRequest": {
+ "description": "Request message to remove tenant project resource from the tenancy unit.",
+ "type": "object",
+ "properties": {
+ "tag": {
+ "description": "Tag of the resource within the tenancy unit.",
+ "type": "string"
+ }
+ },
+ "id": "RemoveTenantProjectRequest"
+ },
+ "TenantResource": {
+ "description": "Resource constituting the TenancyUnit.",
+ "type": "object",
+ "properties": {
+ "tag": {
+ "description": "Unique per single tenancy unit.",
+ "type": "string"
+ },
+ "resource": {
+ "description": "@OutputOnly Identifier of the tenant resource.\nFor cloud projects it is in the form 'projects/{number}'.\nFor example 'projects/123456'.",
+ "type": "string"
+ },
+ "status": {
+ "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"
+ ],
+ "description": "Status of tenant resource.",
+ "type": "string"
+ }
+ },
+ "id": "TenantResource"
+ },
+ "VisibilityRule": {
+ "description": "A visibility rule provides visibility configuration for an individual API\nelement.",
+ "type": "object",
+ "properties": {
+ "restriction": {
+ "description": "A comma-separated list of visibility labels that apply to the `selector`.\nAny of the listed labels can be used to grant the visibility.\n\nIf a rule has multiple labels, removing one of the labels but not all of\nthem can break clients.\n\nExample:\n\n visibility:\n rules:\n - selector: google.calendar.Calendar.EnhancedSearch\n restriction: GOOGLE_INTERNAL, TRUSTED_TESTER\n\nRemoving GOOGLE_INTERNAL from this restriction will break clients that\nrely on this method and only had access to it through GOOGLE_INTERNAL.",
+ "type": "string"
+ },
+ "selector": {
+ "description": "Selects methods, messages, fields, enums, etc. to which this rule applies.\n\nRefer to selector for syntax details.",
+ "type": "string"
+ }
+ },
+ "id": "VisibilityRule"
+ },
"HttpRule": {
"description": "`HttpRule` defines the mapping of an RPC method to one or more HTTP\nREST API methods. The mapping specifies how different portions of the RPC\nrequest message are mapped to URL path, URL query parameters, and\nHTTP request body. The mapping is typically specified as an\n`google.api.http` annotation on the RPC method,\nsee \"google/api/annotations.proto\" for details.\n\nThe mapping consists of a field specifying the path template and\nmethod kind. The path template can refer to fields in the request\nmessage, as in the example below which describes a REST GET\noperation on a resource collection of messages:\n\n\n service Messaging {\n rpc GetMessage(GetMessageRequest) returns (Message) {\n option (google.api.http).get = \"/v1/messages/{message_id}/{sub.subfield}\";\n }\n }\n message GetMessageRequest {\n message SubMessage {\n string subfield = 1;\n }\n string message_id = 1; // mapped to the URL\n SubMessage sub = 2; // `sub.subfield` is url-mapped\n }\n message Message {\n string text = 1; // content of the resource\n }\n\nThe same http annotation can alternatively be expressed inside the\n`GRPC API Configuration` YAML file.\n\n http:\n rules:\n - selector: \u003cproto_package_name\u003e.Messaging.GetMessage\n get: /v1/messages/{message_id}/{sub.subfield}\n\nThis definition enables an automatic, bidrectional mapping of HTTP\nJSON to RPC. Example:\n\nHTTP | RPC\n-----|-----\n`GET /v1/messages/123456/foo` | `GetMessage(message_id: \"123456\" sub: SubMessage(subfield: \"foo\"))`\n\nIn general, not only fields but also field paths can be referenced\nfrom a path pattern. Fields mapped to the path pattern cannot be\nrepeated and must have a primitive (non-message) type.\n\nAny fields in the request message which are not bound by the path\npattern automatically become (optional) HTTP query\nparameters. Assume the following definition of the request message:\n\n\n service Messaging {\n rpc GetMessage(GetMessageRequest) returns (Message) {\n option (google.api.http).get = \"/v1/messages/{message_id}\";\n }\n }\n message GetMessageRequest {\n message SubMessage {\n string subfield = 1;\n }\n string message_id = 1; // mapped to the URL\n int64 revision = 2; // becomes a parameter\n SubMessage sub = 3; // `sub.subfield` becomes a parameter\n }\n\n\nThis enables a HTTP JSON to RPC mapping as below:\n\nHTTP | RPC\n-----|-----\n`GET /v1/messages/123456?revision=2&sub.subfield=foo` | `GetMessage(message_id: \"123456\" revision: 2 sub: SubMessage(subfield: \"foo\"))`\n\nNote that fields which are mapped to HTTP parameters must have a\nprimitive type or a repeated primitive type. Message types are not\nallowed. In the case of a repeated type, the parameter can be\nrepeated in the URL, as in `...?param=A¶m=B`.\n\nFor HTTP method kinds which allow a request body, the `body` field\nspecifies the mapping. Consider a REST update method on the\nmessage resource collection:\n\n\n service Messaging {\n rpc UpdateMessage(UpdateMessageRequest) returns (Message) {\n option (google.api.http) = {\n put: \"/v1/messages/{message_id}\"\n body: \"message\"\n };\n }\n }\n message UpdateMessageRequest {\n string message_id = 1; // mapped to the URL\n Message message = 2; // mapped to the body\n }\n\n\nThe following HTTP JSON to RPC mapping is enabled, where the\nrepresentation of the JSON in the request body is determined by\nprotos JSON encoding:\n\nHTTP | RPC\n-----|-----\n`PUT /v1/messages/123456 { \"text\": \"Hi!\" }` | `UpdateMessage(message_id: \"123456\" message { text: \"Hi!\" })`\n\nThe special name `*` can be used in the body mapping to define that\nevery field not bound by the path template should be mapped to the\nrequest body. This enables the following alternative definition of\nthe update method:\n\n service Messaging {\n rpc UpdateMessage(Message) returns (Message) {\n option (google.api.http) = {\n put: \"/v1/messages/{message_id}\"\n body: \"*\"\n };\n }\n }\n message Message {\n string message_id = 1;\n string text = 2;\n }\n\n\nThe following HTTP JSON to RPC mapping is enabled:\n\nHTTP | RPC\n-----|-----\n`PUT /v1/messages/123456 { \"text\": \"Hi!\" }` | `UpdateMessage(message_id: \"123456\" text: \"Hi!\")`\n\nNote that when using `*` in the body mapping, it is not possible to\nhave HTTP parameters, as all fields not bound by the path end in\nthe body. This makes this option more rarely used in practice of\ndefining REST APIs. The common usage of `*` is in custom methods\nwhich don't use the URL at all for transferring data.\n\nIt is possible to define multiple HTTP methods for one RPC by using\nthe `additional_bindings` option. Example:\n\n service Messaging {\n rpc GetMessage(GetMessageRequest) returns (Message) {\n option (google.api.http) = {\n get: \"/v1/messages/{message_id}\"\n additional_bindings {\n get: \"/v1/users/{user_id}/messages/{message_id}\"\n }\n };\n }\n }\n message GetMessageRequest {\n string message_id = 1;\n string user_id = 2;\n }\n\n\nThis enables the following two alternative HTTP JSON to RPC\nmappings:\n\nHTTP | RPC\n-----|-----\n`GET /v1/messages/123456` | `GetMessage(message_id: \"123456\")`\n`GET /v1/users/me/messages/123456` | `GetMessage(user_id: \"me\" message_id: \"123456\")`\n\n# Rules for HTTP mapping\n\nThe rules for mapping HTTP path, query parameters, and body fields\nto the request message are as follows:\n\n1. The `body` field specifies either `*` or a field path, or is\n omitted. If omitted, it indicates there is no HTTP request body.\n2. Leaf fields (recursive expansion of nested messages in the\n request) can be classified into three types:\n (a) Matched in the URL template.\n (b) Covered by body (if body is `*`, everything except (a) fields;\n else everything under the body field)\n (c) All other fields.\n3. URL query parameters found in the HTTP request are mapped to (c) fields.\n4. Any body sent with an HTTP request can contain only (b) fields.\n\nThe syntax of the path template is as follows:\n\n Template = \"/\" Segments [ Verb ] ;\n Segments = Segment { \"/\" Segment } ;\n Segment = \"*\" | \"**\" | LITERAL | Variable ;\n Variable = \"{\" FieldPath [ \"=\" Segments ] \"}\" ;\n FieldPath = IDENT { \".\" IDENT } ;\n Verb = \":\" LITERAL ;\n\nThe syntax `*` matches a single path segment. The syntax `**` matches zero\nor more path segments, which must be the last part of the path except the\n`Verb`. The syntax `LITERAL` matches literal text in the path.\n\nThe syntax `Variable` matches part of the URL path as specified by its\ntemplate. A variable template must not contain other variables. If a variable\nmatches a single path segment, its template may be omitted, e.g. `{var}`\nis equivalent to `{var=*}`.\n\nIf a variable contains exactly one path segment, such as `\"{var}\"` or\n`\"{var=*}\"`, when such a variable is expanded into a URL path, all characters\nexcept `[-_.~0-9a-zA-Z]` are percent-encoded. Such variables show up in the\nDiscovery Document as `{var}`.\n\nIf a variable contains one or more path segments, such as `\"{var=foo/*}\"`\nor `\"{var=**}\"`, when such a variable is expanded into a URL path, all\ncharacters except `[-_.~/0-9a-zA-Z]` are percent-encoded. Such variables\nshow up in the Discovery Document as `{+var}`.\n\nNOTE: While the single segment variable matches the semantics of\n[RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2\nSimple String Expansion, the multi segment variable **does not** match\nRFC 6570 Reserved Expansion. The reason is that the Reserved Expansion\ndoes not expand special characters like `?` and `#`, which would lead\nto invalid URLs.\n\nNOTE: the field paths in variables and in the `body` must not refer to\nrepeated fields or map fields.",
"type": "object",
@@ -27,23 +554,23 @@
"type": "string"
},
"patch": {
- "type": "string",
- "description": "Used for updating a resource."
+ "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"
- },
- "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."
+ }
},
"put": {
- "type": "string",
- "description": "Used for updating a resource."
+ "description": "Used for updating a resource.",
+ "type": "string"
},
"delete": {
- "type": "string",
- "description": "Used for deleting a resource."
+ "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.",
@@ -58,15 +585,15 @@
"type": "string"
},
"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."
+ "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"
- },
- "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.",
@@ -79,43 +606,37 @@
},
"id": "HttpRule"
},
- "VisibilityRule": {
- "description": "A visibility rule provides visibility configuration for an individual API\nelement.",
- "type": "object",
- "properties": {
- "restriction": {
- "type": "string",
- "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."
- },
- "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": {
- "monitoredResource": {
- "type": "string",
- "description": "The monitored resource type. The type must be defined in\nService.monitored_resources section."
- },
"metrics": {
"description": "Names of the metrics to report to this monitoring destination.\nEach name must be defined in Service.metrics section.",
"type": "array",
"items": {
"type": "string"
}
+ },
+ "monitoredResource": {
+ "description": "The monitored resource type. The type must be defined in\nService.monitored_resources section.",
+ "type": "string"
}
},
- "id": "MonitoringDestination",
- "description": "Configuration of a specific monitoring destination (the producer project\nor the consumer project)."
+ "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"
@@ -130,15 +651,6 @@
"items": {
"$ref": "TenantResource"
}
- },
- "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"
}
},
"id": "TenancyUnit"
@@ -148,11 +660,11 @@
"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"
- },
- "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"
@@ -183,53 +695,17 @@
}
},
"metricRules": {
+ "description": "List of `MetricRule` definitions, each one mapping a selected method to one\nor more metrics.",
"type": "array",
"items": {
"$ref": "MetricRule"
- },
- "description": "List of `MetricRule` definitions, each one mapping a selected method to one\nor more metrics."
+ }
}
},
"id": "Quota"
},
- "TenantProjectConfig": {
- "type": "object",
- "properties": {
- "serviceAccountConfig": {
- "$ref": "ServiceAccountConfig",
- "description": "Configuration for IAM service account on tenant project."
- },
- "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": {
- "$ref": "TenantProjectPolicy",
- "description": "Describes ownership and policies for the new tenant project. Required."
- },
- "folder": {
- "type": "string",
- "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`)."
- },
- "labels": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "Labels that will be applied to this project.",
- "type": "object"
- }
- },
- "id": "TenantProjectConfig",
- "description": "This structure defines a tenant project to be added to the specified tenancy\nunit and its initial configuration and properties. A project lien will be\ncreated for the tenant project to prevent the tenant project from being\ndeleted accidentally. The lien will be deleted as part of tenant project\nremoval."
- },
"PolicyBinding": {
+ "description": "Translates to IAM Policy bindings (without auditing at this level)",
"type": "object",
"properties": {
"members": {
@@ -244,8 +720,44 @@
"type": "string"
}
},
- "id": "PolicyBinding",
- "description": "Translates to IAM Policy bindings (without auditing at this level)"
+ "id": "PolicyBinding"
+ },
+ "TenantProjectConfig": {
+ "description": "This structure defines a tenant project to be added to the specified tenancy\nunit and its initial configuration and properties. A project lien will be\ncreated for the tenant project to prevent the tenant project from being\ndeleted accidentally. The lien will be deleted as part of tenant project\nremoval.",
+ "type": "object",
+ "properties": {
+ "services": {
+ "description": "Google Cloud API names of services that will be activated on this project\nduring provisioning. If any of these services can not be activated,\naddTenantProject method will fail.\nFor example: 'compute.googleapis.com','cloudfunctions.googleapis.com'",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "billingConfig": {
+ "description": "Billing account properties.\nIt may be specified explicitly, or created from the specified group\nduring provisioning",
+ "$ref": "BillingConfig"
+ },
+ "tenantProjectPolicy": {
+ "$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"
},
"LoggingDestination": {
"description": "Configuration of a specific logging destination (the producer project\nor the consumer project).",
@@ -259,59 +771,115 @@
}
},
"monitoredResource": {
- "type": "string",
- "description": "The monitored resource type. The type must be defined in the\nService.monitored_resources section."
+ "description": "The monitored resource type. The type must be defined in the\nService.monitored_resources section.",
+ "type": "string"
}
},
"id": "LoggingDestination"
},
"Option": {
+ "description": "A protocol buffer option, which can be attached to a message, field,\nenumeration, etc.",
"type": "object",
"properties": {
- "name": {
- "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": {
- "additionalProperties": {
- "type": "any",
- "description": "Properties of the object. Contains field @type with type URL."
- },
"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": {
- "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"
+ "type": "object",
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
}
},
+ "name": {
+ "description": "The option's name. For protobuf built-in options (options defined in\ndescriptor.proto), this is the short name. For example, `\"map_entry\"`.\nFor custom options, it should be the fully-qualified name. For example,\n`\"google.api.http\"`.",
+ "type": "string"
+ }
+ },
+ "id": "Option"
+ },
+ "Logging": {
+ "description": "Logging configuration of the service.\n\nThe following example shows how to configure logs to be sent to the\nproducer and consumer projects. In the example, the `activity_history`\nlog is sent to both the producer and consumer projects, whereas the\n`purchase_history` log is only sent to the producer project.\n\n monitored_resources:\n - type: library.googleapis.com/branch\n labels:\n - key: /city\n description: The city where the library branch is located in.\n - key: /name\n description: The name of the branch.\n logs:\n - name: activity_history\n labels:\n - key: /customer_id\n - name: purchase_history\n logging:\n producer_destinations:\n - monitored_resource: library.googleapis.com/branch\n logs:\n - activity_history\n - purchase_history\n consumer_destinations:\n - monitored_resource: library.googleapis.com/branch\n logs:\n - activity_history",
+ "type": "object",
+ "properties": {
"consumerDestinations": {
"description": "Logging configurations for sending logs to the consumer project.\nThere can be multiple consumer destinations, each one must have a\ndifferent monitored resource type. A log can be used in at most\none consumer destination.",
"type": "array",
"items": {
"$ref": "LoggingDestination"
}
+ },
+ "producerDestinations": {
+ "description": "Logging configurations for sending logs to the producer project.\nThere can be multiple producer destinations, each one must have a\ndifferent monitored resource type. A log can be used in at most\none producer destination.",
+ "type": "array",
+ "items": {
+ "$ref": "LoggingDestination"
+ }
}
},
- "id": "Logging",
- "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"
+ "id": "Logging"
},
- "QuotaLimit": {
+ "Method": {
+ "description": "Method represents a method of an API interface.",
"type": "object",
"properties": {
+ "requestTypeUrl": {
+ "description": "A URL of the input message type.",
+ "type": "string"
+ },
+ "requestStreaming": {
+ "description": "If true, the request is streamed.",
+ "type": "boolean"
+ },
+ "syntax": {
+ "enumDescriptions": [
+ "Syntax `proto2`.",
+ "Syntax `proto3`."
+ ],
+ "enum": [
+ "SYNTAX_PROTO2",
+ "SYNTAX_PROTO3"
+ ],
+ "description": "The source syntax of this method.",
+ "type": "string"
+ },
+ "responseTypeUrl": {
+ "description": "The URL of the output message type.",
+ "type": "string"
+ },
+ "options": {
+ "description": "Any metadata attached to the method.",
+ "type": "array",
+ "items": {
+ "$ref": "Option"
+ }
+ },
+ "responseStreaming": {
+ "description": "If true, the response is streamed.",
+ "type": "boolean"
+ },
+ "name": {
+ "description": "The simple name of this method.",
+ "type": "string"
+ }
+ },
+ "id": "Method"
+ },
+ "QuotaLimit": {
+ "description": "`QuotaLimit` defines a specific limit that applies over a specified duration\nfor a limit type. There can be at most one limit for a duration and limit\ntype combination defined within a `QuotaGroup`.",
+ "type": "object",
+ "properties": {
+ "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"
+ "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`).",
@@ -326,101 +894,46 @@
"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"
- },
- "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": {
- "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."
+ "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": {
- "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"
- }
- },
- "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": {
- "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"
- },
- "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."
+ "description": "Name of the quota limit.\n\nThe name must be provided, and it must be unique within the service. The\nname can only include alphanumeric characters as well as '-'.\n\nThe maximum length of the limit name is 64 characters.",
+ "type": "string"
}
},
- "id": "Method"
+ "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",
"properties": {
"root": {
- "type": "string",
- "description": "If non-empty specifies a path under which inherited HTTP paths\nare rooted."
+ "description": "If non-empty specifies a path under which inherited HTTP paths\nare rooted.",
+ "type": "string"
},
"name": {
- "type": "string",
- "description": "The fully qualified name of the interface which is included."
+ "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": {
@@ -438,8 +951,7 @@
}
}
},
- "id": "CustomError",
- "description": "Customize service error responses. For example, list any service\nspecific protobuf types that can appear in error detail lists of\nerror responses.\n\nExample:\n\n custom_error:\n types:\n - google.foo.v1.CustomError\n - google.foo.v1.AnotherError"
+ "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.",
@@ -450,11 +962,11 @@
"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"
@@ -467,17 +979,18 @@
"description": "All files used during config generation.",
"type": "array",
"items": {
- "type": "object",
"additionalProperties": {
- "type": "any",
- "description": "Properties of the object. Contains field @type with type URL."
- }
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "type": "object"
}
}
},
"id": "SourceInfo"
},
"Control": {
+ "description": "Selects and configures the service controller used by the service. The\nservice controller handles features like abuse, quota, billing, logging,\nmonitoring, etc.",
"type": "object",
"properties": {
"environment": {
@@ -485,29 +998,29 @@
"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": "Control"
},
"SystemParameter": {
"description": "Define a parameter's name and location. The parameter may be passed as either\nan HTTP header or a URL query parameter, and if both are passed the behavior\nis implementation-dependent.",
"type": "object",
"properties": {
"httpHeader": {
- "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"
},
"name": {
- "type": "string",
- "description": "Define the name of the parameter, such as \"api_key\" . It is case sensitive."
+ "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"
},
"Field": {
+ "description": "A single field of a message type.",
"type": "object",
"properties": {
"typeUrl": {
@@ -519,12 +1032,7 @@
"format": "int32",
"type": "integer"
},
- "jsonName": {
- "type": "string",
- "description": "The field JSON name."
- },
"kind": {
- "type": "string",
"enumDescriptions": [
"Field type unknown.",
"Field type double.",
@@ -567,22 +1075,26 @@
"TYPE_SINT32",
"TYPE_SINT64"
],
- "description": "The field type."
+ "description": "The field type.",
+ "type": "string"
+ },
+ "jsonName": {
+ "description": "The field JSON name.",
+ "type": "string"
},
"options": {
+ "description": "The protocol buffer options.",
"type": "array",
"items": {
"$ref": "Option"
- },
- "description": "The protocol buffer options."
+ }
},
"oneofIndex": {
- "type": "integer",
"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"
+ "format": "int32",
+ "type": "integer"
},
"cardinality": {
- "type": "string",
"enumDescriptions": [
"For fields with unknown cardinality.",
"For optional fields.",
@@ -595,48 +1107,60 @@
"CARDINALITY_REQUIRED",
"CARDINALITY_REPEATED"
],
- "description": "The field cardinality."
+ "description": "The field cardinality.",
+ "type": "string"
},
"packed": {
"description": "Whether to use alternative packed wire representation.",
"type": "boolean"
},
"defaultValue": {
- "type": "string",
- "description": "The string value of the default value of this field. Proto2 syntax only."
+ "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",
- "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.",
+ "type": "array",
+ "items": {
+ "$ref": "MonitoringDestination"
+ }
+ },
"producerDestinations": {
"description": "Monitoring configurations for sending metrics to the producer project.\nThere can be multiple producer destinations, each one must have a\ndifferent monitored resource type. A metric can be used in at most\none producer destination.",
"type": "array",
"items": {
"$ref": "MonitoringDestination"
}
- },
- "consumerDestinations": {
- "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."
}
},
- "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"
+ "id": "Monitoring"
},
"Enum": {
+ "description": "Enum type definition.",
"type": "object",
"properties": {
+ "name": {
+ "description": "Enum type name.",
+ "type": "string"
+ },
+ "enumvalue": {
+ "description": "Enum value definitions.",
+ "type": "array",
+ "items": {
+ "$ref": "EnumValue"
+ }
+ },
"options": {
"description": "Protocol buffer options.",
"type": "array",
@@ -649,6 +1173,7 @@
"description": "The source context."
},
"syntax": {
+ "description": "The source syntax.",
"type": "string",
"enumDescriptions": [
"Syntax `proto2`.",
@@ -657,49 +1182,36 @@
"enum": [
"SYNTAX_PROTO2",
"SYNTAX_PROTO3"
- ],
- "description": "The source syntax."
- },
- "name": {
- "description": "Enum type name.",
- "type": "string"
- },
- "enumvalue": {
- "description": "Enum value definitions.",
- "type": "array",
- "items": {
- "$ref": "EnumValue"
- }
+ ]
}
},
- "id": "Enum",
- "description": "Enum type definition."
+ "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": {
+ "enumDescriptions": [
+ "A variable-length string. This is the default.",
+ "Boolean; true or false.",
+ "A 64-bit signed integer."
+ ],
"enum": [
"STRING",
"BOOL",
"INT64"
],
"description": "The type of data that can be assigned to the label.",
- "type": "string",
- "enumDescriptions": [
- "A variable-length string. This is the default.",
- "Boolean; true or false.",
- "A 64-bit signed integer."
- ]
- },
- "key": {
- "description": "The label key.",
"type": "string"
- },
- "description": {
- "type": "string",
- "description": "A human-readable description for the label."
}
},
"id": "LabelDescriptor"
@@ -708,12 +1220,35 @@
"description": "A protocol buffer message type.",
"type": "object",
"properties": {
+ "oneofs": {
+ "description": "The list of types appearing in `oneof` definitions in this type.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "sourceContext": {
+ "description": "The source context.",
+ "$ref": "SourceContext"
+ },
+ "syntax": {
+ "description": "The source syntax.",
+ "type": "string",
+ "enumDescriptions": [
+ "Syntax `proto2`.",
+ "Syntax `proto3`."
+ ],
+ "enum": [
+ "SYNTAX_PROTO2",
+ "SYNTAX_PROTO3"
+ ]
+ },
"options": {
+ "description": "The protocol buffer options.",
"type": "array",
"items": {
"$ref": "Option"
- },
- "description": "The protocol buffer options."
+ }
},
"fields": {
"description": "The list of fields.",
@@ -723,80 +1258,58 @@
}
},
"name": {
- "type": "string",
- "description": "The fully qualified message name."
- },
- "oneofs": {
- "description": "The list of types appearing in `oneof` definitions in this type.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "sourceContext": {
- "$ref": "SourceContext",
- "description": "The source context."
- },
- "syntax": {
- "enum": [
- "SYNTAX_PROTO2",
- "SYNTAX_PROTO3"
- ],
- "description": "The source syntax.",
- "type": "string",
- "enumDescriptions": [
- "Syntax `proto2`.",
- "Syntax `proto3`."
- ]
+ "description": "The fully qualified message name.",
+ "type": "string"
}
},
"id": "Type"
},
"Experimental": {
+ "description": "Experimental service configuration. These configuration options can\nonly be used by whitelisted users.",
"type": "object",
"properties": {
"authorization": {
- "$ref": "AuthorizationConfig",
- "description": "Authorization configuration."
+ "description": "Authorization configuration.",
+ "$ref": "AuthorizationConfig"
}
},
- "id": "Experimental",
- "description": "Experimental service configuration. These configuration options can\nonly be used by whitelisted users."
+ "id": "Experimental"
},
"Backend": {
"description": "`Backend` defines the backend configuration for a service.",
"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"
- },
- "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."
+ }
}
},
"id": "Backend"
},
"DocumentationRule": {
+ "description": "A documentation rule provides information about individual API elements.",
"type": "object",
"properties": {
"description": {
- "type": "string",
- "description": "Description of the selected API(s)."
+ "description": "Description of the selected API(s).",
+ "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.",
"type": "string"
}
},
- "id": "DocumentationRule",
- "description": "A documentation rule provides information about individual API elements."
+ "id": "DocumentationRule"
},
"ServiceAccountConfig": {
+ "description": "Describes service account configuration for the tenant project.",
"type": "object",
"properties": {
"tenantProjectRoles": {
@@ -811,10 +1324,10 @@
"type": "string"
}
},
- "id": "ServiceAccountConfig",
- "description": "Describes service account configuration for the tenant project."
+ "id": "ServiceAccountConfig"
},
"AuthorizationConfig": {
+ "description": "Configuration of authorization.\n\nThis section determines the authorization provider, if unspecified, then no\nauthorization check will be done.\n\nExample:\n\n experimental:\n authorization:\n provider: firebaserules.googleapis.com",
"type": "object",
"properties": {
"provider": {
@@ -822,8 +1335,7 @@
"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.",
@@ -850,11 +1362,28 @@
},
"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": {
+ "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"
+ },
"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",
@@ -862,42 +1391,37 @@
"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."
- ]
- },
- "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."
+ "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 '}'."
+ "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"
- },
- "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."
+ }
},
"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\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\""
+ "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.",
@@ -916,54 +1440,24 @@
"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."
+ ]
}
},
"id": "MetricDescriptor"
},
"Billing": {
+ "description": "Billing related configuration of the service.\n\nThe following example shows how to configure monitored resources and metrics\nfor billing:\n\n monitored_resources:\n - type: library.googleapis.com/branch\n labels:\n - key: /city\n description: The city where the library branch is located in.\n - key: /name\n description: The name of the branch.\n metrics:\n - name: library.googleapis.com/book/borrowed_count\n metric_kind: DELTA\n value_type: INT64\n billing:\n consumer_destinations:\n - monitored_resource: library.googleapis.com/branch\n metrics:\n - library.googleapis.com/book/borrowed_count",
"type": "object",
"properties": {
"consumerDestinations": {
+ "description": "Billing configurations for sending metrics to the consumer project.\nThere can be multiple consumer destinations per service, each one must have\na different monitored resource type. A metric can be used in at most\none consumer destination.",
"type": "array",
"items": {
"$ref": "BillingDestination"
- },
- "description": "Billing configurations for sending metrics to the consumer project.\nThere can be multiple consumer destinations per service, each one must have\na different monitored resource type. A metric can be used in at most\none consumer destination."
- }
- },
- "id": "Billing",
- "description": "Billing related configuration of the service.\n\nThe following example shows how to configure monitored resources and metrics\nfor billing:\n\n monitored_resources:\n - type: library.googleapis.com/branch\n labels:\n - key: /city\n description: The city where the library branch is located in.\n - key: /name\n description: The name of the branch.\n metrics:\n - name: library.googleapis.com/book/borrowed_count\n metric_kind: DELTA\n value_type: INT64\n billing:\n consumer_destinations:\n - monitored_resource: library.googleapis.com/branch\n metrics:\n - library.googleapis.com/book/borrowed_count"
- },
- "SourceContext": {
- "description": "`SourceContext` represents information about the source of a\nprotobuf element, like the file in which it is defined.",
- "type": "object",
- "properties": {
- "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"
- },
- "ListTenancyUnitsResponse": {
- "type": "object",
- "properties": {
- "nextPageToken": {
- "description": "Pagination token for large results.",
- "type": "string"
- },
- "tenancyUnits": {
- "description": "Tenancy Units matching the request.",
- "type": "array",
- "items": {
- "$ref": "TenancyUnit"
}
}
},
- "id": "ListTenancyUnitsResponse",
- "description": "Response for the list request."
+ "id": "Billing"
},
"SearchTenancyUnitsResponse": {
"description": "Response for the search query.",
@@ -983,15 +1477,34 @@
},
"id": "SearchTenancyUnitsResponse"
},
+ "ListTenancyUnitsResponse": {
+ "description": "Response for the list request.",
+ "type": "object",
+ "properties": {
+ "nextPageToken": {
+ "description": "Pagination token for large results.",
+ "type": "string"
+ },
+ "tenancyUnits": {
+ "description": "Tenancy Units matching the request.",
+ "type": "array",
+ "items": {
+ "$ref": "TenancyUnit"
+ }
+ }
+ },
+ "id": "ListTenancyUnitsResponse"
+ },
"Endpoint": {
+ "description": "`Endpoint` describes a network endpoint that serves a set of APIs.\nA service may expose any number of endpoints, and all endpoints share the\nsame service configuration, such as quota configuration and monitoring\nconfiguration.\n\nExample service configuration:\n\n name: library-example.googleapis.com\n endpoints:\n # Below entry makes 'google.example.library.v1.Library'\n # API be served from endpoint address library-example.googleapis.com.\n # It also allows HTTP OPTIONS calls to be passed to the backend, for\n # it to decide whether the subsequent cross-origin request is\n # allowed to proceed.\n - name: library-example.googleapis.com\n allow_cors: true",
"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"
- },
- "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.",
@@ -1001,22 +1514,22 @@
}
},
"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."
+ "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": {
- "type": "string",
- "description": "The canonical name of this endpoint."
+ "description": "The canonical name of this endpoint.",
+ "type": "string"
},
"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": "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"
+ "id": "Endpoint"
},
"OAuthRequirements": {
+ "description": "OAuth scopes are a way to define data and permissions on data. For example,\nthere are scopes defined for \"Read-only access to Google Calendar\" and\n\"Access to Cloud Platform\". Users can consent to a scope for an application,\ngiving it permission to access that data on their behalf.\n\nOAuth scope specifications should be fairly coarse grained; a user will need\nto see and understand the text description of what your scope means.\n\nIn most cases: use one or at most two OAuth scopes for an entire family of\nproducts. If your product has multiple APIs, you should probably be sharing\nthe OAuth scope across all of those APIs.\n\nWhen you need finer grained OAuth consent screens: talk with your product\nmanagement about how developers will use them in practice.\n\nPlease note that even though each of the canonical scopes is enough for a\nrequest to be accepted and passed to the backend, a request can still fail\ndue to the backend requiring additional scopes or permissions.",
"type": "object",
"properties": {
"canonicalScopes": {
@@ -1024,35 +1537,35 @@
"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."
+ "id": "OAuthRequirements"
},
"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'.",
"type": "array",
"items": {
"type": "string"
- },
- "description": "Requirements that must be satisfied before a consumer project can use the\nservice. Each requirement is of the form \u003cservice.name\u003e/\u003crequirement-id\u003e;\nfor example 'serviceusage.googleapis.com/billing-enabled'."
+ }
}
},
"id": "Usage"
},
"Context": {
+ "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": {
@@ -1063,12 +1576,20 @@
}
}
},
- "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`."
+ "id": "Context"
},
"LogDescriptor": {
+ "description": "A description of a log type. Example in YAML format:\n\n - name: library.googleapis.com/activity_history\n description: The history of borrowing and returning library items.\n display_name: Activity\n labels:\n - key: /customer_id\n description: Identifier of a library customer",
"type": "object",
"properties": {
+ "description": {
+ "description": "A human-readable description of this log. This information appears in\nthe documentation and can contain details.",
+ "type": "string"
+ },
+ "displayName": {
+ "description": "The human-readable name for this log. This information appears on\nthe user interface and should be concise.",
+ "type": "string"
+ },
"labels": {
"description": "The set of labels that are available to describe a specific log entry.\nRuntime requests that contain labels not specified here are\nconsidered invalid.",
"type": "array",
@@ -1077,52 +1598,14 @@
}
},
"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": {
- "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.",
+ "description": "The name of the log. It must be less than 512 characters long and can\ninclude the following characters: upper- and lower-case alphanumeric\ncharacters [A-Za-z0-9], and punctuation characters including\nslash, underscore, hyphen, period [/_-.].",
"type": "string"
}
},
- "id": "LogDescriptor",
- "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"
- },
- "MonitoredResourceDescriptor": {
- "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": {
- "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": {
- "type": "string",
- "description": "Optional. A detailed description of the monitored resource type that might\nbe used in documentation."
- },
- "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",
- "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": "LogDescriptor"
},
"CustomErrorRule": {
+ "description": "A custom error rule.",
"type": "object",
"properties": {
"isErrorType": {
@@ -1130,63 +1613,92 @@
"type": "boolean"
},
"selector": {
- "type": "string",
- "description": "Selects messages to which this rule applies.\n\nRefer to selector for syntax details."
+ "description": "Selects messages to which this rule applies.\n\nRefer to selector for syntax details.",
+ "type": "string"
}
},
- "id": "CustomErrorRule",
- "description": "A custom error rule."
+ "id": "CustomErrorRule"
},
- "MediaDownload": {
- "description": "Defines the Media configuration for a service in case of a download.\nUse this only for Scotty Requests. Do not use this for media support using\nBytestream, add instead [][google.bytestream.RestByteStream] as an API to\nyour configuration for Bytestream methods.",
+ "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": {
- "enabled": {
- "type": "boolean",
- "description": "Whether download is enabled."
+ "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"
+ }
},
- "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": {
- "type": "boolean",
- "description": "A boolean that determines whether a notification for the completion of a\ndownload should be sent to the backend."
- },
- "maxDirectDownloadSize": {
- "type": "string",
- "description": "Optional maximum acceptable size for direct download.\nThe size is specified in bytes.",
- "format": "int64"
- },
- "dropzone": {
- "description": "Name of the Scotty dropzone to use for the current API.",
+ "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"
},
- "useDirectDownload": {
- "type": "boolean",
- "description": "A boolean that determines if direct download from ESF should be used for\ndownload of this media."
+ "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": "MediaDownload"
+ "id": "MonitoredResourceDescriptor"
},
"CustomAuthRequirements": {
"description": "Configuration for a custom authentication provider.",
"type": "object",
"properties": {
"provider": {
- "type": "string",
- "description": "A configuration string containing connection information for the\nauthentication provider, typically formatted as a SmartService string\n(go/smartservice)."
+ "description": "A configuration string containing connection information for the\nauthentication provider, typically formatted as a SmartService string\n(go/smartservice).",
+ "type": "string"
}
},
"id": "CustomAuthRequirements"
},
+ "MediaDownload": {
+ "description": "Defines the Media configuration for a service in case of a download.\nUse this only for Scotty Requests. Do not use this for media support using\nBytestream, add instead [][google.bytestream.RestByteStream] as an API to\nyour configuration for Bytestream methods.",
+ "type": "object",
+ "properties": {
+ "enabled": {
+ "description": "Whether download is enabled.",
+ "type": "boolean"
+ },
+ "downloadService": {
+ "description": "DO NOT USE FIELDS BELOW THIS LINE UNTIL THIS WARNING IS REMOVED.\n\nSpecify name of the download service if one is used for download.",
+ "type": "string"
+ },
+ "completeNotification": {
+ "description": "A boolean that determines whether a notification for the completion of a\ndownload should be sent to the backend.",
+ "type": "boolean"
+ },
+ "dropzone": {
+ "description": "Name of the Scotty dropzone to use for the current API.",
+ "type": "string"
+ },
+ "maxDirectDownloadSize": {
+ "description": "Optional maximum acceptable size for direct download.\nThe size is specified in bytes.",
+ "format": "int64",
+ "type": "string"
+ },
+ "useDirectDownload": {
+ "description": "A boolean that determines if direct download from ESF should be used for\ndownload of this media.",
+ "type": "boolean"
+ }
+ },
+ "id": "MediaDownload"
+ },
"AuthorizationRule": {
"description": "Authorization rule for API services.\n\nIt specifies the permission(s) required for an API element for the overall\nAPI request to succeed. It is typically used to mark request message fields\nthat contain the name of the resource and indicates the permissions that\nwill be checked on that resource.\n\nFor example:\n\n package google.storage.v1;\n\n message CopyObjectRequest {\n string source = 1 [\n (google.api.authz).permissions = \"storage.objects.get\"];\n\n string destination = 2 [\n (google.api.authz).permissions =\n \"storage.objects.create,storage.objects.update\"];\n }",
"type": "object",
"properties": {
"permissions": {
- "type": "string",
- "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."
+ "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.",
@@ -1199,18 +1711,6 @@
"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": {
- "mimeTypes": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "description": "An array of mimetype patterns. Esf will only accept uploads that match one\nof the given patterns."
- },
- "maxSize": {
- "description": "Optional maximum acceptable size for an upload.\nThe size is specified in bytes.",
- "format": "int64",
- "type": "string"
- },
"completeNotification": {
"description": "A boolean that determines whether a notification for the completion of an\nupload should be sent to the backend. These notifications will not be seen\nby the client and will not consume quota.",
"type": "boolean"
@@ -1224,16 +1724,28 @@
"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": {
"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."
+ "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"
@@ -1249,41 +1761,41 @@
},
"id": "CreateTenancyUnitRequest"
},
- "BillingDestination": {
- "description": "Configuration of a specific billing destination (Currently only support\nbill against consumer project).",
- "type": "object",
- "properties": {
- "metrics": {
- "description": "Names of the metrics to report to this billing destination.\nEach name must be defined in Service.metrics section.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "monitoredResource": {
- "description": "The monitored resource type. The type must be defined in\nService.monitored_resources section.",
- "type": "string"
- }
- },
- "id": "BillingDestination"
- },
"Empty": {
"description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
"type": "object",
"properties": {},
"id": "Empty"
},
+ "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"
+ },
"UsageRule": {
"description": "Usage configuration rules for the service.\n\nNOTE: Under development.\n\n\nUse this rule to configure unregistered calls for the service. Unregistered\ncalls are calls that do not contain consumer project identity.\n(Example: calls that do not contain an API key).\nBy default, API methods do not allow unregistered calls, and each method call\nmust be identified by a consumer project identity. Use this rule to\nallow/disallow unregistered calls.\n\nExample of an API that wants to allow unregistered calls for entire service.\n\n usage:\n rules:\n - selector: \"*\"\n allow_unregistered_calls: true\n\nExample of a method that wants to allow unregistered calls.\n\n usage:\n rules:\n - selector: \"google.example.library.v1.LibraryService.CreateBook\"\n allow_unregistered_calls: true",
"type": "object",
"properties": {
"selector": {
- "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": {
- "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."
+ "description": "If true, the selected method should skip service control and the control\nplane features, such as quota and billing, will not be available.\nThis flag is used by Google Cloud Endpoints to bypass checks for internal\nmethods, such as service health check methods.",
+ "type": "boolean"
},
"allowUnregisteredCalls": {
"description": "If true, the selected method allows unregistered calls, e.g. calls\nthat don't identify any user or application.",
@@ -1320,22 +1832,22 @@
"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"
- },
- "description": "A list of documentation rules that apply to individual API elements.\n\n**NOTE:** All service configuration rules follow \"last one wins\" order."
+ }
},
"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"
- },
- "description": "The top level pages for the documentation set."
+ }
}
},
"id": "Documentation"
@@ -1344,9 +1856,14 @@
"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": {
- "type": "string",
- "description": "The address of the API backend."
+ "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.",
@@ -1356,26 +1873,14 @@
"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": {
+ "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",
@@ -1384,27 +1889,28 @@
}
},
"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."
+ },
+ "customAuth": {
+ "$ref": "CustomAuthRequirements",
+ "description": "Configuration for custom authentication."
}
},
- "id": "AuthenticationRule",
- "description": "Authentication rules for the service.\n\nBy default, if a method has any authentication requirements, every request\nmust include a valid credential matching one of the requirements.\nIt's an error to include more than one kind of credential in a single\nrequest.\n\nIf a method doesn't have any auth requirements, request credentials will be\nignored."
+ "id": "AuthenticationRule"
},
"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": {
- "mixins": {
- "type": "array",
- "items": {
- "$ref": "Mixin"
- },
- "description": "Included interfaces. See Mixin."
- },
"options": {
"description": "Any metadata attached to the interface.",
"type": "array",
@@ -1413,18 +1919,17 @@
}
},
"methods": {
+ "description": "The methods of this interface, in unspecified order.",
"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."
+ "description": "The fully qualified name of this interface, including package name\nfollowed by the interface's simple name.",
+ "type": "string"
},
"syntax": {
- "type": "string",
"enumDescriptions": [
"Syntax `proto2`.",
"Syntax `proto3`."
@@ -1433,7 +1938,8 @@
"SYNTAX_PROTO2",
"SYNTAX_PROTO3"
],
- "description": "The source syntax of the service."
+ "description": "The source syntax of the service.",
+ "type": "string"
},
"sourceContext": {
"$ref": "SourceContext",
@@ -1442,10 +1948,16 @@
"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."
+ "id": "Api"
},
"MetricRule": {
"description": "Bind API methods to metrics. Binding a method to a metric causes that\nmetric's configured quota behaviors to apply to the method call.",
@@ -1456,39 +1968,39 @@
"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"
},
"CancelOperationRequest": {
+ "description": "The request message for Operations.CancelOperation.",
"type": "object",
"properties": {},
- "id": "CancelOperationRequest",
- "description": "The request message for Operations.CancelOperation."
+ "id": "CancelOperationRequest"
},
"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": {
- "type": "array",
- "items": {
- "$ref": "AuthenticationRule"
- },
- "description": "A list of authentication rules that apply to individual API methods.\n\n**NOTE:** All service configuration rules follow \"last one wins\" order."
- },
"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"
@@ -1498,11 +2010,11 @@
"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"
- },
- "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."
+ }
}
},
"id": "TenantProjectPolicy"
@@ -1511,63 +2023,72 @@
"description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
"type": "object",
"properties": {
+ "error": {
+ "$ref": "Status",
+ "description": "The error result of the operation in case of failure or cancellation."
+ },
"metadata": {
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- },
"description": "Service-specific metadata associated with the operation. It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata. Any method that returns a\nlong-running operation should document the metadata type, if any.",
- "type": "object"
- },
- "done": {
- "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"
+ }
+ },
+ "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`."
+ "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"
},
"Page": {
+ "description": "Represents a documentation page. A page can contain subpages to represent\nnested documentation set structure.",
"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": {
"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"
- },
- "description": "Subpages of this page. The order of subpages specified here will be\nhonored in the generated docset."
+ }
+ },
+ "name": {
+ "description": "The name of the page. It will be used as an identity of the page to\ngenerate URI of the page, text of the link to this page in navigation,\netc. The full page name (start from the root page name to this page\nconcatenated with `.`) can be used as reference to the page in your\ndocumentation. For example:\n\u003cpre\u003e\u003ccode\u003epages:\n- name: Tutorial\n content: (== include tutorial.md ==)\n subpages:\n - name: Java\n content: (== include tutorial_java.md ==)\n\u003c/code\u003e\u003c/pre\u003e\nYou can reference `Java` page using Markdown reference link syntax:\n`Java`.",
+ "type": "string"
}
},
- "id": "Page",
- "description": "Represents a documentation page. A page can contain subpages to represent\nnested documentation set structure."
+ "id": "Page"
},
"Status": {
"description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
"type": "object",
"properties": {
+ "code": {
+ "description": "The status code, which should be an enum value of google.rpc.Code.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "message": {
+ "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
+ "type": "string"
+ },
"details": {
"description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.",
"type": "array",
@@ -1578,15 +2099,6 @@
},
"type": "object"
}
- },
- "code": {
- "type": "integer",
- "description": "The status code, which should be an enum value of google.rpc.Code.",
- "format": "int32"
- },
- "message": {
- "type": "string",
- "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client."
}
},
"id": "Status"
@@ -1615,20 +2127,20 @@
"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\"."
+ "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": {
- "type": "string",
- "description": "Redirect URL if JWT token is required but no present or is expired.\nImplement authorizationUrl of securityDefinitions in OpenAPI spec."
+ "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"
+ "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"
@@ -1650,8 +2162,8 @@
"type": "integer"
},
"name": {
- "type": "string",
- "description": "Enum value name."
+ "description": "Enum value name.",
+ "type": "string"
}
},
"id": "EnumValue"
@@ -1660,16 +2172,31 @@
"description": "`Service` is the root object of Google service configuration schema. It\ndescribes basic information about a service, such as the name and the\ntitle, and delegates other aspects to sub-sections. Each sub-section is\neither a proto message or a repeated proto message that configures a\nspecific aspect, such as auth. See each proto message definition for details.\n\nExample:\n\n type: google.api.Service\n config_version: 3\n name: calendar.googleapis.com\n title: Google Calendar API\n apis:\n - name: google.calendar.v3.Calendar\n authentication:\n providers:\n - id: google_calendar_auth\n jwks_uri: https://www.googleapis.com/oauth2/v1/certs\n issuer: https://securetoken.google.com\n rules:\n - selector: \"*\"\n requirements:\n provider_id: google_calendar_auth",
"type": "object",
"properties": {
+ "documentation": {
+ "$ref": "Documentation",
+ "description": "Additional API documentation."
+ },
+ "monitoredResources": {
+ "description": "Defines the monitored resources used by this service. This is required\nby the Service.monitoring and Service.logging configurations.",
+ "type": "array",
+ "items": {
+ "$ref": "MonitoredResourceDescriptor"
+ }
+ },
+ "logging": {
+ "description": "Logging configuration.",
+ "$ref": "Logging"
+ },
+ "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"
- },
- "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"
- },
- "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.",
@@ -1699,107 +2226,92 @@
"description": "Configuration for the service control plane."
},
"configVersion": {
- "type": "integer",
"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"
+ "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"
},
+ "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."
+ "description": "API visibility configuration.",
+ "$ref": "Visibility"
},
"quota": {
"$ref": "Quota",
"description": "Quota configuration."
},
+ "name": {
+ "description": "The DNS address at which this service is available,\ne.g. `calendar.googleapis.com`.",
+ "type": "string"
+ },
"billing": {
"$ref": "Billing",
"description": "Billing configuration."
},
- "name": {
- "type": "string",
- "description": "The DNS address at which this service is available,\ne.g. `calendar.googleapis.com`."
- },
"customError": {
- "$ref": "CustomError",
- "description": "Custom error configuration."
+ "description": "Custom error configuration.",
+ "$ref": "CustomError"
},
"title": {
"description": "The product title for this service.",
"type": "string"
},
"endpoints": {
+ "description": "Configuration for network endpoints. If this is empty, then an endpoint\nwith the same name as the service is automatically generated to service all\ndefined APIs.",
"type": "array",
"items": {
"$ref": "Endpoint"
- },
- "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"
- },
- "description": "A list of API interfaces exported by this service. Only the `name` field\nof the google.protobuf.Api needs to be provided by the configuration\nauthor, as the remaining fields will be derived from the IDL during the\nnormalization process. It is an error to specify an API interface here\nwhich cannot be resolved against the associated IDL files."
+ }
},
"logs": {
+ "description": "Defines the logs used by this service.",
"type": "array",
"items": {
"$ref": "LogDescriptor"
- },
- "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"
- },
- "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."
+ "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."
- },
- "systemParameters": {
- "$ref": "SystemParameters",
- "description": "System parameter configuration."
- },
- "documentation": {
- "$ref": "Documentation",
- "description": "Additional API documentation."
- },
- "monitoredResources": {
- "description": "Defines the monitored resources used by this service. This is required\nby the Service.monitoring and Service.logging configurations.",
- "type": "array",
- "items": {
- "$ref": "MonitoredResourceDescriptor"
- }
- },
- "logging": {
- "$ref": "Logging",
- "description": "Logging configuration."
}
},
"id": "Service"
@@ -1808,107 +2320,19 @@
"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"
- },
- "CustomHttpPattern": {
- "description": "A custom pattern is used for defining custom HTTP verb.",
- "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"
- },
- "SystemParameterRule": {
- "description": "Define a system parameter rule mapping system parameter definitions to\nmethods.",
- "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"
- },
- "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": {
- "description": "@OutputOnly Identifier of the tenant resource.\nFor cloud projects it is in the form 'projects/{number}'.\nFor example 'projects/123456'.",
- "type": "string"
- },
- "status": {
- "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"
- ],
- "description": "Status of tenant resource."
- },
- "tag": {
- "description": "Unique per single tenancy unit.",
- "type": "string"
- }
- },
- "id": "TenantResource"
- },
- "RemoveTenantProjectRequest": {
- "type": "object",
- "properties": {
- "tag": {
- "description": "Tag of the resource within the tenancy unit.",
- "type": "string"
- }
- },
- "id": "RemoveTenantProjectRequest",
- "description": "Request message to remove tenant project resource from the tenancy unit."
}
},
"protocol": "rest",
@@ -1920,11 +2344,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/service.management": {
"description": "Manage your Google API service configuration"
+ },
+ "https://www.googleapis.com/auth/cloud-platform": {
+ "description": "View and manage your data across Google Cloud Platform services"
}
}
}
@@ -1934,429 +2358,5 @@
"name": "serviceconsumermanagement",
"batchPath": "batch",
"fullyEncodeReservedExpansion": true,
- "title": "Service Consumer Management API",
- "ownerName": "Google",
- "resources": {
- "operations": {
- "methods": {
- "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": {
- "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",
- "https://www.googleapis.com/auth/service.management"
- ],
- "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."
- },
- "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": {
- "required": true,
- "type": "string",
- "pattern": "^operations/[^/]+$",
- "location": "path",
- "description": "The name of the operation resource."
- }
- },
- "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}"
- },
- "cancel": {
- "flatPath": "v1/operations/{operationsId}:cancel",
- "path": "v1/{+name}:cancel",
- "id": "serviceconsumermanagement.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"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "POST",
- "parameters": {
- "name": {
- "location": "path",
- "description": "The name of the operation resource to be cancelled.",
- "required": true,
- "type": "string",
- "pattern": "^operations/.+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/service.management"
- ]
- },
- "delete": {
- "httpMethod": "DELETE",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Empty"
- },
- "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/service.management"
- ],
- "flatPath": "v1/operations/{operationsId}",
- "id": "serviceconsumermanagement.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`."
- }
- }
- },
- "services": {
- "methods": {
- "search": {
- "description": "Search tenancy units for a service.",
- "response": {
- "$ref": "SearchTenancyUnitsResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "GET",
- "parameters": {
- "query": {
- "location": "query",
- "description": "Set a query `{expression}` for querying tenancy units. Your `{expression}`\nmust be in the format: `field_name=literal_string`. The `field_name` is the\nname of the field you want to compare. Supported fields are\n`tenant_resources.tag` and`tenant_resources.resource`.\n\nFor example, to search tenancy units that contain at least one tenant\nresource with given tag 'xyz', use query `tenant_resources.tag=xyz`.\nTo search tenancy units that contain at least one tenant resource with\ngiven resource name 'projects/123456', use query\n`tenant_resources.resource=projects/123456`.\n\nMultiple expressions can be joined with `AND`s. Tenancy units must match\nall expressions to be included in the result set. For example,\n`tenant_resources.tag=xyz AND tenant_resources.resource=projects/123456`\n\nOptional.",
- "type": "string"
- },
- "parent": {
- "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/[^/]+$"
- },
- "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.\n\nOptional.",
- "type": "string"
- },
- "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"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/services/{servicesId}:search",
- "path": "v1/{+parent}:search",
- "id": "serviceconsumermanagement.services.search"
- }
- },
- "resources": {
- "tenancyUnits": {
- "methods": {
- "list": {
- "description": "Find tenancy unit for a service and consumer.\nThis method should not be used in producers' runtime path, e.g. finding\nthe tenant project number when creating VMs. Producers should persist\nthe tenant project information after the project is created.",
- "response": {
- "$ref": "ListTenancyUnitsResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "GET",
- "parameters": {
- "parent": {
- "location": "path",
- "description": "Service and consumer. Required.\nservices/{service}/{collection id}/{resource id}\n{collection id} is the cloud resource collection type representing the\nservice consumer, for example 'projects', or 'organizations'.\n{resource id} is the consumer numeric id, such as project number: '123456'.\n{service} the name of a service, for example 'service.googleapis.com'.",
- "required": true,
- "type": "string",
- "pattern": "^services/[^/]+/[^/]+/[^/]+$"
- },
- "filter": {
- "location": "query",
- "description": "Filter expression over tenancy resources field. Optional.",
- "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 returned by this request.",
- "format": "int32",
- "type": "integer"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/services/{servicesId}/{servicesId1}/{servicesId2}/tenancyUnits",
- "path": "v1/{+parent}/tenancyUnits",
- "id": "serviceconsumermanagement.services.tenancyUnits.list"
- },
- "create": {
- "response": {
- "$ref": "TenancyUnit"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "parent": {
- "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/[^/]+/[^/]+/[^/]+$"
- }
- },
- "flatPath": "v1/services/{servicesId}/{servicesId1}/{servicesId2}/tenancyUnits",
- "path": "v1/{+parent}/tenancyUnits",
- "id": "serviceconsumermanagement.services.tenancyUnits.create",
- "description": "Creates a tenancy unit with no tenant resources.",
- "request": {
- "$ref": "CreateTenancyUnitRequest"
- }
- },
- "removeProject": {
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "POST",
- "parameters": {
- "name": {
- "required": true,
- "type": "string",
- "pattern": "^services/[^/]+/[^/]+/[^/]+/tenancyUnits/[^/]+$",
- "location": "path",
- "description": "Name of the tenancy unit.\nSuch as 'services/service.googleapis.com/projects/12345/tenancyUnits/abcd'."
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/services/{servicesId}/{servicesId1}/{servicesId2}/tenancyUnits/{tenancyUnitsId}:removeProject",
- "path": "v1/{+name}:removeProject",
- "id": "serviceconsumermanagement.services.tenancyUnits.removeProject",
- "request": {
- "$ref": "RemoveTenantProjectRequest"
- },
- "description": "Removes specified project resource identified by tenant resource tag.\nIt will remove project lien with 'TenantManager' origin if that was added.\nIt will then attempt to delete the project.\nIf that operation fails, this method fails.\nOperation\u003cresponse: Empty\u003e."
- },
- "delete": {
- "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.",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "DELETE",
- "parameters": {
- "name": {
- "required": true,
- "type": "string",
- "pattern": "^services/[^/]+/[^/]+/[^/]+/tenancyUnits/[^/]+$",
- "location": "path",
- "description": "Name of the tenancy unit to be deleted."
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- },
- "addProject": {
- "flatPath": "v1/services/{servicesId}/{servicesId1}/{servicesId2}/tenancyUnits/{tenancyUnitsId}:addProject",
- "path": "v1/{+parent}:addProject",
- "id": "serviceconsumermanagement.services.tenancyUnits.addProject",
- "description": "Add a new tenant project to the tenancy unit.\nIf there are previously failed AddTenantProject calls, you might need to\ncall RemoveTenantProject first to clean them before you can make another\nAddTenantProject with the same tag.\nOperation\u003cresponse: Empty\u003e.",
- "request": {
- "$ref": "AddTenantProjectRequest"
- },
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "parent": {
- "required": true,
- "type": "string",
- "pattern": "^services/[^/]+/[^/]+/[^/]+/tenancyUnits/[^/]+$",
- "location": "path",
- "description": "Name of the tenancy unit."
- }
- }
- }
- }
- }
- }
- }
- },
- "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": {
- "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": {
- "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": {
- "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."
- },
- "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": {
- "type": "string",
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query",
- "enum": [
- "1",
- "2"
- ],
- "description": "V1 error format."
- }
- },
- "version": "v1",
- "baseUrl": "https://serviceconsumermanagement.googleapis.com/",
- "servicePath": "",
- "description": "Provides management methods for configuring service producer resources on Google Cloud.",
- "kind": "discovery#restDescription"
+ "title": "Service Consumer Management API"
}
diff --git a/servicecontrol/v1/servicecontrol-api.json b/servicecontrol/v1/servicecontrol-api.json
index 79043e8..adb08c7 100644
--- a/servicecontrol/v1/servicecontrol-api.json
+++ b/servicecontrol/v1/servicecontrol-api.json
@@ -1,4 +1,18 @@
{
+ "canonicalName": "Service Control",
+ "auth": {
+ "oauth2": {
+ "scopes": {
+ "https://www.googleapis.com/auth/servicecontrol": {
+ "description": "Manage your Google Service Control data"
+ },
+ "https://www.googleapis.com/auth/cloud-platform": {
+ "description": "View and manage your data across Google Cloud Platform services"
+ }
+ }
+ }
+ },
+ "rootUrl": "https://servicecontrol.googleapis.com/",
"ownerDomain": "google.com",
"name": "servicecontrol",
"batchPath": "batch",
@@ -8,98 +22,7 @@
"resources": {
"services": {
"methods": {
- "endReconciliation": {
- "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).",
- "response": {
- "$ref": "EndReconciliationResponse"
- },
- "parameterOrder": [
- "serviceName"
- ],
- "httpMethod": "POST",
- "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"
- ]
- },
- "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"
- },
- "httpMethod": "POST",
- "parameterOrder": [
- "serviceName"
- ],
- "response": {
- "$ref": "ReportResponse"
- },
- "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",
- "id": "servicecontrol.services.report",
- "path": "v1/services/{serviceName}:report"
- },
- "allocateQuota": {
- "description": "Attempts to allocate quota for the specified consumer. It should be called\nbefore the operation is executed.\n\nThis method requires the `servicemanagement.services.quota`\npermission on the specified service. For more information, see\n[Cloud IAM](https://cloud.google.com/iam).\n\n**NOTE:** The client **must** fail-open on server errors `INTERNAL`,\n`UNKNOWN`, `DEADLINE_EXCEEDED`, and `UNAVAILABLE`. To ensure system\nreliability, the server may inject these errors to prohibit any hard\ndependency on the quota functionality.",
- "request": {
- "$ref": "AllocateQuotaRequest"
- },
- "httpMethod": "POST",
- "parameterOrder": [
- "serviceName"
- ],
- "response": {
- "$ref": "AllocateQuotaResponse"
- },
- "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}:allocateQuota",
- "id": "servicecontrol.services.allocateQuota",
- "path": "v1/services/{serviceName}:allocateQuota"
- },
"startReconciliation": {
- "flatPath": "v1/services/{serviceName}:startReconciliation",
- "id": "servicecontrol.services.startReconciliation",
- "path": "v1/services/{serviceName}: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"
- },
"httpMethod": "POST",
"parameterOrder": [
"serviceName"
@@ -107,24 +30,27 @@
"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"
],
- "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",
+ "id": "servicecontrol.services.startReconciliation",
+ "path": "v1/services/{serviceName}:startReconciliation",
+ "request": {
+ "$ref": "StartReconciliationRequest"
+ },
+ "description": "Unlike rate quota, allocation quota does not get refilled periodically.\nSo, it is possible that the quota usage as seen by the service differs from\nwhat the One Platform considers the usage is. This is expected to happen\nonly rarely, but over time this can accumulate. Services can invoke\nStartReconciliation and EndReconciliation to correct this usage drift, as\ndescribed below:\n1. Service sends StartReconciliation with a timestamp in future for each\n metric that needs to be reconciled. The timestamp being in future allows\n to account for in-flight AllocateQuota and ReleaseQuota requests for the\n same metric.\n2. One Platform records this timestamp and starts tracking subsequent\n AllocateQuota and ReleaseQuota requests until EndReconciliation is\n called.\n3. At or after the time specified in the StartReconciliation, service\n sends EndReconciliation with the usage that needs to be reconciled to.\n4. One Platform adjusts its own record of usage for that metric to the\n value specified in EndReconciliation by taking in to account any\n allocation or release between StartReconciliation and EndReconciliation.\n\nSignals the quota controller that the service wants to perform a usage\nreconciliation as specified in the request.\n\nThis method requires the `servicemanagement.services.quota`\npermission on the specified service. For more information, see\n[Google Cloud IAM](https://cloud.google.com/iam)."
},
"check": {
- "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"
},
@@ -132,10 +58,6 @@
"serviceName"
],
"httpMethod": "POST",
- "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.",
@@ -144,25 +66,26 @@
"location": "path"
}
},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/servicecontrol"
+ ],
"flatPath": "v1/services/{serviceName}:check",
"path": "v1/services/{serviceName}:check",
- "id": "servicecontrol.services.check"
+ "id": "servicecontrol.services.check",
+ "request": {
+ "$ref": "CheckRequest"
+ },
+ "description": "Checks an operation with Google Service Control to decide whether\nthe given operation should proceed. It should be called before the\noperation is executed.\n\nIf feasible, the client should cache the check results and reuse them for\n60 seconds. In case of server errors, the client can rely on the cached\nresults for longer time.\n\nNOTE: the CheckRequest has the size limit of 64KB.\n\nThis method requires the `servicemanagement.services.check` permission\non the specified service. For more information, see\n[Google Cloud IAM](https://cloud.google.com/iam)."
},
"releaseQuota": {
- "flatPath": "v1/services/{serviceName}:releaseQuota",
- "id": "servicecontrol.services.releaseQuota",
- "path": "v1/services/{serviceName}: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"
- },
- "httpMethod": "POST",
- "parameterOrder": [
- "serviceName"
- ],
"response": {
"$ref": "ReleaseQuotaResponse"
},
+ "parameterOrder": [
+ "serviceName"
+ ],
+ "httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/servicecontrol"
@@ -174,16 +97,107 @@
"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": {
+ "response": {
+ "$ref": "EndReconciliationResponse"
+ },
+ "parameterOrder": [
+ "serviceName"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/servicecontrol"
+ ],
+ "parameters": {
+ "serviceName": {
+ "description": "Name of the service as specified in the service configuration. For example,\n`\"pubsub.googleapis.com\"`.\n\nSee google.api.Service for the definition of a service name.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/services/{serviceName}:endReconciliation",
+ "path": "v1/services/{serviceName}:endReconciliation",
+ "id": "servicecontrol.services.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"
+ }
+ },
+ "report": {
+ "response": {
+ "$ref": "ReportResponse"
+ },
+ "parameterOrder": [
+ "serviceName"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "serviceName": {
+ "location": "path",
+ "description": "The service name as specified in its service configuration. For example,\n`\"pubsub.googleapis.com\"`.\n\nSee\n[google.api.Service](https://cloud.google.com/service-management/reference/rpc/google.api#google.api.Service)\nfor the definition of a service name.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/servicecontrol"
+ ],
+ "flatPath": "v1/services/{serviceName}: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)."
+ },
+ "allocateQuota": {
+ "description": "Attempts to allocate quota for the specified consumer. It should be called\nbefore the operation is executed.\n\nThis method requires the `servicemanagement.services.quota`\npermission on the specified service. For more information, see\n[Cloud IAM](https://cloud.google.com/iam).\n\n**NOTE:** The client **must** fail-open on server errors `INTERNAL`,\n`UNKNOWN`, `DEADLINE_EXCEEDED`, and `UNAVAILABLE`. To ensure system\nreliability, the server may inject these errors to prohibit any hard\ndependency on the quota functionality.",
+ "request": {
+ "$ref": "AllocateQuotaRequest"
+ },
+ "response": {
+ "$ref": "AllocateQuotaResponse"
+ },
+ "parameterOrder": [
+ "serviceName"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/servicecontrol"
+ ],
+ "parameters": {
+ "serviceName": {
+ "description": "Name of the service as specified in the service configuration. For example,\n`\"pubsub.googleapis.com\"`.\n\nSee google.api.Service for the definition of a service name.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/services/{serviceName}:allocateQuota",
+ "path": "v1/services/{serviceName}:allocateQuota",
+ "id": "servicecontrol.services.allocateQuota"
}
}
}
},
"parameters": {
"upload_protocol": {
- "location": "query",
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"prettyPrint": {
"description": "Returns response with indentations and line breaks.",
@@ -191,41 +205,35 @@
"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"
+ "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",
+ "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",
@@ -233,17 +241,23 @@
],
"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",
- "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",
@@ -262,23 +276,213 @@
"type": "string"
},
"bearer_token": {
+ "location": "query",
"description": "OAuth bearer token.",
- "type": "string",
- "location": "query"
+ "type": "string"
}
},
"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": "",
+ "description": "Google Service Control provides control plane functionality to managed services, such as logging, monitoring, and status checks.",
+ "kind": "discovery#restDescription",
"basePath": "",
- "revision": "20171230",
- "documentationLink": "https://cloud.google.com/service-control/",
"id": "servicecontrol:v1",
+ "documentationLink": "https://cloud.google.com/service-control/",
+ "revision": "20171230",
"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": {
+ "properties": {
+ "reconciliationOperation": {
+ "$ref": "QuotaOperation",
+ "description": "Operation that describes the quota reconciliation."
+ },
+ "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": "EndReconciliationRequest",
+ "description": "Request message for QuotaController.EndReconciliation.",
+ "type": "object"
+ },
+ "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": {
+ "$ref": "QuotaInfo",
+ "description": "Quota usage info when processing the `Operation`."
+ }
+ },
+ "id": "ReportInfo"
+ },
+ "Operation": {
+ "properties": {
+ "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"
+ },
+ "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": {
+ "enum": [
+ "LOW",
+ "HIGH",
+ "DEBUG"
+ ],
+ "description": "DO NOT USE. This is an experimental field.",
+ "type": "string",
+ "enumDescriptions": [
+ "The API implementation may cache and aggregate the data.\nThe data may be lost when rare and unexpected system failures occur.",
+ "The API implementation doesn't cache and aggregate the data.\nIf the method returns successfully, it's guaranteed that the data has\nbeen persisted in durable storage.",
+ "In addition to the behavior described in HIGH, DEBUG enables\nadditional validation logic that is only useful during the onboarding\nprocess. This is only available to Google internal services and\nthe service must be whitelisted by chemist-dev@google.com in order\nto use this level."
+ ]
+ },
+ "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"
+ }
+ },
+ "id": "Operation",
+ "description": "Represents information regarding an operation.",
+ "type": "object"
+ },
+ "ReportResponse": {
+ "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"
+ }
+ },
+ "id": "ReportResponse",
+ "description": "Response message for the Report method.",
+ "type": "object"
+ },
"CheckResponse": {
"description": "Response message for the Check method.",
"type": "object",
@@ -295,12 +499,12 @@
}
},
"checkInfo": {
- "description": "Feedback data returned from the server during processing a Check request.",
- "$ref": "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"
+ "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.",
@@ -310,7 +514,6 @@
"id": "CheckResponse"
},
"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.",
@@ -320,11 +523,10 @@
}
}
},
- "id": "AllocateInfo"
+ "id": "AllocateInfo",
+ "type": "object"
},
"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.",
@@ -338,21 +540,12 @@
"type": "string"
}
},
- "id": "ReportRequest"
+ "id": "ReportRequest",
+ "description": "Request message for the Report method.",
+ "type": "object"
},
"Status": {
- "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
- "type": "object",
"properties": {
- "code": {
- "description": "The status code, which should be an enum value of google.rpc.Code.",
- "format": "int32",
- "type": "integer"
- },
- "message": {
- "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
- "type": "string"
- },
"details": {
"description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.",
"type": "array",
@@ -363,13 +556,22 @@
},
"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"
+ "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"
},
"LogEntry": {
- "description": "An individual log entry.",
- "type": "object",
"properties": {
"labels": {
"additionalProperties": {
@@ -438,32 +640,41 @@
"type": "string"
}
},
- "id": "LogEntry"
+ "id": "LogEntry",
+ "description": "An individual log entry.",
+ "type": "object"
},
"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": {
- "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",
"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."
+ "description": "Metadata about the operation.",
+ "$ref": "RequestMetadata"
},
"status": {
"$ref": "Status",
"description": "The status of the overall operation."
},
+ "authenticationInfo": {
+ "description": "Authentication information.",
+ "$ref": "AuthenticationInfo"
+ },
"serviceName": {
"description": "The name of the API service performing the operation. For example,\n`\"datastore.googleapis.com\"`.",
"type": "string"
@@ -493,24 +704,17 @@
"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"
- }
+ },
+ "description": "Deprecated, use `metadata` field instead.\nOther service-specific data about the request, response, and other\nactivities.",
+ "type": "object"
},
"numResponseItems": {
"description": "The number of items returned from a List or Query API method,\nif applicable.",
"format": "int64",
"type": "string"
- },
- "authorizationInfo": {
- "description": "Authorization information. If there are multiple\nresources or permissions involved, then there is\none AuthorizationInfo element for each {resource, permission} tuple.",
- "type": "array",
- "items": {
- "$ref": "AuthorizationInfo"
- }
}
},
"id": "AuditLog"
@@ -519,21 +723,6 @@
"description": "Represents a single metric value.",
"type": "object",
"properties": {
- "moneyValue": {
- "description": "A money value.",
- "$ref": "Money"
- },
- "stringValue": {
- "description": "A text string value.",
- "type": "string"
- },
- "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"
- },
"doubleValue": {
"description": "A double precision floating point value.",
"format": "double",
@@ -561,6 +750,21 @@
"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": {
+ "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"
}
},
"id": "MetricValue"
@@ -598,6 +802,11 @@
"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"
@@ -606,11 +815,6 @@
"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"
@@ -619,15 +823,33 @@
"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": {
+ "description": "Buckets with arbitrary user-provided width.",
+ "$ref": "ExplicitBuckets"
+ },
+ "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": {
+ "description": "Buckets with exponentially growing width.",
+ "$ref": "ExponentialBuckets"
+ },
+ "linearBuckets": {
+ "description": "Buckets with constant width.",
+ "$ref": "LinearBuckets"
+ },
"minimum": {
"description": "The minimum of the population of values. Ignored if `count` is zero.",
"format": "double",
"type": "number"
},
- "linearBuckets": {
- "$ref": "LinearBuckets",
- "description": "Buckets with constant width."
- },
"count": {
"description": "The total number of samples in the distribution. Must be \u003e= 0.",
"format": "int64",
@@ -645,31 +867,11 @@
"format": "int64",
"type": "string"
}
- },
- "explicitBuckets": {
- "description": "Buckets with arbitrary user-provided width.",
- "$ref": "ExplicitBuckets"
- },
- "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."
}
},
"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",
@@ -680,12 +882,19 @@
}
}
},
- "id": "ExplicitBuckets"
+ "id": "ExplicitBuckets",
+ "description": "Describing buckets with arbitrary user-provided width.",
+ "type": "object"
},
"ExponentialBuckets": {
"description": "Describing buckets with exponentially growing width.",
"type": "object",
"properties": {
+ "scale": {
+ "description": "The i'th exponential bucket covers the interval\n [scale * growth_factor^(i-1), scale * growth_factor^i)\nwhere i ranges from 1 to num_finite_buckets inclusive.\nMust be \u003e 0.",
+ "format": "double",
+ "type": "number"
+ },
"numFiniteBuckets": {
"description": "The number of finite buckets. With the underflow and overflow buckets,\nthe total number of buckets is `num_finite_buckets` + 2.\nSee comments on `bucket_options` for details.",
"format": "int32",
@@ -695,11 +904,6 @@
"description": "The i'th exponential bucket covers the interval\n [scale * growth_factor^(i-1), scale * growth_factor^i)\nwhere i ranges from 1 to num_finite_buckets inclusive.\nMust be larger than 1.0.",
"format": "double",
"type": "number"
- },
- "scale": {
- "description": "The i'th exponential bucket covers the interval\n [scale * growth_factor^(i-1), scale * growth_factor^i)\nwhere i ranges from 1 to num_finite_buckets inclusive.\nMust be \u003e 0.",
- "format": "double",
- "type": "number"
}
},
"id": "ExponentialBuckets"
@@ -708,10 +912,6 @@
"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",
- "type": "string"
- },
"granted": {
"description": "Whether or not authorization for `resource` and `permission`\nwas granted.",
"type": "boolean"
@@ -719,13 +919,15 @@
"permission": {
"description": "The required IAM permission.",
"type": "string"
+ },
+ "resource": {
+ "description": "The resource being accessed, as a REST-style string. For example:\n\n bigquery.googleapis.com/projects/PROJECTID/datasets/DATASETID",
+ "type": "string"
}
},
"id": "AuthorizationInfo"
},
"ResourceInfo": {
- "description": "Describes a resource associated with this operation.",
- "type": "object",
"properties": {
"resourceName": {
"description": "Name of the resource. This is used for auditing purposes.",
@@ -736,11 +938,11 @@
"type": "string"
}
},
- "id": "ResourceInfo"
+ "id": "ResourceInfo",
+ "description": "Describes a resource associated with this operation.",
+ "type": "object"
},
"StartReconciliationResponse": {
- "description": "Response message for QuotaController.StartReconciliation.",
- "type": "object",
"properties": {
"quotaMetrics": {
"description": "Metric values as tracked by One Platform before the start of\nreconciliation. The following metrics will be included:\n\n1. Per quota metric total usage will be specified using the following gauge\nmetric:\n \"serviceruntime.googleapis.com/allocation/consumer/quota_used_count\"\n\n2. Value for each quota limit associated with the metrics will be specified\nusing the following gauge metric:\n \"serviceruntime.googleapis.com/quota/limit\"",
@@ -765,15 +967,13 @@
"type": "string"
}
},
- "id": "StartReconciliationResponse"
+ "id": "StartReconciliationResponse",
+ "description": "Response message for QuotaController.StartReconciliation.",
+ "type": "object"
},
"QuotaProperties": {
- "description": "Represents the properties needed for quota operations.",
- "type": "object",
"properties": {
"quotaMode": {
- "description": "Quota mode for this operation.",
- "type": "string",
"enumDescriptions": [
"Decreases available quota by the cost specified for the operation.\nIf cost is higher than available quota, operation fails and returns\nerror.",
"Decreases available quota by the cost specified for the operation.\nIf cost is higher than available quota, operation does not fail and\navailable quota goes down to zero but it returns error.",
@@ -785,10 +985,14 @@
"ACQUIRE_BEST_EFFORT",
"CHECK",
"RELEASE"
- ]
+ ],
+ "description": "Quota mode for this operation.",
+ "type": "string"
}
},
- "id": "QuotaProperties"
+ "id": "QuotaProperties",
+ "description": "Represents the properties needed for quota operations.",
+ "type": "object"
},
"LinearBuckets": {
"description": "Describing buckets with constant width.",
@@ -825,20 +1029,25 @@
"type": "string"
},
"thirdPartyPrincipal": {
- "description": "The third party identification (if any) of the authenticated user making\nthe request.\nWhen the JSON object represented here has a proto equivalent, the proto\nname will be indicated in the `@type` property.",
- "type": "object",
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
- }
+ },
+ "description": "The third party identification (if any) of the authenticated user making\nthe request.\nWhen the JSON object represented here has a proto equivalent, the proto\nname will be indicated in the `@type` property.",
+ "type": "object"
}
},
"id": "AuthenticationInfo"
},
"AllocateQuotaResponse": {
- "description": "Response message for the AllocateQuota method.",
- "type": "object",
"properties": {
+ "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",
@@ -857,16 +1066,11 @@
"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"
- }
}
},
- "id": "AllocateQuotaResponse"
+ "id": "AllocateQuotaResponse",
+ "description": "Response message for the AllocateQuota method.",
+ "type": "object"
},
"ReleaseQuotaRequest": {
"description": "Request message for the ReleaseQuota method.",
@@ -877,15 +1081,13 @@
"type": "string"
},
"releaseOperation": {
- "description": "Operation that describes the quota release.",
- "$ref": "QuotaOperation"
+ "$ref": "QuotaOperation",
+ "description": "Operation that describes the quota release."
}
},
"id": "ReleaseQuotaRequest"
},
"QuotaError": {
- "description": "Represents error information for QuotaOperation.",
- "type": "object",
"properties": {
"subject": {
"description": "Subject to whom this error applies. See the specific enum for more details\non this field. For example, \"clientip:\u003cip address of client\u003e\" or\n\"project:\u003cGoogle developer project id\u003e\".",
@@ -896,8 +1098,6 @@
"type": "string"
},
"code": {
- "description": "Error code.",
- "type": "string",
"enumDescriptions": [
"This is never used.",
"Quota allocation failed.\nSame as google.rpc.Code.RESOURCE_EXHAUSTED.",
@@ -929,14 +1129,16 @@
"SERVICE_STATUS_UNAVAILABLE",
"BILLING_STATUS_UNAVAILABLE",
"QUOTA_SYSTEM_UNAVAILABLE"
- ]
+ ],
+ "description": "Error code.",
+ "type": "string"
}
},
- "id": "QuotaError"
+ "id": "QuotaError",
+ "description": "Represents error information for QuotaOperation.",
+ "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\"",
@@ -951,11 +1153,11 @@
"type": "string"
}
},
- "id": "RequestMetadata"
+ "id": "RequestMetadata",
+ "description": "Metadata about the request.",
+ "type": "object"
},
"CheckInfo": {
- "description": "Contains additional information about the check operation.",
- "type": "object",
"properties": {
"unusedArguments": {
"description": "A list of fields and label keys that are ignored by the server.\nThe client doesn't need to send them for following requests to improve\nperformance and allow better aggregation.",
@@ -965,23 +1167,31 @@
}
},
"consumerInfo": {
- "description": "Consumer info of this check.",
- "$ref": "ConsumerInfo"
+ "$ref": "ConsumerInfo",
+ "description": "Consumer info of this check."
}
},
- "id": "CheckInfo"
+ "id": "CheckInfo",
+ "description": "Contains additional information about the check operation.",
+ "type": "object"
+ },
+ "AllocateQuotaRequest": {
+ "properties": {
+ "serviceConfigId": {
+ "description": "Specifies which version of service configuration should be used to process\nthe request. If unspecified or no matching version can be found, the latest\none will be used.",
+ "type": "string"
+ },
+ "allocateOperation": {
+ "$ref": "QuotaOperation",
+ "description": "Operation that describes the quota allocation."
+ }
+ },
+ "id": "AllocateQuotaRequest",
+ "description": "Request message for the AllocateQuota method.",
+ "type": "object"
},
"ReleaseQuotaResponse": {
- "description": "Response message for the ReleaseQuota method.",
- "type": "object",
"properties": {
- "quotaMetrics": {
- "description": "Quota metrics to indicate the result of release. Depending on the\nrequest, one or more of the following metrics will be included:\n\n1. For rate quota, per quota group or per quota metric released amount\nwill be specified using the following delta metric:\n \"serviceruntime.googleapis.com/api/consumer/quota_refund_count\"\n\n2. For allocation quota, per quota metric total usage will be specified\nusing the following gauge metric:\n \"serviceruntime.googleapis.com/allocation/consumer/quota_used_count\"\n\n3. For allocation quota, value for each quota limit associated with\nthe metrics will be specified using the following gauge metric:\n \"serviceruntime.googleapis.com/quota/limit\"",
- "type": "array",
- "items": {
- "$ref": "MetricValueSet"
- }
- },
"operationId": {
"description": "The same operation_id value used in the ReleaseQuotaRequest. Used for\nlogging and diagnostics purposes.",
"type": "string"
@@ -996,54 +1206,48 @@
"items": {
"$ref": "QuotaError"
}
- }
- },
- "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": {
- "$ref": "QuotaOperation",
- "description": "Operation that describes the quota allocation."
+ "quotaMetrics": {
+ "description": "Quota metrics to indicate the result of release. Depending on the\nrequest, one or more of the following metrics will be included:\n\n1. For rate quota, per quota group or per quota metric released amount\nwill be specified using the following delta metric:\n \"serviceruntime.googleapis.com/api/consumer/quota_refund_count\"\n\n2. For allocation quota, per quota metric total usage will be specified\nusing the following gauge metric:\n \"serviceruntime.googleapis.com/allocation/consumer/quota_used_count\"\n\n3. For allocation quota, value for each quota limit associated with\nthe metrics will be specified using the following gauge metric:\n \"serviceruntime.googleapis.com/quota/limit\"",
+ "type": "array",
+ "items": {
+ "$ref": "MetricValueSet"
+ }
}
},
- "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"
+ "id": "MetricValueSet",
+ "description": "Represents a set of metric values in the same metric.\nEach metric value in the set should have a unique combination of start time,\nend time, and label values.",
+ "type": "object"
},
"ReportError": {
"description": "Represents the processing error of one Operation in the request.",
"type": "object",
"properties": {
- "operationId": {
- "description": "The Operation.operation_id value from the request.",
- "type": "string"
- },
"status": {
"$ref": "Status",
"description": "Details of the error when processing the Operation."
+ },
+ "operationId": {
+ "description": "The Operation.operation_id value from the request.",
+ "type": "string"
}
},
"id": "ReportError"
@@ -1136,38 +1340,29 @@
"id": "CheckError"
},
"StartReconciliationRequest": {
- "description": "Request message for QuotaController.StartReconciliation.",
- "type": "object",
"properties": {
"reconciliationOperation": {
- "description": "Operation that describes the quota reconciliation.",
- "$ref": "QuotaOperation"
+ "$ref": "QuotaOperation",
+ "description": "Operation that describes the quota reconciliation."
},
"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"
+ "id": "StartReconciliationRequest",
+ "description": "Request message for QuotaController.StartReconciliation.",
+ "type": "object"
},
"QuotaInfo": {
- "description": "Contains the quota information for a quota check response.",
- "type": "object",
"properties": {
- "limitExceeded": {
- "description": "Quota Metrics that have exceeded quota limits.\nFor QuotaGroup-based quota, this is QuotaGroup.name\nFor QuotaLimit-based quota, this is QuotaLimit.name\nSee: google.api.Quota\nDeprecated: Use quota_metrics to get per quota group limit exceeded status.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
"quotaConsumed": {
- "description": "Map of quota group name to the actual number of tokens consumed. If the\nquota check was not successful, then this will not be populated due to no\nquota consumption.\n\nWe are not merging this field with 'quota_metrics' field because of the\ncomplexity of scaling in Chemist client code base. For simplicity, we will\nkeep this field for Castor (that scales quota usage) and 'quota_metrics'\nfor SuperQuota (that doesn't scale quota usage).\n",
- "type": "object",
"additionalProperties": {
"format": "int32",
"type": "integer"
- }
+ },
+ "description": "Map of quota group name to the actual number of tokens consumed. If the\nquota check was not successful, then this will not be populated due to no\nquota consumption.\n\nWe are not merging this field with 'quota_metrics' field because of the\ncomplexity of scaling in Chemist client code base. For simplicity, we will\nkeep this field for Castor (that scales quota usage) and 'quota_metrics'\nfor SuperQuota (that doesn't scale quota usage).\n",
+ "type": "object"
},
"quotaMetrics": {
"description": "Quota metrics to indicate the usage. Depending on the check request, one or\nmore of the following metrics will be included:\n\n1. For rate quota, per quota group or per quota metric incremental usage\nwill be specified using the following delta metric:\n \"serviceruntime.googleapis.com/api/consumer/quota_used_count\"\n\n2. For allocation quota, per quota metric total usage will be specified\nusing the following gauge metric:\n \"serviceruntime.googleapis.com/allocation/consumer/quota_used_count\"\n\n3. For both rate quota and allocation quota, the quota limit reached\ncondition will be specified using the following boolean metric:\n \"serviceruntime.googleapis.com/quota/exceeded\"",
@@ -1175,9 +1370,18 @@
"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"
+ "id": "QuotaInfo",
+ "description": "Contains the quota information for a quota check response.",
+ "type": "object"
},
"ConsumerInfo": {
"description": "`ConsumerInfo` provides information about the consumer project.",
@@ -1192,16 +1396,14 @@
"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": {
- "$ref": "Operation",
- "description": "The operation to be checked."
+ "description": "The operation to be checked.",
+ "$ref": "Operation"
},
"requestProjectSettings": {
"description": "Requests the project settings to be returned as part of the check response.",
@@ -1212,216 +1414,14 @@
"type": "string"
}
},
- "id": "CheckRequest"
- },
- "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": {
- "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."
- ],
- "enum": [
- "UNSPECIFIED",
- "NORMAL",
- "BEST_EFFORT",
- "CHECK_ONLY"
- ]
- },
- "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": {
- "$ref": "QuotaOperation",
- "description": "Operation that describes the quota reconciliation."
- }
- },
- "id": "EndReconciliationRequest"
- },
- "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": {
- "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"
- }
- },
- "id": "ReportResponse"
- },
- "Operation": {
- "description": "Represents information regarding an operation.",
- "type": "object",
- "properties": {
- "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"
- },
- "endTime": {
- "description": "End time of the operation.\nRequired when the operation is used in ServiceController.Report,\nbut optional when the operation is used in ServiceController.Check.",
- "format": "google-datetime",
- "type": "string"
- },
- "operationName": {
- "description": "Fully qualified name of the operation. Reserved for future use.",
- "type": "string"
- },
- "startTime": {
- "description": "Required. Start time of the operation.",
- "format": "google-datetime",
- "type": "string"
- },
- "importance": {
- "enumDescriptions": [
- "The API implementation may cache and aggregate the data.\nThe data may be lost when rare and unexpected system failures occur.",
- "The API implementation doesn't cache and aggregate the data.\nIf the method returns successfully, it's guaranteed that the data has\nbeen persisted in durable storage.",
- "In addition to the behavior described in HIGH, DEBUG enables\nadditional validation logic that is only useful during the onboarding\nprocess. This is only available to Google internal services and\nthe service must be whitelisted by chemist-dev@google.com in order\nto use this level."
- ],
- "enum": [
- "LOW",
- "HIGH",
- "DEBUG"
- ],
- "description": "DO NOT USE. This is an experimental field.",
- "type": "string"
- },
- "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"
- }
- }
- },
- "id": "Operation"
+ "id": "CheckRequest",
+ "description": "Request message for the Check method.",
+ "type": "object"
}
},
"protocol": "rest",
"icons": {
"x16": "http://www.google.com/images/icons/product/search-16.gif",
"x32": "http://www.google.com/images/icons/product/search-32.gif"
- },
- "canonicalName": "Service Control",
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/servicecontrol": {
- "description": "Manage your Google Service Control data"
- },
- "https://www.googleapis.com/auth/cloud-platform": {
- "description": "View and manage your data across Google Cloud Platform services"
- }
- }
- }
- },
- "rootUrl": "https://servicecontrol.googleapis.com/"
+ }
}
diff --git a/servicemanagement/v1/servicemanagement-api.json b/servicemanagement/v1/servicemanagement-api.json
index 2f40427..8815f94 100644
--- a/servicemanagement/v1/servicemanagement-api.json
+++ b/servicemanagement/v1/servicemanagement-api.json
@@ -1,2296 +1,12 @@
{
- "ownerDomain": "google.com",
- "name": "servicemanagement",
- "batchPath": "batch",
- "fullyEncodeReservedExpansion": true,
- "title": "Google Service Management API",
- "ownerName": "Google",
- "resources": {
- "services": {
- "methods": {
- "list": {
- "flatPath": "v1/services",
- "path": "v1/services",
- "id": "servicemanagement.services.list",
- "description": "Lists managed services.\n\nReturns all public services. For authenticated users, also returns all\nservices the calling user has \"servicemanagement.services.get\" permission\nfor.\n\n**BETA:** If the caller specifies the `consumer_id`, it returns only the\nservices enabled on the consumer. The `consumer_id` must have the format\nof \"project:{PROJECT-ID}\".",
- "response": {
- "$ref": "ListServicesResponse"
- },
- "parameterOrder": [],
- "httpMethod": "GET",
- "parameters": {
- "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"
- },
- "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": {
- "description": "Token identifying which result to start with; returned by a previous list\ncall.",
- "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"
- ]
- },
- "create": {
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/service.management"
- ],
- "parameters": {},
- "flatPath": "v1/services",
- "path": "v1/services",
- "id": "servicemanagement.services.create",
- "description": "Creates a new managed service.\nPlease note one producer project can own no more than 20 services.\n\nOperation\u003cresponse: ManagedService\u003e",
- "request": {
- "$ref": "ManagedService"
- }
- },
- "generateConfigReport": {
- "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.",
- "response": {
- "$ref": "GenerateConfigReportResponse"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "parameters": {},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/service.management"
- ]
- },
- "get": {
- "description": "Gets a managed service. Authentication is required unless the service is\npublic.",
- "httpMethod": "GET",
- "parameterOrder": [
- "serviceName"
- ],
- "response": {
- "$ref": "ManagedService"
- },
- "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}",
- "id": "servicemanagement.services.get",
- "path": "v1/services/{serviceName}"
- },
- "testIamPermissions": {
- "request": {
- "$ref": "TestIamPermissionsRequest"
- },
- "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning.",
- "response": {
- "$ref": "TestIamPermissionsResponse"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
- "parameters": {
- "resource": {
- "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
- "required": true,
- "type": "string",
- "pattern": "^services/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/service.management",
- "https://www.googleapis.com/auth/service.management.readonly"
- ],
- "flatPath": "v1/services/{servicesId}:testIamPermissions",
- "path": "v1/{+resource}:testIamPermissions",
- "id": "servicemanagement.services.testIamPermissions"
- },
- "getConfig": {
- "description": "Gets a service configuration (version) for a managed service.",
- "httpMethod": "GET",
- "parameterOrder": [
- "serviceName"
- ],
- "response": {
- "$ref": "Service"
- },
- "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": "query",
- "description": "The id of the service configuration resource.",
- "type": "string"
- },
- "view": {
- "location": "query",
- "enum": [
- "BASIC",
- "FULL"
- ],
- "description": "Specifies which parts of the Service Config should be returned in the\nresponse.",
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/service.management",
- "https://www.googleapis.com/auth/service.management.readonly"
- ],
- "flatPath": "v1/services/{serviceName}/config",
- "id": "servicemanagement.services.getConfig",
- "path": "v1/services/{serviceName}/config"
- },
- "delete": {
- "flatPath": "v1/services/{serviceName}",
- "id": "servicemanagement.services.delete",
- "path": "v1/services/{serviceName}",
- "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",
- "httpMethod": "DELETE",
- "parameterOrder": [
- "serviceName"
- ],
- "response": {
- "$ref": "Operation"
- },
- "parameters": {
- "serviceName": {
- "description": "The name of the service. See the [overview](/service-management/overview)\nfor naming requirements. For example: `example.googleapis.com`.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/service.management"
- ]
- },
- "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",
- "httpMethod": "POST",
- "parameterOrder": [
- "serviceName"
- ],
- "response": {
- "$ref": "Operation"
- },
- "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",
- "id": "servicemanagement.services.enable",
- "path": "v1/services/{serviceName}:enable"
- },
- "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": "^services/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/service.management"
- ],
- "flatPath": "v1/services/{servicesId}:setIamPolicy",
- "path": "v1/{+resource}:setIamPolicy",
- "id": "servicemanagement.services.setIamPolicy"
- },
- "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",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "serviceName"
- ],
- "httpMethod": "POST",
- "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"
- }
- },
- "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"
- },
- "getIamPolicy": {
- "description": "Gets the access control policy for a resource.\nReturns an empty policy if the resource exists and does not have a policy\nset.",
- "request": {
- "$ref": "GetIamPolicyRequest"
- },
- "response": {
- "$ref": "Policy"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/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 is being requested.\nSee the operation documentation for the appropriate value for this field.",
- "required": true,
- "type": "string",
- "pattern": "^services/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1/services/{servicesId}:getIamPolicy",
- "path": "v1/{+resource}:getIamPolicy",
- "id": "servicemanagement.services.getIamPolicy"
- },
- "undelete": {
- "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}:undelete",
- "path": "v1/services/{serviceName}:undelete",
- "id": "servicemanagement.services.undelete",
- "description": "Revives a previously deleted managed service. The method restores the\nservice using the configuration at the time the service was deleted.\nThe target service must exist and must have been deleted within the\nlast 30 days.\n\nOperation\u003cresponse: UndeleteServiceResponse\u003e"
- }
- },
- "resources": {
- "configs": {
- "methods": {
- "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": {
- "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",
- "path": "v1/services/{serviceName}/configs",
- "id": "servicemanagement.services.configs.list"
- },
- "get": {
- "description": "Gets a service configuration (version) for a managed service.",
- "httpMethod": "GET",
- "parameterOrder": [
- "serviceName",
- "configId"
- ],
- "response": {
- "$ref": "Service"
- },
- "parameters": {
- "view": {
- "description": "Specifies which parts of the Service Config should be returned in the\nresponse.",
- "type": "string",
- "location": "query",
- "enum": [
- "BASIC",
- "FULL"
- ]
- },
- "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"
- }
- },
- "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}",
- "id": "servicemanagement.services.configs.get",
- "path": "v1/services/{serviceName}/configs/{configId}"
- },
- "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",
- "path": "v1/services/{serviceName}/configs",
- "id": "servicemanagement.services.configs.create"
- }
- }
- },
- "consumers": {
- "methods": {
- "setIamPolicy": {
- "flatPath": "v1/services/{servicesId}/consumers/{consumersId}:setIamPolicy",
- "path": "v1/{+resource}:setIamPolicy",
- "id": "servicemanagement.services.consumers.setIamPolicy",
- "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.",
- "request": {
- "$ref": "SetIamPolicyRequest"
- },
- "response": {
- "$ref": "Policy"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/service.management"
- ],
- "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": "^services/[^/]+/consumers/[^/]+$"
- }
- }
- },
- "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": "^services/[^/]+/consumers/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/service.management",
- "https://www.googleapis.com/auth/service.management.readonly"
- ],
- "flatPath": "v1/services/{servicesId}/consumers/{consumersId}:testIamPermissions",
- "path": "v1/{+resource}:testIamPermissions",
- "id": "servicemanagement.services.consumers.testIamPermissions",
- "request": {
- "$ref": "TestIamPermissionsRequest"
- },
- "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning."
- },
- "getIamPolicy": {
- "description": "Gets the access control policy for a resource.\nReturns an empty policy if the resource exists and does not have a policy\nset.",
- "request": {
- "$ref": "GetIamPolicyRequest"
- },
- "response": {
- "$ref": "Policy"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/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 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}:getIamPolicy",
- "path": "v1/{+resource}:getIamPolicy",
- "id": "servicemanagement.services.consumers.getIamPolicy"
- }
- }
- },
- "rollouts": {
- "methods": {
- "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": {
- "pageSize": {
- "description": "The max number of items to include in the response list.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- },
- "filter": {
- "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",
- "location": "query"
- },
- "serviceName": {
- "location": "path",
- "description": "The name of the service. See the [overview](/service-management/overview)\nfor naming requirements. For example: `example.googleapis.com`.",
- "required": true,
- "type": "string"
- },
- "pageToken": {
- "description": "The token of the page to retrieve.",
- "type": "string",
- "location": "query"
- }
- },
- "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"
- },
- "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": {
- "description": "The name of the service. See the [overview](/service-management/overview)\nfor naming requirements. For example: `example.googleapis.com`.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "rolloutId": {
- "location": "path",
- "description": "The id of the rollout resource.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1/services/{serviceName}/rollouts/{rolloutId}",
- "path": "v1/services/{serviceName}/rollouts/{rolloutId}",
- "id": "servicemanagement.services.rollouts.get",
- "description": "Gets a service configuration rollout."
- },
- "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",
- "path": "v1/services/{serviceName}/rollouts",
- "id": "servicemanagement.services.rollouts.create"
- }
- }
- }
- }
- },
- "operations": {
- "methods": {
- "list": {
- "response": {
- "$ref": "ListOperationsResponse"
- },
- "parameterOrder": [],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/service.management"
- ],
- "parameters": {
- "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"
- },
- "name": {
- "location": "query",
- "description": "Not used.",
- "type": "string"
- },
- "pageToken": {
- "description": "The standard list page token.",
- "type": "string",
- "location": "query"
- }
- },
- "flatPath": "v1/operations",
- "path": "v1/operations",
- "id": "servicemanagement.operations.list",
- "description": "Lists service operations that match the specified filter in the request."
- },
- "get": {
- "description": "Gets the latest state of a long-running operation. Clients can use this\nmethod to poll the operation result at intervals as recommended by the API\nservice.",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "parameters": {
- "name": {
- "location": "path",
- "description": "The name of the operation resource.",
- "required": true,
- "type": "string",
- "pattern": "^operations/.+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/service.management"
- ],
- "flatPath": "v1/operations/{operationsId}",
- "path": "v1/{+name}",
- "id": "servicemanagement.operations.get"
- }
- }
- }
- },
- "parameters": {
- "quotaUser": {
- "location": "query",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string"
- },
- "pp": {
- "description": "Pretty-print response.",
- "type": "boolean",
- "default": "true",
- "location": "query"
- },
- "bearer_token": {
- "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": {
- "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": {
- "description": "V1 error format.",
- "type": "string",
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query",
- "enum": [
- "1",
- "2"
- ]
- },
- "alt": {
- "type": "string",
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query",
- "description": "Data format for response.",
- "default": "json",
- "enum": [
- "json",
- "media",
- "proto"
- ]
- },
- "key": {
- "location": "query",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string"
- },
- "access_token": {
- "location": "query",
- "description": "OAuth access token.",
- "type": "string"
- }
- },
- "version": "v1",
- "baseUrl": "https://servicemanagement.googleapis.com/",
- "servicePath": "",
- "description": "Google Service Management allows service producers to publish their services on Google Cloud Platform so that they can be discovered and used by service consumers.",
- "kind": "discovery#restDescription",
"basePath": "",
+ "id": "servicemanagement:v1",
"documentationLink": "https://cloud.google.com/service-management/",
"revision": "20171216",
- "id": "servicemanagement:v1",
"discoveryVersion": "v1",
"schemas": {
- "Page": {
- "description": "Represents a documentation page. A page can contain subpages to represent\nnested documentation set structure.",
- "type": "object",
- "properties": {
- "subpages": {
- "description": "Subpages of this page. The order of subpages specified here will be\nhonored in the generated docset.",
- "type": "array",
- "items": {
- "$ref": "Page"
- }
- },
- "name": {
- "description": "The name of the page. It will be used as an identity of the page to\ngenerate URI of the page, text of the link to this page in navigation,\netc. The full page name (start from the root page name to this page\nconcatenated with `.`) can be used as reference to the page in your\ndocumentation. For example:\n\u003cpre\u003e\u003ccode\u003epages:\n- name: Tutorial\n content: (== include tutorial.md ==)\n subpages:\n - name: Java\n content: (== include tutorial_java.md ==)\n\u003c/code\u003e\u003c/pre\u003e\nYou can reference `Java` page using Markdown reference link syntax:\n`Java`.",
- "type": "string"
- },
- "content": {
- "description": "The Markdown content of the page. You can use \u003ccode\u003e(== include {path} ==)\u003c/code\u003e\nto include content from a Markdown file.",
- "type": "string"
- }
- },
- "id": "Page"
- },
- "Status": {
- "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
- "type": "object",
- "properties": {
- "details": {
- "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.",
- "type": "array",
- "items": {
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- },
- "type": "object"
- }
- },
- "code": {
- "description": "The status code, which should be an enum value of google.rpc.Code.",
- "format": "int32",
- "type": "integer"
- },
- "message": {
- "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
- "type": "string"
- }
- },
- "id": "Status"
- },
- "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"
- },
- "AuthProvider": {
- "description": "Configuration for an anthentication provider, including support for\n[JSON Web Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32).",
- "type": "object",
- "properties": {
- "jwksUri": {
- "description": "URL of the provider's public key set to validate signature of the JWT. See\n[OpenID Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata).\nOptional if the key set document:\n - can be retrieved from\n [OpenID Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html\n of the issuer.\n - can be inferred from the email domain of the issuer (e.g. a Google service account).\n\nExample: https://www.googleapis.com/oauth2/v1/certs",
- "type": "string"
- },
- "audiences": {
- "description": "The list of JWT\n[audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3).\nthat are allowed to access. A JWT containing any of these audiences will\nbe accepted. When this setting is absent, only JWTs with audience\n\"https://Service_name/API_name\"\nwill be accepted. For example, if no audiences are in the setting,\nLibraryService API will only accept JWTs with the following audience\n\"https://library-example.googleapis.com/google.example.library.v1.LibraryService\".\n\nExample:\n\n audiences: bookstore_android.apps.googleusercontent.com,\n bookstore_web.apps.googleusercontent.com",
- "type": "string"
- },
- "id": {
- "description": "The unique identifier of the auth provider. It will be referred to by\n`AuthRequirement.provider_id`.\n\nExample: \"bookstore_auth\".",
- "type": "string"
- },
- "issuer": {
- "description": "Identifies the principal that issued the JWT. See\nhttps://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.1\nUsually a URL or an email address.\n\nExample: https://securetoken.google.com\nExample: 1234567-compute@developer.gserviceaccount.com",
- "type": "string"
- },
- "authorizationUrl": {
- "description": "Redirect URL if JWT token is required but no present or is expired.\nImplement authorizationUrl of securityDefinitions in OpenAPI spec.",
- "type": "string"
- }
- },
- "id": "AuthProvider"
- },
- "Service": {
- "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": {
- "$ref": "Authentication",
- "description": "Auth configuration."
- },
- "experimental": {
- "description": "Experimental configuration.",
- "$ref": "Experimental"
- },
- "control": {
- "$ref": "Control",
- "description": "Configuration for the service control plane."
- },
- "configVersion": {
- "description": "The semantic version of the service configuration. The config version\naffects the interpretation of the service configuration. For example,\ncertain features are enabled by default for certain config versions.\nThe latest config version is `3`.",
- "format": "uint32",
- "type": "integer"
- },
- "monitoring": {
- "$ref": "Monitoring",
- "description": "Monitoring configuration."
- },
- "systemTypes": {
- "description": "A list of all proto message types included in this API service.\nIt serves similar purpose as [google.api.Service.types], except that\nthese types are not needed by user-defined APIs. Therefore, they will not\nshow up in the generated discovery doc. This field should only be used\nto define system APIs in ESF.",
- "type": "array",
- "items": {
- "$ref": "Type"
- }
- },
- "producerProjectId": {
- "description": "The Google project that owns this service.",
- "type": "string"
- },
- "visibility": {
- "description": "API visibility configuration.",
- "$ref": "Visibility"
- },
- "quota": {
- "description": "Quota configuration.",
- "$ref": "Quota"
- },
- "name": {
- "description": "The DNS address at which this service is available,\ne.g. `calendar.googleapis.com`.",
- "type": "string"
- },
- "billing": {
- "description": "Billing configuration.",
- "$ref": "Billing"
- },
- "customError": {
- "description": "Custom error configuration.",
- "$ref": "CustomError"
- },
- "title": {
- "description": "The product title for this service.",
- "type": "string"
- },
- "endpoints": {
- "description": "Configuration for network endpoints. If this is empty, then an endpoint\nwith the same name as the service is automatically generated to service all\ndefined APIs.",
- "type": "array",
- "items": {
- "$ref": "Endpoint"
- }
- },
- "apis": {
- "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": {
- "$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": {
- "$ref": "SystemParameters",
- "description": "System parameter configuration."
- },
- "documentation": {
- "$ref": "Documentation",
- "description": "Additional API documentation."
- },
- "monitoredResources": {
- "description": "Defines the monitored resources used by this service. This is required\nby the Service.monitoring and Service.logging configurations.",
- "type": "array",
- "items": {
- "$ref": "MonitoredResourceDescriptor"
- }
- },
- "logging": {
- "$ref": "Logging",
- "description": "Logging configuration."
- },
- "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"
- }
- }
- },
- "id": "Service"
- },
- "EnumValue": {
- "description": "Enum value definition.",
- "type": "object",
- "properties": {
- "name": {
- "description": "Enum value name.",
- "type": "string"
- },
- "options": {
- "description": "Protocol buffer options.",
- "type": "array",
- "items": {
- "$ref": "Option"
- }
- },
- "number": {
- "description": "Enum value number.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "EnumValue"
- },
- "ListOperationsResponse": {
- "description": "The response message for Operations.ListOperations.",
- "type": "object",
- "properties": {
- "nextPageToken": {
- "description": "The standard List next-page token.",
- "type": "string"
- },
- "operations": {
- "description": "A list of operations that matches the specified filter in the request.",
- "type": "array",
- "items": {
- "$ref": "Operation"
- }
- }
- },
- "id": "ListOperationsResponse"
- },
- "CustomHttpPattern": {
- "description": "A custom pattern is used for defining custom HTTP verb.",
- "type": "object",
- "properties": {
- "kind": {
- "description": "The name of this custom HTTP verb.",
- "type": "string"
- },
- "path": {
- "description": "The path matched by this custom verb.",
- "type": "string"
- }
- },
- "id": "CustomHttpPattern"
- },
- "OperationMetadata": {
- "description": "The metadata associated with a long running operation resource.",
- "type": "object",
- "properties": {
- "startTime": {
- "description": "The start time of the operation.",
- "format": "google-datetime",
- "type": "string"
- },
- "resourceNames": {
- "description": "The full name of the resources that this operation is directly\nassociated with.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "steps": {
- "description": "Detailed status information for each step. The order is undetermined.",
- "type": "array",
- "items": {
- "$ref": "Step"
- }
- },
- "progressPercentage": {
- "description": "Percentage of completion of this operation, ranging from 0 to 100.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "OperationMetadata"
- },
- "SystemParameterRule": {
- "description": "Define a system parameter rule mapping system parameter definitions to\nmethods.",
- "type": "object",
- "properties": {
- "selector": {
- "description": "Selects the methods to which this rule applies. Use '*' to indicate all\nmethods in all APIs.\n\nRefer to selector for syntax details.",
- "type": "string"
- },
- "parameters": {
- "description": "Define parameters. Multiple names may be defined for a parameter.\nFor a given method call, only one of them should be used. If multiple\nnames are used the behavior is implementation-dependent.\nIf none of the specified names are present the behavior is\nparameter-dependent.",
- "type": "array",
- "items": {
- "$ref": "SystemParameter"
- }
- }
- },
- "id": "SystemParameterRule"
- },
- "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": {
- "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"
- },
- "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": {
- "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"
- }
- },
- "id": "HttpRule"
- },
- "VisibilityRule": {
- "description": "A visibility rule provides visibility configuration for an individual API\nelement.",
- "type": "object",
- "properties": {
- "restriction": {
- "description": "A comma-separated list of visibility labels that apply to the `selector`.\nAny of the listed labels can be used to grant the visibility.\n\nIf a rule has multiple labels, removing one of the labels but not all of\nthem can break clients.\n\nExample:\n\n visibility:\n rules:\n - selector: google.calendar.Calendar.EnhancedSearch\n restriction: GOOGLE_INTERNAL, TRUSTED_TESTER\n\nRemoving GOOGLE_INTERNAL from this restriction will break clients that\nrely on this method and only had access to it through GOOGLE_INTERNAL.",
- "type": "string"
- },
- "selector": {
- "description": "Selects methods, messages, fields, enums, etc. to which this rule applies.\n\nRefer to selector for syntax details.",
- "type": "string"
- }
- },
- "id": "VisibilityRule"
- },
- "MonitoringDestination": {
- "description": "Configuration of a specific monitoring destination (the producer project\nor the consumer project).",
- "type": "object",
- "properties": {
- "monitoredResource": {
- "description": "The monitored resource type. The type must be defined in\nService.monitored_resources section.",
- "type": "string"
- },
- "metrics": {
- "description": "Names of the metrics to report to this monitoring destination.\nEach name must be defined in Service.metrics section.",
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "id": "MonitoringDestination"
- },
- "Visibility": {
- "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"
- },
- "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": {
- "changeType": {
- "enumDescriptions": [
- "No value was provided.",
- "The changed object exists in the 'new' service configuration, but not\nin the 'old' service configuration.",
- "The changed object exists in the 'old' service configuration, but not\nin the 'new' service configuration.",
- "The changed object exists in both service configurations, but its value\nis different."
- ],
- "enum": [
- "CHANGE_TYPE_UNSPECIFIED",
- "ADDED",
- "REMOVED",
- "MODIFIED"
- ],
- "description": "The type for this change, either ADDED, REMOVED, or MODIFIED.",
- "type": "string"
- },
- "element": {
- "description": "Object hierarchy path to the change, with levels separated by a '.'\ncharacter. For repeated fields, an applicable unique identifier field is\nused for the index (usually selector, name, or id). For maps, the term\n'key' is used. If the field has no unique identifier, the numeric index\nis used.\nExamples:\n- visibility.rules[selector==\"google.LibraryService.CreateBook\"].restriction\n- quota.metric_rules[selector==\"google\"].metric_costs[key==\"reads\"].value\n- logging.producer_destinations[0]",
- "type": "string"
- },
- "oldValue": {
- "description": "Value of the changed object in the old Service configuration,\nin JSON format. This field will not be populated if ChangeType == ADDED.",
- "type": "string"
- },
- "advices": {
- "description": "Collection of advice provided for this change, useful for determining the\npossible impact of this change.",
- "type": "array",
- "items": {
- "$ref": "Advice"
- }
- },
- "newValue": {
- "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"
- }
- },
- "id": "ConfigChange"
- },
- "SystemParameters": {
- "description": "### System parameter configuration\n\nA system parameter is a special kind of parameter defined by the API\nsystem, not by an individual API. It is typically mapped to an HTTP header\nand/or a URL query parameter. This configuration specifies which methods\nchange the names of the system parameters.",
- "type": "object",
- "properties": {
- "rules": {
- "description": "Define system parameters.\n\nThe parameters defined here will override the default parameters\nimplemented by the system. If this field is missing from the service\nconfig, default system parameters will be used. Default system parameters\nand names is implementation-dependent.\n\nExample: define api key for all methods\n\n system_parameters\n rules:\n - selector: \"*\"\n parameters:\n - name: api_key\n url_query_parameter: api_key\n\n\nExample: define 2 api key names for a specific method.\n\n system_parameters\n rules:\n - selector: \"/ListShelves\"\n parameters:\n - name: api_key\n http_header: Api-Key1\n - name: api_key\n http_header: Api-Key2\n\n**NOTE:** All service configuration rules follow \"last one wins\" order.",
- "type": "array",
- "items": {
- "$ref": "SystemParameterRule"
- }
- }
- },
- "id": "SystemParameters"
- },
- "Rollout": {
- "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": {
- "description": "The status of this rollout. Readonly. In case of a failed rollout,\nthe system will automatically rollback to the current Rollout\nversion. Readonly.",
- "type": "string",
- "enumDescriptions": [
- "No status specified.",
- "The Rollout is in progress.",
- "The Rollout has completed successfully.",
- "The Rollout has been cancelled. This can happen if you have overlapping\nRollout pushes, and the previous ones will be cancelled.",
- "The Rollout has failed and the rollback attempt has failed too.",
- "The Rollout has not started yet and is pending for execution.",
- "The Rollout has failed and rolled back to the previous successful\nRollout."
- ],
- "enum": [
- "ROLLOUT_STATUS_UNSPECIFIED",
- "IN_PROGRESS",
- "SUCCESS",
- "CANCELLED",
- "FAILED",
- "PENDING",
- "FAILED_ROLLED_BACK"
- ]
- },
- "serviceName": {
- "description": "The name of the service associated with this Rollout.",
- "type": "string"
- },
- "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": {
- "description": "The strategy associated with a rollout to delete a `ManagedService`.\nReadonly.",
- "$ref": "DeleteServiceStrategy"
- }
- },
- "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": {
- "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": {
- "description": "Service configuration for which we want to generate the report.\nFor this version of API, the supported types are\ngoogle.api.servicemanagement.v1.ConfigRef,\ngoogle.api.servicemanagement.v1.ConfigSource,\nand google.api.Service",
- "type": "object",
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- }
- }
- },
- "id": "GenerateConfigReportRequest"
- },
- "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"
- },
- "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": {
- "description": {
- "description": "The short description of the step.",
- "type": "string"
- },
- "status": {
- "description": "The status code.",
- "type": "string",
- "enumDescriptions": [
- "Unspecifed code.",
- "The operation or step has completed without errors.",
- "The operation or step has not started yet.",
- "The operation or step is in progress.",
- "The operation or step has completed with errors. If the operation is\nrollbackable, the rollback completed with errors too.",
- "The operation or step has completed with cancellation."
- ],
- "enum": [
- "STATUS_UNSPECIFIED",
- "DONE",
- "NOT_STARTED",
- "IN_PROGRESS",
- "FAILED",
- "CANCELLED"
- ]
- }
- },
- "id": "Step"
- },
- "LoggingDestination": {
- "description": "Configuration of a specific logging destination (the producer project\nor the consumer project).",
- "type": "object",
- "properties": {
- "logs": {
- "description": "Names of the logs to be sent to this destination. Each name must\nbe defined in the Service.logs section. If the log name is\nnot a domain scoped name, it will be automatically prefixed with\nthe service name followed by \"/\".",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "monitoredResource": {
- "description": "The monitored resource type. The type must be defined in the\nService.monitored_resources section.",
- "type": "string"
- }
- },
- "id": "LoggingDestination"
- },
- "Option": {
- "description": "A protocol buffer option, which can be attached to a message, field,\nenumeration, etc.",
- "type": "object",
- "properties": {
- "name": {
- "description": "The option's name. For protobuf built-in options (options defined in\ndescriptor.proto), this is the short name. For example, `\"map_entry\"`.\nFor custom options, it should be the fully-qualified name. For example,\n`\"google.api.http\"`.",
- "type": "string"
- },
- "value": {
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- },
- "description": "The option's value packed in an Any message. If the value is a primitive,\nthe corresponding wrapper type defined in google/protobuf/wrappers.proto\nshould be used. If the value is an enum, it should be stored as an int32\nvalue using the google.protobuf.Int32Value type.",
- "type": "object"
- }
- },
- "id": "Option"
- },
- "Logging": {
- "description": "Logging configuration of the service.\n\nThe following example shows how to configure logs to be sent to the\nproducer and consumer projects. In the example, the `activity_history`\nlog is sent to both the producer and consumer projects, whereas the\n`purchase_history` log is only sent to the producer project.\n\n monitored_resources:\n - type: library.googleapis.com/branch\n labels:\n - key: /city\n description: The city where the library branch is located in.\n - key: /name\n description: The name of the branch.\n logs:\n - name: activity_history\n labels:\n - key: /customer_id\n - name: purchase_history\n logging:\n producer_destinations:\n - monitored_resource: library.googleapis.com/branch\n logs:\n - activity_history\n - purchase_history\n consumer_destinations:\n - monitored_resource: library.googleapis.com/branch\n logs:\n - activity_history",
- "type": "object",
- "properties": {
- "consumerDestinations": {
- "description": "Logging configurations for sending logs to the consumer project.\nThere can be multiple consumer destinations, each one must have a\ndifferent monitored resource type. A log can be used in at most\none consumer destination.",
- "type": "array",
- "items": {
- "$ref": "LoggingDestination"
- }
- },
- "producerDestinations": {
- "description": "Logging configurations for sending logs to the producer project.\nThere can be multiple producer destinations, each one must have a\ndifferent monitored resource type. A log can be used in at most\none producer destination.",
- "type": "array",
- "items": {
- "$ref": "LoggingDestination"
- }
- }
- },
- "id": "Logging"
- },
- "QuotaLimit": {
- "description": "`QuotaLimit` defines a specific limit that applies over a specified duration\nfor a limit type. There can be at most one limit for a duration and limit\ntype combination defined within a `QuotaGroup`.",
- "type": "object",
- "properties": {
- "description": {
- "description": "Optional. User-visible, extended description for this quota limit.\nShould be used only when more context is needed to understand this limit\nthan provided by the limit's display name (see: `display_name`).",
- "type": "string"
- },
- "metric": {
- "description": "The name of the metric this quota limit applies to. The quota limits with\nthe same metric will be checked together during runtime. The metric must be\ndefined within the service config.",
- "type": "string"
- },
- "displayName": {
- "description": "User-visible display name for this limit.\nOptional. If not set, the UI will provide a default display name based on\nthe quota configuration. This field can be used to override the default\ndisplay name generated from the configuration.",
- "type": "string"
- },
- "values": {
- "additionalProperties": {
- "format": "int64",
- "type": "string"
- },
- "description": "Tiered limit values. You must specify this as a key:value pair, with an\ninteger value that is the maximum number of requests allowed for the\nspecified unit. Currently only STANDARD is supported.",
- "type": "object"
- },
- "unit": {
- "description": "Specify the unit of the quota limit. It uses the same syntax as\nMetric.unit. The supported unit kinds are determined by the quota\nbackend system.\n\nHere are some examples:\n* \"1/min/{project}\" for quota per minute per project.\n\nNote: the order of unit components is insignificant.\nThe \"1\" at the beginning is required to follow the metric unit syntax.",
- "type": "string"
- },
- "maxLimit": {
- "description": "Maximum number of tokens that can be consumed during the specified\nduration. Client application developers can override the default limit up\nto this maximum. If specified, this value cannot be set to a value less\nthan the default limit. If not specified, it is set to the default limit.\n\nTo allow clients to apply overrides with no upper bound, set this to -1,\nindicating unlimited maximum quota.\n\nUsed by group-based quotas only.",
- "format": "int64",
- "type": "string"
- },
- "name": {
- "description": "Name of the quota limit.\n\nThe name must be provided, and it must be unique within the service. The\nname can only include alphanumeric characters as well as '-'.\n\nThe maximum length of the limit name is 64 characters.",
- "type": "string"
- },
- "duration": {
- "description": "Duration of this limit in textual notation. Example: \"100s\", \"24h\", \"1d\".\nFor duration longer than a day, only multiple of days is supported. We\nsupport only \"100s\" and \"1d\" for now. Additional support will be added in\nthe future. \"0\" indicates indefinite duration.\n\nUsed by group-based quotas only.",
- "type": "string"
- },
- "freeTier": {
- "description": "Free tier value displayed in the Developers Console for this limit.\nThe free tier is the number of tokens that will be subtracted from the\nbilled amount when billing is enabled.\nThis field can only be set on a limit with duration \"1d\", in a billable\ngroup; it is invalid on any other limit. If this field is not set, it\ndefaults to 0, indicating that there is no free tier for this service.\n\nUsed by group-based quotas only.",
- "format": "int64",
- "type": "string"
- },
- "defaultLimit": {
- "description": "Default number of tokens that can be consumed during the specified\nduration. This is the number of tokens assigned when a client\napplication developer activates the service for his/her project.\n\nSpecifying a value of 0 will block all requests. This can be used if you\nare provisioning quota to selected consumers and blocking others.\nSimilarly, a value of -1 will indicate an unlimited quota. No other\nnegative values are allowed.\n\nUsed by group-based quotas only.",
- "format": "int64",
- "type": "string"
- }
- },
- "id": "QuotaLimit"
- },
- "Method": {
- "description": "Method represents a method of an API interface.",
- "type": "object",
- "properties": {
- "requestTypeUrl": {
- "description": "A URL of the input message type.",
- "type": "string"
- },
- "requestStreaming": {
- "description": "If true, the request is streamed.",
- "type": "boolean"
- },
- "syntax": {
- "enumDescriptions": [
- "Syntax `proto2`.",
- "Syntax `proto3`."
- ],
- "enum": [
- "SYNTAX_PROTO2",
- "SYNTAX_PROTO3"
- ],
- "description": "The source syntax of this method.",
- "type": "string"
- },
- "responseTypeUrl": {
- "description": "The URL of the output message type.",
- "type": "string"
- },
- "options": {
- "description": "Any metadata attached to the method.",
- "type": "array",
- "items": {
- "$ref": "Option"
- }
- },
- "responseStreaming": {
- "description": "If true, the response is streamed.",
- "type": "boolean"
- },
- "name": {
- "description": "The simple name of this method.",
- "type": "string"
- }
- },
- "id": "Method"
- },
- "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": {
- "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": {
- "description": "The metadata associated with a long running operation resource.",
- "type": "object",
- "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": {
- "enumDescriptions": [
- "",
- "",
- "",
- "TenancyUnit, ServiceNetworking fall under this"
- ],
- "enum": [
- "UNSPECIFIED_OP_SERVICE",
- "SERVICE_MANAGEMENT",
- "SERVICE_USAGE",
- "SERVICE_CONSUMER_MANAGEMENT"
- ],
- "type": "string"
- }
- },
- "id": "FlowOperationMetadata"
- },
- "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": {
- "description": "Selects and configures the service controller used by the service. The\nservice controller handles features like abuse, quota, billing, logging,\nmonitoring, etc.",
- "type": "object",
- "properties": {
- "environment": {
- "description": "The service control environment to use. If empty, no control plane\nfeature (like quota and billing) will be enabled.",
- "type": "string"
- }
- },
- "id": "Control"
- },
- "SystemParameter": {
- "description": "Define a parameter's name and location. The parameter may be passed as either\nan HTTP header or a URL query parameter, and if both are passed the behavior\nis implementation-dependent.",
- "type": "object",
- "properties": {
- "httpHeader": {
- "description": "Define the HTTP header name to use for the parameter. It is case\ninsensitive.",
- "type": "string"
- },
- "name": {
- "description": "Define the name of the parameter, such as \"api_key\" . It is case sensitive.",
- "type": "string"
- },
- "urlQueryParameter": {
- "description": "Define the URL query parameter name to use for the parameter. It is case\nsensitive.",
- "type": "string"
- }
- },
- "id": "SystemParameter"
- },
- "Monitoring": {
- "description": "Monitoring configuration of the service.\n\nThe example below shows how to configure monitored resources and metrics\nfor monitoring. In the example, a monitored resource and two metrics are\ndefined. The `library.googleapis.com/book/returned_count` metric is sent\nto both producer and consumer projects, whereas the\n`library.googleapis.com/book/overdue_count` metric is only sent to the\nconsumer project.\n\n monitored_resources:\n - type: library.googleapis.com/branch\n labels:\n - key: /city\n description: The city where the library branch is located in.\n - key: /name\n description: The name of the branch.\n metrics:\n - name: library.googleapis.com/book/returned_count\n metric_kind: DELTA\n value_type: INT64\n labels:\n - key: /customer_id\n - name: library.googleapis.com/book/overdue_count\n metric_kind: GAUGE\n value_type: INT64\n labels:\n - key: /customer_id\n monitoring:\n producer_destinations:\n - monitored_resource: library.googleapis.com/branch\n metrics:\n - library.googleapis.com/book/returned_count\n consumer_destinations:\n - monitored_resource: library.googleapis.com/branch\n metrics:\n - library.googleapis.com/book/returned_count\n - library.googleapis.com/book/overdue_count",
- "type": "object",
- "properties": {
- "consumerDestinations": {
- "description": "Monitoring configurations for sending metrics to the consumer project.\nThere can be multiple consumer destinations, each one must have a\ndifferent monitored resource type. A metric can be used in at most\none consumer destination.",
- "type": "array",
- "items": {
- "$ref": "MonitoringDestination"
- }
- },
- "producerDestinations": {
- "description": "Monitoring configurations for sending metrics to the producer project.\nThere can be multiple producer destinations, each one must have a\ndifferent monitored resource type. A metric can be used in at most\none producer destination.",
- "type": "array",
- "items": {
- "$ref": "MonitoringDestination"
- }
- }
- },
- "id": "Monitoring"
- },
- "Field": {
- "description": "A single field of a message type.",
- "type": "object",
- "properties": {
- "jsonName": {
- "description": "The field JSON name.",
- "type": "string"
- },
- "kind": {
- "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."
- ],
- "enum": [
- "TYPE_UNKNOWN",
- "TYPE_DOUBLE",
- "TYPE_FLOAT",
- "TYPE_INT64",
- "TYPE_UINT64",
- "TYPE_INT32",
- "TYPE_FIXED64",
- "TYPE_FIXED32",
- "TYPE_BOOL",
- "TYPE_STRING",
- "TYPE_GROUP",
- "TYPE_MESSAGE",
- "TYPE_BYTES",
- "TYPE_UINT32",
- "TYPE_ENUM",
- "TYPE_SFIXED32",
- "TYPE_SFIXED64",
- "TYPE_SINT32",
- "TYPE_SINT64"
- ]
- },
- "options": {
- "description": "The protocol buffer options.",
- "type": "array",
- "items": {
- "$ref": "Option"
- }
- },
- "oneofIndex": {
- "description": "The index of the field type in `Type.oneofs`, for message or enumeration\ntypes. The first type has index 1; zero means the type is not in the list.",
- "format": "int32",
- "type": "integer"
- },
- "cardinality": {
- "enumDescriptions": [
- "For fields with unknown cardinality.",
- "For optional fields.",
- "For required fields. Proto2 syntax only.",
- "For repeated fields."
- ],
- "enum": [
- "CARDINALITY_UNKNOWN",
- "CARDINALITY_OPTIONAL",
- "CARDINALITY_REQUIRED",
- "CARDINALITY_REPEATED"
- ],
- "description": "The field cardinality.",
- "type": "string"
- },
- "packed": {
- "description": "Whether to use alternative packed wire representation.",
- "type": "boolean"
- },
- "defaultValue": {
- "description": "The string value of the default value of this field. Proto2 syntax only.",
- "type": "string"
- },
- "name": {
- "description": "The field name.",
- "type": "string"
- },
- "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"
- },
- "TestIamPermissionsRequest": {
- "description": "Request message for `TestIamPermissions` method.",
- "type": "object",
- "properties": {
- "permissions": {
- "description": "The set of permissions to check for the `resource`. Permissions with\nwildcards (such as '*' or 'storage.*') are not allowed. For more\ninformation see\n[IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).",
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "id": "TestIamPermissionsRequest"
- },
- "Enum": {
- "description": "Enum type definition.",
- "type": "object",
- "properties": {
- "options": {
- "description": "Protocol buffer options.",
- "type": "array",
- "items": {
- "$ref": "Option"
- }
- },
- "sourceContext": {
- "$ref": "SourceContext",
- "description": "The source context."
- },
- "syntax": {
- "description": "The source syntax.",
- "type": "string",
- "enumDescriptions": [
- "Syntax `proto2`.",
- "Syntax `proto3`."
- ],
- "enum": [
- "SYNTAX_PROTO2",
- "SYNTAX_PROTO3"
- ]
- },
- "name": {
- "description": "Enum type name.",
- "type": "string"
- },
- "enumvalue": {
- "description": "Enum value definitions.",
- "type": "array",
- "items": {
- "$ref": "EnumValue"
- }
- }
- },
- "id": "Enum"
- },
- "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"
- },
- "Diagnostic": {
- "description": "Represents a diagnostic message (error or warning)",
- "type": "object",
- "properties": {
- "location": {
- "description": "File name and line number of the error or warning.",
- "type": "string"
- },
- "kind": {
- "description": "The kind of diagnostic information provided.",
- "type": "string",
- "enumDescriptions": [
- "Warnings and errors",
- "Only errors"
- ],
- "enum": [
- "WARNING",
- "ERROR"
- ]
- },
- "message": {
- "description": "Message describing the error or warning.",
- "type": "string"
- }
- },
- "id": "Diagnostic"
- },
- "LabelDescriptor": {
- "description": "A description of a label.",
- "type": "object",
- "properties": {
- "description": {
- "description": "A human-readable description for the label.",
- "type": "string"
- },
- "valueType": {
- "enumDescriptions": [
- "A variable-length string. This is the default.",
- "Boolean; true or false.",
- "A 64-bit signed integer."
- ],
- "enum": [
- "STRING",
- "BOOL",
- "INT64"
- ],
- "description": "The type of data that can be assigned to the label.",
- "type": "string"
- },
- "key": {
- "description": "The label key.",
- "type": "string"
- }
- },
- "id": "LabelDescriptor"
- },
- "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"
- },
- "Type": {
- "description": "A protocol buffer message type.",
- "type": "object",
- "properties": {
- "options": {
- "description": "The protocol buffer options.",
- "type": "array",
- "items": {
- "$ref": "Option"
- }
- },
- "fields": {
- "description": "The list of fields.",
- "type": "array",
- "items": {
- "$ref": "Field"
- }
- },
- "name": {
- "description": "The fully qualified message name.",
- "type": "string"
- },
- "oneofs": {
- "description": "The list of types appearing in `oneof` definitions in this type.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "sourceContext": {
- "$ref": "SourceContext",
- "description": "The source context."
- },
- "syntax": {
- "enumDescriptions": [
- "Syntax `proto2`.",
- "Syntax `proto3`."
- ],
- "enum": [
- "SYNTAX_PROTO2",
- "SYNTAX_PROTO3"
- ],
- "description": "The source syntax.",
- "type": "string"
- }
- },
- "id": "Type"
- },
- "Experimental": {
- "description": "Experimental service configuration. These configuration options can\nonly be used by whitelisted users.",
- "type": "object",
- "properties": {
- "authorization": {
- "$ref": "AuthorizationConfig",
- "description": "Authorization configuration."
- }
- },
- "id": "Experimental"
- },
- "ListServiceConfigsResponse": {
- "description": "Response message for ListServiceConfigs method.",
- "type": "object",
- "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"
- },
- "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"
- },
- "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"
- },
- "SubmitConfigSourceRequest": {
- "description": "Request message for SubmitConfigSource method.",
- "type": "object",
- "properties": {
- "configSource": {
- "description": "The source configuration for the service.",
- "$ref": "ConfigSource"
- },
- "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"
- }
- },
- "id": "SubmitConfigSourceRequest"
- },
"AuthorizationConfig": {
+ "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",
"properties": {
@@ -2298,12 +14,9 @@
"description": "The name of the authorization provider, such as\nfirebaserules.googleapis.com.",
"type": "string"
}
- },
- "id": "AuthorizationConfig"
+ }
},
"DocumentationRule": {
- "description": "A documentation rule provides information about individual API elements.",
- "type": "object",
"properties": {
"description": {
"description": "Description of the selected API(s).",
@@ -2318,7 +31,9 @@
"type": "string"
}
},
- "id": "DocumentationRule"
+ "id": "DocumentationRule",
+ "description": "A documentation rule provides information about individual API elements.",
+ "type": "object"
},
"ContextRule": {
"description": "A context rule provides information about the context for an individual API\nelement.",
@@ -2336,11 +51,11 @@
}
},
"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."
}
},
"id": "ContextRule"
@@ -2360,16 +75,8 @@
"id": "Billing"
},
"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": {
- "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"
@@ -2416,43 +123,47 @@
"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": {
"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"
+ }
}
},
- "id": "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."
},
"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"
+ "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"
+ "id": "SourceContext",
+ "description": "`SourceContext` represents information about the source of a\nprotobuf element, like the file in which it is defined.",
+ "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": {
- "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": "Textual representation of an expression in\nCommon Expression Language syntax.\n\nThe application context of the containing message determines which\nwell-known feature set of CEL is supported."
},
"title": {
"description": "An optional title for the expression, i.e. a short string describing\nits purpose. This can be used e.g. in UIs which allow to enter the\nexpression.",
@@ -2461,6 +172,10 @@
"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"
}
},
"id": "Expr"
@@ -2477,8 +192,8 @@
}
},
"nextPageToken": {
- "description": "Token that can be passed to `ListServices` to resume a paginated query.",
- "type": "string"
+ "type": "string",
+ "description": "Token that can be passed to `ListServices` to resume a paginated query."
}
},
"id": "ListServicesResponse"
@@ -2502,8 +217,8 @@
}
},
"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"
+ "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": {
"description": "The canonical name of this endpoint.",
@@ -2517,48 +232,18 @@
"id": "Endpoint"
},
"OAuthRequirements": {
- "description": "OAuth scopes are a way to define data and permissions on data. For example,\nthere are scopes defined for \"Read-only access to Google Calendar\" and\n\"Access to Cloud Platform\". Users can consent to a scope for an application,\ngiving it permission to access that data on their behalf.\n\nOAuth scope specifications should be fairly coarse grained; a user will need\nto see and understand the text description of what your scope means.\n\nIn most cases: use one or at most two OAuth scopes for an entire family of\nproducts. If your product has multiple APIs, you should probably be sharing\nthe OAuth scope across all of those APIs.\n\nWhen you need finer grained OAuth consent screens: talk with your product\nmanagement about how developers will use them in practice.\n\nPlease note that even though each of the canonical scopes is enough for a\nrequest to be accepted and passed to the backend, a request can still fail\ndue to the backend requiring additional scopes or permissions.",
- "type": "object",
"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": {
- "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"
- },
- "rules": {
- "description": "A list of usage rules that apply to individual API methods.\n\n**NOTE:** All service configuration rules follow \"last one wins\" order.",
- "type": "array",
- "items": {
- "$ref": "UsageRule"
- }
- }
- },
- "id": "Usage"
- },
- "GetIamPolicyRequest": {
- "description": "Request message for `GetIamPolicy` method.",
- "type": "object",
- "properties": {},
- "id": "GetIamPolicyRequest"
+ "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"
},
"TestIamPermissionsResponse": {
+ "id": "TestIamPermissionsResponse",
"description": "Response message for `TestIamPermissions` method.",
"type": "object",
"properties": {
@@ -2569,8 +254,38 @@
"type": "string"
}
}
+ }
+ },
+ "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": "TestIamPermissionsResponse"
+ "id": "Usage"
},
"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`.",
@@ -2599,11 +314,11 @@
"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"
- }
+ },
+ "description": "The set of labels that are available to describe a specific log entry.\nRuntime requests that contain labels not specified here are\nconsidered invalid."
},
"name": {
"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 [/_-.].",
@@ -2616,18 +331,7 @@
"description": "Generic specification of a source configuration file",
"type": "object",
"properties": {
- "fileContents": {
- "description": "The bytes that constitute the file.",
- "format": "byte",
- "type": "string"
- },
- "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.",
@@ -2643,7 +347,18 @@
"OPEN_API_YAML",
"FILE_DESCRIPTOR_SET_PROTO",
"PROTO_FILE"
- ]
+ ],
+ "description": "The type of configuration file this represents.",
+ "type": "string"
+ },
+ "fileContents": {
+ "description": "The bytes that constitute the file.",
+ "format": "byte",
+ "type": "string"
+ },
+ "filePath": {
+ "description": "The file name of the configuration file (full or relative path).",
+ "type": "string"
}
},
"id": "ConfigFile"
@@ -2667,6 +382,17 @@
"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"
@@ -2678,17 +404,6 @@
"type": {
"description": "Required. The monitored resource type. For example, the type\n`\"cloudsql_database\"` represents databases in Google Cloud SQL.\nThe maximum length of this value is 256 characters.",
"type": "string"
- },
- "labels": {
- "description": "Required. A set of labels used to describe instances of this monitored\nresource type. For example, an individual Google Cloud SQL database is\nidentified by values for the labels `\"database_id\"` and `\"zone\"`.",
- "type": "array",
- "items": {
- "$ref": "LabelDescriptor"
- }
- },
- "name": {
- "description": "Optional. The resource name of the monitored resource descriptor:\n`\"projects/{project_id}/monitoredResourceDescriptors/{type}\"` where\n{type} is the value of the `type` field in this object and\n{project_id} is a project ID that provides API-specific context for\naccessing the type. APIs that do not use project information can use the\nresource name format `\"monitoredResourceDescriptors/{type}\"`.",
- "type": "string"
}
},
"id": "MonitoredResourceDescriptor"
@@ -2705,9 +420,11 @@
"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": {
+ "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"
@@ -2720,21 +437,19 @@
"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"
+ "maxDirectDownloadSize": {
+ "description": "Optional maximum acceptable size for direct download.\nThe size is specified in bytes.",
+ "format": "int64",
+ "type": "string"
}
},
- "id": "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"
},
"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.",
@@ -2751,6 +466,7 @@
"id": "ChangeReport"
},
"DisableServiceRequest": {
+ "id": "DisableServiceRequest",
"description": "Request message for DisableService method.",
"type": "object",
"properties": {
@@ -2758,16 +474,15 @@
"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"
+ "$ref": "Service",
+ "description": "The generated service configuration."
}
},
"id": "SubmitConfigSourceResponse"
@@ -2776,11 +491,6 @@
"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",
@@ -2788,6 +498,15 @@
"type": "string"
}
},
+ "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"
@@ -2796,10 +515,6 @@
"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"
@@ -2809,8 +524,8 @@
"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"
+ "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."
}
},
"id": "MediaUpload"
@@ -2820,8 +535,8 @@
"type": "object",
"properties": {
"monitoredResource": {
- "description": "The monitored resource type. The type must be defined in\nService.monitored_resources section.",
- "type": "string"
+ "type": "string",
+ "description": "The monitored resource type. The type must be defined in\nService.monitored_resources section."
},
"metrics": {
"description": "Names of the metrics to report to this billing destination.\nEach name must be defined in Service.metrics section.",
@@ -2845,19 +560,19 @@
"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"
+ },
+ "serviceName": {
+ "description": "The name of the service. See the [overview](/service-management/overview)\nfor naming requirements.",
+ "type": "string"
}
},
- "id": "ManagedService"
+ "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",
@@ -2912,13 +627,20 @@
"description": "`Documentation` provides the information for describing a service.\n\nExample:\n\u003cpre\u003e\u003ccode\u003edocumentation:\n summary: \u003e\n The Google Calendar API gives access\n to most calendar features.\n pages:\n - name: Overview\n content: (== include google/foo/overview.md ==)\n - name: Tutorial\n content: (== include google/foo/tutorial.md ==)\n subpages;\n - name: Java\n content: (== include google/foo/tutorial_java.md ==)\n rules:\n - selector: google.calendar.Calendar.Get\n description: \u003e\n ...\n - selector: google.calendar.Calendar.Put\n description: \u003e\n ...\n\u003c/code\u003e\u003c/pre\u003e\nDocumentation is provided in markdown syntax. In addition to\nstandard markdown features, definition lists, tables and fenced\ncode blocks are supported. Section headers can be provided and are\ninterpreted relative to the section nesting of the context where\na documentation fragment is embedded.\n\nDocumentation from the IDL is merged with documentation defined\nvia the config at normalization time, where documentation provided\nby config rules overrides IDL provided.\n\nA number of constructs specific to the API platform are supported\nin documentation text.\n\nIn order to reference a proto element, the following\nnotation can be used:\n\u003cpre\u003e\u003ccode\u003e[fully.qualified.proto.name][]\u003c/code\u003e\u003c/pre\u003e\nTo override the display text used for the link, this can be used:\n\u003cpre\u003e\u003ccode\u003e[display text][fully.qualified.proto.name]\u003c/code\u003e\u003c/pre\u003e\nText can be excluded from doc using the following notation:\n\u003cpre\u003e\u003ccode\u003e(-- internal comment --)\u003c/code\u003e\u003c/pre\u003e\nComments can be made conditional using a visibility label. The below\ntext will be only rendered if the `BETA` label is available:\n\u003cpre\u003e\u003ccode\u003e(--BETA: comment for BETA users --)\u003c/code\u003e\u003c/pre\u003e\nA few directives are available in documentation. Note that\ndirectives must appear on a single line to be properly\nidentified. The `include` directive includes a markdown file from\nan external source:\n\u003cpre\u003e\u003ccode\u003e(== include path/to/file ==)\u003c/code\u003e\u003c/pre\u003e\nThe `resource_for` directive marks a message to be the resource of\na collection in REST view. If it is not specified, tools attempt\nto infer the resource from the operations in a collection:\n\u003cpre\u003e\u003ccode\u003e(== resource_for v1.shelves.books ==)\u003c/code\u003e\u003c/pre\u003e\nThe directive `suppress_warning` does not directly affect documentation\nand is documented together with service config validation.",
"type": "object",
"properties": {
+ "pages": {
+ "description": "The top level pages for the documentation set.",
+ "type": "array",
+ "items": {
+ "$ref": "Page"
+ }
+ },
"summary": {
"description": "A short summary of what the service does. Can only be provided by\nplain text.",
"type": "string"
},
"documentationRootUrl": {
- "description": "The URL to the root of documentation.",
- "type": "string"
+ "type": "string",
+ "description": "The URL to the root of documentation."
},
"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.",
@@ -2930,13 +652,6 @@
"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"
- }
}
},
"id": "Documentation"
@@ -2953,8 +668,6 @@
}
},
"logType": {
- "description": "The log type that this config enables.",
- "type": "string",
"enumDescriptions": [
"Default case. Should never be this.",
"Admin reads. Example: CloudIAM getIamPolicy",
@@ -2966,14 +679,14 @@
"ADMIN_READ",
"DATA_WRITE",
"DATA_READ"
- ]
+ ],
+ "description": "The log type that this config enables.",
+ "type": "string"
}
},
"id": "AuditLogConfig"
},
"ConfigSource": {
- "description": "Represents a source file which is used to generate the service configuration\ndefined by `google.api.Service`.",
- "type": "object",
"properties": {
"files": {
"description": "Set of source configuration files that are used to generate a service\nconfiguration (`google.api.Service`).",
@@ -2987,20 +700,14 @@
"type": "string"
}
},
- "id": "ConfigSource"
+ "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": {
- "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",
@@ -3015,14 +722,31 @@
"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"
}
},
"id": "AuthenticationRule"
},
"BackendRule": {
+ "id": "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",
@@ -3032,17 +756,8 @@
"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"
}
- },
- "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).",
@@ -3059,11 +774,11 @@
"type": "integer"
},
"auditConfigs": {
- "description": "Specifies cloud audit logging configuration for this policy.",
"type": "array",
"items": {
"$ref": "AuditConfig"
- }
+ },
+ "description": "Specifies cloud audit logging configuration for this policy."
},
"bindings": {
"description": "Associates a list of `members` to a `role`.\n`bindings` with no members will result in an error.",
@@ -3079,6 +794,7 @@
"id": "Policy"
},
"UndeleteServiceResponse": {
+ "id": "UndeleteServiceResponse",
"description": "Response message for UndeleteService method.",
"type": "object",
"properties": {
@@ -3086,13 +802,43 @@
"description": "Revived service resource.",
"$ref": "ManagedService"
}
- },
- "id": "UndeleteServiceResponse"
+ }
},
"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",
+ "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",
@@ -3106,42 +852,12 @@
"items": {
"$ref": "Option"
}
- },
- "methods": {
- "description": "The methods of this interface, in unspecified order.",
- "type": "array",
- "items": {
- "$ref": "Method"
- }
- },
- "name": {
- "description": "The fully qualified name of this interface, including package name\nfollowed by the interface's simple name.",
- "type": "string"
- },
- "syntax": {
- "description": "The source syntax of the service.",
- "type": "string",
- "enumDescriptions": [
- "Syntax `proto2`.",
- "Syntax `proto3`."
- ],
- "enum": [
- "SYNTAX_PROTO2",
- "SYNTAX_PROTO3"
- ]
- },
- "sourceContext": {
- "$ref": "SourceContext",
- "description": "Source context for the protocol buffer service represented by this\nmessage."
- },
- "version": {
- "description": "A version string for this interface. If specified, must have the form\n`major-version.minor-version`, as in `1.10`. If the minor version is\nomitted, it defaults to zero. If the entire version field is empty, the\nmajor version is derived from the package name, as outlined below. If the\nfield is not empty, the version in the package name will be verified to be\nconsistent with what is provided here.\n\nThe versioning schema uses [semantic\nversioning](http://semver.org) where the major version number\nindicates a breaking change and the minor version an additive,\nnon-breaking change. Both version numbers are signals to users\nwhat to expect from different versions, and should be carefully\nchosen based on the product plan.\n\nThe major version is also reflected in the package name of the\ninterface, which must end in `v\u003cmajor-version\u003e`, as in\n`google.feature.v1`. For major versions 0 and 1, the suffix can\nbe omitted. Zero major versions must only be used for\nexperimental, non-GA interfaces.\n",
- "type": "string"
}
},
"id": "Api"
},
"MetricRule": {
+ "id": "MetricRule",
"description": "Bind API methods to metrics. Binding a method to a metric causes that\nmetric's configured quota behaviors to apply to the method call.",
"type": "object",
"properties": {
@@ -3157,26 +873,25 @@
"type": "string"
}
}
- },
- "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": {
- "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"
}
+ },
+ "providers": {
+ "description": "Defines a set of authentication providers that a service supports.",
+ "type": "array",
+ "items": {
+ "$ref": "AuthProvider"
+ }
}
},
"id": "Authentication"
@@ -3185,41 +900,1463 @@
"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": {
- "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": {
+ "type": "object",
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
},
- "description": "The normal response of the operation in case of success. If the original\nmethod returns no data on success, such as `Delete`, the response is\n`google.protobuf.Empty`. If the original method is standard\n`Get`/`Create`/`Update`, the response should be the resource. For other\nmethods, the response should have the type `XxxResponse`, where `Xxx`\nis the original method name. For example, if the original method name\nis `TakeSnapshot()`, the inferred response type is\n`TakeSnapshotResponse`.",
- "type": "object"
+ "description": "The normal response of the operation in case of success. If the original\nmethod returns no data on success, such as `Delete`, the response is\n`google.protobuf.Empty`. If the original method is standard\n`Get`/`Create`/`Update`, the response should be the resource. For other\nmethods, the response should have the type `XxxResponse`, where `Xxx`\nis the original method name. For example, if the original method name\nis `TakeSnapshot()`, the inferred response type is\n`TakeSnapshotResponse`."
},
"name": {
- "description": "The server-assigned name, which is only unique within the same service that\noriginally returns it. If you use the default HTTP mapping, the\n`name` should have the format of `operations/some/unique/name`.",
- "type": "string"
+ "type": "string",
+ "description": "The server-assigned name, which is only unique within the same service that\noriginally returns it. If you use the default HTTP mapping, the\n`name` should have the format of `operations/some/unique/name`."
+ },
+ "error": {
+ "$ref": "Status",
+ "description": "The error result of the operation in case of failure or cancellation."
+ },
+ "metadata": {
+ "additionalProperties": {
+ "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": {
+ "properties": {
+ "subpages": {
+ "description": "Subpages of this page. The order of subpages specified here will be\nhonored in the generated docset.",
+ "type": "array",
+ "items": {
+ "$ref": "Page"
+ }
+ },
+ "name": {
+ "description": "The name of the page. It will be used as an identity of the page to\ngenerate URI of the page, text of the link to this page in navigation,\netc. The full page name (start from the root page name to this page\nconcatenated with `.`) can be used as reference to the page in your\ndocumentation. For example:\n\u003cpre\u003e\u003ccode\u003epages:\n- name: Tutorial\n content: (== include tutorial.md ==)\n subpages:\n - name: Java\n content: (== include tutorial_java.md ==)\n\u003c/code\u003e\u003c/pre\u003e\nYou can reference `Java` page using Markdown reference link syntax:\n`Java`.",
+ "type": "string"
+ },
+ "content": {
+ "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."
+ }
+ },
+ "id": "Page",
+ "description": "Represents a documentation page. A page can contain subpages to represent\nnested documentation set structure.",
+ "type": "object"
+ },
+ "Status": {
+ "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",
+ "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons."
+ },
+ "Binding": {
+ "description": "Associates `members` with a `role`.",
+ "type": "object",
+ "properties": {
+ "members": {
+ "description": "Specifies the identities requesting access for a Cloud Platform resource.\n`members` can have the following values:\n\n* `allUsers`: A special identifier that represents anyone who is\n on the internet; with or without a Google account.\n\n* `allAuthenticatedUsers`: A special identifier that represents anyone\n who is authenticated with a Google account or a service account.\n\n* `user:{emailid}`: An email address that represents a specific Google\n account. For example, `alice@gmail.com` or `joe@example.com`.\n\n\n* `serviceAccount:{emailid}`: An email address that represents a service\n account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{emailid}`: An email address that represents a Google group.\n For example, `admins@example.com`.\n\n\n* `domain:{domain}`: A Google Apps domain name that represents all the\n users of that domain. For example, `google.com` or `example.com`.\n\n",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "role": {
+ "description": "Role that is assigned to `members`.\nFor example, `roles/viewer`, `roles/editor`, or `roles/owner`.\nRequired",
+ "type": "string"
+ },
+ "condition": {
+ "description": "The condition that is associated with this binding.\nNOTE: an unsatisfied condition will not allow user access via current\nbinding. Different bindings, including their conditions, are examined\nindependently.\nThis field is GOOGLE_INTERNAL.",
+ "$ref": "Expr"
+ }
+ },
+ "id": "Binding"
+ },
+ "AuthProvider": {
+ "description": "Configuration for an anthentication provider, including support for\n[JSON Web Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32).",
+ "type": "object",
+ "properties": {
+ "jwksUri": {
+ "description": "URL of the provider's public key set to validate signature of the JWT. See\n[OpenID Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata).\nOptional if the key set document:\n - can be retrieved from\n [OpenID Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html\n of the issuer.\n - can be inferred from the email domain of the issuer (e.g. a Google service account).\n\nExample: https://www.googleapis.com/oauth2/v1/certs",
+ "type": "string"
+ },
+ "audiences": {
+ "description": "The list of JWT\n[audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3).\nthat are allowed to access. A JWT containing any of these audiences will\nbe accepted. When this setting is absent, only JWTs with audience\n\"https://Service_name/API_name\"\nwill be accepted. For example, if no audiences are in the setting,\nLibraryService API will only accept JWTs with the following audience\n\"https://library-example.googleapis.com/google.example.library.v1.LibraryService\".\n\nExample:\n\n audiences: bookstore_android.apps.googleusercontent.com,\n bookstore_web.apps.googleusercontent.com",
+ "type": "string"
+ },
+ "id": {
+ "description": "The unique identifier of the auth provider. It will be referred to by\n`AuthRequirement.provider_id`.\n\nExample: \"bookstore_auth\".",
+ "type": "string"
+ },
+ "issuer": {
+ "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": {
+ "type": "string",
+ "description": "Redirect URL if JWT token is required but no present or is expired.\nImplement authorizationUrl of securityDefinitions in OpenAPI spec."
+ }
+ },
+ "id": "AuthProvider"
+ },
+ "Service": {
+ "description": "`Service` is the root object of Google service configuration schema. It\ndescribes basic information about a service, such as the name and the\ntitle, and delegates other aspects to sub-sections. Each sub-section is\neither a proto message or a repeated proto message that configures a\nspecific aspect, such as auth. See each proto message definition for details.\n\nExample:\n\n type: google.api.Service\n config_version: 3\n name: calendar.googleapis.com\n title: Google Calendar API\n apis:\n - name: google.calendar.v3.Calendar\n authentication:\n providers:\n - id: google_calendar_auth\n jwks_uri: https://www.googleapis.com/oauth2/v1/certs\n issuer: https://securetoken.google.com\n rules:\n - selector: \"*\"\n requirements:\n provider_id: google_calendar_auth",
+ "type": "object",
+ "properties": {
+ "documentation": {
+ "$ref": "Documentation",
+ "description": "Additional API documentation."
+ },
+ "logging": {
+ "description": "Logging configuration.",
+ "$ref": "Logging"
+ },
+ "monitoredResources": {
+ "description": "Defines the monitored resources used by this service. This is required\nby the Service.monitoring and Service.logging configurations.",
+ "type": "array",
+ "items": {
+ "$ref": "MonitoredResourceDescriptor"
+ }
+ },
+ "enums": {
+ "description": "A list of all enum types included in this API service. Enums\nreferenced directly or indirectly by the `apis` are automatically\nincluded. Enums which are not referenced but shall be included\nshould be listed here by name. Example:\n\n enums:\n - name: google.someapi.v1.SomeEnum",
+ "type": "array",
+ "items": {
+ "$ref": "Enum"
+ }
+ },
+ "context": {
+ "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": {
+ "$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": {
+ "description": "API visibility configuration.",
+ "$ref": "Visibility"
+ },
+ "quota": {
+ "$ref": "Quota",
+ "description": "Quota configuration."
+ },
+ "name": {
+ "description": "The DNS address at which this service is available,\ne.g. `calendar.googleapis.com`.",
+ "type": "string"
+ },
+ "billing": {
+ "$ref": "Billing",
+ "description": "Billing configuration."
+ },
+ "customError": {
+ "$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": {
+ "$ref": "Http",
+ "description": "HTTP configuration."
+ },
+ "systemParameters": {
+ "description": "System parameter configuration.",
+ "$ref": "SystemParameters"
+ },
+ "backend": {
+ "$ref": "Backend",
+ "description": "API backend configuration."
+ }
+ },
+ "id": "Service"
+ },
+ "EnumValue": {
+ "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",
+ "description": "Enum value definition.",
+ "type": "object"
+ },
+ "ListOperationsResponse": {
+ "type": "object",
+ "properties": {
+ "operations": {
+ "description": "A list of operations that matches the specified filter in the request.",
+ "type": "array",
+ "items": {
+ "$ref": "Operation"
+ }
+ },
+ "nextPageToken": {
+ "description": "The standard List next-page token.",
+ "type": "string"
+ }
+ },
+ "id": "ListOperationsResponse",
+ "description": "The response message for Operations.ListOperations."
+ },
+ "CustomHttpPattern": {
+ "description": "A custom pattern is used for defining custom HTTP verb.",
+ "type": "object",
+ "properties": {
+ "path": {
+ "description": "The path matched by this custom verb.",
+ "type": "string"
+ },
+ "kind": {
+ "description": "The name of this custom HTTP verb.",
+ "type": "string"
+ }
+ },
+ "id": "CustomHttpPattern"
+ },
+ "OperationMetadata": {
+ "properties": {
+ "progressPercentage": {
+ "description": "Percentage of completion of this operation, ranging from 0 to 100.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "startTime": {
+ "description": "The start time of the operation.",
+ "format": "google-datetime",
+ "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"
+ }
+ }
+ },
+ "id": "OperationMetadata",
+ "description": "The metadata associated with a long running operation resource.",
+ "type": "object"
+ },
+ "SystemParameterRule": {
+ "id": "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"
+ }
+ }
+ },
+ "HttpRule": {
+ "description": "`HttpRule` defines the mapping of an RPC method to one or more HTTP\nREST API methods. The mapping specifies how different portions of the RPC\nrequest message are mapped to URL path, URL query parameters, and\nHTTP request body. The mapping is typically specified as an\n`google.api.http` annotation on the RPC method,\nsee \"google/api/annotations.proto\" for details.\n\nThe mapping consists of a field specifying the path template and\nmethod kind. The path template can refer to fields in the request\nmessage, as in the example below which describes a REST GET\noperation on a resource collection of messages:\n\n\n service Messaging {\n rpc GetMessage(GetMessageRequest) returns (Message) {\n option (google.api.http).get = \"/v1/messages/{message_id}/{sub.subfield}\";\n }\n }\n message GetMessageRequest {\n message SubMessage {\n string subfield = 1;\n }\n string message_id = 1; // mapped to the URL\n SubMessage sub = 2; // `sub.subfield` is url-mapped\n }\n message Message {\n string text = 1; // content of the resource\n }\n\nThe same http annotation can alternatively be expressed inside the\n`GRPC API Configuration` YAML file.\n\n http:\n rules:\n - selector: \u003cproto_package_name\u003e.Messaging.GetMessage\n get: /v1/messages/{message_id}/{sub.subfield}\n\nThis definition enables an automatic, bidrectional mapping of HTTP\nJSON to RPC. Example:\n\nHTTP | RPC\n-----|-----\n`GET /v1/messages/123456/foo` | `GetMessage(message_id: \"123456\" sub: SubMessage(subfield: \"foo\"))`\n\nIn general, not only fields but also field paths can be referenced\nfrom a path pattern. Fields mapped to the path pattern cannot be\nrepeated and must have a primitive (non-message) type.\n\nAny fields in the request message which are not bound by the path\npattern automatically become (optional) HTTP query\nparameters. Assume the following definition of the request message:\n\n\n service Messaging {\n rpc GetMessage(GetMessageRequest) returns (Message) {\n option (google.api.http).get = \"/v1/messages/{message_id}\";\n }\n }\n message GetMessageRequest {\n message SubMessage {\n string subfield = 1;\n }\n string message_id = 1; // mapped to the URL\n int64 revision = 2; // becomes a parameter\n SubMessage sub = 3; // `sub.subfield` becomes a parameter\n }\n\n\nThis enables a HTTP JSON to RPC mapping as below:\n\nHTTP | RPC\n-----|-----\n`GET /v1/messages/123456?revision=2&sub.subfield=foo` | `GetMessage(message_id: \"123456\" revision: 2 sub: SubMessage(subfield: \"foo\"))`\n\nNote that fields which are mapped to HTTP parameters must have a\nprimitive type or a repeated primitive type. Message types are not\nallowed. In the case of a repeated type, the parameter can be\nrepeated in the URL, as in `...?param=A¶m=B`.\n\nFor HTTP method kinds which allow a request body, the `body` field\nspecifies the mapping. Consider a REST update method on the\nmessage resource collection:\n\n\n service Messaging {\n rpc UpdateMessage(UpdateMessageRequest) returns (Message) {\n option (google.api.http) = {\n put: \"/v1/messages/{message_id}\"\n body: \"message\"\n };\n }\n }\n message UpdateMessageRequest {\n string message_id = 1; // mapped to the URL\n Message message = 2; // mapped to the body\n }\n\n\nThe following HTTP JSON to RPC mapping is enabled, where the\nrepresentation of the JSON in the request body is determined by\nprotos JSON encoding:\n\nHTTP | RPC\n-----|-----\n`PUT /v1/messages/123456 { \"text\": \"Hi!\" }` | `UpdateMessage(message_id: \"123456\" message { text: \"Hi!\" })`\n\nThe special name `*` can be used in the body mapping to define that\nevery field not bound by the path template should be mapped to the\nrequest body. This enables the following alternative definition of\nthe update method:\n\n service Messaging {\n rpc UpdateMessage(Message) returns (Message) {\n option (google.api.http) = {\n put: \"/v1/messages/{message_id}\"\n body: \"*\"\n };\n }\n }\n message Message {\n string message_id = 1;\n string text = 2;\n }\n\n\nThe following HTTP JSON to RPC mapping is enabled:\n\nHTTP | RPC\n-----|-----\n`PUT /v1/messages/123456 { \"text\": \"Hi!\" }` | `UpdateMessage(message_id: \"123456\" text: \"Hi!\")`\n\nNote that when using `*` in the body mapping, it is not possible to\nhave HTTP parameters, as all fields not bound by the path end in\nthe body. This makes this option more rarely used in practice of\ndefining REST APIs. The common usage of `*` is in custom methods\nwhich don't use the URL at all for transferring data.\n\nIt is possible to define multiple HTTP methods for one RPC by using\nthe `additional_bindings` option. Example:\n\n service Messaging {\n rpc GetMessage(GetMessageRequest) returns (Message) {\n option (google.api.http) = {\n get: \"/v1/messages/{message_id}\"\n additional_bindings {\n get: \"/v1/users/{user_id}/messages/{message_id}\"\n }\n };\n }\n }\n message GetMessageRequest {\n string message_id = 1;\n string user_id = 2;\n }\n\n\nThis enables the following two alternative HTTP JSON to RPC\nmappings:\n\nHTTP | RPC\n-----|-----\n`GET /v1/messages/123456` | `GetMessage(message_id: \"123456\")`\n`GET /v1/users/me/messages/123456` | `GetMessage(user_id: \"me\" message_id: \"123456\")`\n\n# Rules for HTTP mapping\n\nThe rules for mapping HTTP path, query parameters, and body fields\nto the request message are as follows:\n\n1. The `body` field specifies either `*` or a field path, or is\n omitted. If omitted, it indicates there is no HTTP request body.\n2. Leaf fields (recursive expansion of nested messages in the\n request) can be classified into three types:\n (a) Matched in the URL template.\n (b) Covered by body (if body is `*`, everything except (a) fields;\n else everything under the body field)\n (c) All other fields.\n3. URL query parameters found in the HTTP request are mapped to (c) fields.\n4. Any body sent with an HTTP request can contain only (b) fields.\n\nThe syntax of the path template is as follows:\n\n Template = \"/\" Segments [ Verb ] ;\n Segments = Segment { \"/\" Segment } ;\n Segment = \"*\" | \"**\" | LITERAL | Variable ;\n Variable = \"{\" FieldPath [ \"=\" Segments ] \"}\" ;\n FieldPath = IDENT { \".\" IDENT } ;\n Verb = \":\" LITERAL ;\n\nThe syntax `*` matches a single path segment. The syntax `**` matches zero\nor more path segments, which must be the last part of the path except the\n`Verb`. The syntax `LITERAL` matches literal text in the path.\n\nThe syntax `Variable` matches part of the URL path as specified by its\ntemplate. A variable template must not contain other variables. If a variable\nmatches a single path segment, its template may be omitted, e.g. `{var}`\nis equivalent to `{var=*}`.\n\nIf a variable contains exactly one path segment, such as `\"{var}\"` or\n`\"{var=*}\"`, when such a variable is expanded into a URL path, all characters\nexcept `[-_.~0-9a-zA-Z]` are percent-encoded. Such variables show up in the\nDiscovery Document as `{var}`.\n\nIf a variable contains one or more path segments, such as `\"{var=foo/*}\"`\nor `\"{var=**}\"`, when such a variable is expanded into a URL path, all\ncharacters except `[-_.~/0-9a-zA-Z]` are percent-encoded. Such variables\nshow up in the Discovery Document as `{+var}`.\n\nNOTE: While the single segment variable matches the semantics of\n[RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2\nSimple String Expansion, the multi segment variable **does not** match\nRFC 6570 Reserved Expansion. The reason is that the Reserved Expansion\ndoes not expand special characters like `?` and `#`, which would lead\nto invalid URLs.\n\nNOTE: the field paths in variables and in the `body` must not refer to\nrepeated fields or map fields.",
+ "type": "object",
+ "properties": {
+ "delete": {
+ "description": "Used for deleting a resource.",
+ "type": "string"
+ },
+ "body": {
+ "description": "The name of the request field whose value is mapped to the HTTP body, or\n`*` for mapping all fields not captured by the path pattern to the HTTP\nbody. NOTE: the referred field must not be a repeated field and must be\npresent at the top-level of request message type.",
+ "type": "string"
+ },
+ "mediaDownload": {
+ "$ref": "MediaDownload",
+ "description": "Use this only for Scotty Requests. Do not use this for bytestream methods.\nFor media support, add instead [][google.bytestream.RestByteStream] as an\nAPI to your configuration."
+ },
+ "post": {
+ "description": "Used for creating a resource.",
+ "type": "string"
+ },
+ "additionalBindings": {
+ "description": "Additional HTTP bindings for the selector. Nested bindings must\nnot contain an `additional_bindings` field themselves (that is,\nthe nesting may only be one level deep).",
+ "type": "array",
+ "items": {
+ "$ref": "HttpRule"
+ }
+ },
+ "responseBody": {
+ "description": "The name of the response field whose value is mapped to the HTTP body of\nresponse. Other response fields are ignored. This field is optional. When\nnot set, the response message will be used as HTTP body of response.\nNOTE: the referred field must be not a repeated field and must be present\nat the top-level of response message type.",
+ "type": "string"
+ },
+ "mediaUpload": {
+ "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": {
+ "type": "string",
+ "description": "Used for updating a resource."
+ },
+ "put": {
+ "description": "Used for updating a resource.",
+ "type": "string"
+ }
+ },
+ "id": "HttpRule"
+ },
+ "VisibilityRule": {
+ "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",
+ "description": "A visibility rule provides visibility configuration for an individual API\nelement."
+ },
+ "MonitoringDestination": {
+ "description": "Configuration of a specific monitoring destination (the producer project\nor the consumer project).",
+ "type": "object",
+ "properties": {
+ "monitoredResource": {
+ "description": "The monitored resource type. The type must be defined in\nService.monitored_resources section.",
+ "type": "string"
+ },
+ "metrics": {
+ "description": "Names of the metrics to report to this monitoring destination.\nEach name must be defined in Service.metrics section.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "id": "MonitoringDestination"
+ },
+ "Visibility": {
+ "type": "object",
+ "properties": {
+ "rules": {
+ "description": "A list of visibility rules that apply to individual API elements.\n\n**NOTE:** All service configuration rules follow \"last one wins\" order.",
+ "type": "array",
+ "items": {
+ "$ref": "VisibilityRule"
+ }
+ }
+ },
+ "id": "Visibility",
+ "description": "`Visibility` defines restrictions for the visibility of service\nelements. Restrictions are specified using visibility labels\n(e.g., TRUSTED_TESTER) that are elsewhere linked to users and projects.\n\nUsers and projects can have access to more than one visibility label. The\neffective visibility for multiple labels is the union of each label's\nelements, plus any unrestricted elements.\n\nIf an element and its parents have no restrictions, visibility is\nunconditionally granted.\n\nExample:\n\n visibility:\n rules:\n - selector: google.calendar.Calendar.EnhancedSearch\n restriction: TRUSTED_TESTER\n - selector: google.calendar.Calendar.Delegate\n restriction: GOOGLE_INTERNAL\n\nHere, all methods are publicly visible except for the restricted methods\nEnhancedSearch and Delegate."
+ },
+ "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": {
+ "changeType": {
+ "description": "The type for this change, either ADDED, REMOVED, or MODIFIED.",
+ "type": "string",
+ "enumDescriptions": [
+ "No value was provided.",
+ "The changed object exists in the 'new' service configuration, but not\nin the 'old' service configuration.",
+ "The changed object exists in the 'old' service configuration, but not\nin the 'new' service configuration.",
+ "The changed object exists in both service configurations, but its value\nis different."
+ ],
+ "enum": [
+ "CHANGE_TYPE_UNSPECIFIED",
+ "ADDED",
+ "REMOVED",
+ "MODIFIED"
+ ]
+ },
+ "element": {
+ "description": "Object hierarchy path to the change, with levels separated by a '.'\ncharacter. For repeated fields, an applicable unique identifier field is\nused for the index (usually selector, name, or id). For maps, the term\n'key' is used. If the field has no unique identifier, the numeric index\nis used.\nExamples:\n- visibility.rules[selector==\"google.LibraryService.CreateBook\"].restriction\n- quota.metric_rules[selector==\"google\"].metric_costs[key==\"reads\"].value\n- logging.producer_destinations[0]",
+ "type": "string"
+ },
+ "oldValue": {
+ "description": "Value of the changed object in the old Service configuration,\nin JSON format. This field will not be populated if ChangeType == ADDED.",
+ "type": "string"
+ },
+ "advices": {
+ "description": "Collection of advice provided for this change, useful for determining the\npossible impact of this change.",
+ "type": "array",
+ "items": {
+ "$ref": "Advice"
+ }
+ },
+ "newValue": {
+ "type": "string",
+ "description": "Value of the changed object in the new Service configuration,\nin JSON format. This field will not be populated if ChangeType == REMOVED."
+ }
+ },
+ "id": "ConfigChange",
+ "description": "Output generated from semantically comparing two versions of a service\nconfiguration.\n\nIncludes detailed information about a field that have changed with\napplicable advice about potential consequences for the change, such as\nbackwards-incompatibility.",
+ "type": "object"
+ },
+ "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"
+ },
+ "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": {
+ "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": {
+ "type": "string",
+ "description": "The name of the service associated with this Rollout."
+ },
+ "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": {
+ "type": "string",
+ "description": "Optional unique identifier of this Rollout. Only lower case letters, digits\n and '-' are allowed.\n\nIf not specified by client, the server will generate one. The generated id\nwill have the form of \u003cdate\u003e\u003crevision number\u003e, where \"date\" is the create\ndate in ISO 8601 format. \"revision number\" is a monotonically increasing\npositive number that is reset every day for each service.\nAn example of the generated rollout_id is '2016-02-16r1'"
+ }
+ },
+ "id": "Rollout"
+ },
+ "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": {
+ "description": "Service configuration for which we want to generate the report.\nFor this version of API, the supported types are\ngoogle.api.servicemanagement.v1.ConfigRef,\ngoogle.api.servicemanagement.v1.ConfigSource,\nand google.api.Service",
+ "type": "object",
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ }
+ }
+ },
+ "id": "GenerateConfigReportRequest"
+ },
+ "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": {
+ "enum": [
+ "STATUS_UNSPECIFIED",
+ "DONE",
+ "NOT_STARTED",
+ "IN_PROGRESS",
+ "FAILED",
+ "CANCELLED"
+ ],
+ "description": "The status code.",
+ "type": "string",
+ "enumDescriptions": [
+ "Unspecifed code.",
+ "The operation or step has completed without errors.",
+ "The operation or step has not started yet.",
+ "The operation or step is in progress.",
+ "The operation or step has completed with errors. If the operation is\nrollbackable, the rollback completed with errors too.",
+ "The operation or step has completed with cancellation."
+ ]
+ },
+ "description": {
+ "description": "The short description of the step.",
+ "type": "string"
+ }
+ },
+ "id": "Step"
+ },
+ "LoggingDestination": {
+ "description": "Configuration of a specific logging destination (the producer project\nor the consumer project).",
+ "type": "object",
+ "properties": {
+ "monitoredResource": {
+ "description": "The monitored resource type. The type must be defined in the\nService.monitored_resources section.",
+ "type": "string"
+ },
+ "logs": {
+ "description": "Names of the logs to be sent to this destination. Each name must\nbe defined in the Service.logs section. If the log name is\nnot a domain scoped name, it will be automatically prefixed with\nthe service name followed by \"/\".",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "id": "LoggingDestination"
+ },
+ "Option": {
+ "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",
+ "description": "A protocol buffer option, which can be attached to a message, field,\nenumeration, etc.",
+ "type": "object"
+ },
+ "Logging": {
+ "type": "object",
+ "properties": {
+ "consumerDestinations": {
+ "description": "Logging configurations for sending logs to the consumer project.\nThere can be multiple consumer destinations, each one must have a\ndifferent monitored resource type. A log can be used in at most\none consumer destination.",
+ "type": "array",
+ "items": {
+ "$ref": "LoggingDestination"
+ }
+ },
+ "producerDestinations": {
+ "description": "Logging configurations for sending logs to the producer project.\nThere can be multiple producer destinations, each one must have a\ndifferent monitored resource type. A log can be used in at most\none producer destination.",
+ "type": "array",
+ "items": {
+ "$ref": "LoggingDestination"
+ }
+ }
+ },
+ "id": "Logging",
+ "description": "Logging configuration of the service.\n\nThe following example shows how to configure logs to be sent to the\nproducer and consumer projects. In the example, the `activity_history`\nlog is sent to both the producer and consumer projects, whereas the\n`purchase_history` log is only sent to the producer project.\n\n monitored_resources:\n - type: library.googleapis.com/branch\n labels:\n - key: /city\n description: The city where the library branch is located in.\n - key: /name\n description: The name of the branch.\n logs:\n - name: activity_history\n labels:\n - key: /customer_id\n - name: purchase_history\n logging:\n producer_destinations:\n - monitored_resource: library.googleapis.com/branch\n logs:\n - activity_history\n - purchase_history\n consumer_destinations:\n - monitored_resource: library.googleapis.com/branch\n logs:\n - activity_history"
+ },
+ "Method": {
+ "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": {
+ "description": "A URL of the input message type.",
+ "type": "string"
+ },
+ "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",
+ "description": "Method represents a method of an API interface."
+ },
+ "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": {
+ "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": {
+ "type": "string",
+ "description": "User-visible display name for this limit.\nOptional. If not set, the UI will provide a default display name based on\nthe quota configuration. This field can be used to override the default\ndisplay name generated from the configuration."
+ },
+ "values": {
+ "additionalProperties": {
+ "format": "int64",
+ "type": "string"
+ },
+ "description": "Tiered limit values. You must specify this as a key:value pair, with an\ninteger value that is the maximum number of requests allowed for the\nspecified unit. Currently only STANDARD is supported.",
+ "type": "object"
+ },
+ "unit": {
+ "description": "Specify the unit of the quota limit. It uses the same syntax as\nMetric.unit. The supported unit kinds are determined by the quota\nbackend system.\n\nHere are some examples:\n* \"1/min/{project}\" for quota per minute per project.\n\nNote: the order of unit components is insignificant.\nThe \"1\" at the beginning is required to follow the metric unit syntax.",
+ "type": "string"
+ },
+ "maxLimit": {
+ "description": "Maximum number of tokens that can be consumed during the specified\nduration. Client application developers can override the default limit up\nto this maximum. If specified, this value cannot be set to a value less\nthan the default limit. If not specified, it is set to the default limit.\n\nTo allow clients to apply overrides with no upper bound, set this to -1,\nindicating unlimited maximum quota.\n\nUsed by group-based quotas only.",
+ "format": "int64",
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of the quota limit.\n\nThe name must be provided, and it must be unique within the service. The\nname can only include alphanumeric characters as well as '-'.\n\nThe maximum length of the limit name is 64 characters.",
+ "type": "string"
+ },
+ "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"
+ }
+ },
+ "id": "QuotaLimit"
+ },
+ "ConfigRef": {
+ "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",
+ "description": "Represents a service configuration with its name and id.",
+ "type": "object"
+ },
+ "ListServiceRolloutsResponse": {
+ "description": "Response message for ListServiceRollouts method.",
+ "type": "object",
+ "properties": {
+ "nextPageToken": {
+ "description": "The token of the next page of results.",
+ "type": "string"
+ },
+ "rollouts": {
+ "description": "The list of rollout resources.",
+ "type": "array",
+ "items": {
+ "$ref": "Rollout"
+ }
+ }
+ },
+ "id": "ListServiceRolloutsResponse"
+ },
+ "Mixin": {
+ "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": {
+ "description": "The metadata associated with a long running operation resource.",
+ "type": "object",
+ "properties": {
+ "surface": {
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "TenancyUnit, ServiceNetworking fall under this"
+ ],
+ "enum": [
+ "UNSPECIFIED_OP_SERVICE",
+ "SERVICE_MANAGEMENT",
+ "SERVICE_USAGE",
+ "SERVICE_CONSUMER_MANAGEMENT"
+ ],
+ "type": "string"
+ },
+ "flowName": {
+ "description": "The name of the top-level flow corresponding to this operation.\nMust be equal to the \"name\" field for a FlowName enum.",
+ "type": "string"
+ },
+ "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"
+ },
+ "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"
+ }
+ },
+ "id": "FlowOperationMetadata"
+ },
+ "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": {
+ "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"
+ }
+ }
+ },
+ "id": "CustomError"
+ },
+ "Http": {
+ "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",
+ "description": "Defines the HTTP configuration for an API service. It contains a list of\nHttpRule, each specifying the mapping of an RPC method\nto one or more HTTP REST API methods."
+ },
+ "SourceInfo": {
+ "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",
+ "description": "Source information used to create a Service Config",
+ "type": "object"
+ },
+ "Control": {
+ "description": "Selects and configures the service controller used by the service. The\nservice controller handles features like abuse, quota, billing, logging,\nmonitoring, etc.",
+ "type": "object",
+ "properties": {
+ "environment": {
+ "description": "The service control environment to use. If empty, no control plane\nfeature (like quota and billing) will be enabled.",
+ "type": "string"
+ }
+ },
+ "id": "Control"
+ },
+ "SystemParameter": {
+ "description": "Define a parameter's name and location. The parameter may be passed as either\nan HTTP header or a URL query parameter, and if both are passed the behavior\nis implementation-dependent.",
+ "type": "object",
+ "properties": {
+ "httpHeader": {
+ "description": "Define the HTTP header name to use for the parameter. It is case\ninsensitive.",
+ "type": "string"
+ },
+ "name": {
+ "description": "Define the name of the parameter, such as \"api_key\" . It is case sensitive.",
+ "type": "string"
+ },
+ "urlQueryParameter": {
+ "description": "Define the URL query parameter name to use for the parameter. It is case\nsensitive.",
+ "type": "string"
+ }
+ },
+ "id": "SystemParameter"
+ },
+ "Field": {
+ "description": "A single field of a message type.",
+ "type": "object",
+ "properties": {
+ "typeUrl": {
+ "description": "The field type URL, without the scheme, for message or enumeration\ntypes. Example: `\"type.googleapis.com/google.protobuf.Timestamp\"`.",
+ "type": "string"
+ },
+ "number": {
+ "description": "The field number.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "jsonName": {
+ "description": "The field JSON name.",
+ "type": "string"
+ },
+ "kind": {
+ "enum": [
+ "TYPE_UNKNOWN",
+ "TYPE_DOUBLE",
+ "TYPE_FLOAT",
+ "TYPE_INT64",
+ "TYPE_UINT64",
+ "TYPE_INT32",
+ "TYPE_FIXED64",
+ "TYPE_FIXED32",
+ "TYPE_BOOL",
+ "TYPE_STRING",
+ "TYPE_GROUP",
+ "TYPE_MESSAGE",
+ "TYPE_BYTES",
+ "TYPE_UINT32",
+ "TYPE_ENUM",
+ "TYPE_SFIXED32",
+ "TYPE_SFIXED64",
+ "TYPE_SINT32",
+ "TYPE_SINT64"
+ ],
+ "description": "The field type.",
+ "type": "string",
+ "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."
+ ]
+ },
+ "options": {
+ "description": "The protocol buffer options.",
+ "type": "array",
+ "items": {
+ "$ref": "Option"
+ }
+ },
+ "oneofIndex": {
+ "description": "The index of the field type in `Type.oneofs`, for message or enumeration\ntypes. The first type has index 1; zero means the type is not in the list.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "cardinality": {
+ "type": "string",
+ "enumDescriptions": [
+ "For fields with unknown cardinality.",
+ "For optional fields.",
+ "For required fields. Proto2 syntax only.",
+ "For repeated fields."
+ ],
+ "enum": [
+ "CARDINALITY_UNKNOWN",
+ "CARDINALITY_OPTIONAL",
+ "CARDINALITY_REQUIRED",
+ "CARDINALITY_REPEATED"
+ ],
+ "description": "The field cardinality."
+ },
+ "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": {
+ "type": "string",
+ "description": "The field name."
+ }
+ },
+ "id": "Field"
+ },
+ "Monitoring": {
+ "description": "Monitoring configuration of the service.\n\nThe example below shows how to configure monitored resources and metrics\nfor monitoring. In the example, a monitored resource and two metrics are\ndefined. The `library.googleapis.com/book/returned_count` metric is sent\nto both producer and consumer projects, whereas the\n`library.googleapis.com/book/overdue_count` metric is only sent to the\nconsumer project.\n\n monitored_resources:\n - type: library.googleapis.com/branch\n labels:\n - key: /city\n description: The city where the library branch is located in.\n - key: /name\n description: The name of the branch.\n metrics:\n - name: library.googleapis.com/book/returned_count\n metric_kind: DELTA\n value_type: INT64\n labels:\n - key: /customer_id\n - name: library.googleapis.com/book/overdue_count\n metric_kind: GAUGE\n value_type: INT64\n labels:\n - key: /customer_id\n monitoring:\n producer_destinations:\n - monitored_resource: library.googleapis.com/branch\n metrics:\n - library.googleapis.com/book/returned_count\n consumer_destinations:\n - monitored_resource: library.googleapis.com/branch\n metrics:\n - library.googleapis.com/book/returned_count\n - library.googleapis.com/book/overdue_count",
+ "type": "object",
+ "properties": {
+ "consumerDestinations": {
+ "description": "Monitoring configurations for sending metrics to the consumer project.\nThere can be multiple consumer destinations, each one must have a\ndifferent monitored resource type. A metric can be used in at most\none consumer destination.",
+ "type": "array",
+ "items": {
+ "$ref": "MonitoringDestination"
+ }
+ },
+ "producerDestinations": {
+ "description": "Monitoring configurations for sending metrics to the producer project.\nThere can be multiple producer destinations, each one must have a\ndifferent monitored resource type. A metric can be used in at most\none producer destination.",
+ "type": "array",
+ "items": {
+ "$ref": "MonitoringDestination"
+ }
+ }
+ },
+ "id": "Monitoring"
+ },
+ "TestIamPermissionsRequest": {
+ "id": "TestIamPermissionsRequest",
+ "description": "Request message for `TestIamPermissions` method.",
+ "type": "object",
+ "properties": {
+ "permissions": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "The set of permissions to check for the `resource`. Permissions with\nwildcards (such as '*' or 'storage.*') are not allowed. For more\ninformation see\n[IAM Overview](https://cloud.google.com/iam/docs/overview#permissions)."
+ }
+ }
+ },
+ "Enum": {
+ "description": "Enum type definition.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "Enum type name.",
+ "type": "string"
+ },
+ "enumvalue": {
+ "description": "Enum value definitions.",
+ "type": "array",
+ "items": {
+ "$ref": "EnumValue"
+ }
+ },
+ "options": {
+ "description": "Protocol buffer options.",
+ "type": "array",
+ "items": {
+ "$ref": "Option"
+ }
+ },
+ "sourceContext": {
+ "description": "The source context.",
+ "$ref": "SourceContext"
+ },
+ "syntax": {
+ "type": "string",
+ "enumDescriptions": [
+ "Syntax `proto2`.",
+ "Syntax `proto3`."
+ ],
+ "enum": [
+ "SYNTAX_PROTO2",
+ "SYNTAX_PROTO3"
+ ],
+ "description": "The source syntax."
+ }
+ },
+ "id": "Enum"
+ },
+ "EnableServiceRequest": {
+ "id": "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"
+ }
+ }
+ },
+ "Diagnostic": {
+ "properties": {
+ "message": {
+ "type": "string",
+ "description": "Message describing the error or warning."
+ },
+ "location": {
+ "description": "File name and line number of the error or warning.",
+ "type": "string"
+ },
+ "kind": {
+ "enumDescriptions": [
+ "Warnings and errors",
+ "Only errors"
+ ],
+ "enum": [
+ "WARNING",
+ "ERROR"
+ ],
+ "description": "The kind of diagnostic information provided.",
+ "type": "string"
+ }
+ },
+ "id": "Diagnostic",
+ "description": "Represents a diagnostic message (error or warning)",
+ "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"
+ },
+ "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"
+ },
+ "GenerateConfigReportResponse": {
+ "description": "Response message for GenerateConfigReport method.",
+ "type": "object",
+ "properties": {
+ "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"
+ }
+ },
+ "serviceName": {
+ "description": "Name of the service this report belongs to.",
+ "type": "string"
+ }
+ },
+ "id": "GenerateConfigReportResponse"
+ },
+ "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"
+ }
+ },
+ "syntax": {
+ "description": "The source syntax.",
+ "type": "string",
+ "enumDescriptions": [
+ "Syntax `proto2`.",
+ "Syntax `proto3`."
+ ],
+ "enum": [
+ "SYNTAX_PROTO2",
+ "SYNTAX_PROTO3"
+ ]
+ },
+ "sourceContext": {
+ "$ref": "SourceContext",
+ "description": "The source context."
+ },
+ "options": {
+ "description": "The protocol buffer options.",
+ "type": "array",
+ "items": {
+ "$ref": "Option"
+ }
+ }
+ },
+ "id": "Type"
+ },
+ "Experimental": {
+ "id": "Experimental",
+ "description": "Experimental service configuration. These configuration options can\nonly be used by whitelisted users.",
+ "type": "object",
+ "properties": {
+ "authorization": {
+ "$ref": "AuthorizationConfig",
+ "description": "Authorization configuration."
+ }
+ }
+ },
+ "ListServiceConfigsResponse": {
+ "description": "Response message for ListServiceConfigs method.",
+ "type": "object",
+ "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"
+ },
+ "AuditConfig": {
+ "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",
+ "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."
+ },
+ "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"
+ },
+ "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": {
+ "description": "The source configuration for the service.",
+ "$ref": "ConfigSource"
+ }
+ },
+ "id": "SubmitConfigSourceRequest"
}
},
"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",
@@ -3241,5 +2378,868 @@
}
}
},
- "rootUrl": "https://servicemanagement.googleapis.com/"
+ "rootUrl": "https://servicemanagement.googleapis.com/",
+ "ownerDomain": "google.com",
+ "name": "servicemanagement",
+ "batchPath": "batch",
+ "fullyEncodeReservedExpansion": true,
+ "title": "Google Service Management API",
+ "ownerName": "Google",
+ "resources": {
+ "services": {
+ "methods": {
+ "list": {
+ "response": {
+ "$ref": "ListServicesResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "GET",
+ "parameters": {
+ "pageSize": {
+ "location": "query",
+ "description": "Requested size of the next page of data.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "producerProjectId": {
+ "type": "string",
+ "location": "query",
+ "description": "Include services produced by the specified project."
+ },
+ "consumerId": {
+ "location": "query",
+ "description": "Include services consumed by the specified consumer.\n\nThe Google Service Management implementation accepts the following\nforms:\n- project:\u003cproject_id\u003e",
+ "type": "string"
+ },
+ "pageToken": {
+ "description": "Token identifying which result to start with; returned by a previous list\ncall.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "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",
+ "description": "Lists managed services.\n\nReturns all public services. For authenticated users, also returns all\nservices the calling user has \"servicemanagement.services.get\" permission\nfor.\n\n**BETA:** If the caller specifies the `consumer_id`, it returns only the\nservices enabled on the consumer. The `consumer_id` must have the format\nof \"project:{PROJECT-ID}\"."
+ },
+ "create": {
+ "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",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "parameters": {},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/service.management"
+ ],
+ "flatPath": "v1/services",
+ "path": "v1/services",
+ "id": "servicemanagement.services.create"
+ },
+ "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": {
+ "id": "servicemanagement.services.get",
+ "path": "v1/services/{serviceName}",
+ "description": "Gets a managed service. Authentication is required unless the service is\npublic.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "serviceName"
+ ],
+ "response": {
+ "$ref": "ManagedService"
+ },
+ "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}"
+ },
+ "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": {
+ "path": "v1/services/{serviceName}/config",
+ "id": "servicemanagement.services.getConfig",
+ "description": "Gets a service configuration (version) for a managed service.",
+ "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": {
+ "location": "query",
+ "description": "The id of the service configuration resource.",
+ "type": "string"
+ },
+ "view": {
+ "location": "query",
+ "enum": [
+ "BASIC",
+ "FULL"
+ ],
+ "description": "Specifies which parts of the Service Config should be returned in the\nresponse.",
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only",
+ "https://www.googleapis.com/auth/service.management",
+ "https://www.googleapis.com/auth/service.management.readonly"
+ ],
+ "flatPath": "v1/services/{serviceName}/config"
+ },
+ "enable": {
+ "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",
+ "request": {
+ "$ref": "EnableServiceRequest"
+ },
+ "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 enable. Specifying an unknown service name will\ncause the request to fail.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1/services/{serviceName}:enable",
+ "path": "v1/services/{serviceName}:enable",
+ "id": "servicemanagement.services.enable"
+ },
+ "delete": {
+ "httpMethod": "DELETE",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "serviceName"
+ ],
+ "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}",
+ "id": "servicemanagement.services.delete",
+ "path": "v1/services/{serviceName}",
+ "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"
+ },
+ "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": "^services/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/service.management"
+ ],
+ "flatPath": "v1/services/{servicesId}:setIamPolicy",
+ "path": "v1/{+resource}:setIamPolicy",
+ "id": "servicemanagement.services.setIamPolicy",
+ "request": {
+ "$ref": "SetIamPolicyRequest"
+ },
+ "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy."
+ },
+ "disable": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "serviceName"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "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"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/service.management"
+ ],
+ "flatPath": "v1/services/{serviceName}:disable",
+ "id": "servicemanagement.services.disable",
+ "path": "v1/services/{serviceName}:disable",
+ "request": {
+ "$ref": "DisableServiceRequest"
+ },
+ "description": "Disables a service for a project, so it can no longer be\nbe used for the project. It prevents accidental usage that may cause\nunexpected billing charges or security leaks.\n\nOperation\u003cresponse: DisableServiceResponse\u003e"
+ },
+ "getIamPolicy": {
+ "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": {
+ "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}:undelete",
+ "path": "v1/services/{serviceName}:undelete",
+ "id": "servicemanagement.services.undelete",
+ "description": "Revives a previously deleted managed service. The method restores the\nservice using the configuration at the time the service was deleted.\nThe target service must exist and must have been deleted within the\nlast 30 days.\n\nOperation\u003cresponse: UndeleteServiceResponse\u003e"
+ }
+ },
+ "resources": {
+ "configs": {
+ "methods": {
+ "create": {
+ "flatPath": "v1/services/{serviceName}/configs",
+ "path": "v1/services/{serviceName}/configs",
+ "id": "servicemanagement.services.configs.create",
+ "description": "Creates a new service configuration (version) for a managed service.\nThis method only stores the service configuration. To roll out the service\nconfiguration to backend systems please call\nCreateServiceRollout.",
+ "request": {
+ "$ref": "Service"
+ },
+ "response": {
+ "$ref": "Service"
+ },
+ "parameterOrder": [
+ "serviceName"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/service.management"
+ ],
+ "parameters": {
+ "serviceName": {
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "description": "The name of the service. See the [overview](/service-management/overview)\nfor naming requirements. For example: `example.googleapis.com`."
+ }
+ }
+ },
+ "submit": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "serviceName"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/service.management"
+ ],
+ "parameters": {
+ "serviceName": {
+ "description": "The name of the service. See the [overview](/service-management/overview)\nfor naming requirements. For example: `example.googleapis.com`.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/services/{serviceName}/configs:submit",
+ "id": "servicemanagement.services.configs.submit",
+ "path": "v1/services/{serviceName}/configs:submit",
+ "description": "Creates a new service configuration (version) for a managed service based\non\nuser-supplied configuration source files (for example: OpenAPI\nSpecification). This method stores the source configurations as well as the\ngenerated service configuration. To rollout the service configuration to\nother services,\nplease call CreateServiceRollout.\n\nOperation\u003cresponse: SubmitConfigSourceResponse\u003e",
+ "request": {
+ "$ref": "SubmitConfigSourceRequest"
+ }
+ },
+ "list": {
+ "description": "Lists the history of the service configuration for a managed service,\nfrom the newest to the oldest.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "serviceName"
+ ],
+ "response": {
+ "$ref": "ListServiceConfigsResponse"
+ },
+ "parameters": {
+ "serviceName": {
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "description": "The name of the service. See the [overview](/service-management/overview)\nfor naming requirements. For example: `example.googleapis.com`."
+ },
+ "pageToken": {
+ "type": "string",
+ "location": "query",
+ "description": "The token of the page to retrieve."
+ },
+ "pageSize": {
+ "location": "query",
+ "description": "The max number of items to include in the response list.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "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",
+ "id": "servicemanagement.services.configs.list",
+ "path": "v1/services/{serviceName}/configs"
+ },
+ "get": {
+ "response": {
+ "$ref": "Service"
+ },
+ "parameterOrder": [
+ "serviceName",
+ "configId"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "configId": {
+ "description": "The id of the service configuration resource.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "view": {
+ "description": "Specifies which parts of the Service Config should be returned in the\nresponse.",
+ "type": "string",
+ "location": "query",
+ "enum": [
+ "BASIC",
+ "FULL"
+ ]
+ },
+ "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}/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": {
+ "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": {
+ "required": true,
+ "type": "string",
+ "pattern": "^services/[^/]+/consumers/[^/]+$",
+ "location": "path",
+ "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field."
+ }
+ },
+ "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"
+ }
+ },
+ "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": {
+ "path": "v1/{+resource}:setIamPolicy",
+ "id": "servicemanagement.services.consumers.setIamPolicy",
+ "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.",
+ "request": {
+ "$ref": "SetIamPolicyRequest"
+ },
+ "response": {
+ "$ref": "Policy"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/service.management"
+ ],
+ "parameters": {
+ "resource": {
+ "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.",
+ "required": true,
+ "type": "string",
+ "pattern": "^services/[^/]+/consumers/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/services/{servicesId}/consumers/{consumersId}:setIamPolicy"
+ }
+ }
+ },
+ "rollouts": {
+ "methods": {
+ "list": {
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "serviceName"
+ ],
+ "response": {
+ "$ref": "ListServiceRolloutsResponse"
+ },
+ "parameters": {
+ "serviceName": {
+ "location": "path",
+ "description": "The name of the service. See the [overview](/service-management/overview)\nfor naming requirements. For example: `example.googleapis.com`.",
+ "required": true,
+ "type": "string"
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "The token of the page to retrieve.",
+ "type": "string"
+ },
+ "pageSize": {
+ "location": "query",
+ "description": "The max number of items to include in the response list.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "filter": {
+ "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",
+ "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}/rollouts",
+ "id": "servicemanagement.services.rollouts.list",
+ "path": "v1/services/{serviceName}/rollouts",
+ "description": "Lists the history of the service configuration rollouts for a managed\nservice, from the newest to the oldest."
+ },
+ "get": {
+ "description": "Gets a service configuration rollout.",
+ "response": {
+ "$ref": "Rollout"
+ },
+ "parameterOrder": [
+ "serviceName",
+ "rolloutId"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only",
+ "https://www.googleapis.com/auth/service.management",
+ "https://www.googleapis.com/auth/service.management.readonly"
+ ],
+ "parameters": {
+ "serviceName": {
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "description": "The name of the service. See the [overview](/service-management/overview)\nfor naming requirements. For example: `example.googleapis.com`."
+ },
+ "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"
+ },
+ "create": {
+ "flatPath": "v1/services/{serviceName}/rollouts",
+ "id": "servicemanagement.services.rollouts.create",
+ "path": "v1/services/{serviceName}/rollouts",
+ "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",
+ "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"
+ ]
+ }
+ }
+ }
+ }
+ },
+ "operations": {
+ "methods": {
+ "list": {
+ "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": {
+ "description": "The standard list page token.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageSize": {
+ "location": "query",
+ "description": "The maximum number of operations to return. If unspecified, defaults to\n50. The maximum value is 100.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "filter": {
+ "location": "query",
+ "description": "A string for filtering Operations.\n The following filter fields are supported:\n\n * serviceName: Required. Only `=` operator is allowed.\n * startTime: The time this job was started, in ISO 8601 format.\n Allowed operators are `\u003e=`, `\u003e`, `\u003c=`, and `\u003c`.\n * status: Can be `done`, `in_progress`, or `failed`. Allowed\n operators are `=`, and `!=`.\n\n Filter expression supports conjunction (AND) and disjunction (OR)\n logical operators. However, the serviceName restriction must be at the\n top-level and can only be combined with other restrictions via the AND\n logical operator.\n\n Examples:\n\n * `serviceName={some-service}.googleapis.com`\n * `serviceName={some-service}.googleapis.com AND startTime\u003e=\"2017-02-01\"`\n * `serviceName={some-service}.googleapis.com AND status=done`\n * `serviceName={some-service}.googleapis.com AND (status=done OR startTime\u003e=\"2017-02-01\")`",
+ "type": "string"
+ }
+ },
+ "flatPath": "v1/operations",
+ "path": "v1/operations",
+ "id": "servicemanagement.operations.list",
+ "description": "Lists service operations that match the specified filter in the request."
+ },
+ "get": {
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "location": "path",
+ "description": "The name of the operation resource.",
+ "required": true,
+ "type": "string",
+ "pattern": "^operations/.+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/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": {
+ "access_token": {
+ "location": "query",
+ "description": "OAuth access token.",
+ "type": "string"
+ },
+ "key": {
+ "location": "query",
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "type": "string"
+ },
+ "quotaUser": {
+ "location": "query",
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "type": "string"
+ },
+ "pp": {
+ "location": "query",
+ "description": "Pretty-print response.",
+ "type": "boolean",
+ "default": "true"
+ },
+ "bearer_token": {
+ "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": {
+ "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"
+ ]
+ },
+ "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://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": ""
}
diff --git a/serviceuser/v1/serviceuser-api.json b/serviceuser/v1/serviceuser-api.json
index 9b1c47d..6e70c09 100644
--- a/serviceuser/v1/serviceuser-api.json
+++ b/serviceuser/v1/serviceuser-api.json
@@ -1,36 +1,381 @@
{
+ "canonicalName": "Service User",
+ "auth": {
+ "oauth2": {
+ "scopes": {
+ "https://www.googleapis.com/auth/service.management": {
+ "description": "Manage your Google API service configuration"
+ },
+ "https://www.googleapis.com/auth/cloud-platform.read-only": {
+ "description": "View your data across Google Cloud Platform services"
+ },
+ "https://www.googleapis.com/auth/cloud-platform": {
+ "description": "View and manage your data across Google Cloud Platform services"
+ }
+ }
+ }
+ },
+ "rootUrl": "https://serviceuser.googleapis.com/",
+ "ownerDomain": "google.com",
+ "name": "serviceuser",
+ "batchPath": "batch",
+ "title": "Google Service User API",
+ "ownerName": "Google",
+ "resources": {
+ "projects": {
+ "resources": {
+ "services": {
+ "methods": {
+ "enable": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameters": {
+ "name": {
+ "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/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/service.management"
+ ],
+ "flatPath": "v1/projects/{projectsId}/services/{servicesId}:enable",
+ "id": "serviceuser.projects.services.enable",
+ "path": "v1/{+name}:enable",
+ "request": {
+ "$ref": "EnableServiceRequest"
+ },
+ "description": "Enable a service so it can be used with a project.\nSee [Cloud Auth Guide](https://cloud.google.com/docs/authentication) for\nmore information.\n\nOperation\u003cresponse: google.protobuf.Empty\u003e"
+ },
+ "list": {
+ "description": "List enabled services for the specified consumer.",
+ "response": {
+ "$ref": "ListEnabledServicesResponse"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "parameters": {
+ "pageToken": {
+ "description": "Token identifying which result to start with; returned by a previous list\ncall.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageSize": {
+ "description": "Requested size of the next page of data.",
+ "format": "int32",
+ "type": "integer",
+ "location": "query"
+ },
+ "parent": {
+ "description": "List enabled services for the specified parent.\n\nAn example valid parent would be:\n- projects/my-project",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/services",
+ "path": "v1/{+parent}/services",
+ "id": "serviceuser.projects.services.list"
+ },
+ "disable": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "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"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/service.management"
+ ],
+ "flatPath": "v1/projects/{projectsId}/services/{servicesId}:disable",
+ "id": "serviceuser.projects.services.disable",
+ "path": "v1/{+name}: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"
+ }
+ }
+ }
+ }
+ },
+ "services": {
+ "methods": {
+ "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",
+ "parameters": {
+ "pageToken": {
+ "description": "Token identifying which result to start with; returned by a previous list\ncall.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageSize": {
+ "location": "query",
+ "description": "Requested size of the next page of data.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "flatPath": "v1/services:search"
+ }
+ }
+ }
+ },
+ "parameters": {
+ "quotaUser": {
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "type": "string",
+ "location": "query"
+ },
+ "pp": {
+ "description": "Pretty-print response.",
+ "type": "boolean",
+ "default": "true",
+ "location": "query"
+ },
+ "oauth_token": {
+ "location": "query",
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string"
+ },
+ "bearer_token": {
+ "location": "query",
+ "description": "OAuth bearer token.",
+ "type": "string"
+ },
+ "upload_protocol": {
+ "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": {
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query",
+ "description": "Data format for response.",
+ "default": "json",
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
+ "type": "string"
+ },
+ "access_token": {
+ "location": "query",
+ "description": "OAuth access token.",
+ "type": "string"
+ },
+ "key": {
+ "location": "query",
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "type": "string"
+ }
+ },
+ "version": "v1",
+ "baseUrl": "https://serviceuser.googleapis.com/",
"kind": "discovery#restDescription",
"description": "Enables services that service consumers want to use on Google Cloud Platform, lists the available or enabled services, or disables services that service consumers no longer use.",
"servicePath": "",
"basePath": "",
- "revision": "20171215",
- "documentationLink": "https://cloud.google.com/service-management/",
"id": "serviceuser:v1",
+ "documentationLink": "https://cloud.google.com/service-management/",
+ "revision": "20171215",
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
- "Option": {
- "description": "A protocol buffer option, which can be attached to a message, field,\nenumeration, etc.",
- "type": "object",
+ "Visibility": {
"properties": {
- "name": {
- "description": "The option's name. For protobuf built-in options (options defined in\ndescriptor.proto), this is the short name. For example, `\"map_entry\"`.\nFor custom options, it should be the fully-qualified name. For example,\n`\"google.api.http\"`.",
- "type": "string"
- },
- "value": {
- "description": "The option's value packed in an Any message. If the value is a primitive,\nthe corresponding wrapper type defined in google/protobuf/wrappers.proto\nshould be used. If the value is an enum, it should be stored as an int32\nvalue using the google.protobuf.Int32Value type.",
- "type": "object",
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
+ "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": "Option"
+ "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": {
+ "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": {
+ "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": {
+ "enum": [
+ "STATUS_UNSPECIFIED",
+ "DONE",
+ "NOT_STARTED",
+ "IN_PROGRESS",
+ "FAILED",
+ "CANCELLED"
+ ],
+ "description": "The status code.",
+ "type": "string",
+ "enumDescriptions": [
+ "Unspecifed code.",
+ "The operation or step has completed without errors.",
+ "The operation or step has not started yet.",
+ "The operation or step is in progress.",
+ "The operation or step has completed with errors. If the operation is\nrollbackable, the rollback completed with errors too.",
+ "The operation or step has completed with cancellation."
+ ]
+ },
+ "description": {
+ "description": "The short description of the step.",
+ "type": "string"
+ }
+ },
+ "id": "Step"
+ },
+ "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": {
+ "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",
+ "description": "A protocol buffer option, which can be attached to a message, field,\nenumeration, etc.",
+ "type": "object"
},
"Logging": {
- "description": "Logging configuration of the service.\n\nThe following example shows how to configure logs to be sent to the\nproducer and consumer projects. In the example, the `activity_history`\nlog is sent to both the producer and consumer projects, whereas the\n`purchase_history` log is only sent to the producer project.\n\n monitored_resources:\n - type: library.googleapis.com/branch\n labels:\n - key: /city\n description: The city where the library branch is located in.\n - key: /name\n description: The name of the branch.\n logs:\n - name: activity_history\n labels:\n - key: /customer_id\n - name: purchase_history\n logging:\n producer_destinations:\n - monitored_resource: library.googleapis.com/branch\n logs:\n - activity_history\n - purchase_history\n consumer_destinations:\n - monitored_resource: library.googleapis.com/branch\n logs:\n - activity_history",
- "type": "object",
"properties": {
"consumerDestinations": {
"description": "Logging configurations for sending logs to the consumer project.\nThere can be multiple consumer destinations, each one must have a\ndifferent monitored resource type. A log can be used in at most\none consumer destination.",
@@ -47,66 +392,35 @@
}
}
},
- "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": {
- "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": {
- "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"
- }
- },
- "id": "QuotaLimit"
+ "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"
},
"Method": {
- "description": "Method represents a method of an API interface.",
- "type": "object",
"properties": {
+ "syntax": {
+ "enum": [
+ "SYNTAX_PROTO2",
+ "SYNTAX_PROTO3"
+ ],
+ "description": "The source syntax of this method.",
+ "type": "string",
+ "enumDescriptions": [
+ "Syntax `proto2`.",
+ "Syntax `proto3`."
+ ]
+ },
+ "responseTypeUrl": {
+ "description": "The URL of the output message type.",
+ "type": "string"
+ },
+ "options": {
+ "description": "Any metadata attached to the method.",
+ "type": "array",
+ "items": {
+ "$ref": "Option"
+ }
+ },
"responseStreaming": {
"description": "If true, the response is streamed.",
"type": "boolean"
@@ -122,36 +436,67 @@
"requestStreaming": {
"description": "If true, the request is streamed.",
"type": "boolean"
- },
- "syntax": {
- "description": "The source syntax of this method.",
- "type": "string",
- "enumDescriptions": [
- "Syntax `proto2`.",
- "Syntax `proto3`."
- ],
- "enum": [
- "SYNTAX_PROTO2",
- "SYNTAX_PROTO3"
- ]
- },
- "responseTypeUrl": {
- "description": "The URL of the output message type.",
- "type": "string"
- },
- "options": {
- "description": "Any metadata attached to the method.",
- "type": "array",
- "items": {
- "$ref": "Option"
- }
}
},
- "id": "Method"
+ "id": "Method",
+ "description": "Method represents a method of an API interface.",
+ "type": "object"
+ },
+ "QuotaLimit": {
+ "properties": {
+ "freeTier": {
+ "description": "Free tier value displayed in the Developers Console for this limit.\nThe free tier is the number of tokens that will be subtracted from the\nbilled amount when billing is enabled.\nThis field can only be set on a limit with duration \"1d\", in a billable\ngroup; it is invalid on any other limit. If this field is not set, it\ndefaults to 0, indicating that there is no free tier for this service.\n\nUsed by group-based quotas only.",
+ "format": "int64",
+ "type": "string"
+ },
+ "duration": {
+ "description": "Duration of this limit in textual notation. Example: \"100s\", \"24h\", \"1d\".\nFor duration longer than a day, only multiple of days is supported. We\nsupport only \"100s\" and \"1d\" for now. Additional support will be added in\nthe future. \"0\" indicates indefinite duration.\n\nUsed by group-based quotas only.",
+ "type": "string"
+ },
+ "defaultLimit": {
+ "description": "Default number of tokens that can be consumed during the specified\nduration. This is the number of tokens assigned when a client\napplication developer activates the service for his/her project.\n\nSpecifying a value of 0 will block all requests. This can be used if you\nare provisioning quota to selected consumers and blocking others.\nSimilarly, a value of -1 will indicate an unlimited quota. No other\nnegative values are allowed.\n\nUsed by group-based quotas only.",
+ "format": "int64",
+ "type": "string"
+ },
+ "displayName": {
+ "description": "User-visible display name for this limit.\nOptional. If not set, the UI will provide a default display name based on\nthe quota configuration. This field can be used to override the default\ndisplay name generated from the configuration.",
+ "type": "string"
+ },
+ "metric": {
+ "description": "The name of the metric this quota limit applies to. The quota limits with\nthe same metric will be checked together during runtime. The metric must be\ndefined within the service config.",
+ "type": "string"
+ },
+ "description": {
+ "description": "Optional. User-visible, extended description for this quota limit.\nShould be used only when more context is needed to understand this limit\nthan provided by the limit's display name (see: `display_name`).",
+ "type": "string"
+ },
+ "values": {
+ "additionalProperties": {
+ "format": "int64",
+ "type": "string"
+ },
+ "description": "Tiered limit values. You must specify this as a key:value pair, with an\ninteger value that is the maximum number of requests allowed for the\nspecified unit. Currently only STANDARD is supported.",
+ "type": "object"
+ },
+ "unit": {
+ "description": "Specify the unit of the quota limit. It uses the same syntax as\nMetric.unit. The supported unit kinds are determined by the quota\nbackend system.\n\nHere are some examples:\n* \"1/min/{project}\" for quota per minute per project.\n\nNote: the order of unit components is insignificant.\nThe \"1\" at the beginning is required to follow the metric unit syntax.",
+ "type": "string"
+ },
+ "maxLimit": {
+ "description": "Maximum number of tokens that can be consumed during the specified\nduration. Client application developers can override the default limit up\nto this maximum. If specified, this value cannot be set to a value less\nthan the default limit. If not specified, it is set to the default limit.\n\nTo allow clients to apply overrides with no upper bound, set this to -1,\nindicating unlimited maximum quota.\n\nUsed by group-based quotas only.",
+ "format": "int64",
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of the quota limit.\n\nThe name must be provided, and it must be unique within the service. The\nname can only include alphanumeric characters as well as '-'.\n\nThe maximum length of the limit name is 64 characters.",
+ "type": "string"
+ }
+ },
+ "id": "QuotaLimit",
+ "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"
},
"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.",
@@ -162,43 +507,45 @@
"type": "string"
}
},
- "id": "Mixin"
+ "id": "Mixin",
+ "description": "Declares an API Interface to be included in this interface. The including\ninterface must redeclare all the methods from the included interface, but\ndocumentation and options are inherited as follows:\n\n- If after comment and whitespace stripping, the documentation\n string of the redeclared method is empty, it will be inherited\n from the original method.\n\n- Each annotation belonging to the service config (http,\n visibility) which is not set in the redeclared method will be\n inherited.\n\n- If an http annotation is inherited, the path pattern will be\n modified as follows. Any version prefix will be replaced by the\n version of the including interface plus the root path if\n specified.\n\nExample of a simple mixin:\n\n package google.acl.v1;\n service AccessControl {\n // Get the underlying ACL object.\n rpc GetAcl(GetAclRequest) returns (Acl) {\n option (google.api.http).get = \"/v1/{resource=**}:getAcl\";\n }\n }\n\n package google.storage.v2;\n service Storage {\n // rpc GetAcl(GetAclRequest) returns (Acl);\n\n // Get a data record.\n rpc GetData(GetDataRequest) returns (Data) {\n option (google.api.http).get = \"/v2/{resource=**}\";\n }\n }\n\nExample of a mixin configuration:\n\n apis:\n - name: google.storage.v2.Storage\n mixins:\n - name: google.acl.v1.AccessControl\n\nThe mixin construct implies that all methods in `AccessControl` are\nalso declared with same name and request/response types in\n`Storage`. A documentation generator or annotation processor will\nsee the effective `Storage.GetAcl` method after inherting\ndocumentation and annotations as follows:\n\n service Storage {\n // Get the underlying ACL object.\n rpc GetAcl(GetAclRequest) returns (Acl) {\n option (google.api.http).get = \"/v2/{resource=**}:getAcl\";\n }\n ...\n }\n\nNote how the version in the path pattern changed from `v1` to `v2`.\n\nIf the `root` field in the mixin is specified, it should be a\nrelative path under which inherited HTTP paths are placed. Example:\n\n apis:\n - name: google.storage.v2.Storage\n mixins:\n - name: google.acl.v1.AccessControl\n root: acls\n\nThis implies the following inherited HTTP annotation:\n\n service Storage {\n // Get the underlying ACL object.\n rpc GetAcl(GetAclRequest) returns (Acl) {\n option (google.api.http).get = \"/v2/acls/{resource=**}:getAcl\";\n }\n ...\n }",
+ "type": "object"
},
"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"
}
+ },
+ "types": {
+ "description": "The list of custom error detail types, e.g. 'google.foo.v1.CustomError'.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
}
},
- "id": "CustomError"
+ "id": "CustomError",
+ "description": "Customize service error responses. For example, list any service\nspecific protobuf types that can appear in error detail lists of\nerror responses.\n\nExample:\n\n custom_error:\n types:\n - google.foo.v1.CustomError\n - google.foo.v1.AnotherError",
+ "type": "object"
},
"Http": {
"description": "Defines the HTTP configuration for an API service. It contains a list of\nHttpRule, each specifying the mapping of an RPC method\nto one or more HTTP REST API methods.",
"type": "object",
"properties": {
- "fullyDecodeReservedExpansion": {
- "description": "When set to true, URL path parmeters will be fully URI-decoded except in\ncases of single segment matches in reserved expansion, where \"%2F\" will be\nleft encoded.\n\nThe default behavior is to not decode RFC 6570 reserved characters in multi\nsegment matches.",
- "type": "boolean"
- },
"rules": {
"description": "A list of HTTP configuration rules that apply to individual API methods.\n\n**NOTE:** All service configuration rules follow \"last one wins\" order.",
"type": "array",
"items": {
"$ref": "HttpRule"
}
+ },
+ "fullyDecodeReservedExpansion": {
+ "description": "When set to true, URL path parmeters will be fully URI-decoded except in\ncases of single segment matches in reserved expansion, where \"%2F\" will be\nleft encoded.\n\nThe default behavior is to not decode RFC 6570 reserved characters in multi\nsegment matches.",
+ "type": "boolean"
}
},
"id": "Http"
@@ -211,26 +558,26 @@
"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"
}
}
},
"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.",
@@ -251,31 +598,43 @@
},
"id": "SystemParameter"
},
- "Monitoring": {
- "description": "Monitoring configuration of the service.\n\nThe example below shows how to configure monitored resources and metrics\nfor monitoring. In the example, a monitored resource and two metrics are\ndefined. The `library.googleapis.com/book/returned_count` metric is sent\nto both producer and consumer projects, whereas the\n`library.googleapis.com/book/overdue_count` metric is only sent to the\nconsumer project.\n\n monitored_resources:\n - type: library.googleapis.com/branch\n labels:\n - key: /city\n description: The city where the library branch is located in.\n - key: /name\n description: The name of the branch.\n metrics:\n - name: library.googleapis.com/book/returned_count\n metric_kind: DELTA\n value_type: INT64\n labels:\n - key: /customer_id\n - name: library.googleapis.com/book/overdue_count\n metric_kind: GAUGE\n value_type: INT64\n labels:\n - key: /customer_id\n monitoring:\n producer_destinations:\n - monitored_resource: library.googleapis.com/branch\n metrics:\n - library.googleapis.com/book/returned_count\n consumer_destinations:\n - monitored_resource: library.googleapis.com/branch\n metrics:\n - library.googleapis.com/book/returned_count\n - library.googleapis.com/book/overdue_count",
- "type": "object",
- "properties": {
- "consumerDestinations": {
- "description": "Monitoring configurations for sending metrics to the consumer project.\nThere can be multiple consumer destinations, each one must have a\ndifferent monitored resource type. A metric can be used in at most\none consumer destination.",
- "type": "array",
- "items": {
- "$ref": "MonitoringDestination"
- }
- },
- "producerDestinations": {
- "description": "Monitoring configurations for sending metrics to the producer project.\nThere can be multiple producer destinations, each one must have a\ndifferent monitored resource type. A metric can be used in at most\none producer destination.",
- "type": "array",
- "items": {
- "$ref": "MonitoringDestination"
- }
- }
- },
- "id": "Monitoring"
- },
"Field": {
"description": "A single field of a message type.",
"type": "object",
"properties": {
+ "oneofIndex": {
+ "description": "The index of the field type in `Type.oneofs`, for message or enumeration\ntypes. The first type has index 1; zero means the type is not in the list.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "cardinality": {
+ "enum": [
+ "CARDINALITY_UNKNOWN",
+ "CARDINALITY_OPTIONAL",
+ "CARDINALITY_REQUIRED",
+ "CARDINALITY_REPEATED"
+ ],
+ "description": "The field cardinality.",
+ "type": "string",
+ "enumDescriptions": [
+ "For fields with unknown cardinality.",
+ "For optional fields.",
+ "For required fields. Proto2 syntax only.",
+ "For repeated fields."
+ ]
+ },
+ "packed": {
+ "description": "Whether to use alternative packed wire representation.",
+ "type": "boolean"
+ },
+ "defaultValue": {
+ "description": "The string value of the default value of this field. Proto2 syntax only.",
+ "type": "string"
+ },
+ "name": {
+ "description": "The field name.",
+ "type": "string"
+ },
"typeUrl": {
"description": "The field type URL, without the scheme, for message or enumeration\ntypes. Example: `\"type.googleapis.com/google.protobuf.Timestamp\"`.",
"type": "string"
@@ -290,6 +649,27 @@
"type": "string"
},
"kind": {
+ "enum": [
+ "TYPE_UNKNOWN",
+ "TYPE_DOUBLE",
+ "TYPE_FLOAT",
+ "TYPE_INT64",
+ "TYPE_UINT64",
+ "TYPE_INT32",
+ "TYPE_FIXED64",
+ "TYPE_FIXED32",
+ "TYPE_BOOL",
+ "TYPE_STRING",
+ "TYPE_GROUP",
+ "TYPE_MESSAGE",
+ "TYPE_BYTES",
+ "TYPE_UINT32",
+ "TYPE_ENUM",
+ "TYPE_SFIXED32",
+ "TYPE_SFIXED64",
+ "TYPE_SINT32",
+ "TYPE_SINT64"
+ ],
"description": "The field type.",
"type": "string",
"enumDescriptions": [
@@ -312,27 +692,6 @@
"Field type sfixed64.",
"Field type sint32.",
"Field type sint64."
- ],
- "enum": [
- "TYPE_UNKNOWN",
- "TYPE_DOUBLE",
- "TYPE_FLOAT",
- "TYPE_INT64",
- "TYPE_UINT64",
- "TYPE_INT32",
- "TYPE_FIXED64",
- "TYPE_FIXED32",
- "TYPE_BOOL",
- "TYPE_STRING",
- "TYPE_GROUP",
- "TYPE_MESSAGE",
- "TYPE_BYTES",
- "TYPE_UINT32",
- "TYPE_ENUM",
- "TYPE_SFIXED32",
- "TYPE_SFIXED64",
- "TYPE_SINT32",
- "TYPE_SINT64"
]
},
"options": {
@@ -341,68 +700,47 @@
"items": {
"$ref": "Option"
}
- },
- "oneofIndex": {
- "description": "The index of the field type in `Type.oneofs`, for message or enumeration\ntypes. The first type has index 1; zero means the type is not in the list.",
- "format": "int32",
- "type": "integer"
- },
- "cardinality": {
- "enumDescriptions": [
- "For fields with unknown cardinality.",
- "For optional fields.",
- "For required fields. Proto2 syntax only.",
- "For repeated fields."
- ],
- "enum": [
- "CARDINALITY_UNKNOWN",
- "CARDINALITY_OPTIONAL",
- "CARDINALITY_REQUIRED",
- "CARDINALITY_REPEATED"
- ],
- "description": "The field cardinality.",
- "type": "string"
- },
- "packed": {
- "description": "Whether to use alternative packed wire representation.",
- "type": "boolean"
- },
- "defaultValue": {
- "description": "The string value of the default value of this field. Proto2 syntax only.",
- "type": "string"
- },
- "name": {
- "description": "The field name.",
- "type": "string"
}
},
"id": "Field"
},
- "Enum": {
- "description": "Enum type definition.",
- "type": "object",
+ "Monitoring": {
"properties": {
- "options": {
- "description": "Protocol buffer options.",
+ "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": "Option"
+ "$ref": "MonitoringDestination"
}
},
+ "producerDestinations": {
+ "description": "Monitoring configurations for sending metrics to the producer project.\nThere can be multiple producer destinations, each one must have a\ndifferent monitored resource type. A metric can be used in at most\none producer destination.",
+ "type": "array",
+ "items": {
+ "$ref": "MonitoringDestination"
+ }
+ }
+ },
+ "id": "Monitoring",
+ "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": {
+ "properties": {
"sourceContext": {
- "$ref": "SourceContext",
- "description": "The source context."
+ "description": "The source context.",
+ "$ref": "SourceContext"
},
"syntax": {
+ "enum": [
+ "SYNTAX_PROTO2",
+ "SYNTAX_PROTO3"
+ ],
"description": "The source syntax.",
"type": "string",
"enumDescriptions": [
"Syntax `proto2`.",
"Syntax `proto3`."
- ],
- "enum": [
- "SYNTAX_PROTO2",
- "SYNTAX_PROTO3"
]
},
"name": {
@@ -415,28 +753,21 @@
"items": {
"$ref": "EnumValue"
}
+ },
+ "options": {
+ "description": "Protocol buffer options.",
+ "type": "array",
+ "items": {
+ "$ref": "Option"
+ }
}
},
- "id": "Enum"
- },
- "EnableServiceRequest": {
- "description": "Request message for EnableService method.",
- "type": "object",
- "properties": {},
- "id": "EnableServiceRequest"
+ "id": "Enum",
+ "description": "Enum type definition.",
+ "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"
- },
"valueType": {
"enumDescriptions": [
"A variable-length string. This is the default.",
@@ -450,37 +781,44 @@
],
"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"
+ "id": "LabelDescriptor",
+ "description": "A description of a label.",
+ "type": "object"
+ },
+ "EnableServiceRequest": {
+ "properties": {},
+ "id": "EnableServiceRequest",
+ "description": "Request message for EnableService method.",
+ "type": "object"
},
"Type": {
- "description": "A protocol buffer message type.",
- "type": "object",
"properties": {
- "oneofs": {
- "description": "The list of types appearing in `oneof` definitions in this type.",
- "type": "array",
- "items": {
- "type": "string"
- }
+ "sourceContext": {
+ "$ref": "SourceContext",
+ "description": "The source context."
},
"syntax": {
+ "enum": [
+ "SYNTAX_PROTO2",
+ "SYNTAX_PROTO3"
+ ],
"description": "The source syntax.",
"type": "string",
"enumDescriptions": [
"Syntax `proto2`.",
"Syntax `proto3`."
- ],
- "enum": [
- "SYNTAX_PROTO2",
- "SYNTAX_PROTO3"
]
},
- "sourceContext": {
- "$ref": "SourceContext",
- "description": "The source context."
- },
"options": {
"description": "The protocol buffer options.",
"type": "array",
@@ -498,20 +836,29 @@
"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"
+ }
}
},
- "id": "Type"
+ "id": "Type",
+ "description": "A protocol buffer message type.",
+ "type": "object"
},
"Experimental": {
- "description": "Experimental service configuration. These configuration options can\nonly be used by whitelisted users.",
- "type": "object",
"properties": {
"authorization": {
"$ref": "AuthorizationConfig",
"description": "Authorization configuration."
}
},
- "id": "Experimental"
+ "id": "Experimental",
+ "description": "Experimental service configuration. These configuration options can\nonly be used by whitelisted users.",
+ "type": "object"
},
"Backend": {
"description": "`Backend` defines the backend configuration for a service.",
@@ -528,19 +875,17 @@
"id": "Backend"
},
"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"
+ "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"
},
"DocumentationRule": {
- "description": "A documentation rule provides information about individual API elements.",
- "type": "object",
"properties": {
"description": {
"description": "Description of the selected API(s).",
@@ -555,12 +900,21 @@
"type": "string"
}
},
- "id": "DocumentationRule"
+ "id": "DocumentationRule",
+ "description": "A documentation rule provides information about individual API elements.",
+ "type": "object"
},
"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"
@@ -571,46 +925,32 @@
"items": {
"type": "string"
}
- },
- "requested": {
- "description": "A list of full type names of requested contexts.",
- "type": "array",
- "items": {
- "type": "string"
- }
}
},
"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": {
"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"
+ "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": {
+ "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",
@@ -621,11 +961,18 @@
"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",
+ "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."
+ ]
},
"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.",
@@ -637,7 +984,9 @@
"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.",
@@ -657,17 +1006,13 @@
"items": {
"$ref": "LabelDescriptor"
}
- },
- "name": {
- "description": "The resource name of the metric descriptor.",
- "type": "string"
}
},
- "id": "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"
},
"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.",
@@ -677,11 +1022,11 @@
}
}
},
- "id": "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"
},
"ListEnabledServicesResponse": {
- "description": "Response message for `ListEnabledServices` method.",
- "type": "object",
"properties": {
"services": {
"description": "Services enabled for the specified parent.",
@@ -695,12 +1040,22 @@
"type": "string"
}
},
- "id": "ListEnabledServicesResponse"
+ "id": "ListEnabledServicesResponse",
+ "description": "Response message for `ListEnabledServices` method.",
+ "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",
@@ -718,14 +1073,6 @@
"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"
@@ -745,13 +1092,6 @@
"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"
@@ -762,6 +1102,13 @@
"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"
@@ -781,9 +1128,11 @@
"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": {
"description": "A human-readable description of this log. This information appears in\nthe documentation and can contain details.",
"type": "string"
@@ -798,18 +1147,33 @@
"items": {
"$ref": "LabelDescriptor"
}
- },
- "name": {
- "description": "The name of the log. It must be less than 512 characters long and can\ninclude the following characters: upper- and lower-case alphanumeric\ncharacters [A-Za-z0-9], and punctuation characters including\nslash, underscore, hyphen, period [/_-.].",
- "type": "string"
}
},
- "id": "LogDescriptor"
+ "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"
+ },
+ "CustomErrorRule": {
+ "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",
+ "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"
@@ -828,39 +1192,11 @@
"items": {
"$ref": "LabelDescriptor"
}
- },
- "name": {
- "description": "Optional. The resource name of the monitored resource descriptor:\n`\"projects/{project_id}/monitoredResourceDescriptors/{type}\"` where\n{type} is the value of the `type` field in this object and\n{project_id} is a project ID that provides API-specific context for\naccessing the type. APIs that do not use project information can use the\nresource name format `\"monitoredResourceDescriptors/{type}\"`.",
- "type": "string"
}
},
- "id": "MonitoredResourceDescriptor"
- },
- "CustomErrorRule": {
- "description": "A custom error rule.",
- "type": "object",
- "properties": {
- "isErrorType": {
- "description": "Mark this message as possible payload in error response. Otherwise,\nobjects of this type will be filtered when they appear in error payload.",
- "type": "boolean"
- },
- "selector": {
- "description": "Selects messages to which this rule applies.\n\nRefer to selector for syntax details.",
- "type": "string"
- }
- },
- "id": "CustomErrorRule"
- },
- "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"
+ "id": "MonitoredResourceDescriptor",
+ "description": "An object that describes the schema of a MonitoredResource object using a\ntype name and a set of labels. For example, the monitored resource\ndescriptor for Google Compute Engine VM instances has a type of\n`\"gce_instance\"` and specifies the use of the labels `\"instance_id\"` and\n`\"zone\"` to identify particular VM instances.\n\nDifferent APIs can support different monitored resource types. APIs generally\nprovide a `list` method that returns the monitored resource descriptors used\nby the API.",
+ "type": "object"
},
"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.",
@@ -882,18 +1218,29 @@
"description": "A boolean that determines whether a notification for the completion of a\ndownload should be sent to the backend.",
"type": "boolean"
},
- "dropzone": {
- "description": "Name of the Scotty dropzone to use for the current API.",
- "type": "string"
- },
"maxDirectDownloadSize": {
"description": "Optional maximum acceptable size for direct download.\nThe size is specified in bytes.",
"format": "int64",
"type": "string"
+ },
+ "dropzone": {
+ "description": "Name of the Scotty dropzone to use for the current API.",
+ "type": "string"
}
},
"id": "MediaDownload"
},
+ "CustomAuthRequirements": {
+ "properties": {
+ "provider": {
+ "description": "A configuration string containing connection information for the\nauthentication provider, typically formatted as a SmartService string\n(go/smartservice).",
+ "type": "string"
+ }
+ },
+ "id": "CustomAuthRequirements",
+ "description": "Configuration for a custom authentication provider.",
+ "type": "object"
+ },
"DisableServiceRequest": {
"description": "Request message for DisableService method.",
"type": "object",
@@ -901,8 +1248,6 @@
"id": "DisableServiceRequest"
},
"SearchServicesResponse": {
- "description": "Response message for SearchServices method.",
- "type": "object",
"properties": {
"services": {
"description": "Services available publicly or available to the authenticated caller.",
@@ -916,28 +1261,14 @@
"type": "string"
}
},
- "id": "SearchServicesResponse"
+ "id": "SearchServicesResponse",
+ "description": "Response message for SearchServices method.",
+ "type": "object"
},
"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"
@@ -957,6 +1288,22 @@
"description": "Optional maximum acceptable size for an upload.\nThe size is specified in bytes.",
"format": "int64",
"type": "string"
+ },
+ "completeNotification": {
+ "description": "A boolean that determines whether a notification for the completion of an\nupload should be sent to the backend. These notifications will not be seen\nby the client and will not consume quota.",
+ "type": "boolean"
+ },
+ "progressNotification": {
+ "description": "Whether to receive a notification for progress changes of media upload.",
+ "type": "boolean"
+ },
+ "enabled": {
+ "description": "Whether upload is enabled.",
+ "type": "boolean"
+ },
+ "dropzone": {
+ "description": "Name of the Scotty dropzone to use for the current API.",
+ "type": "string"
}
},
"id": "MediaUpload"
@@ -965,24 +1312,26 @@
"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"
}
- },
- "monitoredResource": {
- "description": "The monitored resource type. The type must be defined in\nService.monitored_resources section.",
- "type": "string"
}
},
"id": "BillingDestination"
},
"UsageRule": {
- "description": "Usage configuration rules for the service.\n\nNOTE: Under development.\n\n\nUse this rule to configure unregistered calls for the service. Unregistered\ncalls are calls that do not contain consumer project identity.\n(Example: calls that do not contain an API key).\nBy default, API methods do not allow unregistered calls, and each method call\nmust be identified by a consumer project identity. Use this rule to\nallow/disallow unregistered calls.\n\nExample of an API that wants to allow unregistered calls for entire service.\n\n usage:\n rules:\n - selector: \"*\"\n allow_unregistered_calls: true\n\nExample of a method that wants to allow unregistered calls.\n\n usage:\n rules:\n - selector: \"google.example.library.v1.LibraryService.CreateBook\"\n allow_unregistered_calls: true",
- "type": "object",
"properties": {
+ "selector": {
+ "description": "Selects the methods to which this rule applies. Use '*' to indicate all\nmethods in all APIs.\n\nRefer to selector for syntax details.",
+ "type": "string"
+ },
"skipServiceControl": {
"description": "If true, the selected method should skip service control and the control\nplane features, such as quota and billing, will not be available.\nThis flag is used by Google Cloud Endpoints to bypass checks for internal\nmethods, such as service health check methods.",
"type": "boolean"
@@ -990,17 +1339,13 @@
"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"
}
},
- "id": "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"
},
"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",
@@ -1011,19 +1356,12 @@
"type": "string"
}
},
- "id": "AuthRequirement"
+ "id": "AuthRequirement",
+ "description": "User-defined authentication requirements, including support for\n[JSON Web Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32).",
+ "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": {
- "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"
@@ -1042,44 +1380,29 @@
"overview": {
"description": "Declares a single overview page. For example:\n\u003cpre\u003e\u003ccode\u003edocumentation:\n summary: ...\n overview: (== include overview.md ==)\n\u003c/code\u003e\u003c/pre\u003e\nThis is a shortcut for the following declaration (using pages style):\n\u003cpre\u003e\u003ccode\u003edocumentation:\n summary: ...\n pages:\n - name: Overview\n content: (== include overview.md ==)\n\u003c/code\u003e\u003c/pre\u003e\nNote: you cannot specify both `overview` field and `pages` field.",
"type": "string"
- }
- },
- "id": "Documentation"
- },
- "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.",
+ "pages": {
+ "description": "The top level pages for the documentation set.",
"type": "array",
"items": {
- "$ref": "AuthRequirement"
+ "$ref": "Page"
}
+ }
+ },
+ "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"
+ },
+ "BackendRule": {
+ "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"
},
- "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"
- },
- "BackendRule": {
- "description": "A backend rule provides configuration for an individual API element.",
- "type": "object",
- "properties": {
"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",
@@ -1089,22 +1412,75 @@
"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"
- },
+ }
+ },
+ "id": "BackendRule",
+ "description": "A backend rule provides configuration for an individual API element.",
+ "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": "BackendRule"
+ "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": {
+ "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",
+ "enumDescriptions": [
+ "Syntax `proto2`.",
+ "Syntax `proto3`."
+ ]
+ },
+ "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",
@@ -1118,40 +1494,11 @@
"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"
}
},
- "id": "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"
},
"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.",
@@ -1162,12 +1509,12 @@
"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"
@@ -1197,17 +1544,13 @@
"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`.",
@@ -1218,12 +1561,16 @@
"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.",
+ "type": "boolean"
}
},
"id": "Operation"
@@ -1232,10 +1579,6 @@
"description": "Represents a documentation page. A page can contain subpages to represent\nnested documentation set structure.",
"type": "object",
"properties": {
- "content": {
- "description": "The Markdown content of the page. You can use \u003ccode\u003e(== include {path} ==)\u003c/code\u003e\nto include content from a Markdown file.",
- "type": "string"
- },
"subpages": {
"description": "Subpages of this page. The order of subpages specified here will be\nhonored in the generated docset.",
"type": "array",
@@ -1246,6 +1589,10 @@
"name": {
"description": "The name of the page. It will be used as an identity of the page to\ngenerate URI of the page, text of the link to this page in navigation,\netc. The full page name (start from the root page name to this page\nconcatenated with `.`) can be used as reference to the page in your\ndocumentation. For example:\n\u003cpre\u003e\u003ccode\u003epages:\n- name: Tutorial\n content: (== include tutorial.md ==)\n subpages:\n - name: Java\n content: (== include tutorial_java.md ==)\n\u003c/code\u003e\u003c/pre\u003e\nYou can reference `Java` page using Markdown reference link syntax:\n`Java`.",
"type": "string"
+ },
+ "content": {
+ "description": "The Markdown content of the page. You can use \u003ccode\u003e(== include {path} ==)\u003c/code\u003e\nto include content from a Markdown file.",
+ "type": "string"
}
},
"id": "Page"
@@ -1254,11 +1601,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": {
- "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"
@@ -1267,12 +1609,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"
@@ -1281,14 +1628,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"
- },
"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"
@@ -1300,60 +1639,39 @@
"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": {
- "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": {
"sourceInfo": {
- "description": "Output only. The source information for this configuration if available.",
- "$ref": "SourceInfo"
+ "$ref": "SourceInfo",
+ "description": "Output only. The source information for this configuration if available."
},
"http": {
- "description": "HTTP configuration.",
- "$ref": "Http"
- },
- "backend": {
- "description": "API backend configuration.",
- "$ref": "Backend"
+ "$ref": "Http",
+ "description": "HTTP configuration."
},
"systemParameters": {
"$ref": "SystemParameters",
"description": "System parameter configuration."
},
- "documentation": {
- "description": "Additional API documentation.",
- "$ref": "Documentation"
+ "backend": {
+ "$ref": "Backend",
+ "description": "API backend configuration."
},
- "logging": {
- "description": "Logging configuration.",
- "$ref": "Logging"
+ "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.",
@@ -1362,6 +1680,14 @@
"$ref": "MonitoredResourceDescriptor"
}
},
+ "logging": {
+ "$ref": "Logging",
+ "description": "Logging configuration."
+ },
+ "context": {
+ "$ref": "Context",
+ "description": "Context configuration."
+ },
"enums": {
"description": "A list of all enum types included in this API service. Enums\nreferenced directly or indirectly by the `apis` are automatically\nincluded. Enums which are not referenced but shall be included\nshould be listed here by name. Example:\n\n enums:\n - name: google.someapi.v1.SomeEnum",
"type": "array",
@@ -1369,10 +1695,6 @@
"$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"
@@ -1393,12 +1715,12 @@
"$ref": "Authentication"
},
"experimental": {
- "$ref": "Experimental",
- "description": "Experimental configuration."
+ "description": "Experimental configuration.",
+ "$ref": "Experimental"
},
"control": {
- "$ref": "Control",
- "description": "Configuration for the service control plane."
+ "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`.",
@@ -1409,6 +1731,10 @@
"$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",
@@ -1416,13 +1742,9 @@
"$ref": "Type"
}
},
- "producerProjectId": {
- "description": "The Google project that owns this service.",
- "type": "string"
- },
"visibility": {
- "description": "API visibility configuration.",
- "$ref": "Visibility"
+ "$ref": "Visibility",
+ "description": "API visibility configuration."
},
"quota": {
"description": "Quota configuration.",
@@ -1437,8 +1759,8 @@
"$ref": "Billing"
},
"customError": {
- "description": "Custom error configuration.",
- "$ref": "CustomError"
+ "$ref": "CustomError",
+ "description": "Custom error configuration."
},
"title": {
"description": "The product title for this service.",
@@ -1451,13 +1773,6 @@
"$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",
@@ -1465,6 +1780,13 @@
"$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",
@@ -1473,11 +1795,49 @@
}
}
},
- "id": "Service"
+ "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"
+ },
+ "EnumValue": {
+ "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",
+ "description": "Enum value definition.",
+ "type": "object"
+ },
+ "CustomHttpPattern": {
+ "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",
+ "description": "A custom pattern is used for defining custom HTTP verb.",
+ "type": "object"
},
"OperationMetadata": {
- "description": "The metadata associated with a long running operation resource.",
- "type": "object",
"properties": {
"startTime": {
"description": "The start time of the operation.",
@@ -1504,44 +1864,11 @@
"type": "integer"
}
},
- "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": {
- "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"
+ "id": "OperationMetadata",
+ "description": "The metadata associated with a long running operation resource.",
+ "type": "object"
},
"PublishedService": {
- "description": "The published version of a Service that is managed by\nGoogle Service Management.",
- "type": "object",
"properties": {
"service": {
"description": "The service's published configuration.",
@@ -1552,11 +1879,29 @@
"type": "string"
}
},
- "id": "PublishedService"
+ "id": "PublishedService",
+ "description": "The published version of a Service that is managed by\nGoogle Service Management.",
+ "type": "object"
+ },
+ "SystemParameterRule": {
+ "description": "Define a system parameter rule mapping system parameter definitions to\nmethods.",
+ "type": "object",
+ "properties": {
+ "selector": {
+ "description": "Selects the methods to which this rule applies. Use '*' to indicate all\nmethods in all APIs.\n\nRefer to selector for syntax details.",
+ "type": "string"
+ },
+ "parameters": {
+ "description": "Define parameters. Multiple names may be defined for a parameter.\nFor a given method call, only one of them should be used. If multiple\nnames are used the behavior is implementation-dependent.\nIf none of the specified names are present the behavior is\nparameter-dependent.",
+ "type": "array",
+ "items": {
+ "$ref": "SystemParameter"
+ }
+ }
+ },
+ "id": "SystemParameterRule"
},
"VisibilityRule": {
- "description": "A visibility rule provides visibility configuration for an individual API\nelement.",
- "type": "object",
"properties": {
"restriction": {
"description": "A comma-separated list of visibility labels that apply to the `selector`.\nAny of the listed labels can be used to grant the visibility.\n\nIf a rule has multiple labels, removing one of the labels but not all of\nthem can break clients.\n\nExample:\n\n visibility:\n rules:\n - selector: google.calendar.Calendar.EnhancedSearch\n restriction: GOOGLE_INTERNAL, TRUSTED_TESTER\n\nRemoving GOOGLE_INTERNAL from this restriction will break clients that\nrely on this method and only had access to it through GOOGLE_INTERNAL.",
@@ -1567,47 +1912,19 @@
"type": "string"
}
},
- "id": "VisibilityRule"
+ "id": "VisibilityRule",
+ "description": "A visibility rule provides visibility configuration for an individual API\nelement.",
+ "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": {
- "mediaUpload": {
- "$ref": "MediaUpload",
- "description": "Use this only for Scotty Requests. Do not use this for media support using\nBytestream, add instead\n[][google.bytestream.RestByteStream] as an API to your\nconfiguration for Bytestream methods."
- },
- "selector": {
- "description": "Selects methods to which this rule applies.\n\nRefer to selector for syntax details.",
- "type": "string"
- },
- "custom": {
- "$ref": "CustomHttpPattern",
- "description": "The custom pattern is used for specifying an HTTP method that is not\nincluded in the `pattern` field, such as HEAD, or \"*\" to leave the\nHTTP method unspecified for this rule. The wild-card rule is useful\nfor services that provide content to Web (HTML) clients."
- },
- "get": {
- "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."
+ "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.",
@@ -1623,13 +1940,41 @@
"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": {
+ "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"
+ },
+ "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"
+ },
+ "delete": {
+ "description": "Used for deleting a resource.",
+ "type": "string"
}
},
- "id": "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"
},
"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.",
@@ -1643,359 +1988,14 @@
}
}
},
- "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.",
- "type": "object",
- "properties": {
- "rules": {
- "description": "A list of visibility rules that apply to individual API elements.\n\n**NOTE:** All service configuration rules follow \"last one wins\" order.",
- "type": "array",
- "items": {
- "$ref": "VisibilityRule"
- }
- }
- },
- "id": "Visibility"
- },
- "SystemParameters": {
- "description": "### System parameter configuration\n\nA system parameter is a special kind of parameter defined by the API\nsystem, not by an individual API. It is typically mapped to an HTTP header\nand/or a URL query parameter. This configuration specifies which methods\nchange the names of the system parameters.",
- "type": "object",
- "properties": {
- "rules": {
- "description": "Define system parameters.\n\nThe parameters defined here will override the default parameters\nimplemented by the system. If this field is missing from the service\nconfig, default system parameters will be used. Default system parameters\nand names is implementation-dependent.\n\nExample: define api key for all methods\n\n system_parameters\n rules:\n - selector: \"*\"\n parameters:\n - name: api_key\n url_query_parameter: api_key\n\n\nExample: define 2 api key names for a specific method.\n\n system_parameters\n rules:\n - selector: \"/ListShelves\"\n parameters:\n - name: api_key\n http_header: Api-Key1\n - name: api_key\n http_header: Api-Key2\n\n**NOTE:** All service configuration rules follow \"last one wins\" order.",
- "type": "array",
- "items": {
- "$ref": "SystemParameterRule"
- }
- }
- },
- "id": "SystemParameters"
- },
- "Quota": {
- "description": "Quota configuration helps to achieve fairness and budgeting in service\nusage.\n\nThe quota configuration works this way:\n- The service configuration defines a set of metrics.\n- For API calls, the quota.metric_rules maps methods to metrics with\n corresponding costs.\n- The quota.limits defines limits on the metrics, which will be used for\n quota checks at runtime.\n\nAn example quota configuration in yaml format:\n\n quota:\n\n - name: apiWriteQpsPerProject\n metric: library.googleapis.com/write_calls\n unit: \"1/min/{project}\" # rate limit for consumer projects\n values:\n STANDARD: 10000\n\n\n # The metric rules bind all methods to the read_calls metric,\n # except for the UpdateBook and DeleteBook methods. These two methods\n # are mapped to the write_calls metric, with the UpdateBook method\n # consuming at twice rate as the DeleteBook method.\n metric_rules:\n - selector: \"*\"\n metric_costs:\n library.googleapis.com/read_calls: 1\n - selector: google.example.library.v1.LibraryService.UpdateBook\n metric_costs:\n library.googleapis.com/write_calls: 2\n - selector: google.example.library.v1.LibraryService.DeleteBook\n metric_costs:\n library.googleapis.com/write_calls: 1\n\n Corresponding Metric definition:\n\n metrics:\n - name: library.googleapis.com/read_calls\n display_name: Read requests\n metric_kind: DELTA\n value_type: INT64\n\n - name: library.googleapis.com/write_calls\n display_name: Write requests\n metric_kind: DELTA\n value_type: INT64",
- "type": "object",
- "properties": {
- "limits": {
- "description": "List of `QuotaLimit` definitions for the service.",
- "type": "array",
- "items": {
- "$ref": "QuotaLimit"
- }
- },
- "metricRules": {
- "description": "List of `MetricRule` definitions, each one mapping a selected method to one\nor more metrics.",
- "type": "array",
- "items": {
- "$ref": "MetricRule"
- }
- }
- },
- "id": "Quota"
- },
- "Step": {
- "description": "Represents the status of one operation step.",
- "type": "object",
- "properties": {
- "description": {
- "description": "The short description of the step.",
- "type": "string"
- },
- "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"
- }
- },
- "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"
+ "id": "MonitoringDestination",
+ "description": "Configuration of a specific monitoring destination (the producer project\nor the consumer project).",
+ "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"
},
- "canonicalName": "Service User",
- "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/service.management": {
- "description": "Manage your Google API service configuration"
- }
- }
- }
- },
- "rootUrl": "https://serviceuser.googleapis.com/",
- "ownerDomain": "google.com",
- "name": "serviceuser",
- "batchPath": "batch",
- "title": "Google Service User API",
- "ownerName": "Google",
- "resources": {
- "projects": {
- "resources": {
- "services": {
- "methods": {
- "disable": {
- "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",
- "httpMethod": "POST",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Operation"
- },
- "parameters": {
- "name": {
- "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",
- "pattern": "^projects/[^/]+/services/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/service.management"
- ],
- "flatPath": "v1/projects/{projectsId}/services/{servicesId}:disable",
- "id": "serviceuser.projects.services.disable",
- "path": "v1/{+name}:disable"
- },
- "enable": {
- "request": {
- "$ref": "EnableServiceRequest"
- },
- "description": "Enable a service so it can be used with a project.\nSee [Cloud Auth Guide](https://cloud.google.com/docs/authentication) for\nmore information.\n\nOperation\u003cresponse: google.protobuf.Empty\u003e",
- "httpMethod": "POST",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Operation"
- },
- "parameters": {
- "name": {
- "location": "path",
- "description": "Name of the consumer and the service to enable for that consumer.\n\nA valid path would be:\n- /v1/projects/my-project/services/servicemanagement.googleapis.com:enable",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/services/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/service.management"
- ],
- "flatPath": "v1/projects/{projectsId}/services/{servicesId}:enable",
- "id": "serviceuser.projects.services.enable",
- "path": "v1/{+name}:enable"
- },
- "list": {
- "response": {
- "$ref": "ListEnabledServicesResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {
- "pageSize": {
- "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/[^/]+$"
- },
- "pageToken": {
- "description": "Token identifying which result to start with; returned by a previous list\ncall.",
- "type": "string",
- "location": "query"
- }
- },
- "flatPath": "v1/projects/{projectsId}/services",
- "path": "v1/{+parent}/services",
- "id": "serviceuser.projects.services.list",
- "description": "List enabled services for the specified consumer."
- }
- }
- }
- }
- },
- "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",
- "parameters": {
- "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"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ]
- }
- }
- }
- },
- "parameters": {
- "oauth_token": {
- "location": "query",
- "description": "OAuth 2.0 token for the current user.",
- "type": "string"
- },
- "bearer_token": {
- "location": "query",
- "description": "OAuth bearer token.",
- "type": "string"
- },
- "upload_protocol": {
- "location": "query",
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string"
- },
- "prettyPrint": {
- "description": "Returns response with indentations and line breaks.",
- "type": "boolean",
- "default": "true",
- "location": "query"
- },
- "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": {
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query",
- "enum": [
- "1",
- "2"
- ],
- "description": "V1 error format.",
- "type": "string"
- },
- "callback": {
- "description": "JSONP",
- "type": "string",
- "location": "query"
- },
- "alt": {
- "type": "string",
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query",
- "description": "Data format for response.",
- "default": "json",
- "enum": [
- "json",
- "media",
- "proto"
- ]
- },
- "key": {
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string",
- "location": "query"
- },
- "access_token": {
- "description": "OAuth access token.",
- "type": "string",
- "location": "query"
- },
- "quotaUser": {
- "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": "v1",
- "baseUrl": "https://serviceuser.googleapis.com/"
+ "protocol": "rest"
}
diff --git a/sheets/v4/sheets-api.json b/sheets/v4/sheets-api.json
index 5c6af04..8b649e3 100644
--- a/sheets/v4/sheets-api.json
+++ b/sheets/v4/sheets-api.json
@@ -1,37 +1,1621 @@
{
- "revision": "20171220",
- "documentationLink": "https://developers.google.com/sheets/",
- "id": "sheets:v4",
- "discoveryVersion": "v1",
"version_module": true,
"schemas": {
- "FilterView": {
- "description": "A filter view.",
+ "GridCoordinate": {
+ "description": "A coordinate in a sheet.\nAll indexes are zero-based.",
"type": "object",
"properties": {
- "namedRangeId": {
- "description": "The named range this filter view is backed by, if any.\n\nWhen writing, only one of range or named_range_id\nmay be set.",
- "type": "string"
- },
- "filterViewId": {
- "description": "The ID of the filter view.",
+ "sheetId": {
+ "description": "The sheet this coordinate is on.",
"format": "int32",
"type": "integer"
},
+ "rowIndex": {
+ "description": "The row index of the coordinate.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "columnIndex": {
+ "description": "The column index of the coordinate.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "GridCoordinate"
+ },
+ "UpdateSheetPropertiesRequest": {
+ "description": "Updates properties of the sheet with the specified\nsheetId.",
+ "type": "object",
+ "properties": {
+ "fields": {
+ "description": "The fields that should be updated. At least one field must be specified.\nThe root `properties` is implied and should not be specified.\nA single `\"*\"` can be used as short-hand for listing every field.",
+ "format": "google-fieldmask",
+ "type": "string"
+ },
+ "properties": {
+ "$ref": "SheetProperties",
+ "description": "The properties to update."
+ }
+ },
+ "id": "UpdateSheetPropertiesRequest"
+ },
+ "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": {
+ "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"
+ }
+ },
+ "id": "GridProperties"
+ },
+ "UnmergeCellsRequest": {
+ "description": "Unmerges cells in the given range.",
+ "type": "object",
+ "properties": {
+ "range": {
+ "description": "The range within which all cells should be unmerged.\nIf the range spans multiple merges, all will be unmerged.\nThe range must not partially span any merge.",
+ "$ref": "GridRange"
+ }
+ },
+ "id": "UnmergeCellsRequest"
+ },
+ "Sheet": {
+ "description": "A sheet in a spreadsheet.",
+ "type": "object",
+ "properties": {
+ "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": {
+ "$ref": "BasicFilter",
+ "description": "The filter on this sheet, if any."
+ },
+ "merges": {
+ "description": "The ranges that are merged together.",
+ "type": "array",
+ "items": {
+ "$ref": "GridRange"
+ }
+ },
+ "data": {
+ "description": "Data in the grid, if this is a grid sheet.\nThe number of GridData objects returned is dependent on the number of\nranges requested on this sheet. For example, if this is representing\n`Sheet1`, and the spreadsheet was requested with ranges\n`Sheet1!A1:C10` and `Sheet1!D15:E20`, then the first GridData will have a\nstartRow/startColumn of `0`,\nwhile the second one will have `startRow 14` (zero-based row 15),\nand `startColumn 3` (zero-based column D).",
+ "type": "array",
+ "items": {
+ "$ref": "GridData"
+ }
+ },
+ "bandedRanges": {
+ "description": "The banded (i.e. alternating colors) ranges on this sheet.",
+ "type": "array",
+ "items": {
+ "$ref": "BandedRange"
+ }
+ },
+ "properties": {
+ "$ref": "SheetProperties",
+ "description": "The properties of the sheet."
+ },
+ "charts": {
+ "description": "The specifications of every chart on this sheet.",
+ "type": "array",
+ "items": {
+ "$ref": "EmbeddedChart"
+ }
+ },
+ "filterViews": {
+ "description": "The filter views in this sheet.",
+ "type": "array",
+ "items": {
+ "$ref": "FilterView"
+ }
+ }
+ },
+ "id": "Sheet"
+ },
+ "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"
+ },
+ "SortSpec": {
+ "description": "A sort order associated with a specific column or row.",
+ "type": "object",
+ "properties": {
+ "dimensionIndex": {
+ "description": "The dimension the sort should be applied to.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "sortOrder": {
+ "enum": [
+ "SORT_ORDER_UNSPECIFIED",
+ "ASCENDING",
+ "DESCENDING"
+ ],
+ "description": "The order data should be sorted.",
+ "type": "string",
+ "enumDescriptions": [
+ "Default value, do not use this.",
+ "Sort ascending.",
+ "Sort descending."
+ ]
+ }
+ },
+ "id": "SortSpec"
+ },
+ "BooleanRule": {
+ "description": "A rule that may or may not match, depending on the condition.",
+ "type": "object",
+ "properties": {
+ "condition": {
+ "$ref": "BooleanCondition",
+ "description": "The condition of the rule. If the condition evaluates to true,\nthe format will be applied."
+ },
+ "format": {
+ "$ref": "CellFormat",
+ "description": "The format to apply.\nConditional formatting can only apply a subset of formatting:\nbold, italic,\nstrikethrough,\nforeground color &\nbackground color."
+ }
+ },
+ "id": "BooleanRule"
+ },
+ "PivotGroupValueMetadata": {
+ "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",
+ "description": "Metadata about a value in a pivot grouping."
+ },
+ "FilterCriteria": {
+ "description": "Criteria for showing/hiding rows in a filter or filter view.",
+ "type": "object",
+ "properties": {
+ "hiddenValues": {
+ "description": "Values that should be hidden.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "condition": {
+ "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"
+ },
+ "WaterfallChartSpec": {
+ "description": "A waterfall chart.",
+ "type": "object",
+ "properties": {
+ "stackedType": {
+ "description": "The stacked type.",
+ "type": "string",
+ "enumDescriptions": [
+ "Default value, do not use.",
+ "Values corresponding to the same domain (horizontal axis) value will be\nstacked vertically.",
+ "Series will spread out along the horizontal axis."
+ ],
+ "enum": [
+ "WATERFALL_STACKED_TYPE_UNSPECIFIED",
+ "STACKED",
+ "SEQUENTIAL"
+ ]
+ },
+ "hideConnectorLines": {
+ "description": "True to hide connector lines between columns.",
+ "type": "boolean"
+ },
+ "series": {
+ "description": "The data this waterfall chart is visualizing.",
+ "type": "array",
+ "items": {
+ "$ref": "WaterfallChartSeries"
+ }
+ },
+ "connectorLineStyle": {
+ "description": "The line style for the connector lines.",
+ "$ref": "LineStyle"
+ },
+ "domain": {
+ "description": "The domain data (horizontal axis) for the waterfall chart.",
+ "$ref": "WaterfallChartDomain"
+ },
+ "firstValueIsTotal": {
+ "description": "True to interpret the first value as a total.",
+ "type": "boolean"
+ }
+ },
+ "id": "WaterfallChartSpec"
+ },
+ "Editors": {
+ "description": "The editors of a protected range.",
+ "type": "object",
+ "properties": {
+ "users": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "The email addresses of users with edit access to the protected range."
+ },
+ "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": {
+ "id": "UpdateConditionalFormatRuleRequest",
+ "description": "Updates a conditional format rule at the given index,\nor moves a conditional format rule to another index.",
+ "type": "object",
+ "properties": {
+ "rule": {
+ "$ref": "ConditionalFormatRule",
+ "description": "The rule that should replace the rule at the given index."
+ },
+ "index": {
+ "description": "The zero-based index of the rule that should be replaced or moved.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "sheetId": {
+ "description": "The sheet of the rule to move. Required if new_index is set,\nunused otherwise.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "newIndex": {
+ "description": "The zero-based new index the rule should end up at.",
+ "format": "int32",
+ "type": "integer"
+ }
+ }
+ },
+ "DataValidationRule": {
+ "id": "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."
+ }
+ }
+ },
+ "BasicChartDomain": {
+ "description": "The domain of a chart.\nFor example, if charting stock prices over time, this would be the date.",
+ "type": "object",
+ "properties": {
+ "domain": {
+ "$ref": "ChartData",
+ "description": "The data of the domain. For example, if charting stock prices over time,\nthis is the data representing the dates."
+ },
+ "reversed": {
+ "description": "True to reverse the order of the domain values (horizontal axis).",
+ "type": "boolean"
+ }
+ },
+ "id": "BasicChartDomain"
+ },
+ "PasteDataRequest": {
+ "description": "Inserts data into the spreadsheet starting at the specified coordinate.",
+ "type": "object",
+ "properties": {
+ "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"
+ },
+ "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"
+ }
+ },
+ "id": "PasteDataRequest"
+ },
+ "UpdateDeveloperMetadataResponse": {
+ "description": "The response from updating developer metadata.",
+ "type": "object",
+ "properties": {
+ "developerMetadata": {
+ "description": "The updated developer metadata.",
+ "type": "array",
+ "items": {
+ "$ref": "DeveloperMetadata"
+ }
+ }
+ },
+ "id": "UpdateDeveloperMetadataResponse"
+ },
+ "AppendDimensionRequest": {
+ "id": "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"
+ }
+ }
+ },
+ "AddNamedRangeRequest": {
+ "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",
+ "description": "Adds a named range to the spreadsheet."
+ },
+ "CreateDeveloperMetadataResponse": {
+ "properties": {
+ "developerMetadata": {
+ "$ref": "DeveloperMetadata",
+ "description": "The developer metadata that was created."
+ }
+ },
+ "id": "CreateDeveloperMetadataResponse",
+ "description": "The response from creating developer metadata.",
+ "type": "object"
+ },
+ "UpdateEmbeddedObjectPositionRequest": {
+ "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",
+ "description": "Update an embedded object's position (such as a moving or resizing a\nchart or image).",
+ "type": "object"
+ },
+ "TextRotation": {
+ "description": "The rotation applied to text in a cell.",
+ "type": "object",
+ "properties": {
+ "angle": {
+ "description": "The angle between the standard orientation and the desired orientation.\nMeasured in degrees. Valid values are between -90 and 90. Positive\nangles are angled upwards, negative are angled downwards.\n\nNote: For LTR text direction positive angles are in the counterclockwise\ndirection, whereas for RTL they are in the clockwise direction",
+ "format": "int32",
+ "type": "integer"
+ },
+ "vertical": {
+ "description": "If true, text reads top to bottom, but the orientation of individual\ncharacters is unchanged.\nFor example:\n\n | V |\n | e |\n | r |\n | t |\n | i |\n | c |\n | a |\n | l |",
+ "type": "boolean"
+ }
+ },
+ "id": "TextRotation"
+ },
+ "PieChartSpec": {
+ "description": "A \u003ca href=\"/chart/interactive/docs/gallery/piechart\"\u003epie chart\u003c/a\u003e.",
+ "type": "object",
+ "properties": {
+ "domain": {
+ "$ref": "ChartData",
+ "description": "The data that covers the domain of the pie chart."
+ },
+ "threeDimensional": {
+ "type": "boolean",
+ "description": "True if the pie is three dimensional."
+ },
+ "series": {
+ "$ref": "ChartData",
+ "description": "The data that covers the one and only series of the pie chart."
+ },
+ "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.",
+ "Each pie slice has a label attached to it."
+ ],
+ "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"
+ },
+ "pieHole": {
+ "type": "number",
+ "description": "The size of the hole in the pie chart.",
+ "format": "double"
+ }
+ },
+ "id": "PieChartSpec"
+ },
+ "UpdateDeveloperMetadataRequest": {
+ "description": "A request to update properties of developer metadata.\nUpdates the properties of the developer metadata selected by the filters to\nthe values provided in the DeveloperMetadata resource. Callers must\nspecify the properties they wish to update in the fields parameter, as well\nas specify at least one DataFilter matching the metadata they wish to\nupdate.",
+ "type": "object",
+ "properties": {
+ "dataFilters": {
+ "description": "The filters matching the developer metadata entries to update.",
+ "type": "array",
+ "items": {
+ "$ref": "DataFilter"
+ }
+ },
+ "fields": {
+ "description": "The fields that should be updated. At least one field must be specified.\nThe root `developerMetadata` is implied and should not be specified.\nA single `\"*\"` can be used as short-hand for listing every field.",
+ "format": "google-fieldmask",
+ "type": "string"
+ },
+ "developerMetadata": {
+ "description": "The value that all metadata matched by the data filters will be updated to.",
+ "$ref": "DeveloperMetadata"
+ }
+ },
+ "id": "UpdateDeveloperMetadataRequest"
+ },
+ "WaterfallChartColumnStyle": {
+ "type": "object",
+ "properties": {
+ "color": {
+ "$ref": "Color",
+ "description": "The color of the column."
+ },
+ "label": {
+ "description": "The label of the column's legend.",
+ "type": "string"
+ }
+ },
+ "id": "WaterfallChartColumnStyle",
+ "description": "Styles for a waterfall chart column."
+ },
+ "UpdateFilterViewRequest": {
+ "id": "UpdateFilterViewRequest",
+ "description": "Updates properties of the filter view.",
+ "type": "object",
+ "properties": {
+ "filter": {
+ "$ref": "FilterView",
+ "description": "The new properties of the filter view."
+ },
+ "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"
+ }
+ }
+ },
+ "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": {
+ "description": "The formatting will vary based on the gradients in the rule.",
+ "$ref": "GradientRule"
+ },
+ "booleanRule": {
+ "$ref": "BooleanRule",
+ "description": "The formatting is either \"on\" or \"off\" according to the rule."
+ }
+ },
+ "id": "ConditionalFormatRule"
+ },
+ "CopyPasteRequest": {
+ "description": "Copies data from the source to the destination.",
+ "type": "object",
+ "properties": {
+ "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"
+ },
+ "destination": {
+ "description": "The location to paste to. If the range covers a span that's\na multiple of the source's height or width, then the\ndata will be repeated to fill in the destination range.\nIf the range is smaller than the source range, the entire\nsource data will still be copied (beyond the end of the destination range).",
+ "$ref": "GridRange"
+ },
+ "pasteOrientation": {
+ "description": "How that data should be oriented when pasting.",
+ "type": "string",
+ "enumDescriptions": [
+ "Paste normally.",
+ "Paste transposed, where all rows become columns and vice versa."
+ ],
+ "enum": [
+ "NORMAL",
+ "TRANSPOSE"
+ ]
+ }
+ },
+ "id": "CopyPasteRequest"
+ },
+ "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": {
+ "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"
+ },
+ "Request": {
+ "description": "A single kind of update to apply to a spreadsheet.",
+ "type": "object",
+ "properties": {
+ "sortRange": {
+ "$ref": "SortRangeRequest",
+ "description": "Sorts data in a range."
+ },
+ "deleteProtectedRange": {
+ "$ref": "DeleteProtectedRangeRequest",
+ "description": "Deletes a protected range."
+ },
+ "duplicateFilterView": {
+ "$ref": "DuplicateFilterViewRequest",
+ "description": "Duplicates a filter view."
+ },
+ "addChart": {
+ "$ref": "AddChartRequest",
+ "description": "Adds a chart."
+ },
+ "findReplace": {
+ "$ref": "FindReplaceRequest",
+ "description": "Finds and replaces occurrences of some text with other text."
+ },
+ "textToColumns": {
+ "$ref": "TextToColumnsRequest",
+ "description": "Converts a column of text into many columns of text."
+ },
+ "updateChartSpec": {
+ "$ref": "UpdateChartSpecRequest",
+ "description": "Updates a chart's specifications."
+ },
+ "updateProtectedRange": {
+ "description": "Updates a protected range.",
+ "$ref": "UpdateProtectedRangeRequest"
+ },
+ "addSheet": {
+ "$ref": "AddSheetRequest",
+ "description": "Adds a sheet."
+ },
+ "copyPaste": {
+ "$ref": "CopyPasteRequest",
+ "description": "Copies data from one area and pastes it to another."
+ },
+ "deleteFilterView": {
+ "description": "Deletes a filter view from a sheet.",
+ "$ref": "DeleteFilterViewRequest"
+ },
+ "insertDimension": {
+ "$ref": "InsertDimensionRequest",
+ "description": "Inserts new rows or columns in a sheet."
+ },
+ "deleteRange": {
+ "$ref": "DeleteRangeRequest",
+ "description": "Deletes a range of cells from a sheet, shifting the remaining cells."
+ },
+ "deleteBanding": {
+ "$ref": "DeleteBandingRequest",
+ "description": "Removes a banded range"
+ },
+ "addFilterView": {
+ "$ref": "AddFilterViewRequest",
+ "description": "Adds a filter view."
+ },
+ "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": {
+ "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"
+ },
+ "deleteNamedRange": {
+ "$ref": "DeleteNamedRangeRequest",
+ "description": "Deletes a named range."
+ },
+ "addProtectedRange": {
+ "description": "Adds a protected range.",
+ "$ref": "AddProtectedRangeRequest"
+ },
+ "duplicateSheet": {
+ "$ref": "DuplicateSheetRequest",
+ "description": "Duplicates a sheet."
+ },
+ "unmergeCells": {
+ "$ref": "UnmergeCellsRequest",
+ "description": "Unmerges merged cells."
+ },
+ "deleteSheet": {
+ "$ref": "DeleteSheetRequest",
+ "description": "Deletes a sheet."
+ },
+ "updateEmbeddedObjectPosition": {
+ "$ref": "UpdateEmbeddedObjectPositionRequest",
+ "description": "Updates an embedded object's (e.g. chart, image) position."
+ },
+ "updateDeveloperMetadata": {
+ "description": "Updates an existing developer metadata entry",
+ "$ref": "UpdateDeveloperMetadataRequest"
+ },
+ "updateDimensionProperties": {
+ "$ref": "UpdateDimensionPropertiesRequest",
+ "description": "Updates dimensions' properties."
+ },
+ "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"
+ },
+ "updateCells": {
+ "description": "Updates many cells at once.",
+ "$ref": "UpdateCellsRequest"
+ },
+ "addNamedRange": {
+ "$ref": "AddNamedRangeRequest",
+ "description": "Adds a named range."
+ },
+ "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": {
+ "description": "Updates the properties of a filter view.",
+ "$ref": "UpdateFilterViewRequest"
+ },
+ "addBanding": {
+ "$ref": "AddBandingRequest",
+ "description": "Adds a new banded range"
+ },
+ "autoResizeDimensions": {
+ "$ref": "AutoResizeDimensionsRequest",
+ "description": "Automatically resizes one or more dimensions based on the contents\nof the cells in that dimension."
+ },
+ "appendCells": {
+ "$ref": "AppendCellsRequest",
+ "description": "Appends cells after the last row with data in a sheet."
+ },
+ "cutPaste": {
+ "description": "Cuts data from one area and pastes it to another.",
+ "$ref": "CutPasteRequest"
+ },
+ "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": {
+ "$ref": "AutoFillRequest",
+ "description": "Automatically fills in more data based on existing data."
+ },
+ "deleteDimension": {
+ "description": "Deletes rows or columns in a sheet.",
+ "$ref": "DeleteDimensionRequest"
+ }
+ },
+ "id": "Request"
+ },
+ "WaterfallChartDomain": {
+ "description": "The domain of a waterfall chart.",
+ "type": "object",
+ "properties": {
+ "data": {
+ "description": "The data of the WaterfallChartDomain.",
+ "$ref": "ChartData"
+ },
+ "reversed": {
+ "description": "True to reverse the order of the domain values (horizontal axis).",
+ "type": "boolean"
+ }
+ },
+ "id": "WaterfallChartDomain"
+ },
+ "GridRange": {
+ "properties": {
+ "startColumnIndex": {
+ "description": "The start column (inclusive) of the range, or not set if unbounded.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "sheetId": {
+ "description": "The sheet this range is on.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "endRowIndex": {
+ "description": "The end row (exclusive) of the range, or not set if unbounded.",
+ "format": "int32",
+ "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"
+ }
+ },
+ "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": {
+ "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": {
+ "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."
+ ],
+ "enum": [
+ "BASIC_CHART_TYPE_UNSPECIFIED",
+ "BAR",
+ "LINE",
+ "AREA",
+ "COLUMN",
+ "SCATTER",
+ "COMBO",
+ "STEPPED_AREA"
+ ]
+ },
+ "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": {
+ "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."
+ ],
+ "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"
+ },
+ "compareMode": {
+ "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."
+ ],
+ "enum": [
+ "BASIC_CHART_COMPARE_MODE_UNSPECIFIED",
+ "DATUM",
+ "CATEGORY"
+ ]
+ },
+ "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"
+ },
+ "BubbleChartSpec": {
+ "description": "A \u003ca href=\"/chart/interactive/docs/gallery/bubblechart\"\u003ebubble chart\u003c/a\u003e.",
+ "type": "object",
+ "properties": {
+ "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": {
+ "type": "integer",
+ "description": "The minimum radius size of the bubbles, in pixels.\nIf specific, the field must be a positive value.",
+ "format": "int32"
+ },
+ "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": {
+ "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",
+ "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."
+ ]
+ },
+ "domain": {
+ "description": "The data containing the bubble x-values. These values locate the bubbles\nin the chart horizontally.",
+ "$ref": "ChartData"
+ },
+ "bubbleOpacity": {
+ "description": "The opacity of the bubbles between 0 and 1.0.\n0 is fully transparent and 1 is fully opaque.",
+ "format": "float",
+ "type": "number"
+ },
+ "bubbleSizes": {
+ "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"
+ },
+ "bubbleBorderColor": {
+ "description": "The bubble border color.",
+ "$ref": "Color"
+ },
+ "bubbleTextStyle": {
+ "$ref": "TextFormat",
+ "description": "The format of the text inside the bubbles.\nUnderline and Strikethrough are not supported."
+ }
+ },
+ "id": "BubbleChartSpec"
+ },
+ "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": {
"$ref": "GridRange",
- "description": "The range this filter view covers.\n\nWhen writing, only one of range or named_range_id\nmay be set."
+ "description": "The range the data validation rule should apply to."
+ }
+ },
+ "id": "SetDataValidationRequest"
+ },
+ "CellData": {
+ "id": "CellData",
+ "description": "Data about a specific cell.",
+ "type": "object",
+ "properties": {
+ "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."
},
- "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"
+ "note": {
+ "description": "Any note on the cell.",
+ "type": "string"
+ },
+ "userEnteredValue": {
+ "description": "The value the user entered in the cell. e.g, `1234`, `'Hello'`, or `=NOW()`\nNote: Dates, Times and DateTimes are represented as doubles in\nserial number format.",
+ "$ref": "ExtendedValue"
+ },
+ "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."
+ },
+ "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."
+ },
+ "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"
+ }
+ },
+ "formattedValue": {
+ "description": "The formatted value of the cell.\nThis is the value as it's shown to the user.\nThis field is read-only.",
+ "type": "string"
+ },
+ "hyperlink": {
+ "description": "A hyperlink this cell points to, if any.\nThis field is read-only. (To set it, use a `=HYPERLINK` formula\nin the userEnteredValue.formulaValue\nfield.)",
+ "type": "string"
+ },
+ "pivotTable": {
+ "$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."
+ }
+ }
+ },
+ "TextPosition": {
+ "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",
+ "description": "Position settings for text.",
+ "type": "object"
+ },
+ "BatchUpdateValuesByDataFilterRequest": {
+ "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. 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": {
+ "description": "Determines how dates, times, and durations in the response should be\nrendered. This is ignored if response_value_render_option is\nFORMATTED_VALUE.\nThe default dateTime render option is\nDateTimeRenderOption.SERIAL_NUMBER.",
+ "type": "string",
+ "enumDescriptions": [
+ "Instructs date, time, datetime, and duration fields to be output\nas doubles in \"serial number\" format, as popularized by Lotus 1-2-3.\nThe whole number portion of the value (left of the decimal) counts\nthe days since December 30th 1899. The fractional portion (right of\nthe decimal) counts the time as a fraction of the day. For example,\nJanuary 1st 1900 at noon would be 2.5, 2 because it's 2 days after\nDecember 30st 1899, and .5 because noon is half a day. February 1st\n1900 at 3pm would be 33.625. This correctly treats the year 1900 as\nnot a leap year.",
+ "Instructs date, time, datetime, and duration fields to be output\nas strings in their given number format (which is dependent\non the spreadsheet locale)."
+ ],
+ "enum": [
+ "SERIAL_NUMBER",
+ "FORMATTED_STRING"
+ ]
+ },
+ "responseValueRenderOption": {
+ "enum": [
+ "FORMATTED_VALUE",
+ "UNFORMATTED_VALUE",
+ "FORMULA"
+ ],
+ "description": "Determines how values in the response should be rendered.\nThe default render option is ValueRenderOption.FORMATTED_VALUE.",
+ "type": "string",
+ "enumDescriptions": [
+ "Values will be calculated & formatted in the reply according to the\ncell's formatting. Formatting is based on the spreadsheet's locale,\nnot the requesting user's locale.\nFor example, if `A1` is `1.23` and `A2` is `=A1` and formatted as currency,\nthen `A2` would return `\"$1.23\"`.",
+ "Values will be calculated, but not formatted in the reply.\nFor example, if `A1` is `1.23` and `A2` is `=A1` and formatted as currency,\nthen `A2` would return the number `1.23`.",
+ "Values will not be calculated. The reply will include the formulas.\nFor example, if `A1` is `1.23` and `A2` is `=A1` and formatted as currency,\nthen A2 would return `\"=A1\"`."
+ ]
+ },
+ "includeValuesInResponse": {
+ "description": "Determines if the update response should include the values\nof the cells that were updated. By default, responses\ndo not include the updated values. The `updatedData` field within\neach of the BatchUpdateValuesResponse.responses will contain\nthe updated values. If the range to write was larger than than the range\nactually written, the response will include all values in the requested\nrange (excluding trailing empty rows and columns).",
+ "type": "boolean"
+ }
+ },
+ "id": "BatchUpdateValuesByDataFilterRequest",
+ "description": "The request for updating more than one range of values in a spreadsheet.",
+ "type": "object"
+ },
+ "BatchUpdateSpreadsheetRequest": {
+ "description": "The request for updating any aspect of a spreadsheet.",
+ "type": "object",
+ "properties": {
+ "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"
+ }
+ },
+ "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"
+ }
+ },
+ "id": "BatchUpdateSpreadsheetRequest"
+ },
+ "BasicChartAxis": {
+ "description": "An axis of the chart.\nA chart may not have more than one axis per\naxis position.",
+ "type": "object",
+ "properties": {
+ "titleTextPosition": {
+ "$ref": "TextPosition",
+ "description": "The axis title text position."
+ },
+ "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 name of the filter view.",
+ "description": "The title of this axis. If set, this overrides any title inferred\nfrom headers of the data.",
"type": "string"
+ }
+ },
+ "id": "BasicChartAxis"
+ },
+ "Padding": {
+ "type": "object",
+ "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."
+ },
+ "DeleteDimensionRequest": {
+ "properties": {
+ "range": {
+ "$ref": "DimensionRange",
+ "description": "The dimensions to delete from the sheet."
+ }
+ },
+ "id": "DeleteDimensionRequest",
+ "description": "Deletes the dimensions from the sheet.",
+ "type": "object"
+ },
+ "UpdateChartSpecRequest": {
+ "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",
+ "properties": {
+ "chartId": {
+ "description": "The ID of the chart to update.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "spec": {
+ "description": "The specification to apply to the chart.",
+ "$ref": "ChartSpec"
+ }
+ }
+ },
+ "DeleteFilterViewRequest": {
+ "description": "Deletes a particular filter view.",
+ "type": "object",
+ "properties": {
+ "filterId": {
+ "type": "integer",
+ "description": "The ID of the filter to delete.",
+ "format": "int32"
+ }
+ },
+ "id": "DeleteFilterViewRequest"
+ },
+ "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": {
+ "description": "The request for retrieving a range of values in a spreadsheet selected by a\nset of DataFilters.",
+ "type": "object",
+ "properties": {
+ "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"
+ }
+ },
+ "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": {
+ "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)."
+ ],
+ "enum": [
+ "SERIAL_NUMBER",
+ "FORMATTED_STRING"
+ ]
+ },
+ "majorDimension": {
+ "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"
+ ],
+ "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]]`."
+ }
+ },
+ "id": "BatchGetValuesByDataFilterRequest"
+ },
+ "BatchUpdateValuesResponse": {
+ "description": "The response when updating a range of values in a spreadsheet.",
+ "type": "object",
+ "properties": {
+ "totalUpdatedRows": {
+ "description": "The total number of rows where at least one cell in the row was updated.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "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": {
+ "type": "integer",
+ "description": "The total number of columns where at least one cell in the column was\nupdated.",
+ "format": "int32"
+ },
+ "spreadsheetId": {
+ "description": "The spreadsheet the updates were applied to.",
+ "type": "string"
+ }
+ },
+ "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.",
@@ -41,25 +1625,706 @@
}
}
},
+ "id": "SortRangeRequest"
+ },
+ "MergeCellsRequest": {
+ "description": "Merges all cells in the range.",
+ "type": "object",
+ "properties": {
+ "range": {
+ "$ref": "GridRange",
+ "description": "The range of cells to merge."
+ },
+ "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"
+ },
+ "MatchedDeveloperMetadata": {
+ "description": "A developer metadata entry and the data filters specified in the original\nrequest that matched it.",
+ "type": "object",
+ "properties": {
+ "developerMetadata": {
+ "description": "The developer metadata matching the specified filters.",
+ "$ref": "DeveloperMetadata"
+ },
+ "dataFilters": {
+ "description": "All filters matching the returned developer metadata.",
+ "type": "array",
+ "items": {
+ "$ref": "DataFilter"
+ }
+ }
+ },
+ "id": "MatchedDeveloperMetadata"
+ },
+ "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": {
+ "id": "DuplicateFilterViewResponse",
+ "description": "The result of a filter view being duplicated.",
+ "type": "object",
+ "properties": {
+ "filter": {
+ "$ref": "FilterView",
+ "description": "The newly created filter."
+ }
+ }
+ },
+ "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": {
+ "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",
+ "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"
+ },
+ "DuplicateSheetResponse": {
+ "type": "object",
+ "properties": {
+ "properties": {
+ "description": "The properties of the duplicate sheet.",
+ "$ref": "SheetProperties"
+ }
+ },
+ "id": "DuplicateSheetResponse",
+ "description": "The result of duplicating a sheet."
+ },
+ "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": {
+ "$ref": "GridRange",
+ "description": "The source data range. This must span exactly one column."
+ },
+ "delimiterType": {
+ "enum": [
+ "DELIMITER_TYPE_UNSPECIFIED",
+ "COMMA",
+ "SEMICOLON",
+ "PERIOD",
+ "SPACE",
+ "CUSTOM"
+ ],
+ "description": "The delimiter type to use.",
+ "type": "string",
+ "enumDescriptions": [
+ "Default value. This value must not be used.",
+ "\",\"",
+ "\";\"",
+ "\".\"",
+ "\" \"",
+ "A custom value as defined in delimiter."
+ ]
+ }
+ },
+ "id": "TextToColumnsRequest"
+ },
+ "ClearBasicFilterRequest": {
+ "type": "object",
+ "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."
+ },
+ "BatchUpdateSpreadsheetResponse": {
+ "description": "The reply for batch updating a spreadsheet.",
+ "type": "object",
+ "properties": {
+ "replies": {
+ "description": "The reply of the updates. This maps 1:1 with the updates, although\nreplies to some requests may be empty.",
+ "type": "array",
+ "items": {
+ "$ref": "Response"
+ }
+ },
+ "updatedSpreadsheet": {
+ "$ref": "Spreadsheet",
+ "description": "The spreadsheet after updates were applied. This is only set if\n[BatchUpdateSpreadsheetRequest.include_spreadsheet_in_response] is `true`."
+ },
+ "spreadsheetId": {
+ "type": "string",
+ "description": "The spreadsheet the updates were applied to."
+ }
+ },
+ "id": "BatchUpdateSpreadsheetResponse"
+ },
+ "DeleteBandingRequest": {
+ "id": "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"
+ }
+ }
+ },
+ "AppendValuesResponse": {
+ "description": "The response when updating a range of values in a spreadsheet.",
+ "type": "object",
+ "properties": {
+ "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"
+ },
+ "spreadsheetId": {
+ "description": "The spreadsheet the updates were applied to.",
+ "type": "string"
+ }
+ },
+ "id": "AppendValuesResponse"
+ },
+ "MoveDimensionRequest": {
+ "description": "Moves one or more rows or columns.",
+ "type": "object",
+ "properties": {
+ "source": {
+ "$ref": "DimensionRange",
+ "description": "The source dimensions to move."
+ },
+ "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"
+ }
+ },
+ "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": {
+ "description": "Adds a new conditional format rule at the given index.\nAll subsequent rules' indexes are incremented.",
+ "type": "object",
+ "properties": {
+ "rule": {
+ "$ref": "ConditionalFormatRule",
+ "description": "The rule to add."
+ },
+ "index": {
+ "description": "The zero-based index where the rule should be inserted.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "AddConditionalFormatRuleRequest"
+ },
+ "CreateDeveloperMetadataRequest": {
+ "description": "A request to create developer metadata.",
+ "type": "object",
+ "properties": {
+ "developerMetadata": {
+ "$ref": "DeveloperMetadata",
+ "description": "The developer metadata to create."
+ }
+ },
+ "id": "CreateDeveloperMetadataRequest"
+ },
+ "ChartSpec": {
+ "description": "The specifications of a chart.",
+ "type": "object",
+ "properties": {
+ "basicChart": {
+ "$ref": "BasicChartSpec",
+ "description": "A basic chart specification, can be one of many kinds of charts.\nSee BasicChartType for the list of all\ncharts this supports."
+ },
+ "orgChart": {
+ "$ref": "OrgChartSpec",
+ "description": "An org chart specification."
+ },
+ "pieChart": {
+ "$ref": "PieChartSpec",
+ "description": "A pie chart specification."
+ },
+ "titleTextFormat": {
+ "description": "The title text format.\nStrikethrough and underline are not supported.",
+ "$ref": "TextFormat"
+ },
+ "title": {
+ "description": "The title of the chart.",
+ "type": "string"
+ },
+ "altText": {
+ "description": "The alternative text that describes the chart. This is often used\nfor accessibility.",
+ "type": "string"
+ },
+ "titleTextPosition": {
+ "$ref": "TextPosition",
+ "description": "The title text position.\nThis field is optional."
+ },
+ "histogramChart": {
+ "$ref": "HistogramChartSpec",
+ "description": "A histogram chart specification."
+ },
+ "candlestickChart": {
+ "$ref": "CandlestickChartSpec",
+ "description": "A candlestick chart specification."
+ },
+ "bubbleChart": {
+ "$ref": "BubbleChartSpec",
+ "description": "A bubble chart specification."
+ },
+ "waterfallChart": {
+ "$ref": "WaterfallChartSpec",
+ "description": "A waterfall chart specification."
+ },
+ "fontName": {
+ "description": "The name of the font to use by default for all chart text (e.g. title,\naxis labels, legend). If a font is specified for a specific part of the\nchart it will override this font name.",
+ "type": "string"
+ },
+ "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": {
+ "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",
+ "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."
+ ]
+ },
+ "subtitleTextFormat": {
+ "description": "The subtitle text format.\nStrikethrough and underline are not supported.",
+ "$ref": "TextFormat"
+ },
+ "subtitle": {
+ "description": "The subtitle of the chart.",
+ "type": "string"
+ },
+ "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."
+ }
+ },
+ "id": "ChartSpec"
+ },
+ "BatchGetValuesByDataFilterResponse": {
+ "description": "The response when retrieving more than one range of values in a spreadsheet\nselected by DataFilters.",
+ "type": "object",
+ "properties": {
+ "valueRanges": {
+ "type": "array",
+ "items": {
+ "$ref": "MatchedValueRange"
+ },
+ "description": "The requested values with the list of data filters that matched them."
+ },
+ "spreadsheetId": {
+ "type": "string",
+ "description": "The ID of the spreadsheet the data was retrieved from."
+ }
+ },
+ "id": "BatchGetValuesByDataFilterResponse"
+ },
+ "NumberFormat": {
+ "id": "NumberFormat",
+ "description": "The number format of a cell.",
+ "type": "object",
+ "properties": {
+ "type": {
+ "description": "The type of the number format.\nWhen writing, this field must be set.",
+ "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"
+ ]
+ },
+ "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"
+ }
+ }
+ },
+ "DataFilterValueRange": {
+ "type": "object",
+ "properties": {
+ "dataFilter": {
+ "$ref": "DataFilter",
+ "description": "The data filter describing the location of the values in the spreadsheet."
+ },
+ "majorDimension": {
+ "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."
+ ],
+ "enum": [
+ "DIMENSION_UNSPECIFIED",
+ "ROWS",
+ "COLUMNS"
+ ]
+ },
+ "values": {
+ "type": "array",
+ "items": {
+ "type": "array",
+ "items": {
+ "type": "any"
+ }
+ },
+ "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."
+ }
+ },
+ "id": "DataFilterValueRange",
+ "description": "A range of values whose location is specified by a DataFilter."
+ },
+ "LineStyle": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "description": "The dash type of the line.",
+ "type": "string",
+ "enumDescriptions": [
+ "Default value, do not use.",
+ "No dash type, which is equivalent to a non-visible line.",
+ "A custom dash for a line. Modifying the exact custom dash style is\ncurrently unsupported.",
+ "A solid line.",
+ "A dotted line.",
+ "A dashed line where the dashes have \"medium\" length.",
+ "A line that alternates between a \"medium\" dash and a dot.",
+ "A dashed line where the dashes have \"long\" length.",
+ "A line that alternates between a \"long\" dash and a dot."
+ ],
+ "enum": [
+ "LINE_DASH_TYPE_UNSPECIFIED",
+ "INVISIBLE",
+ "CUSTOM",
+ "SOLID",
+ "DOTTED",
+ "MEDIUM_DASHED",
+ "MEDIUM_DASHED_DOTTED",
+ "LONG_DASHED",
+ "LONG_DASHED_DOTTED"
+ ]
+ },
+ "width": {
+ "description": "The thickness of the line, in px.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "LineStyle",
+ "description": "Properties that describe the style of a line."
+ },
+ "CandlestickDomain": {
+ "description": "The domain of a CandlestickChart.",
+ "type": "object",
+ "properties": {
+ "data": {
+ "description": "The data of the CandlestickDomain.",
+ "$ref": "ChartData"
+ },
+ "reversed": {
+ "description": "True to reverse the order of the domain values (horizontal axis).",
+ "type": "boolean"
+ }
+ },
+ "id": "CandlestickDomain"
+ },
+ "SheetProperties": {
+ "id": "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"
+ },
+ "gridProperties": {
+ "description": "Additional properties of the sheet if this sheet is a grid.\n(If the sheet is an object sheet, containing a chart or image, then\nthis field will be absent.)\nWhen writing it is an error to set any grid properties on non-grid sheets.",
+ "$ref": "GridProperties"
+ },
+ "sheetType": {
+ "description": "The type of sheet. Defaults to GRID.\nThis field cannot be changed once set.",
+ "type": "string",
+ "enumDescriptions": [
+ "Default value, do not use.",
+ "The sheet is a grid.",
+ "The sheet has no grid and instead has an object like a chart or image."
+ ],
+ "enum": [
+ "SHEET_TYPE_UNSPECIFIED",
+ "GRID",
+ "OBJECT"
+ ]
+ }
+ }
+ },
+ "UpdateDimensionPropertiesRequest": {
+ "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",
+ "description": "Updates properties of dimensions within the specified range.",
+ "type": "object"
+ },
+ "SourceAndDestination": {
+ "description": "A combination of a source range and how to extend that source.",
+ "type": "object",
+ "properties": {
+ "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."
+ ]
+ },
+ "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"
+ }
+ },
+ "id": "SourceAndDestination"
+ },
+ "FilterView": {
+ "description": "A filter view.",
+ "type": "object",
+ "properties": {
+ "criteria": {
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "FilterCriteria"
+ },
+ "description": "The criteria for showing/hiding values per column.\nThe map's key is the column index, and the value is the criteria for\nthat column."
+ },
+ "title": {
+ "description": "The name of the filter view.",
+ "type": "string"
+ },
+ "range": {
+ "$ref": "GridRange",
+ "description": "The range this filter view covers.\n\nWhen writing, only one of range or named_range_id\nmay be set."
+ },
+ "sortSpecs": {
+ "description": "The sort order per column. Later specifications are used when values\nare equal in the earlier specifications.",
+ "type": "array",
+ "items": {
+ "$ref": "SortSpec"
+ }
+ },
+ "namedRangeId": {
+ "description": "The named range this filter view is backed by, if any.\n\nWhen writing, only one of range or named_range_id\nmay be set.",
+ "type": "string"
+ },
+ "filterViewId": {
+ "description": "The ID of the filter view.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
"id": "FilterView"
},
"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": {
+ "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."
},
"selectedNodeColor": {
- "$ref": "Color",
- "description": "The color of the selected org chart nodes."
+ "description": "The color of the selected org chart nodes.",
+ "$ref": "Color"
},
"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."
},
"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",
@@ -67,21 +2332,11 @@
"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."
- ]
+ "type": "string"
},
"labels": {
"$ref": "ChartData",
"description": "The data containing the labels for all the nodes in the chart. Labels\nmust be unique."
- },
- "nodeColor": {
- "$ref": "Color",
- "description": "The color of the org chart nodes."
}
},
"id": "OrgChartSpec"
@@ -91,37 +2346,37 @@
"type": "object",
"properties": {
"dataFilters": {
+ "description": "The data filters describing the criteria used to determine which\nDeveloperMetadata entries to return. DeveloperMetadata matching any of the\nspecified filters will be included in the response.",
"type": "array",
"items": {
"$ref": "DataFilter"
- },
- "description": "The data filters describing the criteria used to determine which\nDeveloperMetadata entries to return. DeveloperMetadata matching any of the\nspecified filters will be included in the response."
+ }
}
},
"id": "SearchDeveloperMetadataRequest"
},
"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",
"properties": {
+ "footerColor": {
+ "$ref": "Color",
+ "description": "The color of the last row or column. If this field is not set, the last\nrow or column will be filled with either first_band_color or\nsecond_band_color, depending on the color of the previous row or\ncolumn."
+ },
"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)"
+ "description": "The first color that is alternating. (Required)",
+ "$ref": "Color"
},
"secondBandColor": {
- "description": "The second color that is alternating. (Required)",
- "$ref": "Color"
- },
- "footerColor": {
- "description": "The color of the last row or column. If this field is not set, the last\nrow or column will be filled with either first_band_color or\nsecond_band_color, depending on the color of the previous row or\ncolumn.",
- "$ref": "Color"
+ "$ref": "Color",
+ "description": "The second color that is alternating. (Required)"
}
- }
+ },
+ "id": "BandingProperties"
},
"AddProtectedRangeResponse": {
"description": "The result of adding a new protected range.",
@@ -143,11 +2398,11 @@
"description": "The range the filter covers."
},
"criteria": {
- "description": "The criteria for showing/hiding values per column.\nThe map's key is the column index, and the value is the criteria for\nthat column.",
- "type": "object",
"additionalProperties": {
"$ref": "FilterCriteria"
- }
+ },
+ "description": "The criteria for showing/hiding values per column.\nThe map's key is the column index, and the value is the criteria for\nthat column.",
+ "type": "object"
},
"sortSpecs": {
"description": "The sort order per column. Later specifications are used when values\nare equal in the earlier specifications.",
@@ -160,28 +2415,27 @@
"id": "BasicFilter"
},
"CandlestickSeries": {
- "description": "The series of a CandlestickData.",
"type": "object",
"properties": {
"data": {
- "description": "The data of the CandlestickSeries.",
- "$ref": "ChartData"
+ "$ref": "ChartData",
+ "description": "The data of the CandlestickSeries."
}
},
- "id": "CandlestickSeries"
+ "id": "CandlestickSeries",
+ "description": "The series of a CandlestickData."
},
"HistogramChartSpec": {
- "type": "object",
"properties": {
"bucketSize": {
+ "type": "number",
"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"
+ "format": "double"
},
"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",
- "type": "number"
+ "format": "double"
},
"showItemDividers": {
"description": "Whether horizontal divider lines should be displayed between items in each\ncolumn.",
@@ -218,12 +2472,22 @@
}
},
"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."
+ "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"
},
"UpdateValuesResponse": {
"description": "The response when updating a range of values in a spreadsheet.",
"type": "object",
"properties": {
+ "updatedData": {
+ "$ref": "ValueRange",
+ "description": "The values of the cells after updates were applied.\nThis is only included if the request's `includeValuesInResponse` field\nwas `true`."
+ },
+ "updatedRows": {
+ "description": "The number of rows where at least one cell in the row was updated.",
+ "format": "int32",
+ "type": "integer"
+ },
"updatedColumns": {
"description": "The number of columns where at least one cell in the column was updated.",
"format": "int32",
@@ -241,15 +2505,6 @@
"description": "The number of cells updated.",
"format": "int32",
"type": "integer"
- },
- "updatedRows": {
- "description": "The number of rows where at least one cell in the row was updated.",
- "format": "int32",
- "type": "integer"
- },
- "updatedData": {
- "$ref": "ValueRange",
- "description": "The values of the cells after updates were applied.\nThis is only included if the request's `includeValuesInResponse` field\nwas `true`."
}
},
"id": "UpdateValuesResponse"
@@ -259,7 +2514,6 @@
"type": "object",
"properties": {
"type": {
- "type": "string",
"enumDescriptions": [
"The default error type, do not use this.",
"Corresponds to the `#ERROR!` error.",
@@ -284,7 +2538,8 @@
"N_A",
"LOADING"
],
- "description": "The type of error."
+ "description": "The type of error.",
+ "type": "string"
},
"message": {
"description": "A message with more information about the error\n(in the spreadsheet's locale).",
@@ -294,15 +2549,18 @@
"id": "ErrorValue"
},
"PivotValue": {
+ "description": "The definition of how a value in a pivot table should be calculated.",
"type": "object",
"properties": {
+ "name": {
+ "description": "A name to use for the value.",
+ "type": "string"
+ },
"formula": {
"description": "A custom formula to calculate the value. The formula must start\nwith an `=` character.",
"type": "string"
},
"summarizeFunction": {
- "description": "A function to summarize the value.\nIf formula is set, the only supported values are\nSUM and\nCUSTOM.\nIf sourceColumnOffset is set, then `CUSTOM`\nis not supported.",
- "type": "string",
"enumDescriptions": [
"The default, do not use.",
"Corresponds to the `SUM` function.",
@@ -336,20 +2594,17 @@
"VAR",
"VARP",
"CUSTOM"
- ]
+ ],
+ "description": "A function to summarize the value.\nIf formula is set, the only supported values are\nSUM and\nCUSTOM.\nIf sourceColumnOffset is set, then `CUSTOM`\nis not supported.",
+ "type": "string"
},
"sourceColumnOffset": {
"description": "The column offset of the source range that this value reads from.\n\nFor example, if the source was `C10:E15`, a `sourceColumnOffset` of `0`\nmeans this value refers to column `C`, whereas the offset `1` would\nrefer to column `D`.",
"format": "int32",
"type": "integer"
- },
- "name": {
- "description": "A name to use for the value.",
- "type": "string"
}
},
- "id": "PivotValue",
- "description": "The definition of how a value in a pivot table should be calculated."
+ "id": "PivotValue"
},
"CopySheetToAnotherSpreadsheetRequest": {
"description": "The request to copy a sheet across spreadsheets.",
@@ -363,61 +2618,61 @@
"id": "CopySheetToAnotherSpreadsheetRequest"
},
"PivotGroupSortValueBucket": {
- "description": "Information about which values in a pivot group should be used for sorting.",
- "type": "object",
"properties": {
"buckets": {
+ "description": "Determines the bucket from which values are chosen to sort.\n\nFor example, in a pivot table with one row group & two column groups,\nthe row group can list up to two values. The first value corresponds\nto a value within the first column group, and the second value\ncorresponds to a value in the second column group. If no values\nare listed, this would indicate that the row should be sorted according\nto the \"Grand Total\" over the column groups. If a single value is listed,\nthis would correspond to using the \"Total\" of that bucket.",
"type": "array",
"items": {
"$ref": "ExtendedValue"
- },
- "description": "Determines the bucket from which values are chosen to sort.\n\nFor example, in a pivot table with one row group & two column groups,\nthe row group can list up to two values. The first value corresponds\nto a value within the first column group, and the second value\ncorresponds to a value in the second column group. If no values\nare listed, this would indicate that the row should be sorted according\nto the \"Grand Total\" over the column groups. If a single value is listed,\nthis would correspond to using the \"Total\" of that bucket."
+ }
},
"valuesIndex": {
+ "type": "integer",
"description": "The offset in the PivotTable.values list which the values in this\ngrouping should be sorted by.",
- "format": "int32",
- "type": "integer"
+ "format": "int32"
}
},
- "id": "PivotGroupSortValueBucket"
+ "id": "PivotGroupSortValueBucket",
+ "description": "Information about which values in a pivot group should be used for sorting.",
+ "type": "object"
},
"WaterfallChartSeries": {
+ "description": "A single series of data for a waterfall chart.",
"type": "object",
"properties": {
- "positiveColumnsStyle": {
- "$ref": "WaterfallChartColumnStyle",
- "description": "Styles for all columns in this series with positive values."
- },
"subtotalColumnsStyle": {
- "$ref": "WaterfallChartColumnStyle",
- "description": "Styles for all subtotal columns in this series."
+ "description": "Styles for all subtotal columns in this series.",
+ "$ref": "WaterfallChartColumnStyle"
},
"data": {
"$ref": "ChartData",
"description": "The data being visualized in this series."
},
"negativeColumnsStyle": {
- "$ref": "WaterfallChartColumnStyle",
- "description": "Styles for all columns in this series with negative values."
+ "description": "Styles for all columns in this series with negative values.",
+ "$ref": "WaterfallChartColumnStyle"
},
"hideTrailingSubtotal": {
"description": "True to hide the subtotal column from the end of the series. By default,\na subtotal column will appear at the end of each series. Setting this\nfield to true will hide that subtotal column for this series.",
"type": "boolean"
+ },
+ "positiveColumnsStyle": {
+ "$ref": "WaterfallChartColumnStyle",
+ "description": "Styles for all columns in this series with positive values."
}
},
- "id": "WaterfallChartSeries",
- "description": "A single series of data for a waterfall chart."
+ "id": "WaterfallChartSeries"
},
"DeleteDeveloperMetadataRequest": {
+ "description": "A request to delete developer metadata.",
+ "type": "object",
"properties": {
"dataFilter": {
"description": "The data filter describing the criteria used to select which developer\nmetadata entry to delete.",
"$ref": "DataFilter"
}
},
- "id": "DeleteDeveloperMetadataRequest",
- "description": "A request to delete developer metadata.",
- "type": "object"
+ "id": "DeleteDeveloperMetadataRequest"
},
"CandlestickChartSpec": {
"description": "A \u003ca href=\"/chart/interactive/docs/gallery/candlestickchart\"\u003ecandlestick chart\u003c/a\u003e.",
@@ -438,42 +2693,42 @@
"id": "CandlestickChartSpec"
},
"BatchClearValuesByDataFilterResponse": {
- "description": "The response when clearing a range of values selected with\nDataFilters in a spreadsheet.",
- "type": "object",
"properties": {
+ "spreadsheetId": {
+ "type": "string",
+ "description": "The spreadsheet the updates were applied to."
+ },
"clearedRanges": {
"description": "The ranges that were cleared, in A1 notation.\n(If the requests were for an unbounded range or a ranger larger\n than the bounds of the sheet, this will be the actual ranges\n that were cleared, bounded to the sheet's limits.)",
"type": "array",
"items": {
"type": "string"
}
- },
- "spreadsheetId": {
- "description": "The spreadsheet the updates were applied to.",
- "type": "string"
}
},
- "id": "BatchClearValuesByDataFilterResponse"
+ "id": "BatchClearValuesByDataFilterResponse",
+ "description": "The response when clearing a range of values selected with\nDataFilters in a spreadsheet.",
+ "type": "object"
},
"CandlestickData": {
"description": "The Candlestick chart data, each containing the low, open, close, and high\nvalues for a series.",
"type": "object",
"properties": {
- "highSeries": {
- "$ref": "CandlestickSeries",
- "description": "The range data (vertical axis) for the high/maximum value for each\ncandle. This is the top of the candle's center line."
- },
- "lowSeries": {
- "description": "The range data (vertical axis) for the low/minimum value for each candle.\nThis is the bottom of the candle's center line.",
- "$ref": "CandlestickSeries"
- },
- "closeSeries": {
- "$ref": "CandlestickSeries",
- "description": "The range data (vertical axis) for the close/final value for each candle.\nThis is the top of the candle body. If greater than the open value the\ncandle will be filled. Otherwise the candle will be hollow."
- },
"openSeries": {
"$ref": "CandlestickSeries",
"description": "The range data (vertical axis) for the open/initial value for each\ncandle. This is the bottom of the candle body. If less than the close\nvalue the candle will be filled. Otherwise the candle will be hollow."
+ },
+ "highSeries": {
+ "description": "The range data (vertical axis) for the high/maximum value for each\ncandle. This is the top of the candle's center line.",
+ "$ref": "CandlestickSeries"
+ },
+ "lowSeries": {
+ "$ref": "CandlestickSeries",
+ "description": "The range data (vertical axis) for the low/minimum value for each candle.\nThis is the bottom of the candle's center line."
+ },
+ "closeSeries": {
+ "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"
}
},
"id": "CandlestickData"
@@ -492,13 +2747,15 @@
"type": "integer"
},
"overlayPosition": {
- "description": "The position at which the object is overlaid on top of a grid.",
- "$ref": "OverlayPosition"
+ "$ref": "OverlayPosition",
+ "description": "The position at which the object is overlaid on top of a grid."
}
},
"id": "EmbeddedObjectPosition"
},
"DeleteProtectedRangeRequest": {
+ "id": "DeleteProtectedRangeRequest",
+ "description": "Deletes the protected range with the given ID.",
"type": "object",
"properties": {
"protectedRangeId": {
@@ -506,24 +2763,52 @@
"format": "int32",
"type": "integer"
}
- },
- "id": "DeleteProtectedRangeRequest",
- "description": "Deletes the protected range with the given ID."
+ }
},
"DeveloperMetadataLookup": {
- "id": "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.",
"type": "object",
"properties": {
+ "locationMatchingStrategy": {
+ "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"
+ ],
+ "description": "Determines how this lookup matches the location. If this field is\nspecified as EXACT, only developer metadata associated on the exact\nlocation specified is matched. If this field is specified to INTERSECTING,\ndeveloper metadata associated on intersecting locations is also\nmatched. If left unspecified, this field assumes a default value of\nINTERSECTING.\nIf this field is specified, a metadataLocation\nmust also be specified.",
+ "type": "string"
+ },
+ "metadataLocation": {
+ "$ref": "DeveloperMetadataLocation",
+ "description": "Limits the selected developer metadata to those entries associated with\nthe specified location. This field either matches exact locations or all\nintersecting locations according the specified\nlocationMatchingStrategy."
+ },
+ "locationType": {
+ "type": "string",
+ "enumDescriptions": [
+ "Default value.",
+ "Developer metadata associated on an entire row dimension.",
+ "Developer metadata associated on an entire column dimension.",
+ "Developer metadata associated on an entire sheet.",
+ "Developer metadata associated on the entire spreadsheet."
+ ],
+ "enum": [
+ "DEVELOPER_METADATA_LOCATION_TYPE_UNSPECIFIED",
+ "ROW",
+ "COLUMN",
+ "SHEET",
+ "SPREADSHEET"
+ ],
+ "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."
+ },
"metadataKey": {
"description": "Limits the selected developer metadata to that which has a matching\nDeveloperMetadata.metadata_key.",
"type": "string"
},
- "metadataId": {
- "description": "Limits the selected developer metadata to that which has a matching\nDeveloperMetadata.metadata_id.",
- "format": "int32",
- "type": "integer"
- },
"visibility": {
"description": "Limits the selected developer metadata to that which has a matching\nDeveloperMetadata.visibility. If left unspecified, all developer\nmetadata visibile to the requesting project is considered.",
"type": "string",
@@ -538,63 +2823,33 @@
"PROJECT"
]
},
+ "metadataId": {
+ "description": "Limits the selected developer metadata to that which has a matching\nDeveloperMetadata.metadata_id.",
+ "format": "int32",
+ "type": "integer"
+ },
"metadataValue": {
"description": "Limits the selected developer metadata to that which has a matching\nDeveloperMetadata.metadata_value.",
"type": "string"
- },
- "metadataLocation": {
- "description": "Limits the selected developer metadata to those entries associated with\nthe specified location. This field either matches exact locations or all\nintersecting locations according the specified\nlocationMatchingStrategy.",
- "$ref": "DeveloperMetadataLocation"
- },
- "locationMatchingStrategy": {
- "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": {
- "enumDescriptions": [
- "Default value.",
- "Developer metadata associated on an entire row dimension.",
- "Developer metadata associated on an entire column dimension.",
- "Developer metadata associated on an entire sheet.",
- "Developer metadata associated on the entire spreadsheet."
- ],
- "enum": [
- "DEVELOPER_METADATA_LOCATION_TYPE_UNSPECIFIED",
- "ROW",
- "COLUMN",
- "SHEET",
- "SPREADSHEET"
- ],
- "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"
}
- }
+ },
+ "id": "DeveloperMetadataLookup"
},
"AutoFillRequest": {
"description": "Fills in more data based on existing data.",
"type": "object",
"properties": {
+ "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"
+ "type": "boolean",
+ "description": "True if we should generate data with the \"alternate\" series.\nThis differs based on the type and amount of source data."
},
"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": {
- "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"
}
},
"id": "AutoFillRequest"
@@ -612,56 +2867,40 @@
"description": "The starting interpolation point."
},
"maxpoint": {
- "description": "The final interpolation point.",
- "$ref": "InterpolationPoint"
+ "$ref": "InterpolationPoint",
+ "description": "The final interpolation point."
}
},
"id": "GradientRule"
},
- "SetBasicFilterRequest": {
- "description": "Sets the basic filter associated with a sheet.",
- "type": "object",
- "properties": {
- "filter": {
- "$ref": "BasicFilter",
- "description": "The filter to set."
- }
- },
- "id": "SetBasicFilterRequest"
- },
"ClearValuesRequest": {
"description": "The request for clearing a range of values in a spreadsheet.",
"type": "object",
"properties": {},
"id": "ClearValuesRequest"
},
- "BatchClearValuesByDataFilterRequest": {
+ "SetBasicFilterRequest": {
+ "id": "SetBasicFilterRequest",
+ "description": "Sets the basic filter associated with a sheet.",
"type": "object",
"properties": {
- "dataFilters": {
- "description": "The DataFilters used to determine which ranges to clear.",
- "type": "array",
- "items": {
- "$ref": "DataFilter"
- }
+ "filter": {
+ "$ref": "BasicFilter",
+ "description": "The filter to set."
}
- },
- "id": "BatchClearValuesByDataFilterRequest",
- "description": "The request for clearing more than one range selected by a\nDataFilter in a spreadsheet."
+ }
},
"InterpolationPoint": {
+ "id": "InterpolationPoint",
"description": "A single interpolation point on a gradient conditional format.\nThese pin the gradient color scale according to the color,\ntype and value chosen.",
"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": {
+ "description": "How the value should be interpreted.",
"type": "string",
"enumDescriptions": [
"The default value, do not use.",
@@ -678,19 +2917,36 @@
"NUMBER",
"PERCENT",
"PERCENTILE"
- ],
- "description": "How the value should be interpreted."
+ ]
+ },
+ "value": {
+ "description": "The value this interpolation point uses. May be a formula.\nUnused if type is MIN or\nMAX.",
+ "type": "string"
}
- },
- "id": "InterpolationPoint"
+ }
+ },
+ "BatchClearValuesByDataFilterRequest": {
+ "id": "BatchClearValuesByDataFilterRequest",
+ "description": "The request for clearing more than one range selected by a\nDataFilter in a spreadsheet.",
+ "type": "object",
+ "properties": {
+ "dataFilters": {
+ "type": "array",
+ "items": {
+ "$ref": "DataFilter"
+ },
+ "description": "The DataFilters used to determine which ranges to clear."
+ }
+ }
},
"GetSpreadsheetByDataFilterRequest": {
+ "id": "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"
+ "type": "boolean",
+ "description": "True if grid data should be returned.\nThis parameter is ignored if a field mask was set in the request."
},
"dataFilters": {
"description": "The DataFilters used to select which ranges to retrieve from\nthe spreadsheet.",
@@ -699,22 +2955,38 @@
"$ref": "DataFilter"
}
}
+ }
+ },
+ "DeleteEmbeddedObjectRequest": {
+ "type": "object",
+ "properties": {
+ "objectId": {
+ "type": "integer",
+ "description": "The ID of the embedded object to delete.",
+ "format": "int32"
+ }
},
- "id": "GetSpreadsheetByDataFilterRequest"
+ "id": "DeleteEmbeddedObjectRequest",
+ "description": "Deletes the embedded object with the given ID."
},
"FindReplaceResponse": {
"description": "The result of the find/replace.",
"type": "object",
"properties": {
+ "valuesChanged": {
+ "description": "The number of non-formula cells changed.",
+ "format": "int32",
+ "type": "integer"
+ },
"occurrencesChanged": {
"description": "The number of occurrences (possibly multiple within a cell) changed.\nFor example, if replacing `\"e\"` with `\"o\"` in `\"Google Sheets\"`, this would\nbe `\"3\"` because `\"Google Sheets\"` -\u003e `\"Googlo Shoots\"`.",
"format": "int32",
"type": "integer"
},
"rowsChanged": {
+ "type": "integer",
"description": "The number of rows changed.",
- "format": "int32",
- "type": "integer"
+ "format": "int32"
},
"sheetsChanged": {
"description": "The number of sheets changed.",
@@ -725,40 +2997,23 @@
"description": "The number of formula cells changed.",
"format": "int32",
"type": "integer"
- },
- "valuesChanged": {
- "description": "The number of non-formula cells changed.",
- "format": "int32",
- "type": "integer"
}
},
"id": "FindReplaceResponse"
},
- "DeleteEmbeddedObjectRequest": {
- "description": "Deletes the embedded object with the given ID.",
- "type": "object",
- "properties": {
- "objectId": {
- "description": "The ID of the embedded object to delete.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "DeleteEmbeddedObjectRequest"
- },
"UpdateValuesByDataFilterResponse": {
"description": "The response when updating a range of values by a data filter in a\nspreadsheet.",
"type": "object",
"properties": {
- "updatedData": {
- "description": "The values of the cells in the range matched by the dataFilter after all\nupdates were applied. This is only included if the request's\n`includeValuesInResponse` field was `true`.",
- "$ref": "ValueRange"
- },
"updatedRows": {
"description": "The number of rows where at least one cell in the row was updated.",
"format": "int32",
"type": "integer"
},
+ "updatedData": {
+ "description": "The values of the cells in the range matched by the dataFilter after all\nupdates were applied. This is only included if the request's\n`includeValuesInResponse` field was `true`.",
+ "$ref": "ValueRange"
+ },
"updatedColumns": {
"description": "The number of columns where at least one cell in the column was updated.",
"format": "int32",
@@ -780,7 +3035,20 @@
},
"id": "UpdateValuesByDataFilterResponse"
},
+ "DeleteSheetRequest": {
+ "description": "Deletes the requested sheet.",
+ "type": "object",
+ "properties": {
+ "sheetId": {
+ "type": "integer",
+ "description": "The ID of the sheet to delete.",
+ "format": "int32"
+ }
+ },
+ "id": "DeleteSheetRequest"
+ },
"DuplicateFilterViewRequest": {
+ "id": "DuplicateFilterViewRequest",
"description": "Duplicates a particular filter view.",
"type": "object",
"properties": {
@@ -789,35 +3057,22 @@
"format": "int32",
"type": "integer"
}
- },
- "id": "DuplicateFilterViewRequest"
- },
- "DeleteSheetRequest": {
- "description": "Deletes the requested sheet.",
- "type": "object",
- "properties": {
- "sheetId": {
- "description": "The ID of the sheet to delete.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "DeleteSheetRequest"
+ }
},
"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": {
- "description": "The values matched by the DataFilter.",
- "$ref": "ValueRange"
}
},
"id": "MatchedValueRange"
@@ -826,6 +3081,10 @@
"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"
@@ -852,28 +3111,14 @@
"SHEET",
"SPREADSHEET"
]
- },
- "dimensionRange": {
- "description": "Represents the row or column when metadata is associated with\na dimension. The specified DimensionRange must represent a single row\nor column; it cannot be unbounded or span multiple rows or columns.",
- "$ref": "DimensionRange"
}
},
"id": "DeveloperMetadataLocation"
},
"UpdateConditionalFormatRuleResponse": {
- "id": "UpdateConditionalFormatRuleResponse",
"description": "The result of updating a conditional format rule.",
"type": "object",
"properties": {
- "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)"
- },
"oldRule": {
"$ref": "ConditionalFormatRule",
"description": "The old (deleted) rule. Not set if a rule was moved\n(because it is the same as new_rule)."
@@ -882,8 +3127,18 @@
"description": "The index of the new rule.",
"format": "int32",
"type": "integer"
+ },
+ "oldIndex": {
+ "type": "integer",
+ "description": "The old index of the rule. Not set if a rule was replaced\n(because it is the same as new_index).",
+ "format": "int32"
+ },
+ "newRule": {
+ "description": "The new rule that replaced the old rule (if replacing),\nor the rule that was moved (if moved)",
+ "$ref": "ConditionalFormatRule"
}
- }
+ },
+ "id": "UpdateConditionalFormatRuleResponse"
},
"ConditionValue": {
"description": "The value of the condition.",
@@ -920,14 +3175,9 @@
},
"DuplicateSheetRequest": {
"properties": {
- "insertSheetIndex": {
- "description": "The zero-based index where the new sheet should be inserted.\nThe index of all sheets after this are incremented.",
- "format": "int32",
- "type": "integer"
- },
"newSheetName": {
- "description": "The name of the new sheet. If empty, a new name is chosen for you.",
- "type": "string"
+ "type": "string",
+ "description": "The name of the new sheet. If empty, a new name is chosen for you."
},
"sourceSheetId": {
"description": "The sheet to duplicate.",
@@ -938,6 +3188,11 @@
"description": "If set, the ID of the new sheet. If not set, an ID is chosen.\nIf set, the ID must not conflict with any existing sheet ID.\nIf set, it must be non-negative.",
"format": "int32",
"type": "integer"
+ },
+ "insertSheetIndex": {
+ "type": "integer",
+ "description": "The zero-based index where the new sheet should be inserted.\nThe index of all sheets after this are incremented.",
+ "format": "int32"
}
},
"id": "DuplicateSheetRequest",
@@ -945,8 +3200,21 @@
"type": "object"
},
"ExtendedValue": {
+ "description": "The kinds of value that a cell in a spreadsheet can have.",
"type": "object",
"properties": {
+ "stringValue": {
+ "type": "string",
+ "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\"`."
+ },
+ "boolValue": {
+ "type": "boolean",
+ "description": "Represents a boolean value."
+ },
+ "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",
@@ -955,27 +3223,22 @@
"errorValue": {
"$ref": "ErrorValue",
"description": "Represents an error.\nThis field is read-only."
- },
- "stringValue": {
- "description": "Represents a string value.\nLeading single quotes are not included. For example, if the user typed\n`'123` into the UI, this would be represented as a `stringValue` of\n`\"123\"`.",
- "type": "string"
- },
- "boolValue": {
- "description": "Represents a boolean value.",
- "type": "boolean"
- },
- "formulaValue": {
- "type": "string",
- "description": "Represents a formula."
}
},
- "id": "ExtendedValue",
- "description": "The kinds of value that a cell in a spreadsheet can have."
+ "id": "ExtendedValue"
},
"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": {
"$ref": "GridRange",
"description": "The range over which these properties are applied."
@@ -984,14 +3247,6 @@
"description": "The id of the banded range.",
"format": "int32",
"type": "integer"
- },
- "rowProperties": {
- "$ref": "BandingProperties",
- "description": "Properties for row bands. These properties will be applied on a row-by-row\nbasis throughout all the rows in the range. At least one of\nrow_properties or column_properties must be specified."
- },
- "columnProperties": {
- "$ref": "BandingProperties",
- "description": "Properties for column bands. These properties will be applied on a column-\nby-column basis throughout all the columns in the range. At least one of\nrow_properties or column_properties must be specified."
}
},
"id": "BandedRange"
@@ -1001,12 +3256,12 @@
"type": "object",
"properties": {
"barColor": {
- "$ref": "Color",
- "description": "The color of the column representing this series in each bucket.\nThis field is optional."
+ "description": "The color of the column representing this series in each bucket.\nThis field is optional.",
+ "$ref": "Color"
},
"data": {
- "$ref": "ChartData",
- "description": "The data for this histogram series."
+ "description": "The data for this histogram series.",
+ "$ref": "ChartData"
}
},
"id": "HistogramSeries"
@@ -1015,24 +3270,29 @@
"description": "The response when clearing a range of values in a spreadsheet.",
"type": "object",
"properties": {
+ "spreadsheetId": {
+ "type": "string",
+ "description": "The spreadsheet the updates were applied to."
+ },
"clearedRanges": {
+ "description": "The ranges that were cleared, in A1 notation.\n(If the requests were for an unbounded range or a ranger larger\n than the bounds of the sheet, this will be the actual ranges\n that were cleared, bounded to the sheet's limits.)",
"type": "array",
"items": {
"type": "string"
- },
- "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.)"
- },
- "spreadsheetId": {
- "description": "The spreadsheet the updates were applied to.",
- "type": "string"
+ }
}
},
"id": "BatchClearValuesResponse"
},
"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",
@@ -1048,10 +3308,6 @@
"description": "Overall properties of a spreadsheet.",
"$ref": "SpreadsheetProperties"
},
- "spreadsheetId": {
- "type": "string",
- "description": "The ID of the spreadsheet.\nThis field is read-only."
- },
"namedRanges": {
"description": "The named ranges defined in a spreadsheet.",
"type": "array",
@@ -1059,15 +3315,14 @@
"$ref": "NamedRange"
}
},
- "developerMetadata": {
- "description": "The developer metadata associated with a spreadsheet.",
- "type": "array",
- "items": {
- "$ref": "DeveloperMetadata"
- }
+ "spreadsheetId": {
+ "type": "string",
+ "description": "The ID of the spreadsheet.\nThis field is read-only."
}
},
- "id": "Spreadsheet"
+ "id": "Spreadsheet",
+ "description": "Resource that represents a spreadsheet.",
+ "type": "object"
},
"AddChartRequest": {
"description": "Adds a chart to a sheet in the spreadsheet.",
@@ -1081,47 +3336,56 @@
"id": "AddChartRequest"
},
"UpdateProtectedRangeRequest": {
+ "type": "object",
"properties": {
"protectedRange": {
- "description": "The protected range to update with the new properties.",
- "$ref": "ProtectedRange"
+ "$ref": "ProtectedRange",
+ "description": "The protected range to update with the new properties."
},
"fields": {
+ "type": "string",
"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"
+ "format": "google-fieldmask"
}
},
"id": "UpdateProtectedRangeRequest",
- "description": "Updates an existing protected range with the specified\nprotectedRangeId.",
- "type": "object"
+ "description": "Updates an existing protected range with the specified\nprotectedRangeId."
},
"DataFilter": {
+ "id": "DataFilter",
+ "description": "Filter that describes what data should be selected or returned from a\nrequest.",
+ "type": "object",
"properties": {
- "gridRange": {
- "description": "Selects data that matches the range described by the GridRange.",
- "$ref": "GridRange"
- },
"developerMetadataLookup": {
"$ref": "DeveloperMetadataLookup",
"description": "Selects data associated with the developer metadata matching the criteria\ndescribed by this DeveloperMetadataLookup."
},
"a1Range": {
- "description": "Selects data that matches the specified A1 range.",
- "type": "string"
+ "type": "string",
+ "description": "Selects data that matches the specified A1 range."
+ },
+ "gridRange": {
+ "description": "Selects data that matches the range described by the GridRange.",
+ "$ref": "GridRange"
}
- },
- "id": "DataFilter",
- "description": "Filter that describes what data should be selected or returned from a\nrequest.",
- "type": "object"
+ }
},
"TextFormat": {
+ "id": "TextFormat",
"description": "The format of a run of text in a cell.\nAbsent values indicate that the field isn't specified.",
"type": "object",
"properties": {
+ "foregroundColor": {
+ "description": "The foreground color of the text.",
+ "$ref": "Color"
+ },
+ "bold": {
+ "type": "boolean",
+ "description": "True if the text is bold."
+ },
"fontFamily": {
- "type": "string",
- "description": "The font family."
+ "description": "The font family.",
+ "type": "string"
},
"italic": {
"description": "True if the text is italicized.",
@@ -1139,31 +3403,21 @@
"underline": {
"description": "True if the text is underlined.",
"type": "boolean"
- },
- "foregroundColor": {
- "description": "The foreground color of the text.",
- "$ref": "Color"
- },
- "bold": {
- "description": "True if the text is bold.",
- "type": "boolean"
}
- },
- "id": "TextFormat"
+ }
},
"AddSheetResponse": {
"description": "The result of adding a sheet.",
"type": "object",
"properties": {
"properties": {
- "$ref": "SheetProperties",
- "description": "The properties of the newly added sheet."
+ "description": "The properties of the newly added sheet.",
+ "$ref": "SheetProperties"
}
},
"id": "AddSheetResponse"
},
"AddFilterViewResponse": {
- "id": "AddFilterViewResponse",
"description": "The result of adding a filter view.",
"type": "object",
"properties": {
@@ -1171,36 +3425,38 @@
"description": "The newly added filter view.",
"$ref": "FilterView"
}
- }
+ },
+ "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": {
+ "type": "integer",
"description": "When iterative calculation is enabled, the maximum number of calculation\nrounds to perform.",
- "format": "int32",
- "type": "integer"
+ "format": "int32"
+ },
+ "convergenceThreshold": {
+ "type": "number",
+ "description": "When iterative calculation is enabled and successive results differ by\nless than this threshold value, the calculation rounds stop.",
+ "format": "double"
}
},
"id": "IterativeCalculationSettings"
},
"OverlayPosition": {
+ "description": "The location an object is overlaid on top of a grid.",
"type": "object",
"properties": {
"offsetXPixels": {
+ "type": "integer",
"description": "The horizontal offset, in pixels, that the object is offset\nfrom the anchor cell.",
- "format": "int32",
- "type": "integer"
+ "format": "int32"
},
"anchorCell": {
- "description": "The cell the object is anchored to.",
- "$ref": "GridCoordinate"
+ "$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.",
@@ -1208,9 +3464,9 @@
"type": "integer"
},
"heightPixels": {
- "type": "integer",
"description": "The height of the object, in pixels. Defaults to 371.",
- "format": "int32"
+ "format": "int32",
+ "type": "integer"
},
"widthPixels": {
"description": "The width of the object, in pixels. Defaults to 600.",
@@ -1218,16 +3474,29 @@
"type": "integer"
}
},
- "id": "OverlayPosition",
- "description": "The location an object is overlaid on top of a grid."
+ "id": "OverlayPosition"
},
"SpreadsheetProperties": {
"description": "Properties of a spreadsheet.",
"type": "object",
"properties": {
+ "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": {
+ "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"
+ },
"autoRecalc": {
- "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.",
@@ -1239,58 +3508,44 @@
"ON_CHANGE",
"MINUTE",
"HOUR"
- ]
- },
- "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": {
- "type": "string",
- "description": "The title of the spreadsheet."
- },
- "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": {
- "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.",
+ ],
+ "description": "The amount of time to wait before volatile functions are recalculated.",
"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."
+ "defaultFormat": {
+ "$ref": "CellFormat",
+ "description": "The default format of all cells in the spreadsheet.\nCellData.effectiveFormat will not be set if the\ncell's format is equal to this default format.\nThis field is read-only."
}
},
"id": "SpreadsheetProperties"
},
"RepeatCellRequest": {
- "type": "object",
"properties": {
+ "cell": {
+ "$ref": "CellData",
+ "description": "The data to write."
+ },
"range": {
"$ref": "GridRange",
"description": "The range to repeat the cell in."
},
"fields": {
- "type": "string",
"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"
- },
- "cell": {
- "$ref": "CellData",
- "description": "The data to write."
+ "format": "google-fieldmask",
+ "type": "string"
}
},
"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."
+ "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"
},
"AddChartResponse": {
"description": "The result of adding a chart to a spreadsheet.",
"type": "object",
"properties": {
"chart": {
- "description": "The newly added chart.",
- "$ref": "EmbeddedChart"
+ "$ref": "EmbeddedChart",
+ "description": "The newly added chart."
}
},
"id": "AddChartResponse"
@@ -1315,13 +3570,13 @@
"type": "object",
"properties": {
"fields": {
- "type": "string",
"description": "The fields that should be updated. At least one field must be specified.\nThe root 'properties' is implied and should not be specified.\nA single `\"*\"` can be used as short-hand for listing every field.",
- "format": "google-fieldmask"
+ "format": "google-fieldmask",
+ "type": "string"
},
"properties": {
- "$ref": "SpreadsheetProperties",
- "description": "The properties to update."
+ "description": "The properties to update.",
+ "$ref": "SpreadsheetProperties"
}
},
"id": "UpdateSpreadsheetPropertiesRequest"
@@ -1330,14 +3585,22 @@
"description": "A protected range.",
"type": "object",
"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": {
+ "description": "True if the user who requested this protected range can edit the\nprotected area.\nThis field is read-only.",
+ "type": "boolean"
+ },
+ "editors": {
+ "$ref": "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."
+ },
"range": {
"$ref": "GridRange",
"description": "The range that is being protected.\nThe range may be fully unbounded, in which case this is considered\na protected sheet.\n\nWhen writing, only one of range or named_range_id\nmay be set."
},
- "editors": {
- "description": "The users and groups with edit access to the protected range.\nThis field is only visible to users with edit access to the protected\nrange and the document.\nEditors are not supported with warning_only protection.",
- "$ref": "Editors"
- },
"description": {
"description": "The description of this protected range.",
"type": "string"
@@ -1354,37 +3617,15 @@
"type": "string"
},
"protectedRangeId": {
- "type": "integer",
"description": "The ID of the protected range.\nThis field is read-only.",
- "format": "int32"
- },
- "warningOnly": {
- "type": "boolean",
- "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."
- },
- "requestingUserCanEdit": {
- "description": "True if the user who requested this protected range can edit the\nprotected area.\nThis field is read-only.",
- "type": "boolean"
+ "format": "int32",
+ "type": "integer"
}
},
"id": "ProtectedRange"
},
"BatchUpdateValuesRequest": {
- "description": "The request for updating more than one range of values in a spreadsheet.",
- "type": "object",
"properties": {
- "responseDateTimeRenderOption": {
- "description": "Determines how dates, times, and durations in the response should be\nrendered. This is ignored if response_value_render_option is\nFORMATTED_VALUE.\nThe default dateTime render option is\nDateTimeRenderOption.SERIAL_NUMBER.",
- "type": "string",
- "enumDescriptions": [
- "Instructs date, time, datetime, and duration fields to be output\nas doubles in \"serial number\" format, as popularized by Lotus 1-2-3.\nThe whole number portion of the value (left of the decimal) counts\nthe days since December 30th 1899. The fractional portion (right of\nthe decimal) counts the time as a fraction of the day. For example,\nJanuary 1st 1900 at noon would be 2.5, 2 because it's 2 days after\nDecember 30st 1899, and .5 because noon is half a day. February 1st\n1900 at 3pm would be 33.625. This correctly treats the year 1900 as\nnot a leap year.",
- "Instructs date, time, datetime, and duration fields to be output\nas strings in their given number format (which is dependent\non the spreadsheet locale)."
- ],
- "enum": [
- "SERIAL_NUMBER",
- "FORMATTED_STRING"
- ]
- },
"responseValueRenderOption": {
"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\"`.",
@@ -1400,8 +3641,8 @@
"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"
+ "type": "boolean",
+ "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)."
},
"valueInputOption": {
"description": "How the input data should be interpreted.",
@@ -1423,40 +3664,69 @@
"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"
}
},
- "id": "BatchUpdateValuesRequest"
+ "id": "BatchUpdateValuesRequest",
+ "description": "The request for updating more than one range of values in a spreadsheet.",
+ "type": "object"
},
"DimensionProperties": {
"description": "Properties about a dimension.",
"type": "object",
"properties": {
- "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": {
- "type": "boolean",
- "description": "True if this dimension is being filtered.\nThis field is read-only."
+ "description": "True if this dimension is being filtered.\nThis field is read-only.",
+ "type": "boolean"
},
"hiddenByUser": {
- "type": "boolean",
- "description": "True if this dimension is explicitly hidden."
+ "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"
},
"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",
"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",
@@ -1471,61 +3741,38 @@
"description": "The sheet this span is on.",
"format": "int32",
"type": "integer"
- },
- "dimension": {
- "description": "The dimension of the span.",
- "type": "string",
- "enumDescriptions": [
- "The default value, do not use.",
- "Operates on the rows of a sheet.",
- "Operates on the columns of a sheet."
- ],
- "enum": [
- "DIMENSION_UNSPECIFIED",
- "ROWS",
- "COLUMNS"
- ]
}
},
- "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."
+ "id": "DimensionRange"
},
"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": {
- "description": "The range this represents.",
- "$ref": "GridRange"
- },
- "name": {
- "description": "The name of the named range.",
- "type": "string"
+ "$ref": "GridRange",
+ "description": "The range this represents."
}
},
"id": "NamedRange"
},
"CutPasteRequest": {
+ "description": "Moves data from the source to the destination.",
"type": "object",
"properties": {
"source": {
- "description": "The source data to cut.",
- "$ref": "GridRange"
+ "$ref": "GridRange",
+ "description": "The source data to cut."
},
"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",
@@ -1536,27 +3783,33 @@
"PASTE_CONDITIONAL_FORMATTING"
],
"description": "What kind of data to paste. All the source data will be cut, regardless\nof what is pasted.",
- "type": "string"
+ "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"
+ "$ref": "GridCoordinate",
+ "description": "The top-left coordinate where the data should be pasted."
}
},
- "id": "CutPasteRequest",
- "description": "Moves data from the source to the destination."
+ "id": "CutPasteRequest"
},
"BasicChartSeries": {
- "description": "A single series of data in a chart.\nFor example, if charting stock prices over time, multiple series may exist,\none for the \"Open Price\", \"High Price\", \"Low Price\" and \"Close Price\".",
- "type": "object",
"properties": {
"lineStyle": {
- "$ref": "LineStyle",
- "description": "The line style of this series. Valid only if the\nchartType is AREA,\nLINE, or SCATTER.\nCOMBO charts are also supported if the\nseries chart type is\nAREA or LINE."
+ "description": "The line style of this series. Valid only if the\nchartType is AREA,\nLINE, or SCATTER.\nCOMBO charts are also supported if the\nseries chart type is\nAREA or LINE.",
+ "$ref": "LineStyle"
},
"series": {
- "description": "The data being visualized in this chart series.",
- "$ref": "ChartData"
+ "$ref": "ChartData",
+ "description": "The data being visualized in this chart series."
},
"type": {
"enumDescriptions": [
@@ -1599,33 +3852,34 @@
"type": "string"
}
},
- "id": "BasicChartSeries"
+ "id": "BasicChartSeries",
+ "description": "A single series of data in a chart.\nFor example, if charting stock prices over time, multiple series may exist,\none for the \"Open Price\", \"High Price\", \"Low Price\" and \"Close Price\".",
+ "type": "object"
},
"Borders": {
+ "description": "The borders of the cell.",
"type": "object",
"properties": {
+ "right": {
+ "$ref": "Border",
+ "description": "The right border of the cell."
+ },
"bottom": {
"description": "The bottom border of the cell.",
"$ref": "Border"
},
"top": {
- "description": "The top border of the cell.",
- "$ref": "Border"
+ "$ref": "Border",
+ "description": "The top border of the cell."
},
"left": {
- "description": "The left border of the cell.",
- "$ref": "Border"
- },
- "right": {
- "description": "The right border of the cell.",
- "$ref": "Border"
+ "$ref": "Border",
+ "description": "The left border of the cell."
}
},
- "id": "Borders",
- "description": "The borders of the cell."
+ "id": "Borders"
},
"AutoResizeDimensionsRequest": {
- "description": "Automatically resizes one or more dimensions based on the contents\nof the cells in that dimension.",
"type": "object",
"properties": {
"dimensions": {
@@ -1633,32 +3887,16 @@
"description": "The dimensions to automatically resize."
}
},
- "id": "AutoResizeDimensionsRequest"
+ "id": "AutoResizeDimensionsRequest",
+ "description": "Automatically resizes one or more dimensions based on the contents\nof the cells in that dimension."
},
"UpdateBordersRequest": {
- "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",
"properties": {
- "bottom": {
- "$ref": "Border",
- "description": "The border to put at the bottom of the range."
- },
- "innerVertical": {
- "$ref": "Border",
- "description": "The vertical border to put within the range."
- },
- "right": {
- "$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"
+ "$ref": "Border",
+ "description": "The horizontal border to put within the range."
},
"top": {
"$ref": "Border",
@@ -1667,12 +3905,27 @@
"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."
+ },
+ "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."
}
- }
+ },
+ "id": "UpdateBordersRequest"
},
"CellFormat": {
- "id": "CellFormat",
- "description": "The format of a cell.",
"type": "object",
"properties": {
"numberFormat": {
@@ -1680,6 +3933,8 @@
"description": "A format describing how number values should be represented to the user."
},
"hyperlinkDisplayType": {
+ "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.",
@@ -1689,17 +3944,9 @@
"HYPERLINK_DISPLAY_TYPE_UNSPECIFIED",
"LINKED",
"PLAIN_TEXT"
- ],
- "description": "How a hyperlink, if it exists, should be displayed in the cell.",
- "type": "string"
+ ]
},
"horizontalAlignment": {
- "enum": [
- "HORIZONTAL_ALIGN_UNSPECIFIED",
- "LEFT",
- "CENTER",
- "RIGHT"
- ],
"description": "The horizontal alignment of the value in the cell.",
"type": "string",
"enumDescriptions": [
@@ -1707,6 +3954,12 @@
"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"
]
},
"textFormat": {
@@ -1714,8 +3967,8 @@
"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."
+ "description": "The background color of the cell.",
+ "$ref": "Color"
},
"padding": {
"$ref": "Padding",
@@ -1738,12 +3991,10 @@
]
},
"borders": {
- "$ref": "Borders",
- "description": "The borders of the cell."
+ "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.",
@@ -1753,11 +4004,15 @@
"TEXT_DIRECTION_UNSPECIFIED",
"LEFT_TO_RIGHT",
"RIGHT_TO_LEFT"
- ]
+ ],
+ "description": "The direction of the text in the cell.",
+ "type": "string"
+ },
+ "textRotation": {
+ "$ref": "TextRotation",
+ "description": "The rotation applied to text in a cell"
},
"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. |",
@@ -1771,32 +4026,30 @@
"LEGACY_WRAP",
"CLIP",
"WRAP"
- ]
- },
- "textRotation": {
- "$ref": "TextRotation",
- "description": "The rotation applied to text in a cell"
+ ],
+ "description": "The wrap strategy for the value in the cell.",
+ "type": "string"
}
- }
+ },
+ "id": "CellFormat",
+ "description": "The format of a cell."
},
"ClearValuesResponse": {
"type": "object",
"properties": {
- "clearedRange": {
- "description": "The range (in A1 notation) that was cleared.\n(If the request was for an unbounded range or a ranger larger\n than the bounds of the sheet, this will be the actual range\n that was cleared, bounded to the sheet's limits.)",
- "type": "string"
- },
"spreadsheetId": {
"description": "The spreadsheet the updates were applied to.",
"type": "string"
+ },
+ "clearedRange": {
+ "description": "The range (in A1 notation) that was cleared.\n(If the request was for an unbounded range or a ranger larger\n than the bounds of the sheet, this will be the actual range\n that was cleared, bounded to the sheet's limits.)",
+ "type": "string"
}
},
"id": "ClearValuesResponse",
"description": "The response when clearing a range of values in a spreadsheet."
},
"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.",
@@ -1809,7 +4062,9 @@
"type": "integer"
}
},
- "id": "DeleteConditionalFormatRuleRequest"
+ "id": "DeleteConditionalFormatRuleRequest",
+ "description": "Deletes a conditional format rule at the given index.\nAll subsequent rules' indexes are decremented.",
+ "type": "object"
},
"DeleteNamedRangeRequest": {
"description": "Removes the named range with the given ID from the spreadsheet.",
@@ -1834,6 +4089,7 @@
"id": "AddBandingResponse"
},
"ChartData": {
+ "type": "object",
"properties": {
"sourceRange": {
"$ref": "ChartSourceRange",
@@ -1841,8 +4097,7 @@
}
},
"id": "ChartData",
- "description": "The data included in a domain or series.",
- "type": "object"
+ "description": "The data included in a domain or series."
},
"BatchGetValuesResponse": {
"description": "The response when retrieving more than one range of values in a spreadsheet.",
@@ -1856,8 +4111,8 @@
}
},
"spreadsheetId": {
- "type": "string",
- "description": "The ID of the spreadsheet the data was retrieved from."
+ "description": "The ID of the spreadsheet the data was retrieved from.",
+ "type": "string"
}
},
"id": "BatchGetValuesResponse"
@@ -1866,14 +4121,14 @@
"description": "Updates properties of the supplied banded range.",
"type": "object",
"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"
+ },
+ "bandedRange": {
+ "description": "The banded range to update with the new properties.",
+ "$ref": "BandedRange"
}
},
"id": "UpdateBandingRequest"
@@ -1882,6 +4137,11 @@
"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",
@@ -1896,19 +4156,19 @@
"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"
- },
- "red": {
- "description": "The amount of red in the color as a value in the interval [0, 1].",
- "format": "float",
- "type": "number"
}
},
"id": "Color"
},
"PivotGroup": {
+ "id": "PivotGroup",
"description": "A single grouping (either row or column) in a pivot table.",
"type": "object",
"properties": {
+ "valueBucket": {
+ "description": "The bucket of the opposite pivot group to sort by.\nIf not specified, sorting is alphabetical by this group's values.",
+ "$ref": "PivotGroupSortValueBucket"
+ },
"sourceColumnOffset": {
"description": "The column offset of the source range that this grouping is based on.\n\nFor example, if the source was `C10:E15`, a `sourceColumnOffset` of `0`\nmeans this group refers to column `C`, whereas the offset `1` would refer\nto column `D`.",
"format": "int32",
@@ -1926,45 +4186,29 @@
}
},
"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."
+ "type": "string",
+ "enumDescriptions": [
+ "Default value, do not use this.",
+ "Sort ascending.",
+ "Sort descending."
+ ]
}
- },
- "id": "PivotGroup"
+ }
},
"PivotTable": {
+ "id": "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": {
+ "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)."
@@ -1972,9 +4216,18 @@
"enum": [
"HORIZONTAL",
"VERTICAL"
- ],
- "description": "Whether values should be listed horizontally (as columns)\nor vertically (as rows).",
- "type": "string"
+ ]
+ },
+ "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.",
@@ -1983,19 +4236,21 @@
"$ref": "PivotValue"
}
},
- "source": {
- "description": "The range the pivot table is reading data from.",
- "$ref": "GridRange"
+ "criteria": {
+ "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",
+ "additionalProperties": {
+ "$ref": "PivotFilterCriteria"
+ }
},
- "columns": {
+ "rows": {
+ "description": "Each row grouping in the pivot table.",
"type": "array",
"items": {
"$ref": "PivotGroup"
- },
- "description": "Each column grouping in the pivot table."
+ }
}
- },
- "id": "PivotTable"
+ }
},
"ChartSourceRange": {
"description": "Source ranges for a chart.",
@@ -2012,24 +4267,25 @@
"id": "ChartSourceRange"
},
"SearchDeveloperMetadataResponse": {
+ "id": "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"
- },
- "description": "The metadata matching the criteria of the search request."
+ }
}
- },
- "id": "SearchDeveloperMetadataResponse"
+ }
},
"ValueRange": {
- "id": "ValueRange",
- "description": "Data within a range of the spreadsheet.",
- "type": "object",
"properties": {
+ "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."
+ },
"majorDimension": {
"enumDescriptions": [
"The default value, do not use.",
@@ -2053,14 +4309,15 @@
"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",
+ "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.",
@@ -2080,45 +4337,22 @@
"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"
+ "id": "AppendCellsRequest"
},
"AddBandingRequest": {
- "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",
"description": "Adds a new banded range to the spreadsheet.",
- "type": "object"
- },
- "Response": {
- "description": "A single response from an update.",
"type": "object",
"properties": {
- "addSheet": {
- "$ref": "AddSheetResponse",
- "description": "A reply from adding a sheet."
- },
- "updateConditionalFormatRule": {
- "description": "A reply from updating a conditional format rule.",
- "$ref": "UpdateConditionalFormatRuleResponse"
- },
- "createDeveloperMetadata": {
- "$ref": "CreateDeveloperMetadataResponse",
- "description": "A reply from creating a developer metadata entry."
- },
- "addNamedRange": {
- "description": "A reply from adding a named range.",
- "$ref": "AddNamedRangeResponse"
- },
- "deleteDeveloperMetadata": {
- "$ref": "DeleteDeveloperMetadataResponse",
- "description": "A reply from deleting a developer metadata entry."
- },
+ "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.)"
+ }
+ }
+ },
+ "Response": {
+ "type": "object",
+ "properties": {
"addFilterView": {
"$ref": "AddFilterViewResponse",
"description": "A reply from adding a filter view."
@@ -2128,8 +4362,8 @@
"description": "A reply from adding a banded range."
},
"addProtectedRange": {
- "$ref": "AddProtectedRangeResponse",
- "description": "A reply from adding a protected range."
+ "description": "A reply from adding a protected range.",
+ "$ref": "AddProtectedRangeResponse"
},
"duplicateSheet": {
"$ref": "DuplicateSheetResponse",
@@ -2140,8 +4374,8 @@
"$ref": "DeleteConditionalFormatRuleResponse"
},
"updateEmbeddedObjectPosition": {
- "$ref": "UpdateEmbeddedObjectPositionResponse",
- "description": "A reply from updating an embedded object's position."
+ "description": "A reply from updating an embedded object's position.",
+ "$ref": "UpdateEmbeddedObjectPositionResponse"
},
"duplicateFilterView": {
"description": "A reply from duplicating a filter view.",
@@ -2156,13 +4390,35 @@
"description": "A reply from updating a developer metadata entry."
},
"findReplace": {
- "$ref": "FindReplaceResponse",
- "description": "A reply from doing a find/replace."
+ "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": {
+ "$ref": "UpdateConditionalFormatRuleResponse",
+ "description": "A reply from updating a conditional format rule."
+ },
+ "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"
+ "id": "Response",
+ "description": "A single response from an update."
},
"EmbeddedChart": {
+ "id": "EmbeddedChart",
"description": "A chart embedded in a sheet.",
"type": "object",
"properties": {
@@ -2179,12 +4435,9 @@
"description": "The specification of the chart.",
"$ref": "ChartSpec"
}
- },
- "id": "EmbeddedChart"
+ }
},
"TextFormatRun": {
- "id": "TextFormatRun",
- "description": "A run of a text format. The format of this run continues until the start\nindex of the next run.\nWhen updating, all fields must be set.",
"type": "object",
"properties": {
"startIndex": {
@@ -2193,13 +4446,21 @@
"type": "integer"
},
"format": {
- "$ref": "TextFormat",
- "description": "The format of this run. Absent values inherit the cell's format."
+ "description": "The format of this run. Absent values inherit the cell's format.",
+ "$ref": "TextFormat"
}
- }
+ },
+ "id": "TextFormatRun",
+ "description": "A run of a text format. The format of this run continues until the start\nindex of the next run.\nWhen updating, all fields must be set."
},
"InsertRangeRequest": {
+ "description": "Inserts cells into a range, shifting the existing cells over or down.",
+ "type": "object",
"properties": {
+ "range": {
+ "description": "The range to insert new cells into.",
+ "$ref": "GridRange"
+ },
"shiftDimension": {
"enumDescriptions": [
"The default value, do not use.",
@@ -2213,18 +4474,11 @@
],
"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": {
- "$ref": "GridRange",
- "description": "The range to insert new cells into."
}
},
- "id": "InsertRangeRequest",
- "description": "Inserts cells into a range, shifting the existing cells over or down.",
- "type": "object"
+ "id": "InsertRangeRequest"
},
"AddNamedRangeResponse": {
- "id": "AddNamedRangeResponse",
"description": "The result of adding a named range.",
"type": "object",
"properties": {
@@ -2232,12 +4486,24 @@
"$ref": "NamedRange",
"description": "The named range to add."
}
- }
+ },
+ "id": "AddNamedRangeResponse"
},
"BatchUpdateValuesByDataFilterResponse": {
+ "id": "BatchUpdateValuesByDataFilterResponse",
"description": "The response when updating a range of values in a spreadsheet.",
"type": "object",
"properties": {
+ "totalUpdatedSheets": {
+ "description": "The total number of sheets where at least one cell in the sheet was\nupdated.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "totalUpdatedCells": {
+ "description": "The total number of cells updated.",
+ "format": "int32",
+ "type": "integer"
+ },
"totalUpdatedColumns": {
"description": "The total number of columns where at least one cell in the column was\nupdated.",
"format": "int32",
@@ -2258,19 +4524,8 @@
"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"
}
- },
- "id": "BatchUpdateValuesByDataFilterResponse"
+ }
},
"RowData": {
"description": "Data about each cell in a row.",
@@ -2290,12 +4545,8 @@
"description": "A border along a cell.",
"type": "object",
"properties": {
- "width": {
- "description": "The width of the border, in pixels.\nDeprecated; the width is determined by the \"style\" field.",
- "format": "int32",
- "type": "integer"
- },
"style": {
+ "type": "string",
"enumDescriptions": [
"The style is not specified. Do not use this.",
"The border is dotted.",
@@ -2316,12 +4567,16 @@
"NONE",
"DOUBLE"
],
- "description": "The style of the border.",
- "type": "string"
+ "description": "The style of the border."
},
"color": {
"$ref": "Color",
"description": "The color of the border."
+ },
+ "width": {
+ "description": "The width of the border, in pixels.\nDeprecated; the width is determined by the \"style\" field.",
+ "format": "int32",
+ "type": "integer"
}
},
"id": "Border"
@@ -2330,6 +4585,18 @@
"description": "Data in the grid, as well as metadata about the dimensions.",
"type": "object",
"properties": {
+ "rowData": {
+ "description": "The data in the grid, one entry per row,\nstarting with the row in startRow.\nThe values in RowData will correspond to columns starting\nat start_column.",
+ "type": "array",
+ "items": {
+ "$ref": "RowData"
+ }
+ },
+ "startRow": {
+ "description": "The first row this GridData refers to, zero-based.",
+ "format": "int32",
+ "type": "integer"
+ },
"columnMetadata": {
"description": "Metadata about the requested columns in the grid, starting with the column\nin start_column.",
"type": "array",
@@ -2348,29 +4615,16 @@
"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": {
- "$ref": "NamedRange",
- "description": "The named range to update with the new properties."
+ "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.",
@@ -2378,33 +4632,13 @@
"type": "string"
}
},
- "id": "UpdateNamedRangeRequest"
+ "id": "UpdateNamedRangeRequest",
+ "description": "Updates properties of the named range with the specified\nnamedRangeId."
},
"FindReplaceRequest": {
- "id": "FindReplaceRequest",
"description": "Finds and replaces data in cells over a range, sheet, or all sheets.",
"type": "object",
"properties": {
- "includeFormulas": {
- "description": "True if the search should include cells with formulas.\nFalse to skip cells with formulas.",
- "type": "boolean"
- },
- "matchEntireCell": {
- "description": "True if the find value should match the entire cell.",
- "type": "boolean"
- },
- "searchByRegex": {
- "type": "boolean",
- "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."
- },
- "find": {
- "description": "The value to search.",
- "type": "string"
- },
- "replacement": {
- "type": "string",
- "description": "The value to use as the replacement."
- },
"range": {
"$ref": "GridRange",
"description": "The range to find/replace over."
@@ -2421,21 +4655,43 @@
"matchCase": {
"description": "True if the search is case sensitive.",
"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"
+ },
+ "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"
+ },
+ "find": {
+ "description": "The value to search.",
+ "type": "string"
+ },
+ "replacement": {
+ "description": "The value to use as the replacement.",
+ "type": "string"
}
- }
+ },
+ "id": "FindReplaceRequest"
},
"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": {
- "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.)",
- "$ref": "SheetProperties"
+ "$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": {
+ "id": "UpdateCellsRequest",
"description": "Updates all cells in a range with new data.",
"type": "object",
"properties": {
@@ -2456,33 +4712,32 @@
"type": "string"
},
"start": {
- "description": "The coordinate to start writing data at.\nAny number of rows and columns (including a different number of\ncolumns per row) may be written.",
- "$ref": "GridCoordinate"
+ "$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."
}
- },
- "id": "UpdateCellsRequest"
- },
- "RandomizeRangeRequest": {
- "description": "Randomizes the order of the rows in a range.",
- "type": "object",
- "properties": {
- "range": {
- "$ref": "GridRange",
- "description": "The range to randomize."
- }
- },
- "id": "RandomizeRangeRequest"
+ }
},
"DeleteConditionalFormatRuleResponse": {
+ "description": "The result of deleting a conditional format rule.",
+ "type": "object",
"properties": {
"rule": {
"$ref": "ConditionalFormatRule",
"description": "The rule that was deleted."
}
},
- "id": "DeleteConditionalFormatRuleResponse",
- "description": "The result of deleting a conditional format rule.",
- "type": "object"
+ "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.",
@@ -2503,2270 +4758,11 @@
"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."
},
"range": {
- "$ref": "GridRange",
- "description": "The range of cells to delete."
+ "description": "The range of cells to delete.",
+ "$ref": "GridRange"
}
},
"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": {
- "type": "integer",
- "description": "The column index of the coordinate.",
- "format": "int32"
- },
- "sheetId": {
- "description": "The sheet this coordinate is on.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "GridCoordinate"
- },
- "UpdateSheetPropertiesRequest": {
- "type": "object",
- "properties": {
- "fields": {
- "type": "string",
- "description": "The fields that should be updated. At least one field must be specified.\nThe root `properties` is implied and should not be specified.\nA single `\"*\"` can be used as short-hand for listing every field.",
- "format": "google-fieldmask"
- },
- "properties": {
- "$ref": "SheetProperties",
- "description": "The properties to update."
- }
- },
- "id": "UpdateSheetPropertiesRequest",
- "description": "Updates properties of the sheet with the specified\nsheetId."
- },
- "GridProperties": {
- "description": "Properties of a grid.",
- "type": "object",
- "properties": {
- "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"
- },
- "rowCount": {
- "description": "The number of rows in the grid.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "GridProperties"
- },
- "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"
- },
- "SortSpec": {
- "description": "A sort order associated with a specific column or row.",
- "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": {
- "description": "The dimension the sort should be applied to.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "SortSpec"
- },
- "Sheet": {
- "description": "A sheet in a spreadsheet.",
- "type": "object",
- "properties": {
- "conditionalFormats": {
- "description": "The conditional format rules in this sheet.",
- "type": "array",
- "items": {
- "$ref": "ConditionalFormatRule"
- }
- },
- "protectedRanges": {
- "type": "array",
- "items": {
- "$ref": "ProtectedRange"
- },
- "description": "The protected ranges in this sheet."
- },
- "developerMetadata": {
- "description": "The developer metadata associated with a sheet.",
- "type": "array",
- "items": {
- "$ref": "DeveloperMetadata"
- }
- },
- "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": {
- "type": "array",
- "items": {
- "$ref": "GridData"
- },
- "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)."
- },
- "bandedRanges": {
- "description": "The banded (i.e. alternating colors) ranges on this sheet.",
- "type": "array",
- "items": {
- "$ref": "BandedRange"
- }
- },
- "charts": {
- "type": "array",
- "items": {
- "$ref": "EmbeddedChart"
- },
- "description": "The specifications of every chart on this sheet."
- },
- "properties": {
- "description": "The properties of the sheet.",
- "$ref": "SheetProperties"
- },
- "filterViews": {
- "description": "The filter views in this sheet.",
- "type": "array",
- "items": {
- "$ref": "FilterView"
- }
- }
- },
- "id": "Sheet"
- },
- "UpdateEmbeddedObjectPositionResponse": {
- "description": "The result of updating an embedded object's position.",
- "type": "object",
- "properties": {
- "position": {
- "$ref": "EmbeddedObjectPosition",
- "description": "The new position of the embedded object."
- }
- },
- "id": "UpdateEmbeddedObjectPositionResponse"
- },
- "BooleanRule": {
- "properties": {
- "format": {
- "description": "The format to apply.\nConditional formatting can only apply a subset of formatting:\nbold, italic,\nstrikethrough,\nforeground color &\nbackground color.",
- "$ref": "CellFormat"
- },
- "condition": {
- "$ref": "BooleanCondition",
- "description": "The condition of the rule. If the condition evaluates to true,\nthe format will be applied."
- }
- },
- "id": "BooleanRule",
- "description": "A rule that may or may not match, depending on the condition.",
- "type": "object"
- },
- "FilterCriteria": {
- "description": "Criteria for showing/hiding rows in a filter or filter view.",
- "type": "object",
- "properties": {
- "hiddenValues": {
- "description": "Values that should be hidden.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "condition": {
- "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"
- },
- "PivotGroupValueMetadata": {
- "id": "PivotGroupValueMetadata",
- "description": "Metadata about a value in a pivot grouping.",
- "type": "object",
- "properties": {
- "value": {
- "description": "The calculated value the metadata corresponds to.\n(Note that formulaValue is not valid,\n because the values will be calculated.)",
- "$ref": "ExtendedValue"
- },
- "collapsed": {
- "description": "True if the data corresponding to the value is collapsed.",
- "type": "boolean"
- }
- }
- },
- "WaterfallChartSpec": {
- "type": "object",
- "properties": {
- "stackedType": {
- "enumDescriptions": [
- "Default value, do not use.",
- "Values corresponding to the same domain (horizontal axis) value will be\nstacked vertically.",
- "Series will spread out along the horizontal axis."
- ],
- "enum": [
- "WATERFALL_STACKED_TYPE_UNSPECIFIED",
- "STACKED",
- "SEQUENTIAL"
- ],
- "description": "The stacked type.",
- "type": "string"
- },
- "hideConnectorLines": {
- "description": "True to hide connector lines between columns.",
- "type": "boolean"
- },
- "series": {
- "description": "The data this waterfall chart is visualizing.",
- "type": "array",
- "items": {
- "$ref": "WaterfallChartSeries"
- }
- },
- "connectorLineStyle": {
- "$ref": "LineStyle",
- "description": "The line style for the connector lines."
- },
- "domain": {
- "description": "The domain data (horizontal axis) for the waterfall chart.",
- "$ref": "WaterfallChartDomain"
- },
- "firstValueIsTotal": {
- "description": "True to interpret the first value as a total.",
- "type": "boolean"
- }
- },
- "id": "WaterfallChartSpec",
- "description": "A waterfall chart."
- },
- "Editors": {
- "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",
- "description": "The editors of a protected range."
- },
- "UpdateConditionalFormatRuleRequest": {
- "type": "object",
- "properties": {
- "newIndex": {
- "description": "The zero-based new index the rule should end up at.",
- "format": "int32",
- "type": "integer"
- },
- "rule": {
- "description": "The rule that should replace the rule at the given index.",
- "$ref": "ConditionalFormatRule"
- },
- "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"
- }
- },
- "id": "UpdateConditionalFormatRuleRequest",
- "description": "Updates a conditional format rule at the given index,\nor moves a conditional format rule to another index."
- },
- "DataValidationRule": {
- "type": "object",
- "properties": {
- "condition": {
- "$ref": "BooleanCondition",
- "description": "The condition that data in the cell must match."
- },
- "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",
- "description": "A data validation rule."
- },
- "BasicChartDomain": {
- "description": "The domain of a chart.\nFor example, if charting stock prices over time, this would be the date.",
- "type": "object",
- "properties": {
- "domain": {
- "$ref": "ChartData",
- "description": "The data of the domain. For example, if charting stock prices over time,\nthis is the data representing the dates."
- },
- "reversed": {
- "description": "True to reverse the order of the domain values (horizontal axis).",
- "type": "boolean"
- }
- },
- "id": "BasicChartDomain"
- },
- "PasteDataRequest": {
- "description": "Inserts data into the spreadsheet starting at the specified coordinate.",
- "type": "object",
- "properties": {
- "type": {
- "description": "How the data should be pasted.",
- "type": "string",
- "enumDescriptions": [
- "Paste values, formulas, formats, and merges.",
- "Paste the values ONLY without formats, formulas, or merges.",
- "Paste the format and data validation only.",
- "Like PASTE_NORMAL but without borders.",
- "Paste the formulas only.",
- "Paste the data validation only.",
- "Paste the conditional formatting rules only."
- ],
- "enum": [
- "PASTE_NORMAL",
- "PASTE_VALUES",
- "PASTE_FORMAT",
- "PASTE_NO_BORDERS",
- "PASTE_FORMULA",
- "PASTE_DATA_VALIDATION",
- "PASTE_CONDITIONAL_FORMATTING"
- ]
- },
- "html": {
- "description": "True if the data is HTML.",
- "type": "boolean"
- },
- "coordinate": {
- "$ref": "GridCoordinate",
- "description": "The coordinate at which the data should start being inserted."
- },
- "data": {
- "description": "The data to insert.",
- "type": "string"
- },
- "delimiter": {
- "description": "The delimiter in the data.",
- "type": "string"
- }
- },
- "id": "PasteDataRequest"
- },
- "UpdateDeveloperMetadataResponse": {
- "description": "The response from updating developer metadata.",
- "type": "object",
- "properties": {
- "developerMetadata": {
- "description": "The updated developer metadata.",
- "type": "array",
- "items": {
- "$ref": "DeveloperMetadata"
- }
- }
- },
- "id": "UpdateDeveloperMetadataResponse"
- },
- "AppendDimensionRequest": {
- "description": "Appends rows or columns to the end of a sheet.",
- "type": "object",
- "properties": {
- "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"
- },
- "sheetId": {
- "description": "The sheet to append rows or columns to.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "AppendDimensionRequest"
- },
- "AddNamedRangeRequest": {
- "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",
- "description": "Adds a named range to the spreadsheet."
- },
- "CreateDeveloperMetadataResponse": {
- "description": "The response from creating developer metadata.",
- "type": "object",
- "properties": {
- "developerMetadata": {
- "description": "The developer metadata that was created.",
- "$ref": "DeveloperMetadata"
- }
- },
- "id": "CreateDeveloperMetadataResponse"
- },
- "UpdateEmbeddedObjectPositionRequest": {
- "description": "Update an embedded object's position (such as a moving or resizing a\nchart or image).",
- "type": "object",
- "properties": {
- "newPosition": {
- "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.",
- "$ref": "EmbeddedObjectPosition"
- },
- "fields": {
- "description": "The fields of OverlayPosition\nthat should be updated when setting a new position. Used only if\nnewPosition.overlayPosition\nis set, in which case at least one field must\nbe specified. The root `newPosition.overlayPosition` is implied and\nshould not be specified.\nA single `\"*\"` can be used as short-hand for listing every field.",
- "format": "google-fieldmask",
- "type": "string"
- },
- "objectId": {
- "description": "The ID of the object to moved.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "UpdateEmbeddedObjectPositionRequest"
- },
- "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": {
- "type": "integer",
- "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"
- }
- },
- "id": "TextRotation"
- },
- "PieChartSpec": {
- "description": "A \u003ca href=\"/chart/interactive/docs/gallery/piechart\"\u003epie chart\u003c/a\u003e.",
- "type": "object",
- "properties": {
- "series": {
- "description": "The data that covers the one and only series of the pie chart.",
- "$ref": "ChartData"
- },
- "legendPosition": {
- "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."
- ],
- "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"
- },
- "pieHole": {
- "description": "The size of the hole in the pie chart.",
- "format": "double",
- "type": "number"
- },
- "domain": {
- "$ref": "ChartData",
- "description": "The data that covers the domain of the pie chart."
- },
- "threeDimensional": {
- "description": "True if the pie is three dimensional.",
- "type": "boolean"
- }
- },
- "id": "PieChartSpec"
- },
- "UpdateDeveloperMetadataRequest": {
- "properties": {
- "dataFilters": {
- "description": "The filters matching the developer metadata entries to update.",
- "type": "array",
- "items": {
- "$ref": "DataFilter"
- }
- },
- "fields": {
- "description": "The fields that should be updated. At least one field must be specified.\nThe root `developerMetadata` is implied and should not be specified.\nA single `\"*\"` can be used as short-hand for listing every field.",
- "format": "google-fieldmask",
- "type": "string"
- },
- "developerMetadata": {
- "$ref": "DeveloperMetadata",
- "description": "The value that all metadata matched by the data filters will be updated to."
- }
- },
- "id": "UpdateDeveloperMetadataRequest",
- "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"
- },
- "UpdateFilterViewRequest": {
- "id": "UpdateFilterViewRequest",
- "description": "Updates properties of the filter view.",
- "type": "object",
- "properties": {
- "filter": {
- "$ref": "FilterView",
- "description": "The new properties of the filter view."
- },
- "fields": {
- "type": "string",
- "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"
- }
- }
- },
- "WaterfallChartColumnStyle": {
- "description": "Styles for a waterfall chart column.",
- "type": "object",
- "properties": {
- "label": {
- "description": "The label of the column's legend.",
- "type": "string"
- },
- "color": {
- "description": "The color of the column.",
- "$ref": "Color"
- }
- },
- "id": "WaterfallChartColumnStyle"
- },
- "ConditionalFormatRule": {
- "description": "A rule describing a conditional format.",
- "type": "object",
- "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": {
- "$ref": "BooleanRule",
- "description": "The formatting is either \"on\" or \"off\" according to the rule."
- }
- },
- "id": "ConditionalFormatRule"
- },
- "CopyPasteRequest": {
- "description": "Copies data from the source to the destination.",
- "type": "object",
- "properties": {
- "source": {
- "$ref": "GridRange",
- "description": "The source range to copy."
- },
- "pasteType": {
- "description": "What kind of data to paste.",
- "type": "string",
- "enumDescriptions": [
- "Paste values, formulas, formats, and merges.",
- "Paste the values ONLY without formats, formulas, or merges.",
- "Paste the format and data validation only.",
- "Like PASTE_NORMAL but without borders.",
- "Paste the formulas only.",
- "Paste the data validation only.",
- "Paste the conditional formatting rules only."
- ],
- "enum": [
- "PASTE_NORMAL",
- "PASTE_VALUES",
- "PASTE_FORMAT",
- "PASTE_NO_BORDERS",
- "PASTE_FORMULA",
- "PASTE_DATA_VALIDATION",
- "PASTE_CONDITIONAL_FORMATTING"
- ]
- },
- "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": {
- "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."
- ]
- }
- },
- "id": "CopyPasteRequest"
- },
- "Request": {
- "id": "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": {
- "description": "Deletes a named range.",
- "$ref": "DeleteNamedRangeRequest"
- },
- "addProtectedRange": {
- "$ref": "AddProtectedRangeRequest",
- "description": "Adds a protected range."
- },
- "duplicateSheet": {
- "$ref": "DuplicateSheetRequest",
- "description": "Duplicates a sheet."
- },
- "unmergeCells": {
- "$ref": "UnmergeCellsRequest",
- "description": "Unmerges merged cells."
- },
- "deleteSheet": {
- "$ref": "DeleteSheetRequest",
- "description": "Deletes a sheet."
- },
- "updateEmbeddedObjectPosition": {
- "$ref": "UpdateEmbeddedObjectPositionRequest",
- "description": "Updates an embedded object's (e.g. chart, image) position."
- },
- "updateDeveloperMetadata": {
- "$ref": "UpdateDeveloperMetadataRequest",
- "description": "Updates an existing developer metadata entry"
- },
- "updateDimensionProperties": {
- "$ref": "UpdateDimensionPropertiesRequest",
- "description": "Updates dimensions' properties."
- },
- "pasteData": {
- "$ref": "PasteDataRequest",
- "description": "Pastes data (HTML or delimited) into a sheet."
- },
- "setBasicFilter": {
- "description": "Sets the basic filter on a sheet.",
- "$ref": "SetBasicFilterRequest"
- },
- "addConditionalFormatRule": {
- "description": "Adds a new conditional format rule.",
- "$ref": "AddConditionalFormatRuleRequest"
- },
- "updateCells": {
- "description": "Updates many cells at once.",
- "$ref": "UpdateCellsRequest"
- },
- "addNamedRange": {
- "$ref": "AddNamedRangeRequest",
- "description": "Adds a named range."
- },
- "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": {
- "description": "Updates a named range.",
- "$ref": "UpdateNamedRangeRequest"
- },
- "updateSheetProperties": {
- "description": "Updates a sheet's properties.",
- "$ref": "UpdateSheetPropertiesRequest"
- },
- "autoFill": {
- "description": "Automatically fills in more data based on existing data.",
- "$ref": "AutoFillRequest"
- },
- "deleteDimension": {
- "description": "Deletes rows or columns in a sheet.",
- "$ref": "DeleteDimensionRequest"
- },
- "sortRange": {
- "description": "Sorts data in a range.",
- "$ref": "SortRangeRequest"
- },
- "deleteProtectedRange": {
- "description": "Deletes a protected range.",
- "$ref": "DeleteProtectedRangeRequest"
- },
- "duplicateFilterView": {
- "$ref": "DuplicateFilterViewRequest",
- "description": "Duplicates a filter view."
- },
- "addChart": {
- "$ref": "AddChartRequest",
- "description": "Adds a chart."
- },
- "findReplace": {
- "description": "Finds and replaces occurrences of some text with other text.",
- "$ref": "FindReplaceRequest"
- },
- "textToColumns": {
- "$ref": "TextToColumnsRequest",
- "description": "Converts a column of text into many columns of text."
- },
- "updateChartSpec": {
- "$ref": "UpdateChartSpecRequest",
- "description": "Updates a chart's specifications."
- },
- "addSheet": {
- "$ref": "AddSheetRequest",
- "description": "Adds a sheet."
- },
- "updateProtectedRange": {
- "$ref": "UpdateProtectedRangeRequest",
- "description": "Updates a protected range."
- },
- "deleteFilterView": {
- "$ref": "DeleteFilterViewRequest",
- "description": "Deletes a filter view from a sheet."
- },
- "copyPaste": {
- "description": "Copies data from one area and pastes it to another.",
- "$ref": "CopyPasteRequest"
- },
- "insertDimension": {
- "description": "Inserts new rows or columns in a sheet.",
- "$ref": "InsertDimensionRequest"
- },
- "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": {
- "$ref": "AddFilterViewRequest",
- "description": "Adds a filter view."
- },
- "setDataValidation": {
- "description": "Sets data validation for one or more cells.",
- "$ref": "SetDataValidationRequest"
- },
- "updateBorders": {
- "$ref": "UpdateBordersRequest",
- "description": "Updates the borders in a range of cells."
- },
- "deleteConditionalFormatRule": {
- "description": "Deletes an existing conditional format rule.",
- "$ref": "DeleteConditionalFormatRuleRequest"
- },
- "repeatCell": {
- "$ref": "RepeatCellRequest",
- "description": "Repeats a single cell across a range."
- },
- "clearBasicFilter": {
- "$ref": "ClearBasicFilterRequest",
- "description": "Clears the basic filter on a sheet."
- },
- "appendDimension": {
- "$ref": "AppendDimensionRequest",
- "description": "Appends dimensions to the end of a sheet."
- },
- "updateConditionalFormatRule": {
- "description": "Updates an existing conditional format rule.",
- "$ref": "UpdateConditionalFormatRuleRequest"
- },
- "createDeveloperMetadata": {
- "$ref": "CreateDeveloperMetadataRequest",
- "description": "Creates new developer metadata"
- },
- "insertRange": {
- "$ref": "InsertRangeRequest",
- "description": "Inserts new cells in a sheet, shifting the existing cells."
- },
- "deleteDeveloperMetadata": {
- "description": "Deletes developer metadata",
- "$ref": "DeleteDeveloperMetadataRequest"
- },
- "moveDimension": {
- "$ref": "MoveDimensionRequest",
- "description": "Moves rows or columns to another location in a sheet."
- }
- }
- },
- "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": {
- "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."
- ],
- "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."
- },
- "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": {
- "startColumnIndex": {
- "description": "The start column (inclusive) of the range, or not set if unbounded.",
- "format": "int32",
- "type": "integer"
- },
- "sheetId": {
- "description": "The sheet this range is on.",
- "format": "int32",
- "type": "integer"
- },
- "endRowIndex": {
- "description": "The end row (exclusive) of the range, or not set if unbounded.",
- "format": "int32",
- "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"
- }
- },
- "id": "GridRange"
- },
- "WaterfallChartDomain": {
- "description": "The domain of a waterfall chart.",
- "type": "object",
- "properties": {
- "data": {
- "$ref": "ChartData",
- "description": "The data of the WaterfallChartDomain."
- },
- "reversed": {
- "description": "True to reverse the order of the domain values (horizontal axis).",
- "type": "boolean"
- }
- },
- "id": "WaterfallChartDomain"
- },
- "BasicChartSpec": {
- "description": "The specification for a basic chart. See BasicChartType for the list\nof charts this supports.",
- "type": "object",
- "properties": {
- "headerCount": {
- "type": "integer",
- "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"
- },
- "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": {
- "type": "array",
- "items": {
- "$ref": "BasicChartAxis"
- },
- "description": "The axis on the chart."
- },
- "threeDimensional": {
- "description": "True to make the chart 3D.\nApplies to Bar and Column charts.",
- "type": "boolean"
- },
- "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": {
- "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."
- ],
- "enum": [
- "BASIC_CHART_LEGEND_POSITION_UNSPECIFIED",
- "BOTTOM_LEGEND",
- "LEFT_LEGEND",
- "RIGHT_LEGEND",
- "TOP_LEGEND",
- "NO_LEGEND"
- ],
- "description": "The position of the chart legend."
- },
- "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"
- },
- "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": {
- "properties": {
- "rule": {
- "description": "The data validation rule to set on each cell in the range,\nor empty to clear the data validation in the range.",
- "$ref": "DataValidationRule"
- },
- "range": {
- "$ref": "GridRange",
- "description": "The range the data validation rule should apply to."
- }
- },
- "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": {
- "description": "A \u003ca href=\"/chart/interactive/docs/gallery/bubblechart\"\u003ebubble chart\u003c/a\u003e.",
- "type": "object",
- "properties": {
- "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": {
- "description": "The data contianing the bubble y-values. These values locate the bubbles\nin the chart vertically.",
- "$ref": "ChartData"
- },
- "legendPosition": {
- "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.",
- "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."
- },
- "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."
- },
- "domain": {
- "$ref": "ChartData",
- "description": "The data containing the bubble x-values. These values locate the bubbles\nin the chart horizontally."
- },
- "bubbleBorderColor": {
- "$ref": "Color",
- "description": "The bubble border color."
- },
- "bubbleTextStyle": {
- "description": "The format of the text inside the bubbles.\nUnderline and Strikethrough are not supported.",
- "$ref": "TextFormat"
- }
- },
- "id": "BubbleChartSpec"
- },
- "CellData": {
- "id": "CellData",
- "description": "Data about a specific cell.",
- "type": "object",
- "properties": {
- "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": {
- "description": "Any note on the cell.",
- "type": "string"
- },
- "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"
- },
- "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": {
- "description": "The value the user entered in the cell. e.g, `1234`, `'Hello'`, or `=NOW()`\nNote: Dates, Times and DateTimes are represented as doubles in\nserial number format.",
- "$ref": "ExtendedValue"
- },
- "effectiveValue": {
- "$ref": "ExtendedValue",
- "description": "The effective value of the cell. For cells with formulas, this will be\nthe calculated value. For cells with literals, this will be\nthe same as the user_entered_value.\nThis field is read-only."
- },
- "formattedValue": {
- "description": "The formatted value of the cell.\nThis is the value as it's shown to the user.\nThis field is read-only.",
- "type": "string"
- },
- "textFormatRuns": {
- "description": "Runs of rich text applied to subsections of the cell. Runs are only valid\non user entered strings, not formulas, bools, or numbers.\nRuns start at specific indexes in the text and continue until the next\nrun. Properties of a run will continue unless explicitly changed\nin a subsequent run (and properties of the first run will continue\nthe properties of the cell unless explicitly changed).\n\nWhen writing, the new runs will overwrite any prior runs. When writing a\nnew user_entered_value, previous runs will be erased.",
- "type": "array",
- "items": {
- "$ref": "TextFormatRun"
- }
- }
- }
- },
- "TextPosition": {
- "description": "Position settings for text.",
- "type": "object",
- "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"
- },
- "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": {
- "enumDescriptions": [
- "Default input value. This value must not be used.",
- "The values the user has entered will not be parsed and will be stored\nas-is.",
- "The values will be parsed as if the user typed them into the UI.\nNumbers will stay as numbers, but strings may be converted to numbers,\ndates, etc. following the same rules that are applied when entering\ntext into a cell via the Google Sheets UI."
- ],
- "enum": [
- "INPUT_VALUE_OPTION_UNSPECIFIED",
- "RAW",
- "USER_ENTERED"
- ],
- "description": "How the input data should be interpreted.",
- "type": "string"
- },
- "data": {
- "type": "array",
- "items": {
- "$ref": "DataFilterValueRange"
- },
- "description": "The new values to apply to the spreadsheet. If more than one range is\nmatched by the specified DataFilter the specified values will be\napplied to all of those ranges."
- },
- "responseDateTimeRenderOption": {
- "enum": [
- "SERIAL_NUMBER",
- "FORMATTED_STRING"
- ],
- "description": "Determines how dates, times, and durations in the response should be\nrendered. This is ignored if response_value_render_option is\nFORMATTED_VALUE.\nThe default dateTime render option is\nDateTimeRenderOption.SERIAL_NUMBER.",
- "type": "string",
- "enumDescriptions": [
- "Instructs date, time, datetime, and duration fields to be output\nas doubles in \"serial number\" format, as popularized by Lotus 1-2-3.\nThe whole number portion of the value (left of the decimal) counts\nthe days since December 30th 1899. The fractional portion (right of\nthe decimal) counts the time as a fraction of the day. For example,\nJanuary 1st 1900 at noon would be 2.5, 2 because it's 2 days after\nDecember 30st 1899, and .5 because noon is half a day. February 1st\n1900 at 3pm would be 33.625. This correctly treats the year 1900 as\nnot a leap year.",
- "Instructs date, time, datetime, and duration fields to be output\nas strings in their given number format (which is dependent\non the spreadsheet locale)."
- ]
- }
- }
- },
- "BatchUpdateSpreadsheetRequest": {
- "description": "The request for updating any aspect of a spreadsheet.",
- "type": "object",
- "properties": {
- "requests": {
- "type": "array",
- "items": {
- "$ref": "Request"
- },
- "description": "A list of updates to apply to the spreadsheet.\nRequests will be applied in the order they are specified.\nIf any request is not valid, no requests will be applied."
- },
- "includeSpreadsheetInResponse": {
- "description": "Determines if the update response should include the spreadsheet\nresource.",
- "type": "boolean"
- },
- "responseRanges": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "description": "Limits the ranges included in the response spreadsheet.\nMeaningful only if include_spreadsheet_response is 'true'."
- },
- "responseIncludeGridData": {
- "description": "True if grid data should be returned. Meaningful only if\nif include_spreadsheet_response is 'true'.\nThis parameter is ignored if a field mask was set in the request.",
- "type": "boolean"
- }
- },
- "id": "BatchUpdateSpreadsheetRequest"
- },
- "BasicChartAxis": {
- "properties": {
- "position": {
- "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 position of this axis.",
- "type": "string"
- },
- "title": {
- "description": "The title of this axis. If set, this overrides any title inferred\nfrom headers of the data.",
- "type": "string"
- },
- "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."
- }
- },
- "id": "BasicChartAxis",
- "description": "An axis of the chart.\nA chart may not have more than one axis per\naxis position.",
- "type": "object"
- },
- "Padding": {
- "description": "The amount of padding around the cell, in pixels.\nWhen updating padding, every field must be specified.",
- "type": "object",
- "properties": {
- "right": {
- "type": "integer",
- "description": "The right padding of the cell.",
- "format": "int32"
- },
- "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"
- },
- "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": {
- "spec": {
- "$ref": "ChartSpec",
- "description": "The specification to apply to the chart."
- },
- "chartId": {
- "description": "The ID of the chart to update.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "UpdateChartSpecRequest"
- },
- "DeleteFilterViewRequest": {
- "id": "DeleteFilterViewRequest",
- "description": "Deletes a particular filter view.",
- "type": "object",
- "properties": {
- "filterId": {
- "description": "The ID of the filter to delete.",
- "format": "int32",
- "type": "integer"
- }
- }
- },
- "BatchGetValuesByDataFilterRequest": {
- "description": "The request for retrieving a range of values in a spreadsheet selected by a\nset of DataFilters.",
- "type": "object",
- "properties": {
- "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": {
- "enumDescriptions": [
- "The default value, do not use.",
- "Operates on the rows of a sheet.",
- "Operates on the columns of a sheet."
- ],
- "enum": [
- "DIMENSION_UNSPECIFIED",
- "ROWS",
- "COLUMNS"
- ],
- "description": "The major dimension that results should use.\n\nFor example, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`,\nthen a request that selects that range and sets `majorDimension=ROWS` will\nreturn `[[1,2],[3,4]]`,\nwhereas a request that sets `majorDimension=COLUMNS` will return\n`[[1,3],[2,4]]`.",
- "type": "string"
- },
- "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"
- },
- "DeleteDeveloperMetadataResponse": {
- "properties": {
- "deletedDeveloperMetadata": {
- "description": "The metadata that was deleted.",
- "type": "array",
- "items": {
- "$ref": "DeveloperMetadata"
- }
- }
- },
- "id": "DeleteDeveloperMetadataResponse",
- "description": "The response from deleting developer metadata.",
- "type": "object"
- },
- "BatchUpdateValuesResponse": {
- "description": "The response when updating a range of values in a spreadsheet.",
- "type": "object",
- "properties": {
- "totalUpdatedRows": {
- "type": "integer",
- "description": "The total number of rows where at least one cell in the row was updated.",
- "format": "int32"
- },
- "responses": {
- "description": "One UpdateValuesResponse per requested range, in the same order as\nthe requests appeared.",
- "type": "array",
- "items": {
- "$ref": "UpdateValuesResponse"
- }
- },
- "totalUpdatedSheets": {
- "type": "integer",
- "description": "The total number of sheets where at least one cell in the sheet was\nupdated.",
- "format": "int32"
- },
- "totalUpdatedCells": {
- "description": "The total number of cells updated.",
- "format": "int32",
- "type": "integer"
- },
- "totalUpdatedColumns": {
- "description": "The total number of columns where at least one cell in the column was\nupdated.",
- "format": "int32",
- "type": "integer"
- },
- "spreadsheetId": {
- "description": "The spreadsheet the updates were applied to.",
- "type": "string"
- }
- },
- "id": "BatchUpdateValuesResponse"
- },
- "SortRangeRequest": {
- "description": "Sorts data in rows based on a sort order per column.",
- "type": "object",
- "properties": {
- "range": {
- "description": "The range to sort.",
- "$ref": "GridRange"
- },
- "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"
- },
- "MatchedDeveloperMetadata": {
- "id": "MatchedDeveloperMetadata",
- "description": "A developer metadata entry and the data filters specified in the original\nrequest that matched it.",
- "type": "object",
- "properties": {
- "developerMetadata": {
- "description": "The developer metadata matching the specified filters.",
- "$ref": "DeveloperMetadata"
- },
- "dataFilters": {
- "description": "All filters matching the returned developer metadata.",
- "type": "array",
- "items": {
- "$ref": "DataFilter"
- }
- }
- }
- },
- "MergeCellsRequest": {
- "description": "Merges all cells in the range.",
- "type": "object",
- "properties": {
- "mergeType": {
- "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"
- ],
- "enum": [
- "MERGE_ALL",
- "MERGE_COLUMNS",
- "MERGE_ROWS"
- ]
- },
- "range": {
- "$ref": "GridRange",
- "description": "The range of cells to merge."
- }
- },
- "id": "MergeCellsRequest"
- },
- "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": {
- "id": "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"
- }
- }
- }
- },
- "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": {
- "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": {
- "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"
- },
- "metadataValue": {
- "type": "string",
- "description": "Data associated with the metadata's key."
- }
- },
- "id": "DeveloperMetadata"
- },
- "DuplicateFilterViewResponse": {
- "description": "The result of a filter view being duplicated.",
- "type": "object",
- "properties": {
- "filter": {
- "$ref": "FilterView",
- "description": "The newly created filter."
- }
- },
- "id": "DuplicateFilterViewResponse"
- },
- "DuplicateSheetResponse": {
- "id": "DuplicateSheetResponse",
- "description": "The result of duplicating a sheet.",
- "type": "object",
- "properties": {
- "properties": {
- "description": "The properties of the duplicate sheet.",
- "$ref": "SheetProperties"
- }
- }
- },
- "ClearBasicFilterRequest": {
- "description": "Clears the basic filter, if any exists on the sheet.",
- "type": "object",
- "properties": {
- "sheetId": {
- "description": "The sheet ID on which the basic filter should be cleared.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "ClearBasicFilterRequest"
- },
- "TextToColumnsRequest": {
- "description": "Splits a column of text into multiple columns,\nbased on a delimiter in each cell.",
- "type": "object",
- "properties": {
- "source": {
- "description": "The source data range. This must span exactly one column.",
- "$ref": "GridRange"
- },
- "delimiterType": {
- "enum": [
- "DELIMITER_TYPE_UNSPECIFIED",
- "COMMA",
- "SEMICOLON",
- "PERIOD",
- "SPACE",
- "CUSTOM"
- ],
- "description": "The delimiter type to use.",
- "type": "string",
- "enumDescriptions": [
- "Default value. This value must not be used.",
- "\",\"",
- "\";\"",
- "\".\"",
- "\" \"",
- "A custom value as defined in delimiter."
- ]
- },
- "delimiter": {
- "type": "string",
- "description": "The delimiter to use. Used only if delimiterType is\nCUSTOM."
- }
- },
- "id": "TextToColumnsRequest"
- },
- "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"
- },
- "BatchUpdateSpreadsheetResponse": {
- "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."
- },
- "updatedSpreadsheet": {
- "description": "The spreadsheet after updates were applied. This is only set if\n[BatchUpdateSpreadsheetRequest.include_spreadsheet_in_response] is `true`.",
- "$ref": "Spreadsheet"
- },
- "spreadsheetId": {
- "type": "string",
- "description": "The spreadsheet the updates were applied to."
- }
- },
- "id": "BatchUpdateSpreadsheetResponse",
- "description": "The reply for batch updating a spreadsheet."
- },
- "AppendValuesResponse": {
- "properties": {
- "spreadsheetId": {
- "type": "string",
- "description": "The spreadsheet the updates were applied to."
- },
- "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": {
- "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",
- "description": "Moves one or more rows or columns.",
- "type": "object"
- },
- "AddFilterViewRequest": {
- "description": "Adds a filter view.",
- "type": "object",
- "properties": {
- "filter": {
- "$ref": "FilterView",
- "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.)"
- }
- },
- "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": {
- "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"
- },
- "CreateDeveloperMetadataRequest": {
- "type": "object",
- "properties": {
- "developerMetadata": {
- "description": "The developer metadata to create.",
- "$ref": "DeveloperMetadata"
- }
- },
- "id": "CreateDeveloperMetadataRequest",
- "description": "A request to create developer metadata."
- },
- "ChartSpec": {
- "description": "The specifications of a chart.",
- "type": "object",
- "properties": {
- "bubbleChart": {
- "$ref": "BubbleChartSpec",
- "description": "A bubble chart specification."
- },
- "waterfallChart": {
- "$ref": "WaterfallChartSpec",
- "description": "A waterfall chart specification."
- },
- "fontName": {
- "type": "string",
- "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."
- },
- "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"
- },
- "subtitleTextPosition": {
- "description": "The subtitle text position.\nThis field is optional.",
- "$ref": "TextPosition"
- },
- "backgroundColor": {
- "description": "The background color of the entire chart.\nNot applicable to Org charts.",
- "$ref": "Color"
- },
- "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": {
- "description": "An org chart specification.",
- "$ref": "OrgChartSpec"
- },
- "pieChart": {
- "$ref": "PieChartSpec",
- "description": "A pie chart specification."
- },
- "titleTextFormat": {
- "description": "The title text format.\nStrikethrough and underline are not supported.",
- "$ref": "TextFormat"
- },
- "title": {
- "description": "The title of the chart.",
- "type": "string"
- },
- "altText": {
- "description": "The alternative text that describes the chart. This is often used\nfor accessibility.",
- "type": "string"
- },
- "titleTextPosition": {
- "$ref": "TextPosition",
- "description": "The title text position.\nThis field is optional."
- },
- "histogramChart": {
- "description": "A histogram chart specification.",
- "$ref": "HistogramChartSpec"
- },
- "candlestickChart": {
- "$ref": "CandlestickChartSpec",
- "description": "A candlestick chart specification."
- }
- },
- "id": "ChartSpec"
- },
- "BatchGetValuesByDataFilterResponse": {
- "description": "The response when retrieving more than one range of values in a spreadsheet\nselected by DataFilters.",
- "type": "object",
- "properties": {
- "spreadsheetId": {
- "description": "The ID of the spreadsheet the data was retrieved from.",
- "type": "string"
- },
- "valueRanges": {
- "description": "The requested values with the list of data filters that matched them.",
- "type": "array",
- "items": {
- "$ref": "MatchedValueRange"
- }
- }
- },
- "id": "BatchGetValuesByDataFilterResponse"
- },
- "NumberFormat": {
- "description": "The number format of a cell.",
- "type": "object",
- "properties": {
- "type": {
- "description": "The type of the number format.\nWhen writing, this field must be set.",
- "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"
- ]
- },
- "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": {
- "description": "A range of values whose location is specified by a DataFilter.",
- "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"
- },
- "LineStyle": {
- "type": "object",
- "properties": {
- "type": {
- "enum": [
- "LINE_DASH_TYPE_UNSPECIFIED",
- "INVISIBLE",
- "CUSTOM",
- "SOLID",
- "DOTTED",
- "MEDIUM_DASHED",
- "MEDIUM_DASHED_DOTTED",
- "LONG_DASHED",
- "LONG_DASHED_DOTTED"
- ],
- "description": "The dash type of the line.",
- "type": "string",
- "enumDescriptions": [
- "Default value, do not use.",
- "No dash type, which is equivalent to a non-visible line.",
- "A custom dash for a line. Modifying the exact custom dash style is\ncurrently unsupported.",
- "A solid line.",
- "A dotted line.",
- "A dashed line where the dashes have \"medium\" length.",
- "A line that alternates between a \"medium\" dash and a dot.",
- "A dashed line where the dashes have \"long\" length.",
- "A line that alternates between a \"long\" dash and a dot."
- ]
- },
- "width": {
- "description": "The thickness of the line, in px.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "LineStyle",
- "description": "Properties that describe the style of a line."
- },
- "CandlestickDomain": {
- "type": "object",
- "properties": {
- "reversed": {
- "description": "True to reverse the order of the domain values (horizontal axis).",
- "type": "boolean"
- },
- "data": {
- "$ref": "ChartData",
- "description": "The data of the CandlestickDomain."
- }
- },
- "id": "CandlestickDomain",
- "description": "The domain of a CandlestickChart."
- },
- "SheetProperties": {
- "description": "Properties of a sheet.",
- "type": "object",
- "properties": {
- "title": {
- "type": "string",
- "description": "The name of the sheet."
- },
- "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": {
- "type": "boolean",
- "description": "True if the sheet is hidden in the UI, false if it's visible."
- },
- "gridProperties": {
- "$ref": "GridProperties",
- "description": "Additional properties of the sheet if this sheet is a grid.\n(If the sheet is an object sheet, containing a chart or image, then\nthis field will be absent.)\nWhen writing it is an error to set any grid properties on non-grid sheets."
- },
- "sheetType": {
- "enum": [
- "SHEET_TYPE_UNSPECIFIED",
- "GRID",
- "OBJECT"
- ],
- "description": "The type of sheet. Defaults to GRID.\nThis field cannot be changed once set.",
- "type": "string",
- "enumDescriptions": [
- "Default value, do not use.",
- "The sheet is a grid.",
- "The sheet has no grid and instead has an object like a chart or image."
- ]
- }
- },
- "id": "SheetProperties"
- },
- "UpdateDimensionPropertiesRequest": {
- "description": "Updates properties of dimensions within the specified range.",
- "type": "object",
- "properties": {
- "range": {
- "$ref": "DimensionRange",
- "description": "The rows or columns to update."
- },
- "fields": {
- "type": "string",
- "description": "The fields that should be updated. At least one field must be specified.\nThe root `properties` is implied and should not be specified.\nA single `\"*\"` can be used as short-hand for listing every field.",
- "format": "google-fieldmask"
- },
- "properties": {
- "$ref": "DimensionProperties",
- "description": "Properties to update."
- }
- },
- "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": {
- "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 that data should be filled into.",
- "type": "string"
- }
- },
- "id": "SourceAndDestination"
}
},
"icons": {
@@ -4806,20 +4802,21 @@
"spreadsheets": {
"methods": {
"get": {
- "httpMethod": "GET",
"response": {
"$ref": "Spreadsheet"
},
"parameterOrder": [
"spreadsheetId"
],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/drive",
+ "https://www.googleapis.com/auth/drive.file",
+ "https://www.googleapis.com/auth/drive.readonly",
+ "https://www.googleapis.com/auth/spreadsheets",
+ "https://www.googleapis.com/auth/spreadsheets.readonly"
+ ],
"parameters": {
- "spreadsheetId": {
- "description": "The spreadsheet to request.",
- "required": true,
- "type": "string",
- "location": "path"
- },
"ranges": {
"description": "The ranges to retrieve from the spreadsheet.",
"type": "string",
@@ -4830,38 +4827,7 @@
"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"
- }
- },
- "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}",
- "id": "sheets.spreadsheets.get",
- "path": "v4/spreadsheets/{spreadsheetId}",
- "description": "Returns the spreadsheet at the given ID.\nThe caller must specify the spreadsheet ID.\n\nBy default, data within grids will not be returned.\nYou can include grid data one of two ways:\n\n* Specify a field mask listing your desired fields using the `fields` URL\nparameter in HTTP\n\n* Set the includeGridData\nURL parameter to true. If a field mask is set, the `includeGridData`\nparameter is ignored\n\nFor large spreadsheets, it is recommended to retrieve only the specific\nfields of the spreadsheet that you want.\n\nTo retrieve only subsets of the spreadsheet, use the\nranges URL parameter.\nMultiple ranges can be specified. Limiting the range will\nreturn only the portions of the spreadsheet that intersect the requested\nranges. Ranges are specified using A1 notation."
- },
- "getByDataFilter": {
- "description": "Returns the spreadsheet at the given ID.\nThe caller must specify the spreadsheet ID.\n\nThis method differs from GetSpreadsheet in that it allows selecting\nwhich subsets of spreadsheet data to return by specifying a\ndataFilters parameter.\nMultiple DataFilters can be specified. Specifying one or\nmore data filters will return the portions of the spreadsheet that\nintersect ranges matched by any of the filters.\n\nBy default, data within grids will not be returned.\nYou can include grid data one of two ways:\n\n* Specify a field mask listing your desired fields using the `fields` URL\nparameter in HTTP\n\n* Set the includeGridData\nparameter to true. If a field mask is set, the `includeGridData`\nparameter is ignored\n\nFor large spreadsheets, it is recommended to retrieve only the specific\nfields of the spreadsheet that you want.",
- "request": {
- "$ref": "GetSpreadsheetByDataFilterRequest"
- },
- "response": {
- "$ref": "Spreadsheet"
- },
- "parameterOrder": [
- "spreadsheetId"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/drive",
- "https://www.googleapis.com/auth/drive.file",
- "https://www.googleapis.com/auth/spreadsheets"
- ],
- "parameters": {
+ },
"spreadsheetId": {
"description": "The spreadsheet to request.",
"required": true,
@@ -4869,11 +4835,45 @@
"location": "path"
}
},
+ "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": {
+ "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.",
+ "response": {
+ "$ref": "Spreadsheet"
+ },
+ "parameterOrder": [
+ "spreadsheetId"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "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/spreadsheets"
+ ],
"flatPath": "v4/spreadsheets/{spreadsheetId}:getByDataFilter",
"path": "v4/spreadsheets/{spreadsheetId}:getByDataFilter",
"id": "sheets.spreadsheets.getByDataFilter"
},
"create": {
+ "description": "Creates a spreadsheet, returning the newly created spreadsheet.",
+ "request": {
+ "$ref": "Spreadsheet"
+ },
"response": {
"$ref": "Spreadsheet"
},
@@ -4887,20 +4887,20 @@
"parameters": {},
"flatPath": "v4/spreadsheets",
"path": "v4/spreadsheets",
- "id": "sheets.spreadsheets.create",
- "description": "Creates a spreadsheet, returning the newly created spreadsheet.",
- "request": {
- "$ref": "Spreadsheet"
- }
+ "id": "sheets.spreadsheets.create"
},
"batchUpdate": {
- "httpMethod": "POST",
- "parameterOrder": [
- "spreadsheetId"
- ],
+ "request": {
+ "$ref": "BatchUpdateSpreadsheetRequest"
+ },
+ "description": "Applies one or more updates to the spreadsheet.\n\nEach request is validated before\nbeing applied. If any request is not valid then the entire request will\nfail and nothing will be applied.\n\nSome requests have replies to\ngive you some information about how\nthey are applied. The replies will mirror the requests. For example,\nif you applied 4 updates and the 3rd one had a reply, then the\nresponse will have 2 empty replies, the actual reply, and another empty\nreply, in that order.\n\nDue to the collaborative nature of spreadsheets, it is not guaranteed that\nthe spreadsheet will reflect exactly your changes after this completes,\nhowever it is guaranteed that the updates in the request will be\napplied together atomically. Your changes may be altered with respect to\ncollaborator changes. If there are no collaborators, the spreadsheet\nshould reflect your changes.",
"response": {
"$ref": "BatchUpdateSpreadsheetResponse"
},
+ "parameterOrder": [
+ "spreadsheetId"
+ ],
+ "httpMethod": "POST",
"parameters": {
"spreadsheetId": {
"location": "path",
@@ -4915,18 +4915,20 @@
"https://www.googleapis.com/auth/spreadsheets"
],
"flatPath": "v4/spreadsheets/{spreadsheetId}:batchUpdate",
- "id": "sheets.spreadsheets.batchUpdate",
"path": "v4/spreadsheets/{spreadsheetId}: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."
+ "id": "sheets.spreadsheets.batchUpdate"
}
},
"resources": {
"sheets": {
"methods": {
"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.",
"response": {
"$ref": "SheetProperties"
},
@@ -4944,10 +4946,10 @@
"type": "integer"
},
"spreadsheetId": {
- "location": "path",
"description": "The ID of the spreadsheet containing the sheet to copy.",
"required": true,
- "type": "string"
+ "type": "string",
+ "location": "path"
}
},
"scopes": [
@@ -4955,13 +4957,7 @@
"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."
+ "flatPath": "v4/spreadsheets/{spreadsheetId}/sheets/{sheetId}:copyTo"
}
}
},
@@ -4977,42 +4973,47 @@
"metadataId"
],
"httpMethod": "GET",
- "parameters": {
- "metadataId": {
- "required": true,
- "type": "integer",
- "location": "path",
- "description": "The ID of the developer metadata to retrieve.",
- "format": "int32"
- },
- "spreadsheetId": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "The ID of the spreadsheet to retrieve metadata from."
- }
- },
"scopes": [
"https://www.googleapis.com/auth/drive",
"https://www.googleapis.com/auth/drive.file",
"https://www.googleapis.com/auth/spreadsheets"
],
+ "parameters": {
+ "spreadsheetId": {
+ "location": "path",
+ "description": "The ID of the spreadsheet to retrieve metadata from.",
+ "required": true,
+ "type": "string"
+ },
+ "metadataId": {
+ "location": "path",
+ "description": "The ID of the developer metadata to retrieve.",
+ "format": "int32",
+ "required": true,
+ "type": "integer"
+ }
+ },
"flatPath": "v4/spreadsheets/{spreadsheetId}/developerMetadata/{metadataId}",
"path": "v4/spreadsheets/{spreadsheetId}/developerMetadata/{metadataId}",
"id": "sheets.spreadsheets.developerMetadata.get"
},
"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"
},
- "description": "Returns all developer metadata matching the specified DataFilter.\nIf the provided DataFilter represents a DeveloperMetadataLookup object,\nthis will return all DeveloperMetadata entries selected by it. If the\nDataFilter represents a location in a spreadsheet, this will return all\ndeveloper metadata associated with locations intersecting that region.",
- "httpMethod": "POST",
- "parameterOrder": [
- "spreadsheetId"
- ],
"response": {
"$ref": "SearchDeveloperMetadataResponse"
},
+ "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",
@@ -5021,289 +5022,33 @@
"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}/developerMetadata:search",
- "id": "sheets.spreadsheets.developerMetadata.search",
- "path": "v4/spreadsheets/{spreadsheetId}/developerMetadata:search"
+ "path": "v4/spreadsheets/{spreadsheetId}/developerMetadata:search",
+ "id": "sheets.spreadsheets.developerMetadata.search"
}
}
},
"values": {
"methods": {
- "batchGetByDataFilter": {
- "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",
- "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."
- },
- "batchClear": {
- "flatPath": "v4/spreadsheets/{spreadsheetId}/values:batchClear",
- "id": "sheets.spreadsheets.values.batchClear",
- "path": "v4/spreadsheets/{spreadsheetId}/values:batchClear",
- "request": {
- "$ref": "BatchClearValuesRequest"
- },
- "description": "Clears one or more ranges of values from a spreadsheet.\nThe caller must specify the spreadsheet ID and one or more ranges.\nOnly values are cleared -- all other properties of the cell (such as\nformatting, data validation, etc..) are kept.",
- "httpMethod": "POST",
- "parameterOrder": [
- "spreadsheetId"
- ],
- "response": {
- "$ref": "BatchClearValuesResponse"
- },
- "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"
- ]
- },
- "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": {
- "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"
- ]
- },
- "spreadsheetId": {
- "description": "The ID of the spreadsheet to retrieve data from.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "range": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "The A1 notation of the values to retrieve."
- },
- "valueRenderOption": {
- "description": "How values should be represented in the output.\nThe default render option is ValueRenderOption.FORMATTED_VALUE.",
- "type": "string",
- "location": "query",
- "enum": [
- "FORMATTED_VALUE",
- "UNFORMATTED_VALUE",
- "FORMULA"
- ]
- },
- "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"
- }
- },
- "flatPath": "v4/spreadsheets/{spreadsheetId}/values/{range}",
- "path": "v4/spreadsheets/{spreadsheetId}/values/{range}",
- "id": "sheets.spreadsheets.values.get"
- },
- "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": {
- "description": "The ID of the spreadsheet to update.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "flatPath": "v4/spreadsheets/{spreadsheetId}/values:batchUpdateByDataFilter",
- "path": "v4/spreadsheets/{spreadsheetId}/values:batchUpdateByDataFilter",
- "id": "sheets.spreadsheets.values.batchUpdateByDataFilter"
- },
- "update": {
- "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": {
- "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": {
- "description": "How the input data should be interpreted.",
- "type": "string",
- "location": "query",
- "enum": [
- "INPUT_VALUE_OPTION_UNSPECIFIED",
- "RAW",
- "USER_ENTERED"
- ]
- },
- "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"
- },
- "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": {
- "location": "path",
- "description": "The A1 notation of the values 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/{range}",
- "id": "sheets.spreadsheets.values.update",
- "path": "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": {
- "location": "path",
- "description": "The ID of the spreadsheet to update.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v4/spreadsheets/{spreadsheetId}/values:batchUpdate",
- "path": "v4/spreadsheets/{spreadsheetId}/values:batchUpdate",
- "id": "sheets.spreadsheets.values.batchUpdate"
- },
"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"
},
- "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": {
- "required": true,
- "type": "string",
"location": "path",
- "description": "The ID of the spreadsheet to update."
+ "description": "The ID of the spreadsheet to update.",
+ "required": true,
+ "type": "string"
},
"range": {
"description": "The A1 notation of the values to clear.",
@@ -5312,13 +5057,14 @@
"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",
- "path": "v4/spreadsheets/{spreadsheetId}/values/{range}:clear",
"id": "sheets.spreadsheets.values.clear",
- "description": "Clears values from a spreadsheet.\nThe caller must specify the spreadsheet ID and range.\nOnly values are cleared -- all other properties of the cell (such as\nformatting, data validation, etc..) are kept.",
- "request": {
- "$ref": "ClearValuesRequest"
- }
+ "path": "v4/spreadsheets/{spreadsheetId}/values/{range}:clear"
},
"batchGet": {
"flatPath": "v4/spreadsheets/{spreadsheetId}/values:batchGet",
@@ -5340,31 +5086,6 @@
"https://www.googleapis.com/auth/spreadsheets.readonly"
],
"parameters": {
- "spreadsheetId": {
- "location": "path",
- "description": "The ID of the spreadsheet to retrieve data from.",
- "required": true,
- "type": "string"
- },
- "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": {
- "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"
- },
"ranges": {
"description": "The A1 notation of the values to retrieve.",
"type": "string",
@@ -5372,14 +5093,39 @@
"location": "query"
},
"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"
- ]
+ ],
+ "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": {
+ "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": {
+ "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"
}
}
},
@@ -5398,10 +5144,10 @@
],
"parameters": {
"spreadsheetId": {
- "location": "path",
"description": "The ID of the spreadsheet to update.",
"required": true,
- "type": "string"
+ "type": "string",
+ "location": "path"
}
},
"flatPath": "v4/spreadsheets/{spreadsheetId}/values:batchClearByDataFilter",
@@ -5413,12 +5159,10 @@
}
},
"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"
},
- "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.",
"response": {
"$ref": "AppendValuesResponse"
},
@@ -5427,16 +5171,218 @@
"range"
],
"httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/drive",
+ "https://www.googleapis.com/auth/drive.file",
+ "https://www.googleapis.com/auth/spreadsheets"
+ ],
"parameters": {
- "range": {
+ "spreadsheetId": {
"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.",
+ "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"
+ },
+ "insertDataOption": {
+ "enum": [
+ "OVERWRITE",
+ "INSERT_ROWS"
+ ],
+ "description": "How the input data should be inserted.",
+ "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": {
+ "description": "Determines how dates, times, and durations in the response should be\nrendered. This is ignored if response_value_render_option is\nFORMATTED_VALUE.\nThe default dateTime render option is [DateTimeRenderOption.SERIAL_NUMBER].",
+ "type": "string",
+ "location": "query",
+ "enum": [
+ "SERIAL_NUMBER",
+ "FORMATTED_STRING"
+ ]
+ },
+ "range": {
+ "description": "The A1 notation of a range to search for a logical table of data.\nValues will be appended after the last row of the table.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "includeValuesInResponse": {
+ "type": "boolean",
+ "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."
+ }
+ },
+ "flatPath": "v4/spreadsheets/{spreadsheetId}/values/{range}:append",
+ "path": "v4/spreadsheets/{spreadsheetId}/values/{range}:append",
+ "id": "sheets.spreadsheets.values.append"
+ },
+ "batchGetByDataFilter": {
+ "response": {
+ "$ref": "BatchGetValuesByDataFilterResponse"
+ },
+ "parameterOrder": [
+ "spreadsheetId"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/drive",
+ "https://www.googleapis.com/auth/drive.file",
+ "https://www.googleapis.com/auth/spreadsheets"
+ ],
+ "parameters": {
+ "spreadsheetId": {
+ "description": "The ID of the spreadsheet to retrieve data from.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "flatPath": "v4/spreadsheets/{spreadsheetId}/values:batchGetByDataFilter",
+ "path": "v4/spreadsheets/{spreadsheetId}/values:batchGetByDataFilter",
+ "id": "sheets.spreadsheets.values.batchGetByDataFilter",
+ "description": "Returns one or more ranges of values that match the specified data filters.\nThe caller must specify the spreadsheet ID and one or more\nDataFilters. Ranges that match any of the data filters in\nthe request will be returned.",
+ "request": {
+ "$ref": "BatchGetValuesByDataFilterRequest"
+ }
+ },
+ "batchClear": {
+ "response": {
+ "$ref": "BatchClearValuesResponse"
+ },
+ "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:batchClear",
+ "path": "v4/spreadsheets/{spreadsheetId}/values:batchClear",
+ "id": "sheets.spreadsheets.values.batchClear",
+ "request": {
+ "$ref": "BatchClearValuesRequest"
+ },
+ "description": "Clears one or more ranges of values from a spreadsheet.\nThe caller must specify the spreadsheet ID and one or more ranges.\nOnly values are cleared -- all other properties of the cell (such as\nformatting, data validation, etc..) are kept."
+ },
+ "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": {
+ "description": "The A1 notation of the values to retrieve.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "valueRenderOption": {
+ "description": "How values should be represented in the output.\nThe default render option is ValueRenderOption.FORMATTED_VALUE.",
+ "type": "string",
+ "location": "query",
+ "enum": [
+ "FORMATTED_VALUE",
+ "UNFORMATTED_VALUE",
+ "FORMULA"
+ ]
+ },
+ "dateTimeRenderOption": {
+ "location": "query",
+ "enum": [
+ "SERIAL_NUMBER",
+ "FORMATTED_STRING"
+ ],
+ "description": "How dates, times, and durations should be represented in the output.\nThis is ignored if value_render_option is\nFORMATTED_VALUE.\nThe default dateTime render option is [DateTimeRenderOption.SERIAL_NUMBER].",
+ "type": "string"
+ },
+ "majorDimension": {
+ "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"
+ ]
+ },
+ "spreadsheetId": {
+ "location": "path",
+ "description": "The ID of the spreadsheet to retrieve data from.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v4/spreadsheets/{spreadsheetId}/values/{range}",
+ "path": "v4/spreadsheets/{spreadsheetId}/values/{range}",
+ "id": "sheets.spreadsheets.values.get"
+ },
+ "update": {
+ "response": {
+ "$ref": "UpdateValuesResponse"
+ },
+ "parameterOrder": [
+ "spreadsheetId",
+ "range"
+ ],
+ "httpMethod": "PUT",
+ "scopes": [
+ "https://www.googleapis.com/auth/drive",
+ "https://www.googleapis.com/auth/drive.file",
+ "https://www.googleapis.com/auth/spreadsheets"
+ ],
+ "parameters": {
+ "range": {
+ "description": "The A1 notation of the values to update.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
"includeValuesInResponse": {
"location": "query",
- "description": "Determines if the update response should include the values\nof the cells that were appended. By default, responses\ndo not include the updated values.",
+ "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": {
@@ -5446,42 +5392,57 @@
"type": "string"
},
"responseValueRenderOption": {
- "description": "Determines how values in the response should be rendered.\nThe default render option is ValueRenderOption.FORMATTED_VALUE.",
"type": "string",
"location": "query",
"enum": [
"FORMATTED_VALUE",
"UNFORMATTED_VALUE",
"FORMULA"
- ]
- },
- "insertDataOption": {
- "location": "query",
- "enum": [
- "OVERWRITE",
- "INSERT_ROWS"
],
- "description": "How the input data should be inserted.",
- "type": "string"
+ "description": "Determines how values in the response should be rendered.\nThe default render option is ValueRenderOption.FORMATTED_VALUE."
},
"valueInputOption": {
+ "description": "How the input data should be interpreted.",
+ "type": "string",
+ "location": "query",
"enum": [
"INPUT_VALUE_OPTION_UNSPECIFIED",
"RAW",
"USER_ENTERED"
- ],
- "description": "How the input data should be interpreted.",
- "type": "string",
- "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",
- "location": "query"
+ "type": "string"
+ }
+ },
+ "flatPath": "v4/spreadsheets/{spreadsheetId}/values/{range}",
+ "path": "v4/spreadsheets/{spreadsheetId}/values/{range}",
+ "id": "sheets.spreadsheets.values.update",
+ "description": "Sets values in a range of a spreadsheet.\nThe caller must specify the spreadsheet ID, range, and\na valueInputOption.",
+ "request": {
+ "$ref": "ValueRange"
+ }
+ },
+ "batchUpdateByDataFilter": {
+ "response": {
+ "$ref": "BatchUpdateValuesByDataFilterResponse"
+ },
+ "parameterOrder": [
+ "spreadsheetId"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "spreadsheetId": {
+ "location": "path",
+ "description": "The ID of the spreadsheet to update.",
+ "required": true,
+ "type": "string"
}
},
"scopes": [
@@ -5489,7 +5450,42 @@
"https://www.googleapis.com/auth/drive.file",
"https://www.googleapis.com/auth/spreadsheets"
],
- "flatPath": "v4/spreadsheets/{spreadsheetId}/values/{range}:append"
+ "flatPath": "v4/spreadsheets/{spreadsheetId}/values:batchUpdateByDataFilter",
+ "path": "v4/spreadsheets/{spreadsheetId}/values:batchUpdateByDataFilter",
+ "id": "sheets.spreadsheets.values.batchUpdateByDataFilter",
+ "request": {
+ "$ref": "BatchUpdateValuesByDataFilterRequest"
+ },
+ "description": "Sets values in one or more ranges of a spreadsheet.\nThe caller must specify the spreadsheet ID,\na valueInputOption, and one or more\nDataFilterValueRanges."
+ },
+ "batchUpdate": {
+ "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": {
+ "description": "The ID of the spreadsheet to update.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "flatPath": "v4/spreadsheets/{spreadsheetId}/values:batchUpdate",
+ "path": "v4/spreadsheets/{spreadsheetId}/values:batchUpdate",
+ "id": "sheets.spreadsheets.values.batchUpdate",
+ "description": "Sets values in one or more ranges of a spreadsheet.\nThe caller must specify the spreadsheet ID,\na valueInputOption, and one or more\nValueRanges.",
+ "request": {
+ "$ref": "BatchUpdateValuesRequest"
+ }
}
}
}
@@ -5497,28 +5493,9 @@
}
},
"parameters": {
- "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": {
+ "description": "V1 error format.",
+ "type": "string",
"enumDescriptions": [
"v1 error format",
"v2 error format"
@@ -5527,9 +5504,7 @@
"enum": [
"1",
"2"
- ],
- "description": "V1 error format.",
- "type": "string"
+ ]
},
"callback": {
"location": "query",
@@ -5537,6 +5512,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",
@@ -5544,23 +5525,17 @@
],
"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"
+ "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"
+ "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.",
@@ -5568,26 +5543,51 @@
"location": "query"
},
"pp": {
- "type": "boolean",
- "default": "true",
"location": "query",
- "description": "Pretty-print response."
+ "description": "Pretty-print response.",
+ "type": "boolean",
+ "default": "true"
},
"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",
"description": "OAuth bearer token.",
+ "type": "string"
+ },
+ "upload_protocol": {
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "type": "string",
+ "location": "query"
+ },
+ "prettyPrint": {
+ "description": "Returns response with indentations and line breaks.",
+ "type": "boolean",
+ "default": "true",
+ "location": "query"
+ },
+ "uploadType": {
+ "location": "query",
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string"
+ },
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
"type": "string",
"location": "query"
}
},
"version": "v4",
"baseUrl": "https://sheets.googleapis.com/",
- "servicePath": "",
- "description": "Reads and writes Google Sheets.",
"kind": "discovery#restDescription",
- "basePath": ""
+ "description": "Reads and writes Google Sheets.",
+ "servicePath": "",
+ "basePath": "",
+ "id": "sheets:v4",
+ "revision": "20171220",
+ "documentationLink": "https://developers.google.com/sheets/",
+ "discoveryVersion": "v1"
}
diff --git a/slides/v1/slides-api.json b/slides/v1/slides-api.json
index d09e60b..de7bffa 100644
--- a/slides/v1/slides-api.json
+++ b/slides/v1/slides-api.json
@@ -6,13 +6,771 @@
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
- "DeleteParagraphBulletsRequest": {
+ "Size": {
+ "description": "A width and height.",
"type": "object",
"properties": {
- "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"
+ "height": {
+ "description": "The height of the object.",
+ "$ref": "Dimension"
},
+ "width": {
+ "description": "The width of the object.",
+ "$ref": "Dimension"
+ }
+ },
+ "id": "Size"
+ },
+ "TextStyle": {
+ "properties": {
+ "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"
+ },
+ "bold": {
+ "description": "Whether or not the text is rendered as bold.",
+ "type": "boolean"
+ },
+ "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."
+ },
+ "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": {
+ "description": "Whether or not the text is italicized.",
+ "type": "boolean"
+ },
+ "strikethrough": {
+ "description": "Whether or not the text is struck through.",
+ "type": "boolean"
+ },
+ "fontSize": {
+ "description": "The size of the text's font. When read, the `font_size` will specified in\npoints.",
+ "$ref": "Dimension"
+ },
+ "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"
+ },
+ "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."
+ }
+ },
+ "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": {
+ "description": "Update the properties of a Video.",
+ "type": "object",
+ "properties": {
+ "videoProperties": {
+ "$ref": "VideoProperties",
+ "description": "The video properties to update."
+ },
+ "fields": {
+ "description": "The fields that should be updated.\n\nAt least one field must be specified. The root `videoProperties` is\nimplied and should not be specified. A single `\"*\"` can be used as\nshort-hand for listing every field.\n\nFor example to update the video outline color, set `fields` to\n`\"outline.outlineFill.solidFill.color\"`.\n\nTo reset a property to its default value, include its field name in the\nfield mask but leave the field itself unset.",
+ "format": "google-fieldmask",
+ "type": "string"
+ },
+ "objectId": {
+ "description": "The object ID of the video the updates are applied to.",
+ "type": "string"
+ }
+ },
+ "id": "UpdateVideoPropertiesRequest"
+ },
+ "Request": {
+ "description": "A single kind of update to apply to a presentation.",
+ "type": "object",
+ "properties": {
+ "replaceAllShapesWithImage": {
+ "description": "Replaces all shapes matching some criteria with an image.",
+ "$ref": "ReplaceAllShapesWithImageRequest"
+ },
+ "replaceAllText": {
+ "description": "Replaces all instances of specified text.",
+ "$ref": "ReplaceAllTextRequest"
+ },
+ "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": {
+ "description": "Updates the properties of a Line.",
+ "$ref": "UpdateLinePropertiesRequest"
+ },
+ "updateSlidesPosition": {
+ "$ref": "UpdateSlidesPositionRequest",
+ "description": "Updates the position of a set of slides in the presentation."
+ },
+ "deleteTableRow": {
+ "description": "Deletes a row from a table.",
+ "$ref": "DeleteTableRowRequest"
+ },
+ "updateShapeProperties": {
+ "description": "Updates the properties of a Shape.",
+ "$ref": "UpdateShapePropertiesRequest"
+ },
+ "groupObjects": {
+ "description": "Groups objects, such as page elements.",
+ "$ref": "GroupObjectsRequest"
+ },
+ "ungroupObjects": {
+ "$ref": "UngroupObjectsRequest",
+ "description": "Ungroups objects, such as groups."
+ },
+ "insertText": {
+ "description": "Inserts text into a shape or table cell.",
+ "$ref": "InsertTextRequest"
+ },
+ "updateTableColumnProperties": {
+ "description": "Updates the properties of a Table\ncolumn.",
+ "$ref": "UpdateTableColumnPropertiesRequest"
+ },
+ "deleteText": {
+ "description": "Deletes text from a shape or a table cell.",
+ "$ref": "DeleteTextRequest"
+ },
+ "updatePageProperties": {
+ "$ref": "UpdatePagePropertiesRequest",
+ "description": "Updates the properties of a Page."
+ },
+ "deleteParagraphBullets": {
+ "description": "Deletes bullets from paragraphs.",
+ "$ref": "DeleteParagraphBulletsRequest"
+ },
+ "createShape": {
+ "$ref": "CreateShapeRequest",
+ "description": "Creates a new shape."
+ },
+ "updateTableBorderProperties": {
+ "$ref": "UpdateTableBorderPropertiesRequest",
+ "description": "Updates the properties of the table borders in a Table."
+ },
+ "insertTableColumns": {
+ "description": "Inserts columns into a table.",
+ "$ref": "InsertTableColumnsRequest"
+ },
+ "mergeTableCells": {
+ "description": "Merges cells in a Table.",
+ "$ref": "MergeTableCellsRequest"
+ },
+ "refreshSheetsChart": {
+ "$ref": "RefreshSheetsChartRequest",
+ "description": "Refreshes a Google Sheets chart."
+ },
+ "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": {
+ "description": "Updates the styling of paragraphs within a Shape or Table.",
+ "$ref": "UpdateParagraphStyleRequest"
+ },
+ "deleteTableColumn": {
+ "$ref": "DeleteTableColumnRequest",
+ "description": "Deletes a column from a table."
+ },
+ "duplicateObject": {
+ "description": "Duplicates a slide or page element.",
+ "$ref": "DuplicateObjectRequest"
+ },
+ "updateVideoProperties": {
+ "$ref": "UpdateVideoPropertiesRequest",
+ "description": "Updates the properties of a Video."
+ },
+ "createLine": {
+ "$ref": "CreateLineRequest",
+ "description": "Creates a line."
+ },
+ "createImage": {
+ "$ref": "CreateImageRequest",
+ "description": "Creates an image."
+ },
+ "createParagraphBullets": {
+ "description": "Creates bullets for paragraphs.",
+ "$ref": "CreateParagraphBulletsRequest"
+ },
+ "createVideo": {
+ "description": "Creates a video.",
+ "$ref": "CreateVideoRequest"
+ },
+ "createSheetsChart": {
+ "description": "Creates an embedded Google Sheets chart.",
+ "$ref": "CreateSheetsChartRequest"
+ },
+ "replaceAllShapesWithSheetsChart": {
+ "$ref": "ReplaceAllShapesWithSheetsChartRequest",
+ "description": "Replaces all shapes matching some criteria with a Google Sheets chart."
+ },
+ "unmergeTableCells": {
+ "description": "Unmerges cells in a Table.",
+ "$ref": "UnmergeTableCellsRequest"
+ },
+ "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": {
+ "description": "Updates the properties of a Table row.",
+ "$ref": "UpdateTableRowPropertiesRequest"
+ }
+ },
+ "id": "Request"
+ },
+ "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": {
+ "description": "The image properties to update.",
+ "$ref": "ImageProperties"
+ },
+ "objectId": {
+ "description": "The object ID of the image the updates are applied to.",
+ "type": "string"
+ }
+ },
+ "id": "UpdateImagePropertiesRequest",
+ "description": "Update the properties of an Image.",
+ "type": "object"
+ },
+ "ParagraphStyle": {
+ "properties": {
+ "spaceBelow": {
+ "description": "The amount of extra space above the paragraph. If unset, the value is\ninherited from the parent.",
+ "$ref": "Dimension"
+ },
+ "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": {
+ "description": "The amount indentation for the paragraph on the side that corresponds to\nthe end of the text, based on the current text direction. If unset, the\nvalue is inherited from the parent.",
+ "$ref": "Dimension"
+ },
+ "indentStart": {
+ "$ref": "Dimension",
+ "description": "The amount indentation for the paragraph on the side that corresponds to\nthe start of the text, based on the current text direction. If unset, the\nvalue is inherited from the parent."
+ },
+ "spaceAbove": {
+ "$ref": "Dimension",
+ "description": "The amount of extra space above the paragraph. If unset, the value is\ninherited from the parent."
+ },
+ "alignment": {
+ "enum": [
+ "ALIGNMENT_UNSPECIFIED",
+ "START",
+ "CENTER",
+ "END",
+ "JUSTIFIED"
+ ],
+ "description": "The text alignment for this paragraph.",
+ "type": "string",
+ "enumDescriptions": [
+ "The paragraph alignment is inherited from the parent.",
+ "The paragraph is aligned to the start of the line. Left-aligned for\nLTR text, right-aligned otherwise.",
+ "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."
+ ]
+ },
+ "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": {
+ "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"
+ }
+ },
+ "id": "ParagraphStyle",
+ "description": "Styles that apply to a whole paragraph.\n\nIf this text is contained in a shape with a parent placeholder, then these paragraph styles may be\ninherited from the parent. Which paragraph styles are inherited depend on the\nnesting level of lists:\n\n* A paragraph not in a list will inherit its paragraph style from the\n paragraph at the 0 nesting level of the list inside the parent placeholder.\n* A paragraph in a list will inherit its paragraph style from the paragraph\n at its corresponding nesting level of the list inside the parent\n placeholder.\n\nInherited paragraph styles are represented as unset fields in this message.",
+ "type": "object"
+ },
+ "UpdateTableRowPropertiesRequest": {
+ "properties": {
+ "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": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "fields": {
+ "description": "The fields that should be updated.\n\nAt least one field must be specified. The root `tableRowProperties` is\nimplied and should not be specified. A single `\"*\"` can be used as\nshort-hand for listing every field.\n\nFor example to update the minimum row height, set `fields` to\n`\"min_row_height\"`.\n\nIf '\"min_row_height\"' is included in the field mask but the property is\nleft unset, the minimum row height will default to 0.",
+ "format": "google-fieldmask",
+ "type": "string"
+ },
+ "tableRowProperties": {
+ "description": "The table row properties to update.",
+ "$ref": "TableRowProperties"
+ },
+ "objectId": {
+ "description": "The object ID of the table.",
+ "type": "string"
+ }
+ },
+ "id": "UpdateTableRowPropertiesRequest",
+ "description": "Updates the properties of a Table row.",
+ "type": "object"
+ },
+ "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": {
+ "description": "The background fill of the table cell. The default fill matches the fill\nfor newly created table cells in the Slides editor.",
+ "$ref": "TableCellBackgroundFill"
+ },
+ "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 table cell. The default alignment\nmatches the alignment for newly created table cells in the Slides editor.",
+ "type": "string"
+ }
+ },
+ "id": "TableCellProperties"
+ },
+ "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"
+ },
+ "Outline": {
+ "properties": {
+ "weight": {
+ "$ref": "Dimension",
+ "description": "The thickness of the outline."
+ },
+ "dashStyle": {
+ "enum": [
+ "DASH_STYLE_UNSPECIFIED",
+ "SOLID",
+ "DOT",
+ "DASH",
+ "DASH_DOT",
+ "LONG_DASH",
+ "LONG_DASH_DOT"
+ ],
+ "description": "The dash style of the outline.",
+ "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'."
+ ]
+ },
+ "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."
+ ]
+ },
+ "outlineFill": {
+ "$ref": "OutlineFill",
+ "description": "The fill of the outline."
+ }
+ },
+ "id": "Outline",
+ "description": "The outline of a PageElement.\n\nIf these fields are unset, they may be inherited from a parent placeholder\nif it exists. If there is no parent, the fields will default to the value\nused for new page elements created in the Slides editor, which may depend on\nthe page element kind.",
+ "type": "object"
+ },
+ "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"
+ },
+ "TableColumnProperties": {
+ "properties": {
+ "columnWidth": {
+ "$ref": "Dimension",
+ "description": "Width of a column."
+ }
+ },
+ "id": "TableColumnProperties",
+ "description": "Properties of each column in a table.",
+ "type": "object"
+ },
+ "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": {
+ "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": {
+ "$ref": "ShapeBackgroundFill",
+ "description": "The background fill of the shape. If unset, the background fill is\ninherited from a parent placeholder if it exists. If the shape has no\nparent, then the default background fill depends on the shape type,\nmatching the defaults for new shapes created in the Slides editor."
+ },
+ "shadow": {
+ "description": "The shadow properties of the shape. If unset, the shadow is inherited from\na parent placeholder if it exists. If the shape has no parent, then the\ndefault shadow matches the defaults for new shapes created in the Slides\neditor. This property is read-only.",
+ "$ref": "Shadow"
+ },
+ "contentAlignment": {
+ "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",
+ "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'."
+ ]
+ },
+ "link": {
+ "$ref": "Link",
+ "description": "The hyperlink destination of the shape. If unset, there is no link. Links\nare not inherited from parent placeholders."
+ }
+ },
+ "id": "ShapeProperties"
+ },
+ "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": {
+ "tableCellProperties": {
+ "description": "The table cell properties to update.",
+ "$ref": "TableCellProperties"
+ },
+ "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"
+ }
+ },
+ "id": "UpdateTableCellPropertiesRequest"
+ },
+ "CreateSlideRequest": {
+ "properties": {
+ "slideLayoutReference": {
+ "description": "Layout reference of the slide to be inserted, based on the *current\nmaster*, which is one of the following:\n\n- The master of the previous slide index.\n- The master of the first slide, if the insertion_index is zero.\n- The first master in the presentation, if there are no slides.\n\nIf the LayoutReference is not found in the current master, a 400 bad\nrequest error is returned.\n\nIf you don't specify a layout reference, then the new slide will use the\npredefined layout `BLANK`.",
+ "$ref": "LayoutReference"
+ },
+ "objectId": {
+ "description": "A user-supplied object ID.\n\nIf you specify an ID, it must be unique among all pages and page elements\nin the presentation. The ID must start with an alphanumeric character or an\nunderscore (matches regex `[a-zA-Z0-9_]`); remaining characters\nmay include those as well as a hyphen or colon (matches regex\n`[a-zA-Z0-9_-:]`).\nThe length of the ID must not be less than 5 or greater than 50.\n\nIf you don't specify an ID, a unique one is generated.",
+ "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": "CreateSlideRequest",
+ "description": "Creates a new slide.",
+ "type": "object"
+ },
+ "BatchUpdatePresentationRequest": {
+ "description": "Request message for PresentationsService.BatchUpdatePresentation.",
+ "type": "object",
+ "properties": {
+ "writeControl": {
+ "description": "Provides control over how write requests are executed.",
+ "$ref": "WriteControl"
+ },
+ "requests": {
+ "description": "A list of updates to apply to the presentation.",
+ "type": "array",
+ "items": {
+ "$ref": "Request"
+ }
+ }
+ },
+ "id": "BatchUpdatePresentationRequest"
+ },
+ "TableRowProperties": {
+ "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.",
+ "type": "object"
+ },
+ "GroupObjectsResponse": {
+ "description": "The result of grouping objects.",
+ "type": "object",
+ "properties": {
+ "objectId": {
+ "description": "The object ID of the created group.",
+ "type": "string"
+ }
+ },
+ "id": "GroupObjectsResponse"
+ },
+ "TableBorderProperties": {
+ "properties": {
+ "weight": {
+ "$ref": "Dimension",
+ "description": "The thickness of the border."
+ },
+ "tableBorderFill": {
+ "description": "The fill of the table border.",
+ "$ref": "TableBorderFill"
+ },
+ "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 border.",
+ "type": "string"
+ }
+ },
+ "id": "TableBorderProperties",
+ "description": "The border styling properties of the\nTableBorderCell.",
+ "type": "object"
+ },
+ "TableBorderCell": {
+ "description": "The properties of each border cell.",
+ "type": "object",
+ "properties": {
+ "tableBorderProperties": {
+ "description": "The border properties.",
+ "$ref": "TableBorderProperties"
+ },
+ "location": {
+ "description": "The location of the border within the border table.",
+ "$ref": "TableCellLocation"
+ }
+ },
+ "id": "TableBorderCell"
+ },
+ "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"
+ }
+ },
+ "id": "TextContent"
+ },
+ "CreateSheetsChartResponse": {
+ "properties": {
+ "objectId": {
+ "description": "The object ID of the created chart.",
+ "type": "string"
+ }
+ },
+ "id": "CreateSheetsChartResponse",
+ "description": "The result of creating an embedded Google Sheets chart.",
+ "type": "object"
+ },
+ "WriteControl": {
+ "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",
+ "description": "Provides control over how write requests are executed.",
+ "type": "object"
+ },
+ "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"
@@ -20,15 +778,15 @@
"textRange": {
"$ref": "Range",
"description": "The range of text to delete bullets from, based on TextElement indexes."
+ },
+ "cellLocation": {
+ "description": "The optional table cell location if the text to be modified is in a table\ncell. If present, the object_id must refer to a table.",
+ "$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."
+ "id": "DeleteParagraphBulletsRequest"
},
"ParagraphMarker": {
- "id": "ParagraphMarker",
- "description": "A TextElement kind that represents the beginning of a new paragraph.",
- "type": "object",
"properties": {
"style": {
"$ref": "ParagraphStyle",
@@ -38,77 +796,78 @@
"$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.",
+ "type": "object"
+ },
+ "InsertTableColumnsRequest": {
+ "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": {
+ "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.",
+ "type": "boolean"
+ }
+ },
+ "id": "InsertTableColumnsRequest",
+ "description": "Inserts columns into a table.\n\nOther columns in the table will be resized to fit the new column.",
+ "type": "object"
},
"Thumbnail": {
+ "description": "The thumbnail of a page.",
"type": "object",
"properties": {
"height": {
- "type": "integer",
"description": "The positive height in pixels of the thumbnail image.",
- "format": "int32"
+ "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"
},
"width": {
- "type": "integer",
"description": "The positive width in pixels of the thumbnail image.",
- "format": "int32"
- }
- },
- "id": "Thumbnail",
- "description": "The thumbnail of a page."
- },
- "InsertTableColumnsRequest": {
- "id": "InsertTableColumnsRequest",
- "description": "Inserts columns into a table.\n\nOther columns in the table will be resized to fit the new column.",
- "type": "object",
- "properties": {
- "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": {
- "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.",
- "type": "boolean"
- },
- "tableObjectId": {
- "type": "string",
- "description": "The table to insert columns into."
- },
- "number": {
- "description": "The number of columns to be inserted. Maximum 20 per request.",
"format": "int32",
"type": "integer"
}
- }
+ },
+ "id": "Thumbnail"
},
"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": {
- "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"
- },
"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."
+ "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"
+ "id": "LayoutPlaceholderIdMapping",
+ "description": "The user-specified ID mapping for a placeholder that will be created on a\nslide from a specified layout.",
+ "type": "object"
},
"UpdateTableBorderPropertiesRequest": {
- "type": "object",
"properties": {
"borderPosition": {
- "type": "string",
"enumDescriptions": [
"All borders in the range.",
"Borders at the bottom of the range.",
@@ -131,7 +890,8 @@
"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."
+ "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.",
+ "type": "string"
},
"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.",
@@ -143,8 +903,8 @@
"type": "string"
},
"tableRange": {
- "$ref": "TableRange",
- "description": "The table range representing the subset of the table to which the updates\nare applied. If a table range is not specified, the updates will apply to\nthe entire table."
+ "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": {
"$ref": "TableBorderProperties",
@@ -152,10 +912,18 @@
}
},
"id": "UpdateTableBorderPropertiesRequest",
- "description": "Updates the properties of the table borders in a Table."
+ "description": "Updates the properties of the table borders in a Table.",
+ "type": "object"
},
"UpdateShapePropertiesRequest": {
+ "description": "Update the properties of a Shape.",
+ "type": "object",
"properties": {
+ "fields": {
+ "description": "The fields that should be updated.\n\nAt least one field must be specified. The root `shapeProperties` is\nimplied and should not be specified. A single `\"*\"` can be used as\nshort-hand for listing every field.\n\nFor example to update the shape background solid fill color, set `fields`\nto `\"shapeBackgroundFill.solidFill.color\"`.\n\nTo reset a property to its default value, include its field name in the\nfield mask but leave the field itself unset.",
+ "format": "google-fieldmask",
+ "type": "string"
+ },
"objectId": {
"description": "The object ID of the shape the updates are applied to.",
"type": "string"
@@ -163,16 +931,9 @@
"shapeProperties": {
"$ref": "ShapeProperties",
"description": "The shape properties to update."
- },
- "fields": {
- "description": "The fields that should be updated.\n\nAt least one field must be specified. The root `shapeProperties` is\nimplied and should not be specified. A single `\"*\"` can be used as\nshort-hand for listing every field.\n\nFor example to update the shape background solid fill color, set `fields`\nto `\"shapeBackgroundFill.solidFill.color\"`.\n\nTo reset a property to its default value, include its field name in the\nfield mask but leave the field itself unset.",
- "format": "google-fieldmask",
- "type": "string"
}
},
- "id": "UpdateShapePropertiesRequest",
- "description": "Update the properties of a Shape.",
- "type": "object"
+ "id": "UpdateShapePropertiesRequest"
},
"UpdateTableColumnPropertiesRequest": {
"description": "Updates the properties of a Table column.",
@@ -191,8 +952,8 @@
"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": {
- "type": "integer",
- "format": "int32"
+ "format": "int32",
+ "type": "integer"
}
},
"tableColumnProperties": {
@@ -203,15 +964,15 @@
"id": "UpdateTableColumnPropertiesRequest"
},
"WordArt": {
- "description": "A PageElement kind representing\nword art.",
- "type": "object",
"properties": {
"renderedText": {
"description": "The text rendered as word art.",
"type": "string"
}
},
- "id": "WordArt"
+ "id": "WordArt",
+ "description": "A PageElement kind representing\nword art.",
+ "type": "object"
},
"Recolor": {
"description": "A recolor effect applied on an image.",
@@ -225,7 +986,6 @@
}
},
"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.",
@@ -280,31 +1040,23 @@
"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."
+ "description": "The name of the recolor effect.\n\nThe name is determined from the `recolor_stops` by matching the gradient\nagainst the colors in the page's current color scheme. This property is\nread-only.",
+ "type": "string"
}
},
"id": "Recolor"
},
"Link": {
- "description": "A hypertext link.",
- "type": "object",
"properties": {
"pageObjectId": {
- "type": "string",
- "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."
+ "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."
+ "description": "If set, indicates this is a link to the external web page at this URL.",
+ "type": "string"
},
"relativeLink": {
- "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",
@@ -313,7 +1065,14 @@
"LAST_SLIDE"
],
"description": "If set, indicates this is a link to a slide in this presentation,\naddressed by its position.",
- "type": "string"
+ "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."
+ ]
},
"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.",
@@ -321,21 +1080,22 @@
"type": "integer"
}
},
- "id": "Link"
+ "id": "Link",
+ "description": "A hypertext link.",
+ "type": "object"
},
"CreateShapeResponse": {
- "id": "CreateShapeResponse",
"description": "The result of creating a shape.",
"type": "object",
"properties": {
"objectId": {
- "type": "string",
- "description": "The object ID of the created shape."
+ "description": "The object ID of the created shape.",
+ "type": "string"
}
- }
+ },
+ "id": "CreateShapeResponse"
},
"RgbColor": {
- "type": "object",
"properties": {
"red": {
"description": "The red component of the color, from 0.0 to 1.0.",
@@ -354,33 +1114,34 @@
}
},
"id": "RgbColor",
- "description": "An RGB color."
+ "description": "An RGB color.",
+ "type": "object"
},
"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",
- "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."
- ]
+ "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"
}
},
"id": "CreateLineRequest"
@@ -397,13 +1158,163 @@
"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": {
+ "enumDescriptions": [
+ "The shape type that is not predefined.",
+ "Text box shape.",
+ "Rectangle shape. Corresponds to ECMA-376 ST_ShapeType 'rect'.",
+ "Round corner rectangle shape. Corresponds to ECMA-376 ST_ShapeType\n'roundRect'",
+ "Ellipse shape. Corresponds to ECMA-376 ST_ShapeType 'ellipse'",
+ "Curved arc shape. Corresponds to ECMA-376 ST_ShapeType 'arc'",
+ "Bent arrow shape. Corresponds to ECMA-376 ST_ShapeType 'bentArrow'",
+ "Bent up arrow shape. Corresponds to ECMA-376 ST_ShapeType 'bentUpArrow'",
+ "Bevel shape. Corresponds to ECMA-376 ST_ShapeType 'bevel'",
+ "Block arc shape. Corresponds to ECMA-376 ST_ShapeType 'blockArc'",
+ "Brace pair shape. Corresponds to ECMA-376 ST_ShapeType 'bracePair'",
+ "Bracket pair shape. Corresponds to ECMA-376 ST_ShapeType 'bracketPair'",
+ "Can shape. Corresponds to ECMA-376 ST_ShapeType 'can'",
+ "Chevron shape. Corresponds to ECMA-376 ST_ShapeType 'chevron'",
+ "Chord shape. Corresponds to ECMA-376 ST_ShapeType 'chord'",
+ "Cloud shape. Corresponds to ECMA-376 ST_ShapeType 'cloud'",
+ "Corner shape. Corresponds to ECMA-376 ST_ShapeType 'corner'",
+ "Cube shape. Corresponds to ECMA-376 ST_ShapeType 'cube'",
+ "Curved down arrow shape. Corresponds to ECMA-376 ST_ShapeType\n'curvedDownArrow'",
+ "Curved left arrow shape. Corresponds to ECMA-376 ST_ShapeType\n'curvedLeftArrow'",
+ "Curved right arrow shape. Corresponds to ECMA-376 ST_ShapeType\n'curvedRightArrow'",
+ "Curved up arrow shape. Corresponds to ECMA-376 ST_ShapeType\n'curvedUpArrow'",
+ "Decagon shape. Corresponds to ECMA-376 ST_ShapeType 'decagon'",
+ "Diagonal stripe shape. Corresponds to ECMA-376 ST_ShapeType 'diagStripe'",
+ "Diamond shape. Corresponds to ECMA-376 ST_ShapeType 'diamond'",
+ "Dodecagon shape. Corresponds to ECMA-376 ST_ShapeType 'dodecagon'",
+ "Donut shape. Corresponds to ECMA-376 ST_ShapeType 'donut'",
+ "Double wave shape. Corresponds to ECMA-376 ST_ShapeType 'doubleWave'",
+ "Down arrow shape. Corresponds to ECMA-376 ST_ShapeType 'downArrow'",
+ "Callout down arrow shape. Corresponds to ECMA-376 ST_ShapeType\n'downArrowCallout'",
+ "Folded corner shape. Corresponds to ECMA-376 ST_ShapeType 'foldedCorner'",
+ "Frame shape. Corresponds to ECMA-376 ST_ShapeType 'frame'",
+ "Half frame shape. Corresponds to ECMA-376 ST_ShapeType 'halfFrame'",
+ "Heart shape. Corresponds to ECMA-376 ST_ShapeType 'heart'",
+ "Heptagon shape. Corresponds to ECMA-376 ST_ShapeType 'heptagon'",
+ "Hexagon shape. Corresponds to ECMA-376 ST_ShapeType 'hexagon'",
+ "Home plate shape. Corresponds to ECMA-376 ST_ShapeType 'homePlate'",
+ "Horizontal scroll shape. Corresponds to ECMA-376 ST_ShapeType\n'horizontalScroll'",
+ "Irregular seal 1 shape. Corresponds to ECMA-376 ST_ShapeType\n'irregularSeal1'",
+ "Irregular seal 2 shape. Corresponds to ECMA-376 ST_ShapeType\n'irregularSeal2'",
+ "Left arrow shape. Corresponds to ECMA-376 ST_ShapeType 'leftArrow'",
+ "Callout left arrow shape. Corresponds to ECMA-376 ST_ShapeType\n'leftArrowCallout'",
+ "Left brace shape. Corresponds to ECMA-376 ST_ShapeType 'leftBrace'",
+ "Left bracket shape. Corresponds to ECMA-376 ST_ShapeType 'leftBracket'",
+ "Left right arrow shape. Corresponds to ECMA-376 ST_ShapeType\n'leftRightArrow'",
+ "Callout left right arrow shape. Corresponds to ECMA-376 ST_ShapeType\n'leftRightArrowCallout'",
+ "Left right up arrow shape. Corresponds to ECMA-376 ST_ShapeType\n'leftRightUpArrow'",
+ "Left up arrow shape. Corresponds to ECMA-376 ST_ShapeType 'leftUpArrow'",
+ "Lightning bolt shape. Corresponds to ECMA-376 ST_ShapeType\n'lightningBolt'",
+ "Divide math shape. Corresponds to ECMA-376 ST_ShapeType 'mathDivide'",
+ "Equal math shape. Corresponds to ECMA-376 ST_ShapeType 'mathEqual'",
+ "Minus math shape. Corresponds to ECMA-376 ST_ShapeType 'mathMinus'",
+ "Multiply math shape. Corresponds to ECMA-376 ST_ShapeType 'mathMultiply'",
+ "Not equal math shape. Corresponds to ECMA-376 ST_ShapeType 'mathNotEqual'",
+ "Plus math shape. Corresponds to ECMA-376 ST_ShapeType 'mathPlus'",
+ "Moon shape. Corresponds to ECMA-376 ST_ShapeType 'moon'",
+ "No smoking shape. Corresponds to ECMA-376 ST_ShapeType 'noSmoking'",
+ "Notched right arrow shape. Corresponds to ECMA-376 ST_ShapeType\n'notchedRightArrow'",
+ "Octagon shape. Corresponds to ECMA-376 ST_ShapeType 'octagon'",
+ "Parallelogram shape. Corresponds to ECMA-376 ST_ShapeType 'parallelogram'",
+ "Pentagon shape. Corresponds to ECMA-376 ST_ShapeType 'pentagon'",
+ "Pie shape. Corresponds to ECMA-376 ST_ShapeType 'pie'",
+ "Plaque shape. Corresponds to ECMA-376 ST_ShapeType 'plaque'",
+ "Plus shape. Corresponds to ECMA-376 ST_ShapeType 'plus'",
+ "Quad-arrow shape. Corresponds to ECMA-376 ST_ShapeType 'quadArrow'",
+ "Callout quad-arrow shape. Corresponds to ECMA-376 ST_ShapeType\n'quadArrowCallout'",
+ "Ribbon shape. Corresponds to ECMA-376 ST_ShapeType 'ribbon'",
+ "Ribbon 2 shape. Corresponds to ECMA-376 ST_ShapeType 'ribbon2'",
+ "Right arrow shape. Corresponds to ECMA-376 ST_ShapeType 'rightArrow'",
+ "Callout right arrow shape. Corresponds to ECMA-376 ST_ShapeType\n'rightArrowCallout'",
+ "Right brace shape. Corresponds to ECMA-376 ST_ShapeType 'rightBrace'",
+ "Right bracket shape. Corresponds to ECMA-376 ST_ShapeType 'rightBracket'",
+ "One round corner rectangle shape. Corresponds to ECMA-376 ST_ShapeType\n'round1Rect'",
+ "Two diagonal round corner rectangle shape. Corresponds to ECMA-376\nST_ShapeType 'round2DiagRect'",
+ "Two same-side round corner rectangle shape. Corresponds to ECMA-376\nST_ShapeType 'round2SameRect'",
+ "Right triangle shape. Corresponds to ECMA-376 ST_ShapeType 'rtTriangle'",
+ "Smiley face shape. Corresponds to ECMA-376 ST_ShapeType 'smileyFace'",
+ "One snip corner rectangle shape. Corresponds to ECMA-376 ST_ShapeType\n'snip1Rect'",
+ "Two diagonal snip corner rectangle shape. Corresponds to ECMA-376\nST_ShapeType 'snip2DiagRect'",
+ "Two same-side snip corner rectangle shape. Corresponds to ECMA-376\nST_ShapeType 'snip2SameRect'",
+ "One snip one round corner rectangle shape. Corresponds to ECMA-376\nST_ShapeType 'snipRoundRect'",
+ "Ten pointed star shape. Corresponds to ECMA-376 ST_ShapeType 'star10'",
+ "Twelve pointed star shape. Corresponds to ECMA-376 ST_ShapeType 'star12'",
+ "Sixteen pointed star shape. Corresponds to ECMA-376 ST_ShapeType 'star16'",
+ "Twenty four pointed star shape. Corresponds to ECMA-376 ST_ShapeType\n'star24'",
+ "Thirty two pointed star shape. Corresponds to ECMA-376 ST_ShapeType\n'star32'",
+ "Four pointed star shape. Corresponds to ECMA-376 ST_ShapeType 'star4'",
+ "Five pointed star shape. Corresponds to ECMA-376 ST_ShapeType 'star5'",
+ "Six pointed star shape. Corresponds to ECMA-376 ST_ShapeType 'star6'",
+ "Seven pointed star shape. Corresponds to ECMA-376 ST_ShapeType 'star7'",
+ "Eight pointed star shape. Corresponds to ECMA-376 ST_ShapeType 'star8'",
+ "Striped right arrow shape. Corresponds to ECMA-376 ST_ShapeType\n'stripedRightArrow'",
+ "Sun shape. Corresponds to ECMA-376 ST_ShapeType 'sun'",
+ "Trapezoid shape. Corresponds to ECMA-376 ST_ShapeType 'trapezoid'",
+ "Triangle shape. Corresponds to ECMA-376 ST_ShapeType 'triangle'",
+ "Up arrow shape. Corresponds to ECMA-376 ST_ShapeType 'upArrow'",
+ "Callout up arrow shape. Corresponds to ECMA-376 ST_ShapeType\n'upArrowCallout'",
+ "Up down arrow shape. Corresponds to ECMA-376 ST_ShapeType 'upDownArrow'",
+ "U-turn arrow shape. Corresponds to ECMA-376 ST_ShapeType 'uturnArrow'",
+ "Vertical scroll shape. Corresponds to ECMA-376 ST_ShapeType\n'verticalScroll'",
+ "Wave shape. Corresponds to ECMA-376 ST_ShapeType 'wave'",
+ "Callout wedge ellipse shape. Corresponds to ECMA-376 ST_ShapeType\n'wedgeEllipseCallout'",
+ "Callout wedge rectangle shape. Corresponds to ECMA-376 ST_ShapeType\n'wedgeRectCallout'",
+ "Callout wedge round rectangle shape. Corresponds to ECMA-376 ST_ShapeType\n'wedgeRoundRectCallout'",
+ "Alternate process flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartAlternateProcess'",
+ "Collate flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartCollate'",
+ "Connector flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartConnector'",
+ "Decision flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartDecision'",
+ "Delay flow shape. Corresponds to ECMA-376 ST_ShapeType 'flowChartDelay'",
+ "Display flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartDisplay'",
+ "Document flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartDocument'",
+ "Extract flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartExtract'",
+ "Input output flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartInputOutput'",
+ "Internal storage flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartInternalStorage'",
+ "Magnetic disk flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartMagneticDisk'",
+ "Magnetic drum flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartMagneticDrum'",
+ "Magnetic tape flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartMagneticTape'",
+ "Manual input flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartManualInput'",
+ "Manual operation flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartManualOperation'",
+ "Merge flow shape. Corresponds to ECMA-376 ST_ShapeType 'flowChartMerge'",
+ "Multi-document flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartMultidocument'",
+ "Offline storage flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartOfflineStorage'",
+ "Off-page connector flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartOffpageConnector'",
+ "Online storage flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartOnlineStorage'",
+ "Or flow shape. Corresponds to ECMA-376 ST_ShapeType 'flowChartOr'",
+ "Predefined process flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartPredefinedProcess'",
+ "Preparation flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartPreparation'",
+ "Process flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartProcess'",
+ "Punched card flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartPunchedCard'",
+ "Punched tape flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartPunchedTape'",
+ "Sort flow shape. Corresponds to ECMA-376 ST_ShapeType 'flowChartSort'",
+ "Summing junction flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartSummingJunction'",
+ "Terminator flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartTerminator'",
+ "East arrow shape.",
+ "Northeast arrow shape.",
+ "North arrow shape.",
+ "Speech shape.",
+ "Star burst shape.",
+ "Teardrop shape. Corresponds to ECMA-376 ST_ShapeType 'teardrop'",
+ "Ellipse ribbon shape. Corresponds to ECMA-376 ST_ShapeType\n'ellipseRibbon'",
+ "Ellipse ribbon 2 shape. Corresponds to ECMA-376 ST_ShapeType\n'ellipseRibbon2'",
+ "Callout cloud shape. Corresponds to ECMA-376 ST_ShapeType 'cloudCallout'",
+ "Custom shape."
+ ],
"enum": [
"TYPE_UNSPECIFIED",
"TEXT_BOX",
@@ -550,163 +1461,12 @@
"CUSTOM"
],
"description": "The shape type.",
- "type": "string",
- "enumDescriptions": [
- "The shape type that is not predefined.",
- "Text box shape.",
- "Rectangle shape. Corresponds to ECMA-376 ST_ShapeType 'rect'.",
- "Round corner rectangle shape. Corresponds to ECMA-376 ST_ShapeType\n'roundRect'",
- "Ellipse shape. Corresponds to ECMA-376 ST_ShapeType 'ellipse'",
- "Curved arc shape. Corresponds to ECMA-376 ST_ShapeType 'arc'",
- "Bent arrow shape. Corresponds to ECMA-376 ST_ShapeType 'bentArrow'",
- "Bent up arrow shape. Corresponds to ECMA-376 ST_ShapeType 'bentUpArrow'",
- "Bevel shape. Corresponds to ECMA-376 ST_ShapeType 'bevel'",
- "Block arc shape. Corresponds to ECMA-376 ST_ShapeType 'blockArc'",
- "Brace pair shape. Corresponds to ECMA-376 ST_ShapeType 'bracePair'",
- "Bracket pair shape. Corresponds to ECMA-376 ST_ShapeType 'bracketPair'",
- "Can shape. Corresponds to ECMA-376 ST_ShapeType 'can'",
- "Chevron shape. Corresponds to ECMA-376 ST_ShapeType 'chevron'",
- "Chord shape. Corresponds to ECMA-376 ST_ShapeType 'chord'",
- "Cloud shape. Corresponds to ECMA-376 ST_ShapeType 'cloud'",
- "Corner shape. Corresponds to ECMA-376 ST_ShapeType 'corner'",
- "Cube shape. Corresponds to ECMA-376 ST_ShapeType 'cube'",
- "Curved down arrow shape. Corresponds to ECMA-376 ST_ShapeType\n'curvedDownArrow'",
- "Curved left arrow shape. Corresponds to ECMA-376 ST_ShapeType\n'curvedLeftArrow'",
- "Curved right arrow shape. Corresponds to ECMA-376 ST_ShapeType\n'curvedRightArrow'",
- "Curved up arrow shape. Corresponds to ECMA-376 ST_ShapeType\n'curvedUpArrow'",
- "Decagon shape. Corresponds to ECMA-376 ST_ShapeType 'decagon'",
- "Diagonal stripe shape. Corresponds to ECMA-376 ST_ShapeType 'diagStripe'",
- "Diamond shape. Corresponds to ECMA-376 ST_ShapeType 'diamond'",
- "Dodecagon shape. Corresponds to ECMA-376 ST_ShapeType 'dodecagon'",
- "Donut shape. Corresponds to ECMA-376 ST_ShapeType 'donut'",
- "Double wave shape. Corresponds to ECMA-376 ST_ShapeType 'doubleWave'",
- "Down arrow shape. Corresponds to ECMA-376 ST_ShapeType 'downArrow'",
- "Callout down arrow shape. Corresponds to ECMA-376 ST_ShapeType\n'downArrowCallout'",
- "Folded corner shape. Corresponds to ECMA-376 ST_ShapeType 'foldedCorner'",
- "Frame shape. Corresponds to ECMA-376 ST_ShapeType 'frame'",
- "Half frame shape. Corresponds to ECMA-376 ST_ShapeType 'halfFrame'",
- "Heart shape. Corresponds to ECMA-376 ST_ShapeType 'heart'",
- "Heptagon shape. Corresponds to ECMA-376 ST_ShapeType 'heptagon'",
- "Hexagon shape. Corresponds to ECMA-376 ST_ShapeType 'hexagon'",
- "Home plate shape. Corresponds to ECMA-376 ST_ShapeType 'homePlate'",
- "Horizontal scroll shape. Corresponds to ECMA-376 ST_ShapeType\n'horizontalScroll'",
- "Irregular seal 1 shape. Corresponds to ECMA-376 ST_ShapeType\n'irregularSeal1'",
- "Irregular seal 2 shape. Corresponds to ECMA-376 ST_ShapeType\n'irregularSeal2'",
- "Left arrow shape. Corresponds to ECMA-376 ST_ShapeType 'leftArrow'",
- "Callout left arrow shape. Corresponds to ECMA-376 ST_ShapeType\n'leftArrowCallout'",
- "Left brace shape. Corresponds to ECMA-376 ST_ShapeType 'leftBrace'",
- "Left bracket shape. Corresponds to ECMA-376 ST_ShapeType 'leftBracket'",
- "Left right arrow shape. Corresponds to ECMA-376 ST_ShapeType\n'leftRightArrow'",
- "Callout left right arrow shape. Corresponds to ECMA-376 ST_ShapeType\n'leftRightArrowCallout'",
- "Left right up arrow shape. Corresponds to ECMA-376 ST_ShapeType\n'leftRightUpArrow'",
- "Left up arrow shape. Corresponds to ECMA-376 ST_ShapeType 'leftUpArrow'",
- "Lightning bolt shape. Corresponds to ECMA-376 ST_ShapeType\n'lightningBolt'",
- "Divide math shape. Corresponds to ECMA-376 ST_ShapeType 'mathDivide'",
- "Equal math shape. Corresponds to ECMA-376 ST_ShapeType 'mathEqual'",
- "Minus math shape. Corresponds to ECMA-376 ST_ShapeType 'mathMinus'",
- "Multiply math shape. Corresponds to ECMA-376 ST_ShapeType 'mathMultiply'",
- "Not equal math shape. Corresponds to ECMA-376 ST_ShapeType 'mathNotEqual'",
- "Plus math shape. Corresponds to ECMA-376 ST_ShapeType 'mathPlus'",
- "Moon shape. Corresponds to ECMA-376 ST_ShapeType 'moon'",
- "No smoking shape. Corresponds to ECMA-376 ST_ShapeType 'noSmoking'",
- "Notched right arrow shape. Corresponds to ECMA-376 ST_ShapeType\n'notchedRightArrow'",
- "Octagon shape. Corresponds to ECMA-376 ST_ShapeType 'octagon'",
- "Parallelogram shape. Corresponds to ECMA-376 ST_ShapeType 'parallelogram'",
- "Pentagon shape. Corresponds to ECMA-376 ST_ShapeType 'pentagon'",
- "Pie shape. Corresponds to ECMA-376 ST_ShapeType 'pie'",
- "Plaque shape. Corresponds to ECMA-376 ST_ShapeType 'plaque'",
- "Plus shape. Corresponds to ECMA-376 ST_ShapeType 'plus'",
- "Quad-arrow shape. Corresponds to ECMA-376 ST_ShapeType 'quadArrow'",
- "Callout quad-arrow shape. Corresponds to ECMA-376 ST_ShapeType\n'quadArrowCallout'",
- "Ribbon shape. Corresponds to ECMA-376 ST_ShapeType 'ribbon'",
- "Ribbon 2 shape. Corresponds to ECMA-376 ST_ShapeType 'ribbon2'",
- "Right arrow shape. Corresponds to ECMA-376 ST_ShapeType 'rightArrow'",
- "Callout right arrow shape. Corresponds to ECMA-376 ST_ShapeType\n'rightArrowCallout'",
- "Right brace shape. Corresponds to ECMA-376 ST_ShapeType 'rightBrace'",
- "Right bracket shape. Corresponds to ECMA-376 ST_ShapeType 'rightBracket'",
- "One round corner rectangle shape. Corresponds to ECMA-376 ST_ShapeType\n'round1Rect'",
- "Two diagonal round corner rectangle shape. Corresponds to ECMA-376\nST_ShapeType 'round2DiagRect'",
- "Two same-side round corner rectangle shape. Corresponds to ECMA-376\nST_ShapeType 'round2SameRect'",
- "Right triangle shape. Corresponds to ECMA-376 ST_ShapeType 'rtTriangle'",
- "Smiley face shape. Corresponds to ECMA-376 ST_ShapeType 'smileyFace'",
- "One snip corner rectangle shape. Corresponds to ECMA-376 ST_ShapeType\n'snip1Rect'",
- "Two diagonal snip corner rectangle shape. Corresponds to ECMA-376\nST_ShapeType 'snip2DiagRect'",
- "Two same-side snip corner rectangle shape. Corresponds to ECMA-376\nST_ShapeType 'snip2SameRect'",
- "One snip one round corner rectangle shape. Corresponds to ECMA-376\nST_ShapeType 'snipRoundRect'",
- "Ten pointed star shape. Corresponds to ECMA-376 ST_ShapeType 'star10'",
- "Twelve pointed star shape. Corresponds to ECMA-376 ST_ShapeType 'star12'",
- "Sixteen pointed star shape. Corresponds to ECMA-376 ST_ShapeType 'star16'",
- "Twenty four pointed star shape. Corresponds to ECMA-376 ST_ShapeType\n'star24'",
- "Thirty two pointed star shape. Corresponds to ECMA-376 ST_ShapeType\n'star32'",
- "Four pointed star shape. Corresponds to ECMA-376 ST_ShapeType 'star4'",
- "Five pointed star shape. Corresponds to ECMA-376 ST_ShapeType 'star5'",
- "Six pointed star shape. Corresponds to ECMA-376 ST_ShapeType 'star6'",
- "Seven pointed star shape. Corresponds to ECMA-376 ST_ShapeType 'star7'",
- "Eight pointed star shape. Corresponds to ECMA-376 ST_ShapeType 'star8'",
- "Striped right arrow shape. Corresponds to ECMA-376 ST_ShapeType\n'stripedRightArrow'",
- "Sun shape. Corresponds to ECMA-376 ST_ShapeType 'sun'",
- "Trapezoid shape. Corresponds to ECMA-376 ST_ShapeType 'trapezoid'",
- "Triangle shape. Corresponds to ECMA-376 ST_ShapeType 'triangle'",
- "Up arrow shape. Corresponds to ECMA-376 ST_ShapeType 'upArrow'",
- "Callout up arrow shape. Corresponds to ECMA-376 ST_ShapeType\n'upArrowCallout'",
- "Up down arrow shape. Corresponds to ECMA-376 ST_ShapeType 'upDownArrow'",
- "U-turn arrow shape. Corresponds to ECMA-376 ST_ShapeType 'uturnArrow'",
- "Vertical scroll shape. Corresponds to ECMA-376 ST_ShapeType\n'verticalScroll'",
- "Wave shape. Corresponds to ECMA-376 ST_ShapeType 'wave'",
- "Callout wedge ellipse shape. Corresponds to ECMA-376 ST_ShapeType\n'wedgeEllipseCallout'",
- "Callout wedge rectangle shape. Corresponds to ECMA-376 ST_ShapeType\n'wedgeRectCallout'",
- "Callout wedge round rectangle shape. Corresponds to ECMA-376 ST_ShapeType\n'wedgeRoundRectCallout'",
- "Alternate process flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartAlternateProcess'",
- "Collate flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartCollate'",
- "Connector flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartConnector'",
- "Decision flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartDecision'",
- "Delay flow shape. Corresponds to ECMA-376 ST_ShapeType 'flowChartDelay'",
- "Display flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartDisplay'",
- "Document flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartDocument'",
- "Extract flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartExtract'",
- "Input output flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartInputOutput'",
- "Internal storage flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartInternalStorage'",
- "Magnetic disk flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartMagneticDisk'",
- "Magnetic drum flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartMagneticDrum'",
- "Magnetic tape flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartMagneticTape'",
- "Manual input flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartManualInput'",
- "Manual operation flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartManualOperation'",
- "Merge flow shape. Corresponds to ECMA-376 ST_ShapeType 'flowChartMerge'",
- "Multi-document flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartMultidocument'",
- "Offline storage flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartOfflineStorage'",
- "Off-page connector flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartOffpageConnector'",
- "Online storage flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartOnlineStorage'",
- "Or flow shape. Corresponds to ECMA-376 ST_ShapeType 'flowChartOr'",
- "Predefined process flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartPredefinedProcess'",
- "Preparation flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartPreparation'",
- "Process flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartProcess'",
- "Punched card flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartPunchedCard'",
- "Punched tape flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartPunchedTape'",
- "Sort flow shape. Corresponds to ECMA-376 ST_ShapeType 'flowChartSort'",
- "Summing junction flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartSummingJunction'",
- "Terminator flow shape. Corresponds to ECMA-376 ST_ShapeType\n'flowChartTerminator'",
- "East arrow shape.",
- "Northeast arrow shape.",
- "North arrow shape.",
- "Speech shape.",
- "Star burst shape.",
- "Teardrop shape. Corresponds to ECMA-376 ST_ShapeType 'teardrop'",
- "Ellipse ribbon shape. Corresponds to ECMA-376 ST_ShapeType\n'ellipseRibbon'",
- "Ellipse ribbon 2 shape. Corresponds to ECMA-376 ST_ShapeType\n'ellipseRibbon2'",
- "Callout cloud shape. Corresponds to ECMA-376 ST_ShapeType 'cloudCallout'",
- "Custom shape."
- ]
- },
- "elementProperties": {
- "$ref": "PageElementProperties",
- "description": "The element properties for the shape."
+ "type": "string"
}
},
- "id": "CreateShapeRequest",
- "description": "Creates a new shape."
+ "id": "CreateShapeRequest"
},
"Video": {
- "id": "Video",
"description": "A PageElement kind representing a\nvideo.",
"type": "object",
"properties": {
@@ -715,12 +1475,12 @@
"type": "string"
},
"id": {
- "type": "string",
- "description": "The video source's unique identifier for this video."
+ "description": "The video source's unique identifier for this video.",
+ "type": "string"
},
"videoProperties": {
- "description": "The properties of the video.",
- "$ref": "VideoProperties"
+ "$ref": "VideoProperties",
+ "description": "The properties of the video."
},
"source": {
"enumDescriptions": [
@@ -734,27 +1494,31 @@
"description": "The video source.",
"type": "string"
}
- }
+ },
+ "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": {
- "$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."
- },
"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."
+ "description": "The background fill of the page. If unset, the background fill is inherited\nfrom a parent page if it exists. If the page has no parent, then the\nbackground fill defaults to the corresponding fill in the Slides editor.",
+ "$ref": "PageBackgroundFill"
+ },
+ "colorScheme": {
+ "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"
}
},
"id": "PageProperties"
},
"TableCell": {
- "description": "Properties and contents of each table cell.",
- "type": "object",
"properties": {
+ "columnSpan": {
+ "description": "Column span of the cell.",
+ "format": "int32",
+ "type": "integer"
+ },
"text": {
"$ref": "TextContent",
"description": "The text content of the cell."
@@ -764,41 +1528,34 @@
"description": "The properties of the table cell."
},
"location": {
- "$ref": "TableCellLocation",
- "description": "The location of the cell within the table."
+ "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"
}
},
- "id": "TableCell"
+ "id": "TableCell",
+ "description": "Properties and contents of each table cell.",
+ "type": "object"
},
"NestingLevel": {
- "id": "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"
+ "$ref": "TextStyle",
+ "description": "The style of a bullet at this level of nesting."
}
- }
+ },
+ "id": "NestingLevel"
},
"UpdateLinePropertiesRequest": {
"description": "Updates the properties of a Line.",
"type": "object",
"properties": {
- "lineProperties": {
- "description": "The line properties to update.",
- "$ref": "LineProperties"
- },
"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",
@@ -807,44 +1564,49 @@
"objectId": {
"description": "The object ID of the line the update is applied to.",
"type": "string"
+ },
+ "lineProperties": {
+ "$ref": "LineProperties",
+ "description": "The line properties to update."
}
},
"id": "UpdateLinePropertiesRequest"
},
"TableCellBackgroundFill": {
+ "description": "The table cell background fill.",
+ "type": "object",
"properties": {
- "solidFill": {
- "description": "Solid color fill.",
- "$ref": "SolidFill"
- },
"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 table cell will implicitly update this field\nto `RENDERED`, unless another value is specified in the same request. To\nhave no fill on a table cell, set this field to `NOT_RENDERED`. In this\ncase, any other fill fields set in the same request will be ignored.",
- "type": "string"
+ "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": {
+ "description": "Solid color fill.",
+ "$ref": "SolidFill"
}
},
- "id": "TableCellBackgroundFill",
- "description": "The table cell background fill.",
- "type": "object"
+ "id": "TableCellBackgroundFill"
},
"UpdateSlidesPositionRequest": {
+ "description": "Updates the position of slides in the presentation.",
"type": "object",
"properties": {
"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"
- },
- "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."
+ }
},
"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.",
@@ -852,12 +1614,9 @@
"type": "integer"
}
},
- "id": "UpdateSlidesPositionRequest",
- "description": "Updates the position of slides in the presentation."
+ "id": "UpdateSlidesPositionRequest"
},
"UpdatePagePropertiesRequest": {
- "description": "Updates the properties of a Page.",
- "type": "object",
"properties": {
"fields": {
"description": "The fields that should be updated.\n\nAt least one field must be specified. The root `pageProperties` is\nimplied and should not be specified. A single `\"*\"` can be used as\nshort-hand for listing every field.\n\nFor example to update the page background solid fill color, set `fields`\nto `\"pageBackgroundFill.solidFill.color\"`.\n\nTo reset a property to its default value, include its field name in the\nfield mask but leave the field itself unset.",
@@ -873,7 +1632,9 @@
"$ref": "PageProperties"
}
},
- "id": "UpdatePagePropertiesRequest"
+ "id": "UpdatePagePropertiesRequest",
+ "description": "Updates the properties of a Page.",
+ "type": "object"
},
"Group": {
"description": "A PageElement kind representing a\njoined collection of PageElements.",
@@ -948,22 +1709,22 @@
"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": {
"objectIds": {
- "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",
"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"
+ "id": "DuplicateObjectRequest",
+ "description": "Duplicates a slide or page element.\n\nWhen duplicating a slide, the duplicate slide will be created immediately\nfollowing the specified slide. When duplicating a page element, the duplicate\nwill be placed on the same page at the same position as the original.",
+ "type": "object"
},
"ReplaceAllTextRequest": {
"description": "Replaces all instances of text matching a criteria with replace text.",
@@ -974,57 +1735,52 @@
"type": "string"
},
"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 master,\nor if a page with that object ID doesn't exist in the presentation.",
"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."
+ "description": "Finds text in a shape matching this substring.",
+ "$ref": "SubstringMatchCriteria"
}
},
"id": "ReplaceAllTextRequest"
},
"UnmergeTableCellsRequest": {
- "description": "Unmerges cells in a Table.",
- "type": "object",
"properties": {
"objectId": {
- "type": "string",
- "description": "The object ID of the table."
+ "description": "The object ID of the table.",
+ "type": "string"
},
"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."
+ "description": "The table range specifying which cells of the table to unmerge.\n\nAll merged cells in this range will be unmerged, and cells that are already\nunmerged will not be affected. If the range has no merged cells, the\nrequest will do nothing. If there is text in any of the merged cells, the\ntext will remain in the upper-left (\"head\") cell of the resulting block of\nunmerged cells.",
+ "$ref": "TableRange"
}
},
- "id": "UnmergeTableCellsRequest"
+ "id": "UnmergeTableCellsRequest",
+ "description": "Unmerges cells in a Table.",
+ "type": "object"
},
"Page": {
"description": "A page in a presentation.",
"type": "object",
"properties": {
- "masterProperties": {
- "description": "Master specific properties. Only set if page_type = MASTER.",
- "$ref": "MasterProperties"
- },
- "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."
+ "description": "Layout specific properties. Only set if page_type = LAYOUT.",
+ "$ref": "LayoutProperties"
+ },
+ "pageElements": {
+ "description": "The page elements rendered on the page.",
+ "type": "array",
+ "items": {
+ "$ref": "PageElement"
+ }
},
"notesProperties": {
- "description": "Notes specific properties. Only set if page_type = NOTES.",
- "$ref": "NotesProperties"
+ "$ref": "NotesProperties",
+ "description": "Notes specific properties. Only set if page_type = NOTES."
},
"pageType": {
"enum": [
@@ -1044,62 +1800,58 @@
"A notes master page."
]
},
- "pageElements": {
- "description": "The page elements rendered on the page.",
- "type": "array",
- "items": {
- "$ref": "PageElement"
- }
- },
- "pageProperties": {
- "$ref": "PageProperties",
- "description": "The properties of the page."
- },
"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"
},
"ShapeBackgroundFill": {
+ "description": "The shape background fill.",
+ "type": "object",
"properties": {
+ "solidFill": {
+ "$ref": "SolidFill",
+ "description": "Solid color fill."
+ },
"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 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."
+ "type": "string"
}
},
- "id": "ShapeBackgroundFill",
- "description": "The shape background fill.",
- "type": "object"
+ "id": "ShapeBackgroundFill"
},
"CropProperties": {
+ "description": "The crop properties of an object enclosed in a container. For example, an\nImage.\n\nThe crop properties is represented by the offsets of four edges which define\na crop rectangle. The offsets are measured in percentage from the\ncorresponding edges of the object's original bounding rectangle towards\ninside, relative to the object's original dimensions.\n\n- If the offset is in the interval (0, 1), the corresponding edge of crop\nrectangle is positioned inside of the object's original bounding rectangle.\n- If the offset is negative or greater than 1, the corresponding edge of crop\nrectangle is positioned outside of the object's original bounding rectangle.\n- If the left edge of the crop rectangle is on the right side of its right\nedge, the object will be flipped horizontally.\n- If the top edge of the crop rectangle is below its bottom edge, the object\nwill be flipped vertically.\n- If all offsets and rotation angle is 0, the object is not cropped.\n\nAfter cropping, the content in the crop rectangle will be stretched to fit\nits container.",
"type": "object",
"properties": {
- "bottomOffset": {
- "description": "The offset specifies the bottom edge of the crop rectangle that is located\nabove the original bounding rectangle bottom edge, relative to the object's\noriginal height.",
- "format": "float",
- "type": "number"
- },
- "angle": {
- "description": "The rotation angle of the crop window around its center, in radians.\nRotation angle is applied after the offset.",
- "format": "float",
- "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",
@@ -1114,10 +1866,19 @@
"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": {
+ "description": "The rotation angle of the crop window around its center, in radians.\nRotation angle is applied after the offset.",
+ "format": "float",
+ "type": "number"
}
},
- "id": "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."
+ "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.",
@@ -1128,16 +1889,16 @@
"type": "string"
},
"linkingMode": {
- "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.",
- "type": "string"
+ "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",
@@ -1163,8 +1924,8 @@
"type": "object",
"properties": {
"color": {
- "description": "The color of the gradient stop.",
- "$ref": "OpaqueColor"
+ "$ref": "OpaqueColor",
+ "description": "The color of the gradient stop."
},
"alpha": {
"description": "The alpha value of this color in the gradient band. Defaults to 1.0,\nfully opaque.",
@@ -1182,7 +1943,6 @@
"Range": {
"properties": {
"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.",
@@ -1195,7 +1955,8 @@
"FROM_START_INDEX",
"ALL"
],
- "description": "The type of range."
+ "description": "The type of range.",
+ "type": "string"
},
"startIndex": {
"description": "The optional zero-based index of the beginning of the collection.\nRequired for `FIXED_RANGE` and `FROM_START_INDEX` ranges.",
@@ -1214,6 +1975,14 @@
},
"CreateVideoRequest": {
"properties": {
+ "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": {
+ "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"
@@ -1229,14 +1998,6 @@
"The video source is unspecified.",
"The video source is YouTube."
]
- },
- "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": {
- "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"
}
},
"id": "CreateVideoRequest",
@@ -1255,11 +2016,28 @@
"id": "DuplicateObjectResponse"
},
"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": {
+ "enum": [
+ "CENTER_INSIDE",
+ "CENTER_CROP"
+ ],
+ "description": "The replace method.",
+ "type": "string",
+ "enumDescriptions": [
+ "Scales and centers the image to fit within the bounds of the original\nshape and maintains the image's aspect ratio. The rendered size of the\nimage may be smaller than the size of the shape. This is the default\nmethod when one is not specified.",
+ "Scales and centers the image to fill the bounds of the original shape.\nThe image may be cropped in order to fill the shape. The rendered size of\nthe image will be the same as that of the original shape."
+ ]
+ },
"containsText": {
- "description": "If set, this request will replace all of the shapes that contain the\ngiven text.",
- "$ref": "SubstringMatchCriteria"
+ "$ref": "SubstringMatchCriteria",
+ "description": "If set, this request will replace all of the shapes that contain the\ngiven text."
},
"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.",
@@ -1267,45 +2045,26 @@
"items": {
"type": "string"
}
- },
- "imageUrl": {
- "description": "The image URL.\n\nThe image is fetched once at insertion time and a copy is stored for\ndisplay inside the presentation. Images must be less than 50MB in size,\ncannot exceed 25 megapixels, and must be in either in PNG, JPEG, or GIF\nformat.\n\nThe provided URL can be at most 2 kB in length.",
- "type": "string"
- },
- "replaceMethod": {
- "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"
}
},
- "id": "ReplaceAllShapesWithImageRequest",
- "description": "Replaces all shapes that match the given criteria with the provided image."
+ "id": "ReplaceAllShapesWithImageRequest"
},
"MergeTableCellsRequest": {
- "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."
+ "description": "The table range specifying which cells of the table to merge.\n\nAny text in the cells being merged will be concatenated and stored in the\nupper-left (\"head\") cell of the range. If the range is non-rectangular\n(which can occur in some cases where the range covers cells that are\nalready merged), a 400 bad request error is returned.",
+ "$ref": "TableRange"
}
},
"id": "MergeTableCellsRequest",
- "description": "Merges cells in a Table."
+ "description": "Merges cells in a Table.",
+ "type": "object"
},
"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.",
@@ -1315,7 +2074,9 @@
}
}
},
- "id": "UngroupObjectsRequest"
+ "id": "UngroupObjectsRequest",
+ "description": "Ungroups objects, such as groups.",
+ "type": "object"
},
"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.",
@@ -1330,15 +2091,15 @@
"$ref": "AffineTransform"
},
"type": {
+ "enum": [
+ "SHADOW_TYPE_UNSPECIFIED",
+ "OUTER"
+ ],
"description": "The type of the shadow.",
"type": "string",
"enumDescriptions": [
"Unspecified shadow type.",
"Outer shadow."
- ],
- "enum": [
- "SHADOW_TYPE_UNSPECIFIED",
- "OUTER"
]
},
"alignment": {
@@ -1383,18 +2144,18 @@
"type": "boolean"
},
"propertyState": {
- "enumDescriptions": [
- "If a property's state is RENDERED, then the element has the corresponding\nproperty when rendered on a page. If the element is a placeholder shape as\ndetermined by the placeholder\nfield, and it inherits from a placeholder shape, the corresponding field\nmay be unset, meaning that the property value is inherited from a parent\nplaceholder. If the element does not inherit, then the field will contain\nthe rendered value. This is the default value.",
- "If a property's state is NOT_RENDERED, then the element does not have the\ncorresponding property when rendered on a page. However, the field may\nstill be set so it can be inherited by child shapes. To remove a property\nfrom a rendered element, set its property_state to NOT_RENDERED.",
- "If a property's state is INHERIT, then the property state uses the value of\ncorresponding `property_state` field on the parent shape. Elements that do\nnot inherit will never have an INHERIT property state."
- ],
"enum": [
"RENDERED",
"NOT_RENDERED",
"INHERIT"
],
"description": "The shadow property state.\n\nUpdating the shadow on a page element will implicitly update this field to\n`RENDERED`, unless another value is specified in the same request. To have\nno shadow on a page element, set this field to `NOT_RENDERED`. In this\ncase, any other shadow fields set in the same request will be ignored.",
- "type": "string"
+ "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": "Shadow"
@@ -1404,8 +2165,8 @@
"type": "object",
"properties": {
"cellLocation": {
- "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.",
- "$ref": "TableCellLocation"
+ "$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.",
@@ -1443,8 +2204,8 @@
"type": "object",
"properties": {
"solidFill": {
- "$ref": "SolidFill",
- "description": "Solid color fill."
+ "description": "Solid color fill.",
+ "$ref": "SolidFill"
}
},
"id": "OutlineFill"
@@ -1478,24 +2239,24 @@
"id": "TableCellLocation"
},
"ReplaceAllTextResponse": {
- "id": "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",
+ "description": "The result of replacing text.",
+ "type": "object"
},
"TableBorderFill": {
"description": "The fill of the border.",
"type": "object",
"properties": {
"solidFill": {
- "$ref": "SolidFill",
- "description": "Solid fill."
+ "description": "Solid fill.",
+ "$ref": "SolidFill"
}
},
"id": "TableBorderFill"
@@ -1504,6 +2265,14 @@
"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": {
+ "cellLocation": {
+ "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.",
+ "$ref": "TableCellLocation"
+ },
+ "style": {
+ "description": "The paragraph's style.",
+ "$ref": "ParagraphStyle"
+ },
"fields": {
"description": "The fields that should be updated.\n\nAt least one field must be specified. The root `style` is implied and\nshould not be specified. A single `\"*\"` can be used as short-hand for\nlisting every field.\n\nFor example, to update the paragraph alignment, set `fields` to\n`\"alignment\"`.\n\nTo reset a property to its default value, include its field name in the\nfield mask but leave the field itself unset.",
"format": "google-fieldmask",
@@ -1514,16 +2283,8 @@
"type": "string"
},
"textRange": {
- "$ref": "Range",
- "description": "The range of text containing the paragraph(s) to style."
- },
- "cellLocation": {
- "$ref": "TableCellLocation",
- "description": "The location of the cell in the table containing the paragraph(s) to\nstyle. If `object_id` refers to a table, `cell_location` must have a value.\nOtherwise, it must not."
- },
- "style": {
- "$ref": "ParagraphStyle",
- "description": "The paragraph's style."
+ "description": "The range of text containing the paragraph(s) to style.",
+ "$ref": "Range"
}
},
"id": "UpdateParagraphStyleRequest"
@@ -1845,8 +2606,8 @@
"description": "The text content of the shape."
},
"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."
+ "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.",
@@ -1856,23 +2617,72 @@
"id": "Shape"
},
"Image": {
- "description": "A PageElement kind representing an\nimage.",
- "type": "object",
"properties": {
"imageProperties": {
- "description": "The properties of the image.",
- "$ref": "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"
+ "id": "Image",
+ "description": "A PageElement kind representing an\nimage.",
+ "type": "object"
+ },
+ "AffineTransform": {
+ "properties": {
+ "shearY": {
+ "description": "The Y coordinate shearing element.",
+ "format": "double",
+ "type": "number"
+ },
+ "unit": {
+ "enum": [
+ "UNIT_UNSPECIFIED",
+ "EMU",
+ "PT"
+ ],
+ "description": "The units for translate elements.",
+ "type": "string",
+ "enumDescriptions": [
+ "The units are unknown.",
+ "An English Metric Unit (EMU) is defined as 1/360,000 of a centimeter\nand thus there are 914,400 EMUs per inch, and 12,700 EMUs per point.",
+ "A point, 1/72 of an inch."
+ ]
+ },
+ "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"
+ },
+ "translateX": {
+ "description": "The X coordinate translation element.",
+ "format": "double",
+ "type": "number"
+ }
+ },
+ "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.",
+ "type": "object"
},
"InsertTextRequest": {
- "description": "Inserts text into a shape or a table cell.",
- "type": "object",
"properties": {
"objectId": {
"description": "The object ID of the shape or table where the text will be inserted.",
@@ -1888,77 +2698,26 @@
"type": "integer"
},
"cellLocation": {
- "description": "The optional table cell location if the text is to be inserted into a table\ncell. If present, the object_id must refer to a table.",
- "$ref": "TableCellLocation"
+ "$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"
- },
- "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": {
- "scaleY": {
- "type": "number",
- "description": "The Y coordinate scaling element.",
- "format": "double"
- },
- "translateY": {
- "description": "The Y coordinate translation element.",
- "format": "double",
- "type": "number"
- },
- "translateX": {
- "description": "The X coordinate translation element.",
- "format": "double",
- "type": "number"
- },
- "shearY": {
- "description": "The Y coordinate shearing element.",
- "format": "double",
- "type": "number"
- },
- "unit": {
- "description": "The units for translate elements.",
- "type": "string",
- "enumDescriptions": [
- "The units are unknown.",
- "An English Metric Unit (EMU) is defined as 1/360,000 of a centimeter\nand thus there are 914,400 EMUs per inch, and 12,700 EMUs per point.",
- "A point, 1/72 of an inch."
- ],
- "enum": [
- "UNIT_UNSPECIFIED",
- "EMU",
- "PT"
- ]
- },
- "scaleX": {
- "description": "The X coordinate scaling element.",
- "format": "double",
- "type": "number"
- },
- "shearX": {
- "description": "The X coordinate shearing element.",
- "format": "double",
- "type": "number"
- }
- },
- "id": "AffineTransform"
+ "id": "InsertTextRequest",
+ "description": "Inserts text into a shape or a table cell.",
+ "type": "object"
},
"AutoText": {
- "description": "A TextElement kind that represents auto text.",
- "type": "object",
"properties": {
"type": {
+ "enum": [
+ "TYPE_UNSPECIFIED",
+ "SLIDE_NUMBER"
+ ],
"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": {
@@ -1970,34 +2729,36 @@
"description": "The styling applied to this auto text."
}
},
- "id": "AutoText"
+ "id": "AutoText",
+ "description": "A TextElement kind that represents auto text.",
+ "type": "object"
},
"CreateVideoResponse": {
- "description": "The result of creating a video.",
- "type": "object",
"properties": {
"objectId": {
"description": "The object ID of the created video.",
"type": "string"
}
},
- "id": "CreateVideoResponse"
+ "id": "CreateVideoResponse",
+ "description": "The result of creating a video.",
+ "type": "object"
},
"DeleteTextRequest": {
"description": "Deletes text from a shape or a table cell.",
"type": "object",
"properties": {
+ "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"
+ },
"objectId": {
- "type": "string",
- "description": "The object ID of the shape or table from which the text will be deleted."
+ "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"
@@ -2006,16 +2767,7 @@
"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": {
- "type": "string",
- "description": "The object ID of the page element to update."
- },
- "transform": {
- "description": "The input transform matrix used to update the page element.",
- "$ref": "AffineTransform"
- },
"applyMode": {
- "type": "string",
"enumDescriptions": [
"Unspecified mode.",
"Applies the new AffineTransform matrix to the existing one, and\nreplaces the existing one with the resulting concatenation.",
@@ -2026,49 +2778,60 @@
"RELATIVE",
"ABSOLUTE"
],
- "description": "The apply mode of the transform update."
+ "description": "The apply mode of the transform update.",
+ "type": "string"
+ },
+ "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."
}
},
"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"
+ "id": "DeleteObjectRequest",
+ "description": "Deletes an object, either pages or\npage elements, from the\npresentation.",
+ "type": "object"
},
"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",
- "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."
- ]
- },
- "magnitude": {
- "description": "The magnitude.",
- "format": "double",
- "type": "number"
+ "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": {
"autoText": {
"$ref": "AutoText",
@@ -2084,48 +2847,49 @@
"type": "integer"
},
"endIndex": {
- "type": "integer",
"description": "The zero-based end index of this text element, exclusive, in Unicode code\nunits.",
- "format": "int32"
+ "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"
+ "$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."
}
},
- "id": "TextElement",
- "description": "A TextElement describes the content of a range of indices in the text content\nof a Shape or TableCell.",
- "type": "object"
+ "id": "TextElement"
},
"LineFill": {
- "description": "The fill of the line.",
- "type": "object",
"properties": {
"solidFill": {
- "$ref": "SolidFill",
- "description": "Solid color fill."
+ "description": "Solid color fill.",
+ "$ref": "SolidFill"
}
},
- "id": "LineFill"
+ "id": "LineFill",
+ "description": "The fill of the line.",
+ "type": "object"
},
"VideoProperties": {
- "description": "The properties of the Video.",
- "type": "object",
"properties": {
"outline": {
"description": "The outline of the video. The default outline matches the defaults for new\nvideos created in the Slides editor.",
"$ref": "Outline"
}
},
- "id": "VideoProperties"
+ "id": "VideoProperties",
+ "description": "The properties of the Video.",
+ "type": "object"
},
"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"
+ },
"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."
+ "description": "The reference table cell location from which rows will be inserted.\n\nA new row will be inserted above (or below) the row where the reference\ncell is. If the reference cell is a merged cell, a new row will be\ninserted above (or below) the merged cell.",
+ "$ref": "TableCellLocation"
},
"tableObjectId": {
"description": "The table to insert rows into.",
@@ -2134,33 +2898,30 @@
"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"
}
},
- "id": "InsertTableRowsRequest"
+ "id": "InsertTableRowsRequest",
+ "description": "Inserts rows into a table.",
+ "type": "object"
},
"LayoutProperties": {
- "type": "object",
"properties": {
- "masterObjectId": {
- "description": "The object ID of the master that this layout is based on.",
- "type": "string"
- },
"name": {
"description": "The name of the layout.",
"type": "string"
},
"displayName": {
- "type": "string",
- "description": "The human-readable name of the layout."
+ "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",
- "description": "The properties of Page are only\nrelevant for pages with page_type LAYOUT."
+ "description": "The properties of Page are only\nrelevant for pages with page_type LAYOUT.",
+ "type": "object"
},
"Presentation": {
"description": "A Google Slides presentation.",
@@ -2205,32 +2966,20 @@
"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"
- },
- "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."
+ }
}
},
"id": "Presentation"
},
"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": {
- "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",
@@ -2240,22 +2989,23 @@
"LONG_DASH",
"LONG_DASH_DOT"
],
- "description": "The dash style of the line."
+ "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'."
+ ]
+ },
+ "link": {
+ "description": "The hyperlink destination of the line. If unset, there is no link.",
+ "$ref": "Link"
},
"startArrow": {
- "enumDescriptions": [
- "An unspecified arrow style.",
- "No arrow.",
- "Arrow with notched back. Corresponds to ECMA-376 ST_LineEndType value\n'stealth'.",
- "Filled arrow. Corresponds to ECMA-376 ST_LineEndType value 'triangle'.",
- "Filled circle. Corresponds to ECMA-376 ST_LineEndType value 'oval'.",
- "Filled square.",
- "Filled diamond. Corresponds to ECMA-376 ST_LineEndType value 'diamond'.",
- "Hollow arrow.",
- "Hollow circle.",
- "Hollow square.",
- "Hollow diamond."
- ],
"enum": [
"ARROW_STYLE_UNSPECIFIED",
"NONE",
@@ -2270,9 +3020,7 @@
"OPEN_DIAMOND"
],
"description": "The style of the arrow at the beginning of the line.",
- "type": "string"
- },
- "endArrow": {
+ "type": "string",
"enumDescriptions": [
"An unspecified arrow style.",
"No arrow.",
@@ -2285,7 +3033,9 @@
"Hollow circle.",
"Hollow square.",
"Hollow diamond."
- ],
+ ]
+ },
+ "endArrow": {
"enum": [
"ARROW_STYLE_UNSPECIFIED",
"NONE",
@@ -2300,28 +3050,36 @@
"OPEN_DIAMOND"
],
"description": "The style of the arrow at the end of the line.",
- "type": "string"
+ "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": {
- "description": "The thickness of the line.",
- "$ref": "Dimension"
+ "$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."
+ "description": "The fill of the line. The default line fill matches the defaults for new\nlines created in the Slides editor.",
+ "$ref": "LineFill"
}
},
- "id": "LineProperties",
- "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"
+ "id": "LineProperties"
},
"OpaqueColor": {
+ "description": "A themeable solid color value.",
"type": "object",
"properties": {
- "rgbColor": {
- "$ref": "RgbColor",
- "description": "An opaque RGB color."
- },
"themeColor": {
"enumDescriptions": [
"Unspecified theme color. This value should not be used.",
@@ -2363,23 +3121,16 @@
],
"description": "An opaque theme color.",
"type": "string"
+ },
+ "rgbColor": {
+ "description": "An opaque RGB color.",
+ "$ref": "RgbColor"
}
},
- "id": "OpaqueColor",
- "description": "A themeable solid color value."
+ "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."
@@ -2395,22 +3146,34 @@
"type": "number"
},
"shadow": {
- "description": "The shadow of the image. If not set, the image has no shadow. This property\nis read-only.",
- "$ref": "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."
+ "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"
+ },
+ "recolor": {
+ "description": "The recolor effect of the image. If not set, the image is not recolored.\nThis property is read-only.",
+ "$ref": "Recolor"
+ },
+ "cropProperties": {
+ "description": "The crop properties of the image. If not set, the image is not cropped.\nThis property is read-only.",
+ "$ref": "CropProperties"
}
},
- "id": "ImageProperties"
+ "id": "ImageProperties",
+ "description": "The properties of the Image.",
+ "type": "object"
},
"ReplaceAllShapesWithImageResponse": {
+ "description": "The result of replacing shapes with an image.",
+ "type": "object",
"properties": {
"occurrencesChanged": {
"description": "The number of shapes replaced with images.",
@@ -2418,22 +3181,13 @@
"type": "integer"
}
},
- "id": "ReplaceAllShapesWithImageResponse",
- "description": "The result of replacing shapes with an image.",
- "type": "object"
+ "id": "ReplaceAllShapesWithImageResponse"
},
"Line": {
- "id": "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": {
- "description": "The type of the line.",
- "type": "string",
"enumDescriptions": [
"An unspecified line type.",
"Straight connector 1 form. Corresponds to ECMA-376 ST_ShapeType\n'straightConnector1'.",
@@ -2457,14 +3211,23 @@
"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"
},
"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"
@@ -2474,41 +3237,39 @@
"type": "string"
},
"linkingMode": {
+ "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.",
- "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."
- ]
+ "type": "string"
},
"chartId": {
"description": "The ID of the specific chart in the Google Sheets spreadsheet.",
"format": "int32",
"type": "integer"
- },
- "objectId": {
- "type": "string",
- "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."
}
},
- "id": "CreateSheetsChartRequest"
+ "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.",
+ "type": "object"
},
"BatchUpdatePresentationResponse": {
"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"
}
- },
- "presentationId": {
- "description": "The presentation the updates were applied to.",
- "type": "string"
}
},
"id": "BatchUpdatePresentationResponse",
@@ -2527,6 +3288,8 @@
"id": "CreateImageResponse"
},
"SlideProperties": {
+ "description": "The properties of Page that are only\nrelevant for pages with page_type SLIDE.",
+ "type": "object",
"properties": {
"notesPage": {
"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.",
@@ -2541,12 +3304,9 @@
"type": "string"
}
},
- "id": "SlideProperties",
- "description": "The properties of Page that are only\nrelevant for pages with page_type SLIDE.",
- "type": "object"
+ "id": "SlideProperties"
},
"MasterProperties": {
- "type": "object",
"properties": {
"displayName": {
"description": "The human-readable name of the master.",
@@ -2554,23 +3314,52 @@
}
},
"id": "MasterProperties",
- "description": "The properties of Page that are only\nrelevant for pages with page_type MASTER."
+ "description": "The properties of Page that are only\nrelevant for pages with page_type MASTER.",
+ "type": "object"
},
"Response": {
"description": "A single response from an update.",
"type": "object",
"properties": {
+ "duplicateObject": {
+ "$ref": "DuplicateObjectResponse",
+ "description": "The result of duplicating an object."
+ },
+ "createLine": {
+ "description": "The result of creating a line.",
+ "$ref": "CreateLineResponse"
+ },
+ "createImage": {
+ "description": "The result of creating an image.",
+ "$ref": "CreateImageResponse"
+ },
+ "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"
+ },
"createShape": {
"description": "The result of creating a shape.",
"$ref": "CreateShapeResponse"
},
"replaceAllShapesWithImage": {
- "$ref": "ReplaceAllShapesWithImageResponse",
- "description": "The result of replacing all shapes matching some criteria with an\nimage."
+ "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."
+ "description": "The result of creating a table.",
+ "$ref": "CreateTableResponse"
},
"replaceAllText": {
"$ref": "ReplaceAllTextResponse",
@@ -2579,58 +3368,42 @@
"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": {
- "description": "The result of creating an image.",
- "$ref": "CreateImageResponse"
- },
- "createVideo": {
- "description": "The result of creating a video.",
- "$ref": "CreateVideoResponse"
- },
- "createSheetsChart": {
- "description": "The result of creating a Google Sheets chart.",
- "$ref": "CreateSheetsChartResponse"
- },
- "replaceAllShapesWithSheetsChart": {
- "description": "The result of replacing all shapes matching some criteria with a Google\nSheets chart.",
- "$ref": "ReplaceAllShapesWithSheetsChartResponse"
- },
- "groupObjects": {
- "description": "The result of grouping objects.",
- "$ref": "GroupObjectsResponse"
}
},
"id": "Response"
},
- "TextRun": {
- "description": "A TextElement kind that represents a run of text that all has the same\nstyling.",
- "type": "object",
+ "SubstringMatchCriteria": {
"properties": {
- "content": {
- "description": "The text of this run.",
+ "text": {
+ "description": "The text to search for in the shape or table.",
"type": "string"
},
- "style": {
- "description": "The styling applied to this run.",
- "$ref": "TextStyle"
+ "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": "TextRun"
+ "id": "SubstringMatchCriteria",
+ "description": "A criteria that matches a specific string of text in a shape or table.",
+ "type": "object"
},
"LayoutReference": {
- "description": "Slide layout reference. This may reference either:\n\n- A predefined layout\n- One of the layouts in the presentation.",
- "type": "object",
"properties": {
"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",
@@ -2646,56 +3419,42 @@
"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."
- ]
+ "type": "string"
},
"layoutId": {
"description": "Layout ID: the object ID of one of the layouts in the presentation.",
"type": "string"
}
},
- "id": "LayoutReference"
+ "id": "LayoutReference",
+ "description": "Slide layout reference. This may reference either:\n\n- A predefined layout\n- One of the layouts in the presentation.",
+ "type": "object"
},
- "SubstringMatchCriteria": {
- "id": "SubstringMatchCriteria",
- "description": "A criteria that matches a specific string of text in a shape or table.",
- "type": "object",
+ "TextRun": {
"properties": {
- "text": {
- "description": "The text to search for in the shape or table.",
- "type": "string"
+ "style": {
+ "description": "The styling applied to this run.",
+ "$ref": "TextStyle"
},
- "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"
+ "content": {
+ "description": "The text of this run.",
+ "type": "string"
}
- }
+ },
+ "id": "TextRun",
+ "description": "A TextElement kind that represents a run of text that all has the same\nstyling.",
+ "type": "object"
},
"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": {
- "type": "integer",
"description": "The row span of the table range.",
- "format": "int32"
+ "format": "int32",
+ "type": "integer"
},
"columnSpan": {
"description": "The column span of the table range.",
@@ -2703,24 +3462,24 @@
"type": "integer"
}
},
- "id": "TableRange"
+ "id": "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"
},
"CreateTableRequest": {
- "description": "Creates a new table.",
- "type": "object",
"properties": {
"elementProperties": {
- "description": "The element properties for the table.\n\nThe table will be created at the provided size, subject to a minimum size.\nIf no size is provided, the table will be automatically sized.\n\nTable transforms must have a scale of 1 and no shear components. If no\ntransform is provided, the table will be centered on the page.",
- "$ref": "PageElementProperties"
+ "$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"
+ "format": "int32",
+ "type": "integer"
},
"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."
+ "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.",
@@ -2728,10 +3487,11 @@
"type": "integer"
}
},
- "id": "CreateTableRequest"
+ "id": "CreateTableRequest",
+ "description": "Creates a new table.",
+ "type": "object"
},
"CreateTableResponse": {
- "type": "object",
"properties": {
"objectId": {
"description": "The object ID of the created table.",
@@ -2739,23 +3499,15 @@
}
},
"id": "CreateTableResponse",
- "description": "The result of creating a table."
+ "description": "The result of creating a table.",
+ "type": "object"
},
"Table": {
- "description": "A PageElement kind representing a\ntable.",
- "type": "object",
"properties": {
- "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": {
- "type": "integer",
"description": "Number of rows in the table.",
- "format": "int32"
+ "format": "int32",
+ "type": "integer"
},
"tableColumns": {
"description": "Properties of each column.",
@@ -2765,9 +3517,9 @@
}
},
"columns": {
- "type": "integer",
"description": "Number of columns in the table.",
- "format": "int32"
+ "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.",
@@ -2782,31 +3534,38 @@
"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"
+ }
}
},
- "id": "Table"
+ "id": "Table",
+ "description": "A PageElement kind representing a\ntable.",
+ "type": "object"
},
"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": {
"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"
}
+ },
+ "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"
}
},
"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.",
@@ -2816,45 +3575,43 @@
}
}
},
- "id": "TableBorderRow"
+ "id": "TableBorderRow",
+ "description": "Contents of each border row in a table.",
+ "type": "object"
},
"PageBackgroundFill": {
+ "description": "The page background fill.",
"type": "object",
"properties": {
- "stretchedPictureFill": {
- "$ref": "StretchedPictureFill",
- "description": "Stretched picture fill."
- },
"solidFill": {
"description": "Solid color fill.",
"$ref": "SolidFill"
},
"propertyState": {
+ "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",
"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"
]
+ },
+ "stretchedPictureFill": {
+ "description": "Stretched picture fill.",
+ "$ref": "StretchedPictureFill"
}
},
- "id": "PageBackgroundFill",
- "description": "The page background fill."
+ "id": "PageBackgroundFill"
},
"SheetsChart": {
"description": "A PageElement kind representing\na linked chart embedded from Google Sheets.",
"type": "object",
"properties": {
- "contentUrl": {
- "description": "The URL of an image of the embedded chart, with a default lifetime of 30\nminutes. This URL is tagged with the account of the requester. Anyone with\nthe URL effectively accesses the image as the original requester. Access to\nthe image may be lost if the presentation's sharing settings change.",
- "type": "string"
- },
"spreadsheetId": {
"description": "The ID of the Google Sheets spreadsheet that contains the source chart.",
"type": "string"
@@ -2865,8 +3622,12 @@
"type": "integer"
},
"sheetsChartProperties": {
- "description": "The properties of the Sheets chart.",
- "$ref": "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"
@@ -2875,41 +3636,27 @@
"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": {
- "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."
+ "description": "The color value of the solid fill.",
+ "$ref": "OpaqueColor"
+ },
+ "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"
}
},
"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": {
- "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",
@@ -2929,16 +3676,30 @@
"TEXT2",
"BACKGROUND2"
],
- "description": "The type of the theme color."
- },
- "color": {
- "description": "The concrete color corresponding to the theme color type above.",
- "$ref": "RgbColor"
+ "description": "The type of the 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": "ThemeColorPair",
- "description": "A pair mapping a theme color type to the concrete color it represents.",
- "type": "object"
+ "id": "ThemeColorPair"
},
"OptionalColor": {
"description": "A color that can either be fully opaque or fully transparent.",
@@ -2955,109 +3716,110 @@
"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": {
"description": "The object ID of the page where the element is located.",
"type": "string"
},
"size": {
- "$ref": "Size",
- "description": "The size of the element."
+ "description": "The size of the element.",
+ "$ref": "Size"
+ },
+ "transform": {
+ "description": "The transform for the element.",
+ "$ref": "AffineTransform"
}
},
"id": "PageElementProperties"
},
"SheetsChartProperties": {
- "description": "The properties of the SheetsChart.",
- "type": "object",
"properties": {
"chartImageProperties": {
- "$ref": "ImageProperties",
- "description": "The properties of the embedded chart image."
+ "description": "The properties of the embedded chart image.",
+ "$ref": "ImageProperties"
}
},
- "id": "SheetsChartProperties"
+ "id": "SheetsChartProperties",
+ "description": "The properties of the SheetsChart.",
+ "type": "object"
},
"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": {
- "$ref": "Size",
- "description": "The original size of the picture fill. This field is read-only."
- },
"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": {
+ "description": "The original size of the picture fill. This field is read-only.",
+ "$ref": "Size"
}
},
"id": "StretchedPictureFill"
},
+ "DeleteTableColumnRequest": {
+ "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",
+ "description": "Deletes a column from a table.",
+ "type": "object"
+ },
"UpdateTextStyleRequest": {
"description": "Update the styling of text in a Shape or\nTable.",
"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": {
- "type": "string",
- "description": "The object ID of the shape or table with the text to be styled."
+ "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."
+ "description": "The location of the cell in the table containing the text to style. If\n`object_id` refers to a table, `cell_location` must have a value.\nOtherwise, it must not.",
+ "$ref": "TableCellLocation"
},
"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"
},
- "DeleteTableColumnRequest": {
- "description": "Deletes a column from a table.",
- "type": "object",
- "properties": {
- "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."
- },
- "tableObjectId": {
- "description": "The table to delete columns from.",
- "type": "string"
- }
- },
- "id": "DeleteTableColumnRequest"
- },
"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": {
- "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"
+ },
+ "nestingLevel": {
+ "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.",
+ "type": "object"
}
},
- "id": "List"
+ "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.",
+ "type": "object"
},
"WeightedFontFamily": {
+ "description": "Represents a font family and weight used to style a TextRun.",
"type": "object",
"properties": {
"fontFamily": {
@@ -3070,76 +3832,69 @@
"type": "integer"
}
},
- "id": "WeightedFontFamily",
- "description": "Represents a font family and weight used to style a TextRun."
+ "id": "WeightedFontFamily"
},
"PageElement": {
- "type": "object",
"properties": {
- "table": {
- "description": "A table page element.",
- "$ref": "Table"
+ "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"
},
"transform": {
"description": "The transform of the page element.\n\nThe visual appearance of the page element is determined by its absolute\ntransform. To compute the absolute transform, preconcatenate a page\nelement's transform with the transforms of all of its parent groups. If the\npage element is not in a group, its absolute transform is the same as the\nvalue in this field.\n\nThe initial transform for the newly created Group is always the identity transform.",
"$ref": "AffineTransform"
},
- "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": {
- "description": "A generic shape.",
- "$ref": "Shape"
+ "$ref": "Shape",
+ "description": "A generic shape."
},
"line": {
- "description": "A line page element.",
- "$ref": "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."
+ "description": "The description of the page element. Combined with title to display alt\ntext.",
+ "type": "string"
},
"elementGroup": {
- "$ref": "Group",
- "description": "A collection of page elements joined as a single unit."
+ "description": "A collection of page elements joined as a single unit.",
+ "$ref": "Group"
},
"image": {
- "description": "An image page element.",
- "$ref": "Image"
+ "$ref": "Image",
+ "description": "An image page element."
},
"size": {
"description": "The size of the page element.",
"$ref": "Size"
},
"title": {
- "type": "string",
- "description": "The title of the page element. Combined with description to display alt\ntext."
+ "description": "The title of the page element. Combined with description to display alt\ntext.",
+ "type": "string"
},
"sheetsChart": {
"description": "A linked chart embedded from Google Sheets. Unlinked charts are\nrepresented as images.",
"$ref": "SheetsChart"
},
"video": {
- "$ref": "Video",
- "description": "A video page element."
+ "description": "A video page element.",
+ "$ref": "Video"
},
"wordArt": {
"$ref": "WordArt",
"description": "A word art page element."
+ },
+ "table": {
+ "description": "A table page element.",
+ "$ref": "Table"
}
},
"id": "PageElement",
- "description": "A visual element rendered on a page."
+ "description": "A visual element rendered on a page.",
+ "type": "object"
},
"CreateImageRequest": {
- "description": "Creates an image.",
- "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 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."
@@ -3147,24 +3902,38 @@
"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"
}
},
- "id": "CreateImageRequest"
+ "id": "CreateImageRequest",
+ "description": "Creates an image.",
+ "type": "object"
},
"CreateParagraphBulletsRequest": {
- "id": "CreateParagraphBulletsRequest",
"description": "Creates bullets for all of the paragraphs that overlap with the given\ntext index range.\n\nThe nesting level of each paragraph will be determined by counting leading\ntabs in front of each paragraph. To avoid excess space between the bullet and\nthe corresponding paragraph, these leading tabs are removed by this request.\nThis may change the indices of parts of the text.\n\nIf the paragraph immediately before paragraphs being updated is in a list\nwith a matching preset, the paragraphs being updated are added to that\npreceding list.",
"type": "object",
"properties": {
- "objectId": {
- "description": "The object ID of the shape or table containing the text to add bullets to.",
- "type": "string"
- },
- "textRange": {
- "$ref": "Range",
- "description": "The range of text to apply the bullet presets to, based on TextElement indexes."
- },
"bulletPreset": {
+ "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",
"enumDescriptions": [
@@ -3183,791 +3952,22 @@
"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"
]
},
"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."
- }
- }
- },
- "TextStyle": {
- "properties": {
- "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."
- },
- "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."
- },
- "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"
- },
- "italic": {
- "description": "Whether or not the text is italicized.",
- "type": "boolean"
- },
- "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": {
- "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.",
- "type": "string"
- }
- },
- "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"
- },
- "Size": {
- "properties": {
- "height": {
- "description": "The height of the object.",
- "$ref": "Dimension"
- },
- "width": {
- "$ref": "Dimension",
- "description": "The width of the object."
- }
- },
- "id": "Size",
- "description": "A width and height.",
- "type": "object"
- },
- "UpdateVideoPropertiesRequest": {
- "description": "Update the properties of a Video.",
- "type": "object",
- "properties": {
- "objectId": {
- "description": "The object ID of the video the updates are applied to.",
- "type": "string"
- },
- "videoProperties": {
- "$ref": "VideoProperties",
- "description": "The video properties to update."
- },
- "fields": {
- "description": "The fields that should be updated.\n\nAt least one field must be specified. The root `videoProperties` is\nimplied and should not be specified. A single `\"*\"` can be used as\nshort-hand for listing every field.\n\nFor example to update the video outline color, set `fields` to\n`\"outline.outlineFill.solidFill.color\"`.\n\nTo reset a property to its default value, include its field name in the\nfield mask but leave the field itself unset.",
- "format": "google-fieldmask",
- "type": "string"
- }
- },
- "id": "UpdateVideoPropertiesRequest"
- },
- "Request": {
- "id": "Request",
- "description": "A single kind of update to apply to a presentation.",
- "type": "object",
- "properties": {
- "updateTableCellProperties": {
- "description": "Updates the properties of a TableCell.",
- "$ref": "UpdateTableCellPropertiesRequest"
- },
- "createTable": {
- "description": "Creates a new table.",
- "$ref": "CreateTableRequest"
- },
- "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."
- },
- "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": {
- "description": "Creates a line.",
- "$ref": "CreateLineRequest"
- },
- "createImage": {
- "description": "Creates an image.",
- "$ref": "CreateImageRequest"
- },
- "createParagraphBullets": {
- "$ref": "CreateParagraphBulletsRequest",
- "description": "Creates bullets for paragraphs."
- },
- "createVideo": {
- "$ref": "CreateVideoRequest",
- "description": "Creates a video."
- },
- "replaceAllShapesWithSheetsChart": {
- "$ref": "ReplaceAllShapesWithSheetsChartRequest",
- "description": "Replaces all shapes matching some criteria with a Google Sheets chart."
- },
- "createSheetsChart": {
- "description": "Creates an embedded Google Sheets chart.",
- "$ref": "CreateSheetsChartRequest"
- },
- "unmergeTableCells": {
- "$ref": "UnmergeTableCellsRequest",
- "description": "Unmerges cells in a Table."
- },
- "updatePageElementTransform": {
- "$ref": "UpdatePageElementTransformRequest",
- "description": "Updates the transform of a page element."
- },
- "updateTextStyle": {
- "description": "Updates the styling of text within a Shape or Table.",
- "$ref": "UpdateTextStyleRequest"
- },
- "updateTableRowProperties": {
- "description": "Updates the properties of a Table row.",
- "$ref": "UpdateTableRowPropertiesRequest"
- },
- "replaceAllShapesWithImage": {
- "description": "Replaces all shapes matching some criteria with an image.",
- "$ref": "ReplaceAllShapesWithImageRequest"
- },
- "replaceAllText": {
- "$ref": "ReplaceAllTextRequest",
- "description": "Replaces all instances of specified text."
- },
- "updateImageProperties": {
- "description": "Updates the properties of an Image.",
- "$ref": "UpdateImagePropertiesRequest"
- },
- "insertTableRows": {
- "$ref": "InsertTableRowsRequest",
- "description": "Inserts rows into a table."
- },
- "createSlide": {
- "$ref": "CreateSlideRequest",
- "description": "Creates a new slide."
- },
- "updateLineProperties": {
- "$ref": "UpdateLinePropertiesRequest",
- "description": "Updates the properties of a Line."
- },
- "updateSlidesPosition": {
- "description": "Updates the position of a set of slides in the presentation.",
- "$ref": "UpdateSlidesPositionRequest"
- },
- "deleteTableRow": {
- "$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": {
- "description": "Groups objects, such as page elements.",
- "$ref": "GroupObjectsRequest"
- },
- "insertText": {
- "$ref": "InsertTextRequest",
- "description": "Inserts text into a shape or table cell."
- },
- "updateTableColumnProperties": {
- "$ref": "UpdateTableColumnPropertiesRequest",
- "description": "Updates the properties of a Table\ncolumn."
- },
- "deleteText": {
- "description": "Deletes text from a shape or a table cell.",
- "$ref": "DeleteTextRequest"
- },
- "updatePageProperties": {
- "description": "Updates the properties of a Page.",
- "$ref": "UpdatePagePropertiesRequest"
- },
- "deleteParagraphBullets": {
- "description": "Deletes bullets from paragraphs.",
- "$ref": "DeleteParagraphBulletsRequest"
- },
- "createShape": {
- "description": "Creates a new shape.",
- "$ref": "CreateShapeRequest"
- },
- "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": {
- "description": "Refreshes a Google Sheets chart.",
- "$ref": "RefreshSheetsChartRequest"
- }
- }
- },
- "UpdateImagePropertiesRequest": {
- "description": "Update the properties of an Image.",
- "type": "object",
- "properties": {
- "imageProperties": {
- "$ref": "ImageProperties",
- "description": "The image properties to update."
+ "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"
},
"objectId": {
- "description": "The object ID of the image the updates are applied to.",
+ "description": "The object ID of the shape or table containing the text to add bullets to.",
"type": "string"
},
- "fields": {
- "description": "The fields that should be updated.\n\nAt least one field must be specified. The root `imageProperties` is\nimplied and should not be specified. A single `\"*\"` can be used as\nshort-hand for listing every field.\n\nFor example to update the image outline color, set `fields` to\n`\"outline.outlineFill.solidFill.color\"`.\n\nTo reset a property to its default value, include its field name in the\nfield mask but leave the field itself unset.",
- "format": "google-fieldmask",
- "type": "string"
+ "textRange": {
+ "$ref": "Range",
+ "description": "The range of text to apply the bullet presets to, based on TextElement indexes."
}
},
- "id": "UpdateImagePropertiesRequest"
- },
- "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": {
- "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": {
- "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."
- ],
- "enum": [
- "SPACING_MODE_UNSPECIFIED",
- "NEVER_COLLAPSE",
- "COLLAPSE_LISTS"
- ]
- },
- "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."
- },
- "indentFirstLine": {
- "$ref": "Dimension",
- "description": "The amount of indentation for the start of the first line of the paragraph.\nIf unset, the value is inherited from the parent."
- },
- "lineSpacing": {
- "description": "The amount of space between lines, as a percentage of normal, where normal\nis represented as 100.0. If unset, the value is inherited from the parent.",
- "format": "float",
- "type": "number"
- },
- "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": {
- "$ref": "Dimension",
- "description": "The amount of extra space above the paragraph. If unset, the value is\ninherited from the parent."
- },
- "direction": {
- "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."
- ],
- "enum": [
- "TEXT_DIRECTION_UNSPECIFIED",
- "LEFT_TO_RIGHT",
- "RIGHT_TO_LEFT"
- ]
- }
- },
- "id": "ParagraphStyle"
- },
- "UpdateTableRowPropertiesRequest": {
- "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": {
- "type": "string",
- "description": "The object ID of the table."
- },
- "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",
- "description": "Updates the properties of a Table row.",
- "type": "object"
- },
- "ReplaceAllShapesWithSheetsChartResponse": {
- "description": "The result of replacing shapes with a Google Sheets chart.",
- "type": "object",
- "properties": {
- "occurrencesChanged": {
- "description": "The number of shapes replaced with charts.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "ReplaceAllShapesWithSheetsChartResponse"
- },
- "TableCellProperties": {
- "description": "The properties of the TableCell.",
- "type": "object",
- "properties": {
- "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'."
- ]
- },
- "tableCellBackgroundFill": {
- "description": "The background fill of the table cell. The default fill matches the fill\nfor newly created table cells in the Slides editor.",
- "$ref": "TableCellBackgroundFill"
- }
- },
- "id": "TableCellProperties"
- },
- "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."
- }
- },
- "id": "RefreshSheetsChartRequest"
- },
- "Outline": {
- "properties": {
- "propertyState": {
- "description": "The outline property state.\n\nUpdating the outline on a page element will implicitly update this field\nto `RENDERED`, unless another value is specified in the same request. To\nhave no outline on a page element, set this field to `NOT_RENDERED`. In\nthis case, any other outline fields set in the same request will be\nignored.",
- "type": "string",
- "enumDescriptions": [
- "If a property's state is RENDERED, then the element has the corresponding\nproperty when rendered on a page. If the element is a placeholder shape as\ndetermined by the placeholder\nfield, and it inherits from a placeholder shape, the corresponding field\nmay be unset, meaning that the property value is inherited from a parent\nplaceholder. If the element does not inherit, then the field will contain\nthe rendered value. This is the default value.",
- "If a property's state is NOT_RENDERED, then the element does not have the\ncorresponding property when rendered on a page. However, the field may\nstill be set so it can be inherited by child shapes. To remove a property\nfrom a rendered element, set its property_state to NOT_RENDERED.",
- "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"
- ]
- },
- "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"
- }
- },
- "id": "Outline",
- "description": "The outline of a PageElement.\n\nIf these fields are unset, they may be inherited from a parent placeholder\nif it exists. If there is no parent, the fields will default to the value\nused for new page elements created in the Slides editor, which may depend on\nthe page element kind.",
- "type": "object"
- },
- "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"
- },
- "TableColumnProperties": {
- "description": "Properties of each column in a table.",
- "type": "object",
- "properties": {
- "columnWidth": {
- "$ref": "Dimension",
- "description": "Width of a column."
- }
- },
- "id": "TableColumnProperties"
- },
- "ShapeProperties": {
- "description": "The properties of a Shape.\n\nIf the shape is a placeholder shape as determined by the\nplaceholder field, then these\nproperties may be inherited from a parent placeholder shape.\nDetermining the rendered value of the property depends on the corresponding\nproperty_state field value.",
- "type": "object",
- "properties": {
- "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": {
- "$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": {
- "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"
- },
- "link": {
- "description": "The hyperlink destination of the shape. If unset, there is no link. Links\nare not inherited from parent placeholders.",
- "$ref": "Link"
- }
- },
- "id": "ShapeProperties"
- },
- "TableRow": {
- "id": "TableRow",
- "description": "Properties and contents of each row in a table.",
- "type": "object",
- "properties": {
- "tableRowProperties": {
- "$ref": "TableRowProperties",
- "description": "Properties of the row."
- },
- "rowHeight": {
- "description": "Height of a row.",
- "$ref": "Dimension"
- },
- "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"
- }
- }
- }
- },
- "UpdateTableCellPropertiesRequest": {
- "description": "Update the properties of a TableCell.",
- "type": "object",
- "properties": {
- "objectId": {
- "description": "The object ID of the table.",
- "type": "string"
- },
- "tableRange": {
- "$ref": "TableRange",
- "description": "The table range representing the subset of the table to which the updates\nare applied. If a table range is not specified, the updates will apply to\nthe entire table."
- },
- "tableCellProperties": {
- "$ref": "TableCellProperties",
- "description": "The table cell properties to update."
- },
- "fields": {
- "description": "The fields that should be updated.\n\nAt least one field must be specified. The root `tableCellProperties` is\nimplied and should not be specified. A single `\"*\"` can be used as\nshort-hand for listing every field.\n\nFor example to update the table cell background solid fill color, set\n`fields` to `\"tableCellBackgroundFill.solidFill.color\"`.\n\nTo reset a property to its default value, include its field name in the\nfield mask but leave the field itself unset.",
- "format": "google-fieldmask",
- "type": "string"
- }
- },
- "id": "UpdateTableCellPropertiesRequest"
- },
- "CreateSlideRequest": {
- "properties": {
- "slideLayoutReference": {
- "description": "Layout reference of the slide to be inserted, based on the *current\nmaster*, which is one of the following:\n\n- The master of the previous slide index.\n- The master of the first slide, if the insertion_index is zero.\n- The first master in the presentation, if there are no slides.\n\nIf the LayoutReference is not found in the current master, a 400 bad\nrequest error is returned.\n\nIf you don't specify a layout reference, then the new slide will use the\npredefined layout `BLANK`.",
- "$ref": "LayoutReference"
- },
- "objectId": {
- "description": "A user-supplied object ID.\n\nIf you specify an ID, it must be unique among all pages and page elements\nin the presentation. The ID must start with an alphanumeric character or an\nunderscore (matches regex `[a-zA-Z0-9_]`); remaining characters\nmay include those as well as a hyphen or colon (matches regex\n`[a-zA-Z0-9_-:]`).\nThe length of the ID must not be less than 5 or greater than 50.\n\nIf you don't specify an ID, a unique one is generated.",
- "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": "CreateSlideRequest",
- "description": "Creates a new slide.",
- "type": "object"
- },
- "BatchUpdatePresentationRequest": {
- "description": "Request message for PresentationsService.BatchUpdatePresentation.",
- "type": "object",
- "properties": {
- "requests": {
- "description": "A list of updates to apply to the presentation.",
- "type": "array",
- "items": {
- "$ref": "Request"
- }
- },
- "writeControl": {
- "description": "Provides control over how write requests are executed.",
- "$ref": "WriteControl"
- }
- },
- "id": "BatchUpdatePresentationRequest"
- },
- "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"
- },
- "GroupObjectsResponse": {
- "description": "The result of grouping objects.",
- "type": "object",
- "properties": {
- "objectId": {
- "description": "The object ID of the created group.",
- "type": "string"
- }
- },
- "id": "GroupObjectsResponse"
- },
- "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": {
- "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.",
- "type": "string"
- }
- },
- "id": "TableBorderProperties"
- },
- "TableBorderCell": {
- "description": "The properties of each border cell.",
- "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"
- },
- "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": {
- "description": "The bulleted lists contained in this text, keyed by list ID.",
- "type": "object",
- "additionalProperties": {
- "$ref": "List"
- }
- }
- },
- "id": "TextContent"
- },
- "CreateSheetsChartResponse": {
- "type": "object",
- "properties": {
- "objectId": {
- "description": "The object ID of the created chart.",
- "type": "string"
- }
- },
- "id": "CreateSheetsChartResponse",
- "description": "The result of creating an embedded Google Sheets chart."
- },
- "WriteControl": {
- "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",
- "description": "Provides control over how write requests are executed.",
- "type": "object"
+ "id": "CreateParagraphBulletsRequest"
}
},
"icons": {
@@ -3979,12 +3979,6 @@
"auth": {
"oauth2": {
"scopes": {
- "https://www.googleapis.com/auth/presentations": {
- "description": "View and manage your Google Slides presentations"
- },
- "https://www.googleapis.com/auth/presentations.readonly": {
- "description": "View your Google Slides presentations"
- },
"https://www.googleapis.com/auth/drive.file": {
"description": "View and manage Google Drive files and folders that you have opened or created with this app"
},
@@ -3999,6 +3993,12 @@
},
"https://www.googleapis.com/auth/spreadsheets": {
"description": "View and manage your spreadsheets in Google Drive"
+ },
+ "https://www.googleapis.com/auth/presentations": {
+ "description": "View and manage your Google Slides presentations"
+ },
+ "https://www.googleapis.com/auth/presentations.readonly": {
+ "description": "View your Google Slides presentations"
}
}
}
@@ -4011,59 +4011,100 @@
"ownerName": "Google",
"resources": {
"presentations": {
- "methods": {
- "create": {
- "parameters": {},
- "scopes": [
- "https://www.googleapis.com/auth/drive",
- "https://www.googleapis.com/auth/drive.file",
- "https://www.googleapis.com/auth/presentations"
- ],
- "flatPath": "v1/presentations",
- "path": "v1/presentations",
- "id": "slides.presentations.create",
- "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.",
- "response": {
- "$ref": "Presentation"
- },
- "parameterOrder": [],
- "httpMethod": "POST"
- },
- "batchUpdate": {
- "request": {
- "$ref": "BatchUpdatePresentationRequest"
- },
- "description": "Applies one or more updates to the presentation.\n\nEach request is validated before\nbeing applied. If any request is not valid, then the entire request will\nfail and nothing will be applied.\n\nSome requests have replies to\ngive you some information about how they are applied. Other requests do\nnot need to return information; these each return an empty reply.\nThe order of replies matches that of the requests.\n\nFor example, suppose you call batchUpdate with four updates, and only the\nthird one returns information. The response would have two empty replies:\nthe reply to the third request, and another empty reply, in that order.\n\nBecause other users may be editing the presentation, the presentation\nmight not exactly reflect your changes: your changes may\nbe altered with respect to collaborator changes. If there are no\ncollaborators, the presentation should reflect your changes. In any case,\nthe updates in your request are guaranteed to be applied together\natomically.",
- "httpMethod": "POST",
- "parameterOrder": [
- "presentationId"
- ],
- "response": {
- "$ref": "BatchUpdatePresentationResponse"
- },
- "parameters": {
- "presentationId": {
- "location": "path",
- "description": "The presentation to apply the updates to.",
- "required": true,
- "type": "string"
+ "resources": {
+ "pages": {
+ "methods": {
+ "getThumbnail": {
+ "response": {
+ "$ref": "Thumbnail"
+ },
+ "parameterOrder": [
+ "presentationId",
+ "pageObjectId"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "presentationId": {
+ "description": "The ID of the presentation to retrieve.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "pageObjectId": {
+ "description": "The object ID of the page whose thumbnail to retrieve.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "thumbnailProperties.mimeType": {
+ "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",
+ "location": "query"
+ },
+ "thumbnailProperties.thumbnailSize": {
+ "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",
+ "location": "query"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/drive",
+ "https://www.googleapis.com/auth/drive.file",
+ "https://www.googleapis.com/auth/drive.readonly",
+ "https://www.googleapis.com/auth/presentations",
+ "https://www.googleapis.com/auth/presentations.readonly"
+ ],
+ "flatPath": "v1/presentations/{presentationId}/pages/{pageObjectId}/thumbnail",
+ "path": "v1/presentations/{presentationId}/pages/{pageObjectId}/thumbnail",
+ "id": "slides.presentations.pages.getThumbnail",
+ "description": "Generates a thumbnail of the latest version of the specified page in the\npresentation and returns a URL to the thumbnail image."
+ },
+ "get": {
+ "id": "slides.presentations.pages.get",
+ "path": "v1/presentations/{presentationId}/pages/{pageObjectId}",
+ "description": "Gets the latest version of the specified page in the presentation.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "presentationId",
+ "pageObjectId"
+ ],
+ "response": {
+ "$ref": "Page"
+ },
+ "parameters": {
+ "pageObjectId": {
+ "description": "The object ID of the page to retrieve.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "presentationId": {
+ "location": "path",
+ "description": "The ID of the presentation to retrieve.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/drive",
+ "https://www.googleapis.com/auth/drive.file",
+ "https://www.googleapis.com/auth/drive.readonly",
+ "https://www.googleapis.com/auth/presentations",
+ "https://www.googleapis.com/auth/presentations.readonly"
+ ],
+ "flatPath": "v1/presentations/{presentationId}/pages/{pageObjectId}"
}
- },
- "scopes": [
- "https://www.googleapis.com/auth/drive",
- "https://www.googleapis.com/auth/drive.file",
- "https://www.googleapis.com/auth/drive.readonly",
- "https://www.googleapis.com/auth/presentations",
- "https://www.googleapis.com/auth/spreadsheets",
- "https://www.googleapis.com/auth/spreadsheets.readonly"
- ],
- "flatPath": "v1/presentations/{presentationId}:batchUpdate",
- "id": "slides.presentations.batchUpdate",
- "path": "v1/presentations/{presentationId}:batchUpdate"
- },
+ }
+ }
+ },
+ "methods": {
"get": {
"response": {
"$ref": "Presentation"
@@ -4092,104 +4133,68 @@
"path": "v1/presentations/{+presentationId}",
"id": "slides.presentations.get",
"description": "Gets the latest version of the specified presentation."
- }
- },
- "resources": {
- "pages": {
- "methods": {
- "getThumbnail": {
- "description": "Generates a thumbnail of the latest version of the specified page in the\npresentation and returns a URL to the thumbnail image.",
- "httpMethod": "GET",
- "parameterOrder": [
- "presentationId",
- "pageObjectId"
- ],
- "response": {
- "$ref": "Thumbnail"
- },
- "parameters": {
- "thumbnailProperties.mimeType": {
- "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"
- },
- "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."
- },
- "presentationId": {
- "location": "path",
- "description": "The ID of the presentation to retrieve.",
- "required": true,
- "type": "string"
- },
- "pageObjectId": {
- "description": "The object ID of the page whose thumbnail to retrieve.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/drive",
- "https://www.googleapis.com/auth/drive.file",
- "https://www.googleapis.com/auth/drive.readonly",
- "https://www.googleapis.com/auth/presentations",
- "https://www.googleapis.com/auth/presentations.readonly"
- ],
- "flatPath": "v1/presentations/{presentationId}/pages/{pageObjectId}/thumbnail",
- "id": "slides.presentations.pages.getThumbnail",
- "path": "v1/presentations/{presentationId}/pages/{pageObjectId}/thumbnail"
- },
- "get": {
- "scopes": [
- "https://www.googleapis.com/auth/drive",
- "https://www.googleapis.com/auth/drive.file",
- "https://www.googleapis.com/auth/drive.readonly",
- "https://www.googleapis.com/auth/presentations",
- "https://www.googleapis.com/auth/presentations.readonly"
- ],
- "parameters": {
- "pageObjectId": {
- "description": "The object ID of the page to retrieve.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "presentationId": {
- "location": "path",
- "description": "The ID of the presentation to retrieve.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1/presentations/{presentationId}/pages/{pageObjectId}",
- "path": "v1/presentations/{presentationId}/pages/{pageObjectId}",
- "id": "slides.presentations.pages.get",
- "description": "Gets the latest version of the specified page in the presentation.",
- "response": {
- "$ref": "Page"
- },
- "parameterOrder": [
- "presentationId",
- "pageObjectId"
- ],
- "httpMethod": "GET"
+ },
+ "create": {
+ "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.",
+ "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"
+ ],
+ "flatPath": "v1/presentations",
+ "path": "v1/presentations",
+ "id": "slides.presentations.create"
+ },
+ "batchUpdate": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "presentationId"
+ ],
+ "response": {
+ "$ref": "BatchUpdatePresentationResponse"
+ },
+ "parameters": {
+ "presentationId": {
+ "location": "path",
+ "description": "The presentation 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/drive.readonly",
+ "https://www.googleapis.com/auth/presentations",
+ "https://www.googleapis.com/auth/spreadsheets",
+ "https://www.googleapis.com/auth/spreadsheets.readonly"
+ ],
+ "flatPath": "v1/presentations/{presentationId}:batchUpdate",
+ "id": "slides.presentations.batchUpdate",
+ "path": "v1/presentations/{presentationId}:batchUpdate",
+ "request": {
+ "$ref": "BatchUpdatePresentationRequest"
+ },
+ "description": "Applies one or more updates to the presentation.\n\nEach request is validated before\nbeing applied. If any request is not valid, then the entire request will\nfail and nothing will be applied.\n\nSome requests have replies to\ngive you some information about how they are applied. Other requests do\nnot need to return information; these each return an empty reply.\nThe order of replies matches that of the requests.\n\nFor example, suppose you call batchUpdate with four updates, and only the\nthird one returns information. The response would have two empty replies:\nthe reply to the third request, and another empty reply, in that order.\n\nBecause other users may be editing the presentation, the presentation\nmight not exactly reflect your changes: your changes may\nbe altered with respect to collaborator changes. If there are no\ncollaborators, the presentation should reflect your changes. In any case,\nthe updates in your request are guaranteed to be applied together\natomically."
}
}
}
},
"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",
@@ -4197,34 +4202,40 @@
"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": {
- "description": "JSONP",
- "type": "string",
- "location": "query"
- },
"$.xgafv": {
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query",
"enum": [
"1",
"2"
],
"description": "V1 error format.",
- "type": "string"
+ "type": "string",
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query"
+ },
+ "callback": {
+ "description": "JSONP",
+ "type": "string",
+ "location": "query"
},
"alt": {
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
+ "type": "string",
"enumDescriptions": [
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
@@ -4232,18 +4243,12 @@
],
"location": "query",
"description": "Data format for response.",
- "default": "json",
- "enum": [
- "json",
- "media",
- "proto"
- ],
- "type": "string"
+ "default": "json"
},
"key": {
+ "location": "query",
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"access_token": {
"location": "query",
@@ -4256,30 +4261,25 @@
"location": "query"
},
"pp": {
- "type": "boolean",
- "default": "true",
"location": "query",
- "description": "Pretty-print response."
+ "description": "Pretty-print response.",
+ "type": "boolean",
+ "default": "true"
},
- "bearer_token": {
- "description": "OAuth bearer token.",
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
"type": "string",
"location": "query"
},
- "oauth_token": {
- "type": "string",
- "location": "query",
- "description": "OAuth 2.0 token for the current user."
- },
- "upload_protocol": {
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "bearer_token": {
+ "description": "OAuth bearer token.",
"type": "string",
"location": "query"
}
},
"version": "v1",
"baseUrl": "https://slides.googleapis.com/",
- "servicePath": "",
"kind": "discovery#restDescription",
- "description": "An API for creating and editing Google Slides presentations."
+ "description": "An API for creating and editing Google Slides presentations.",
+ "servicePath": ""
}
diff --git a/sourcerepo/v1/sourcerepo-api.json b/sourcerepo/v1/sourcerepo-api.json
index 337dd1e..6784432 100644
--- a/sourcerepo/v1/sourcerepo-api.json
+++ b/sourcerepo/v1/sourcerepo-api.json
@@ -11,25 +11,95 @@
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
- "SetIamPolicyRequest": {
+ "TestIamPermissionsRequest": {
"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."
+ "permissions": {
+ "description": "The set of permissions to check for the `resource`. Permissions with\nwildcards (such as '*' or 'storage.*') are not allowed. For more\ninformation see\n[IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "id": "TestIamPermissionsRequest",
+ "description": "Request message for `TestIamPermissions` method.",
+ "type": "object"
+ },
+ "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": "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",
+ "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"
+ },
+ "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",
- "description": "Request message for `SetIamPolicy` method.",
- "type": "object"
+ "id": "SetIamPolicyRequest"
},
"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.",
@@ -47,9 +117,36 @@
"type": "string"
}
},
- "id": "Binding"
+ "id": "Binding",
+ "description": "Associates `members` with a `role`.",
+ "type": "object"
+ },
+ "Expr": {
+ "properties": {
+ "title": {
+ "description": "An optional title for the expression, i.e. a short string describing\nits purpose. This can be used e.g. in UIs which allow to enter the\nexpression.",
+ "type": "string"
+ },
+ "location": {
+ "description": "An optional string indicating the location of the expression for error\nreporting, e.g. a file name and a position in the file.",
+ "type": "string"
+ },
+ "description": {
+ "description": "An optional description of the expression. This is a longer text which\ndescribes the expression, e.g. when hovered over it in a UI.",
+ "type": "string"
+ },
+ "expression": {
+ "description": "Textual representation of an expression in\nCommon Expression Language syntax.\n\nThe application context of the containing message determines which\nwell-known feature set of CEL is supported.",
+ "type": "string"
+ }
+ },
+ "id": "Expr",
+ "description": "Represents an expression text. Example:\n\n title: \"User account presence\"\n description: \"Determines whether the request has a user account\"\n expression: \"size(request.user) \u003e 0\"",
+ "type": "object"
},
"MirrorConfig": {
+ "description": "Configuration to automatically mirror a repository from another\nhosting service, for example GitHub or BitBucket.",
+ "type": "object",
"properties": {
"url": {
"description": "URL of the main repository at the other hosting service.",
@@ -64,37 +161,12 @@
"type": "string"
}
},
- "id": "MirrorConfig",
- "description": "Configuration to automatically mirror a repository from another\nhosting service, for example GitHub or BitBucket.",
- "type": "object"
+ "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"
- },
- "Expr": {
- "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",
- "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\"",
+ "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"
},
"Repo": {
@@ -136,24 +208,26 @@
"id": "TestIamPermissionsResponse"
},
"ListReposResponse": {
+ "description": "Response for ListRepos. The size is not set in the returned repositories.",
+ "type": "object",
"properties": {
+ "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"
+ },
"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",
- "description": "Response for ListRepos. The size is not set in the returned repositories.",
- "type": "object"
+ "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.",
@@ -163,12 +237,6 @@
}
},
"logType": {
- "enumDescriptions": [
- "Default case. Should never be this.",
- "Admin reads. Example: CloudIAM getIamPolicy",
- "Data writes. Example: CloudSQL Users create",
- "Data reads. Example: CloudSQL Users list"
- ],
"enum": [
"LOG_TYPE_UNSPECIFIED",
"ADMIN_READ",
@@ -176,84 +244,16 @@
"DATA_READ"
],
"description": "The log type that this config enables.",
- "type": "string"
+ "type": "string",
+ "enumDescriptions": [
+ "Default case. Should never be this.",
+ "Admin reads. Example: CloudIAM getIamPolicy",
+ "Data writes. Example: CloudSQL Users create",
+ "Data reads. Example: CloudSQL Users list"
+ ]
}
},
- "id": "AuditLogConfig",
- "description": "Provides the configuration for logging a type of permissions.\nExample:\n\n {\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n }\n ]\n }\n\nThis enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting\nfoo@gmail.com from DATA_READ logging.",
- "type": "object"
- },
- "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": {
- "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"
- },
- "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"
+ "id": "AuditLogConfig"
}
},
"icons": {
@@ -291,6 +291,155 @@
"resources": {
"repos": {
"methods": {
+ "setIamPolicy": {
+ "response": {
+ "$ref": "Policy"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "resource": {
+ "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/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}:setIamPolicy",
+ "path": "v1/{+resource}:setIamPolicy",
+ "id": "sourcerepo.projects.repos.setIamPolicy",
+ "request": {
+ "$ref": "SetIamPolicyRequest"
+ },
+ "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy."
+ },
+ "create": {
+ "path": "v1/{+parent}/repos",
+ "id": "sourcerepo.projects.repos.create",
+ "description": "Creates a repo in the given project with the given name.\n\nIf the named repository already exists, `CreateRepo` returns\n`ALREADY_EXISTS`.",
+ "request": {
+ "$ref": "Repo"
+ },
+ "response": {
+ "$ref": "Repo"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/source.full_control",
+ "https://www.googleapis.com/auth/source.read_only",
+ "https://www.googleapis.com/auth/source.read_write"
+ ],
+ "parameters": {
+ "parent": {
+ "description": "The project in which to create the repo. Values are of the form\n`projects/\u003cproject\u003e`.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/repos"
+ },
+ "getIamPolicy": {
+ "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": {
+ "pattern": "^projects/[^/]+/repos/.+$",
+ "location": "path",
+ "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "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."
+ },
+ "get": {
+ "path": "v1/{+name}",
+ "id": "sourcerepo.projects.repos.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}"
+ },
+ "testIamPermissions": {
+ "response": {
+ "$ref": "TestIamPermissionsResponse"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "resource": {
+ "pattern": "^projects/[^/]+/repos/.+$",
+ "location": "path",
+ "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/source.full_control",
+ "https://www.googleapis.com/auth/source.read_only",
+ "https://www.googleapis.com/auth/source.read_write"
+ ],
+ "flatPath": "v1/projects/{projectsId}/repos/{reposId}: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": {
@@ -329,22 +478,22 @@
},
"parameters": {
"name": {
+ "pattern": "^projects/[^/]+$",
+ "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"
- },
- "pageToken": {
- "location": "query",
- "description": "Resume listing repositories where a prior ListReposResponse\nleft off. This is an opaque token that must be obtained from\na recent, prior ListReposResponse's next_page_token field.",
"type": "string"
},
+ "pageToken": {
+ "description": "Resume listing repositories where a prior ListReposResponse\nleft off. This is an opaque token that must be obtained from\na recent, prior ListReposResponse's next_page_token field.",
+ "type": "string",
+ "location": "query"
+ },
"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",
- "location": "query"
+ "type": "integer"
}
},
"scopes": [
@@ -357,155 +506,6 @@
"id": "sourcerepo.projects.repos.list",
"path": "v1/{+name}/repos",
"description": "Returns all repos belonging to a project. The sizes of the repos are\nnot set by ListRepos. To get the size of a repo, use GetRepo."
- },
- "create": {
- "request": {
- "$ref": "Repo"
- },
- "description": "Creates a repo in the given project with the given name.\n\nIf the named repository already exists, `CreateRepo` returns\n`ALREADY_EXISTS`.",
- "response": {
- "$ref": "Repo"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "POST",
- "parameters": {
- "parent": {
- "description": "The project in which to create the repo. Values are of the form\n`projects/\u003cproject\u003e`.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+$",
- "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",
- "path": "v1/{+parent}/repos",
- "id": "sourcerepo.projects.repos.create"
- },
- "setIamPolicy": {
- "response": {
- "$ref": "Policy"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
- "parameters": {
- "resource": {
- "pattern": "^projects/[^/]+/repos/.+$",
- "location": "path",
- "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/source.full_control",
- "https://www.googleapis.com/auth/source.read_only",
- "https://www.googleapis.com/auth/source.read_write"
- ],
- "flatPath": "v1/projects/{projectsId}/repos/{reposId}:setIamPolicy",
- "path": "v1/{+resource}:setIamPolicy",
- "id": "sourcerepo.projects.repos.setIamPolicy",
- "request": {
- "$ref": "SetIamPolicyRequest"
- },
- "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy."
- },
- "getIamPolicy": {
- "httpMethod": "GET",
- "parameterOrder": [
- "resource"
- ],
- "response": {
- "$ref": "Policy"
- },
- "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": {
- "pattern": "^projects/[^/]+/repos/.+$",
- "location": "path",
- "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1/projects/{projectsId}/repos/{reposId}:getIamPolicy",
- "id": "sourcerepo.projects.repos.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."
- },
- "get": {
- "description": "Returns information about a repo.",
- "httpMethod": "GET",
- "response": {
- "$ref": "Repo"
- },
- "parameterOrder": [
- "name"
- ],
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/repos/.+$",
- "location": "path",
- "description": "The name of the requested repository. Values are of the form\n`projects/\u003cproject\u003e/repos/\u003crepo\u003e`.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/source.full_control",
- "https://www.googleapis.com/auth/source.read_only",
- "https://www.googleapis.com/auth/source.read_write"
- ],
- "flatPath": "v1/projects/{projectsId}/repos/{reposId}",
- "id": "sourcerepo.projects.repos.get",
- "path": "v1/{+name}"
- },
- "testIamPermissions": {
- "response": {
- "$ref": "TestIamPermissionsResponse"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
- "parameters": {
- "resource": {
- "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/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}: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."
}
}
}
@@ -513,26 +513,42 @@
}
},
"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": {
+ "description": "API key. 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": {
+ "quotaUser": {
"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": "Available 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"
},
- "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",
@@ -550,54 +566,38 @@
"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"
},
"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"
+ "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"
}
}
}
diff --git a/spanner/v1/spanner-api.json b/spanner/v1/spanner-api.json
index 8875818..216451c 100644
--- a/spanner/v1/spanner-api.json
+++ b/spanner/v1/spanner-api.json
@@ -1,4 +1,1257 @@
{
+ "ownerName": "Google",
+ "resources": {
+ "projects": {
+ "resources": {
+ "instances": {
+ "resources": {
+ "databases": {
+ "resources": {
+ "operations": {
+ "methods": {
+ "cancel": {
+ "description": "Starts asynchronous cancellation on a long-running operation. The server\nmakes a best effort to cancel the operation, but success is not\nguaranteed. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`. Clients can use\nOperations.GetOperation or\nother methods to check whether the cancellation succeeded or whether the\noperation completed despite cancellation. On successful cancellation,\nthe operation is not deleted; instead, it becomes an operation with\nan Operation.error value with a google.rpc.Status.code of 1,\ncorresponding to `Code.CANCELLED`.",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "POST",
+ "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 cancelled.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/operations/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/operations/{operationsId}:cancel",
+ "path": "v1/{+name}:cancel",
+ "id": "spanner.projects.instances.databases.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": "^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",
+ "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": "ListOperationsResponse"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/spanner.admin"
+ ],
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/operations$",
+ "location": "path",
+ "description": "The name of the operation's parent resource.",
+ "required": true,
+ "type": "string"
+ },
+ "pageToken": {
+ "description": "The standard list page token.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageSize": {
+ "location": "query",
+ "description": "The standard list page size.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "filter": {
+ "location": "query",
+ "description": "The standard list filter.",
+ "type": "string"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/operations",
+ "path": "v1/{+name}",
+ "id": "spanner.projects.instances.databases.operations.list"
+ },
+ "get": {
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/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/spanner.admin"
+ ],
+ "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/operations/{operationsId}",
+ "path": "v1/{+name}",
+ "id": "spanner.projects.instances.databases.operations.get",
+ "description": "Gets the latest state of a long-running operation. Clients can use this\nmethod to poll the operation result at intervals as recommended by the API\nservice."
+ }
+ }
+ },
+ "sessions": {
+ "methods": {
+ "delete": {
+ "description": "Ends a session, releasing server resources associated with it.",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "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}",
+ "path": "v1/{+name}",
+ "id": "spanner.projects.instances.databases.sessions.delete"
+ },
+ "executeStreamingSql": {
+ "id": "spanner.projects.instances.databases.sessions.executeStreamingSql",
+ "path": "v1/{+session}:executeStreamingSql",
+ "request": {
+ "$ref": "ExecuteSqlRequest"
+ },
+ "description": "Like ExecuteSql, except returns the result\nset as a stream. Unlike ExecuteSql, there\nis no limit on the size of the returned result set. However, no\nindividual row in the result set can exceed 100 MiB, and no\ncolumn value can exceed 10 MiB.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "session"
+ ],
+ "response": {
+ "$ref": "PartialResultSet"
+ },
+ "parameters": {
+ "session": {
+ "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/sessions/[^/]+$",
+ "location": "path",
+ "description": "Required. The session in which the SQL query should be performed.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/spanner.data"
+ ],
+ "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions/{sessionsId}:executeStreamingSql"
+ },
+ "beginTransaction": {
+ "response": {
+ "$ref": "Transaction"
+ },
+ "parameterOrder": [
+ "session"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/spanner.data"
+ ],
+ "parameters": {
+ "session": {
+ "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/sessions/[^/]+$",
+ "location": "path",
+ "description": "Required. The session in which the transaction runs.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions/{sessionsId}:beginTransaction",
+ "path": "v1/{+session}:beginTransaction",
+ "id": "spanner.projects.instances.databases.sessions.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"
+ }
+ },
+ "commit": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "session"
+ ],
+ "response": {
+ "$ref": "CommitResponse"
+ },
+ "parameters": {
+ "session": {
+ "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/sessions/[^/]+$",
+ "location": "path",
+ "description": "Required. The session in which the transaction to be committed is running.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/spanner.data"
+ ],
+ "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions/{sessionsId}:commit",
+ "id": "spanner.projects.instances.databases.sessions.commit",
+ "path": "v1/{+session}: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."
+ },
+ "executeSql": {
+ "id": "spanner.projects.instances.databases.sessions.executeSql",
+ "path": "v1/{+session}: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",
+ "parameterOrder": [
+ "session"
+ ],
+ "response": {
+ "$ref": "ResultSet"
+ },
+ "parameters": {
+ "session": {
+ "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/sessions/[^/]+$",
+ "location": "path",
+ "description": "Required. The session in which the SQL query should be performed.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/spanner.data"
+ ],
+ "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions/{sessionsId}:executeSql"
+ },
+ "list": {
+ "response": {
+ "$ref": "ListSessionsResponse"
+ },
+ "parameterOrder": [
+ "database"
+ ],
+ "httpMethod": "GET",
+ "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 to list sessions.",
+ "required": true,
+ "type": "string"
+ },
+ "filter": {
+ "description": "An expression for filtering the results of the request. Filter rules are\ncase insensitive. The fields eligible for filtering are:\n\n * `labels.key` where key is the name of a label\n\nSome examples of using filters are:\n\n * `labels.env:*` --\u003e The session has the label \"env\".\n * `labels.env:dev` --\u003e The session has the label \"env\" and the value of\n the label contains the string \"dev\".",
+ "type": "string",
+ "location": "query"
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "If non-empty, `page_token` should contain a\nnext_page_token from a previous\nListSessionsResponse.",
+ "type": "string"
+ },
+ "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"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions",
+ "path": "v1/{+database}/sessions",
+ "id": "spanner.projects.instances.databases.sessions.list",
+ "description": "Lists all sessions in a given database."
+ },
+ "rollback": {
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "session"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/spanner.data"
+ ],
+ "parameters": {
+ "session": {
+ "description": "Required. The session in which the transaction to roll back is running.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/sessions/[^/]+$",
+ "location": "path"
+ }
+ },
+ "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"
+ }
+ },
+ "streamingRead": {
+ "description": "Like Read, except returns the result set as a\nstream. Unlike Read, there is no limit on the\nsize of the returned result set. However, no individual row in\nthe result set can exceed 100 MiB, and no column value can exceed\n10 MiB.",
+ "request": {
+ "$ref": "ReadRequest"
+ },
+ "response": {
+ "$ref": "PartialResultSet"
+ },
+ "parameterOrder": [
+ "session"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/spanner.data"
+ ],
+ "parameters": {
+ "session": {
+ "description": "Required. The session in which the read should be performed.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/sessions/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions/{sessionsId}:streamingRead",
+ "path": "v1/{+session}:streamingRead",
+ "id": "spanner.projects.instances.databases.sessions.streamingRead"
+ },
+ "create": {
+ "request": {
+ "$ref": "CreateSessionRequest"
+ },
+ "description": "Creates a new session. A session can be used to perform\ntransactions that read and/or modify data in a Cloud Spanner database.\nSessions are meant to be reused for many consecutive\ntransactions.\n\nSessions can only execute one transaction at a time. To execute\nmultiple concurrent read-write/write-only transactions, create\nmultiple sessions. Note that standalone reads and queries use a\ntransaction internally, and count toward the one transaction\nlimit.\n\nCloud Spanner limits the number of sessions that can exist at any given\ntime; thus, it is a good idea to delete idle and/or unneeded sessions.\nAside from explicit deletes, Cloud Spanner can delete sessions for which no\noperations are sent for more than an hour. If a session is deleted,\nrequests to it return `NOT_FOUND`.\n\nIdle sessions can be kept alive by sending a trivial SQL query\nperiodically, e.g., `\"SELECT 1\"`.",
+ "response": {
+ "$ref": "Session"
+ },
+ "parameterOrder": [
+ "database"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "database": {
+ "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+$",
+ "location": "path",
+ "description": "Required. The database in which the new session is created.",
+ "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",
+ "path": "v1/{+database}/sessions",
+ "id": "spanner.projects.instances.databases.sessions.create"
+ },
+ "read": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "session"
+ ],
+ "response": {
+ "$ref": "ResultSet"
+ },
+ "parameters": {
+ "session": {
+ "description": "Required. The session in which the read should be performed.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/sessions/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/spanner.data"
+ ],
+ "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions/{sessionsId}:read",
+ "id": "spanner.projects.instances.databases.sessions.read",
+ "path": "v1/{+session}:read",
+ "request": {
+ "$ref": "ReadRequest"
+ },
+ "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."
+ },
+ "get": {
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "Session"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "description": "Required. The name of the session to retrieve.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/sessions/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/spanner.data"
+ ],
+ "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions/{sessionsId}",
+ "id": "spanner.projects.instances.databases.sessions.get",
+ "path": "v1/{+name}",
+ "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."
+ }
+ }
+ }
+ },
+ "methods": {
+ "dropDatabase": {
+ "httpMethod": "DELETE",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "database"
+ ],
+ "parameters": {
+ "database": {
+ "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+$",
+ "location": "path",
+ "description": "Required. The database to be dropped.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/spanner.admin"
+ ],
+ "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}",
+ "id": "spanner.projects.instances.databases.dropDatabase",
+ "path": "v1/{+database}",
+ "description": "Drops (aka deletes) a Cloud Spanner database."
+ },
+ "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"
+ },
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "database"
+ ],
+ "httpMethod": "PATCH",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/spanner.admin"
+ ],
+ "parameters": {
+ "database": {
+ "description": "Required. The database to update.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/ddl",
+ "path": "v1/{+database}/ddl",
+ "id": "spanner.projects.instances.databases.updateDdl"
+ },
+ "testIamPermissions": {
+ "description": "Returns permissions that the caller has on the specified database resource.\n\nAttempting this RPC on a non-existent Cloud Spanner database will result in\na NOT_FOUND error if the user has `spanner.databases.list` permission on\nthe containing Cloud Spanner instance. Otherwise returns an empty set of\npermissions.",
+ "request": {
+ "$ref": "TestIamPermissionsRequest"
+ },
+ "response": {
+ "$ref": "TestIamPermissionsResponse"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/spanner.admin"
+ ],
+ "parameters": {
+ "resource": {
+ "description": "REQUIRED: The Cloud Spanner resource for which permissions are being tested. The format is `projects/\u003cproject ID\u003e/instances/\u003cinstance ID\u003e` for instance resources and `projects/\u003cproject ID\u003e/instances/\u003cinstance ID\u003e/databases/\u003cdatabase ID\u003e` for database resources.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}:testIamPermissions",
+ "path": "v1/{+resource}:testIamPermissions",
+ "id": "spanner.projects.instances.databases.testIamPermissions"
+ },
+ "getDdl": {
+ "response": {
+ "$ref": "GetDatabaseDdlResponse"
+ },
+ "parameterOrder": [
+ "database"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/spanner.admin"
+ ],
+ "parameters": {
+ "database": {
+ "description": "Required. The database whose schema we wish to get.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+$",
+ "location": "path"
+ }
+ },
+ "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."
+ },
+ "list": {
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "ListDatabasesResponse"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "parameters": {
+ "pageToken": {
+ "location": "query",
+ "description": "If non-empty, `page_token` should contain a\nnext_page_token from a\nprevious ListDatabasesResponse.",
+ "type": "string"
+ },
+ "pageSize": {
+ "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",
+ "location": "query"
+ },
+ "parent": {
+ "pattern": "^projects/[^/]+/instances/[^/]+$",
+ "location": "path",
+ "description": "Required. The instance whose databases should be listed.\nValues are of the form `projects/\u003cproject\u003e/instances/\u003cinstance\u003e`.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/spanner.admin"
+ ],
+ "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases",
+ "id": "spanner.projects.instances.databases.list",
+ "path": "v1/{+parent}/databases",
+ "description": "Lists Cloud Spanner databases."
+ },
+ "setIamPolicy": {
+ "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",
+ "id": "spanner.projects.instances.databases.setIamPolicy",
+ "path": "v1/{+resource}:setIamPolicy",
+ "request": {
+ "$ref": "SetIamPolicyRequest"
+ },
+ "description": "Sets the access control policy on a database resource. Replaces any\nexisting policy.\n\nAuthorization requires `spanner.databases.setIamPolicy` permission on\nresource."
+ },
+ "create": {
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/spanner.admin"
+ ],
+ "parameters": {
+ "parent": {
+ "pattern": "^projects/[^/]+/instances/[^/]+$",
+ "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"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases",
+ "path": "v1/{+parent}/databases",
+ "id": "spanner.projects.instances.databases.create",
+ "description": "Creates a new Cloud Spanner database and starts to prepare it for serving.\nThe returned long-running operation will\nhave a name of the format `\u003cdatabase_name\u003e/operations/\u003coperation_id\u003e` and\ncan be used to track preparation of the database. The\nmetadata field type is\nCreateDatabaseMetadata. The\nresponse field type is\nDatabase, if successful.",
+ "request": {
+ "$ref": "CreateDatabaseRequest"
+ }
+ },
+ "getIamPolicy": {
+ "request": {
+ "$ref": "GetIamPolicyRequest"
+ },
+ "description": "Gets the access control policy for a database resource. Returns an empty\npolicy if a database exists but does not have a policy set.\n\nAuthorization requires `spanner.databases.getIamPolicy` permission on\nresource.",
+ "response": {
+ "$ref": "Policy"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "resource": {
+ "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+$",
+ "location": "path",
+ "description": "REQUIRED: The Cloud Spanner resource for which the policy is being retrieved. The format is `projects/\u003cproject ID\u003e/instances/\u003cinstance ID\u003e` for instance resources and `projects/\u003cproject ID\u003e/instances/\u003cinstance ID\u003e/databases/\u003cdatabase ID\u003e` for database resources.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/spanner.admin"
+ ],
+ "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}:getIamPolicy",
+ "path": "v1/{+resource}:getIamPolicy",
+ "id": "spanner.projects.instances.databases.getIamPolicy"
+ },
+ "get": {
+ "description": "Gets the state of a Cloud Spanner database.",
+ "response": {
+ "$ref": "Database"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/spanner.admin"
+ ],
+ "parameters": {
+ "name": {
+ "description": "Required. The name of the requested 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"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}",
+ "path": "v1/{+name}",
+ "id": "spanner.projects.instances.databases.get"
+ }
+ }
+ },
+ "operations": {
+ "methods": {
+ "cancel": {
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "POST",
+ "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 cancelled.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/instances/[^/]+/operations/[^/]+$",
+ "location": "path"
+ }
+ },
+ "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`."
+ },
+ "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": {
+ "response": {
+ "$ref": "ListOperationsResponse"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/spanner.admin"
+ ],
+ "parameters": {
+ "filter": {
+ "location": "query",
+ "description": "The standard list filter.",
+ "type": "string"
+ },
+ "name": {
+ "pattern": "^projects/[^/]+/instances/[^/]+/operations$",
+ "location": "path",
+ "description": "The name of the operation's parent resource.",
+ "required": true,
+ "type": "string"
+ },
+ "pageToken": {
+ "description": "The standard list page token.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageSize": {
+ "description": "The standard list page size.",
+ "format": "int32",
+ "type": "integer",
+ "location": "query"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/operations",
+ "path": "v1/{+name}",
+ "id": "spanner.projects.instances.operations.list",
+ "description": "Lists operations that match the specified filter in the request. If the\nserver doesn't support this method, it returns `UNIMPLEMENTED`.\n\nNOTE: the `name` binding allows API services to override the binding\nto use different resource name schemes, such as `users/*/operations`. To\noverride the binding, API services can add a binding such as\n`\"/v1/{name=users/*}/operations\"` to their service configuration.\nFor backwards compatibility, the default name includes the operations\ncollection id, however overriding users must ensure the name binding\nis the parent resource, without the operations collection id."
+ },
+ "get": {
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "name": {
+ "description": "The name of the operation resource.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/instances/[^/]+/operations/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/spanner.admin"
+ ],
+ "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/operations/{operationsId}",
+ "path": "v1/{+name}",
+ "id": "spanner.projects.instances.operations.get",
+ "description": "Gets the latest state of a long-running operation. Clients can use this\nmethod to poll the operation result at intervals as recommended by the API\nservice."
+ }
+ }
+ }
+ },
+ "methods": {
+ "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.",
+ "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": "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"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/instances/{instancesId}",
+ "path": "v1/{+name}",
+ "id": "spanner.projects.instances.delete"
+ },
+ "list": {
+ "path": "v1/{+parent}/instances",
+ "id": "spanner.projects.instances.list",
+ "description": "Lists all instances in the given project.",
+ "response": {
+ "$ref": "ListInstancesResponse"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/spanner.admin"
+ ],
+ "parameters": {
+ "parent": {
+ "description": "Required. The name of the project for which a list of instances is\nrequested. Values are of the form `projects/\u003cproject\u003e`.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+$",
+ "location": "path"
+ },
+ "filter": {
+ "location": "query",
+ "description": "An expression for filtering the results of the request. Filter rules are\ncase insensitive. The fields eligible for filtering are:\n\n * `name`\n * `display_name`\n * `labels.key` where key is the name of a label\n\nSome examples of using filters are:\n\n * `name:*` --\u003e The instance has a name.\n * `name:Howl` --\u003e The instance's name contains the string \"howl\".\n * `name:HOWL` --\u003e Equivalent to above.\n * `NAME:howl` --\u003e Equivalent to above.\n * `labels.env:*` --\u003e The instance has the label \"env\".\n * `labels.env:dev` --\u003e The instance has the label \"env\" and the value of\n the label contains the string \"dev\".\n * `name:howl labels.env:dev` --\u003e The instance's name contains \"howl\" and\n it has the label \"env\" with its value\n containing \"dev\".",
+ "type": "string"
+ },
+ "pageToken": {
+ "description": "If non-empty, `page_token` should contain a\nnext_page_token from a\nprevious ListInstancesResponse.",
+ "type": "string",
+ "location": "query"
+ },
+ "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"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/instances"
+ },
+ "setIamPolicy": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "resource"
+ ],
+ "response": {
+ "$ref": "Policy"
+ },
+ "parameters": {
+ "resource": {
+ "description": "REQUIRED: The Cloud Spanner resource for which the policy is being set. The format is `projects/\u003cproject ID\u003e/instances/\u003cinstance ID\u003e` for instance resources and `projects/\u003cproject ID\u003e/instances/\u003cinstance ID\u003e/databases/\u003cdatabase ID\u003e` for databases resources.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/instances/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/spanner.admin"
+ ],
+ "flatPath": "v1/projects/{projectsId}/instances/{instancesId}:setIamPolicy",
+ "id": "spanner.projects.instances.setIamPolicy",
+ "path": "v1/{+resource}: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."
+ },
+ "create": {
+ "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"
+ },
+ "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"
+ },
+ "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.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "resource"
+ ],
+ "response": {
+ "$ref": "Policy"
+ },
+ "parameters": {
+ "resource": {
+ "description": "REQUIRED: The Cloud Spanner resource for which the policy is being retrieved. The format is `projects/\u003cproject ID\u003e/instances/\u003cinstance ID\u003e` for instance resources and `projects/\u003cproject ID\u003e/instances/\u003cinstance ID\u003e/databases/\u003cdatabase ID\u003e` for database resources.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/instances/[^/]+$",
+ "location": "path"
+ }
+ },
+ "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"
+ },
+ "patch": {
+ "httpMethod": "PATCH",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+/instances/[^/]+$",
+ "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"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/spanner.admin"
+ ],
+ "flatPath": "v1/projects/{projectsId}/instances/{instancesId}",
+ "id": "spanner.projects.instances.patch",
+ "path": "v1/{+name}",
+ "request": {
+ "$ref": "UpdateInstanceRequest"
+ },
+ "description": "Updates an instance, and begins allocating or releasing resources\nas requested. The returned long-running\noperation can be used to track the\nprogress of updating the instance. If the named instance does not\nexist, returns `NOT_FOUND`.\n\nImmediately upon completion of this request:\n\n * For resource types for which a decrease in the instance's allocation\n has been requested, billing is based on the newly-requested level.\n\nUntil completion of the returned operation:\n\n * Cancelling the operation sets its metadata's\n cancel_time, and begins\n restoring resources to their pre-request values. The operation\n is guaranteed to succeed at undoing all resource changes,\n after which point it terminates with a `CANCELLED` status.\n * All other attempts to modify the instance are rejected.\n * Reading the instance via the API continues to give the pre-request\n resource levels.\n\nUpon completion of the returned operation:\n\n * Billing begins for all successfully-allocated resources (some types\n may have lower than the requested levels).\n * All newly-reserved resources are available for serving the instance's\n tables.\n * The instance's new resource levels are readable via the API.\n\nThe returned long-running operation will\nhave a name of the format `\u003cinstance_name\u003e/operations/\u003coperation_id\u003e` and\ncan be used to track the instance modification. The\nmetadata field type is\nUpdateInstanceMetadata.\nThe response field type is\nInstance, if successful.\n\nAuthorization requires `spanner.instances.update` permission on\nresource name."
+ },
+ "get": {
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "Instance"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "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"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/spanner.admin"
+ ],
+ "flatPath": "v1/projects/{projectsId}/instances/{instancesId}",
+ "id": "spanner.projects.instances.get",
+ "path": "v1/{+name}",
+ "description": "Gets information about a particular instance."
+ },
+ "testIamPermissions": {
+ "response": {
+ "$ref": "TestIamPermissionsResponse"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/spanner.admin"
+ ],
+ "parameters": {
+ "resource": {
+ "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"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/instances/{instancesId}:testIamPermissions",
+ "path": "v1/{+resource}:testIamPermissions",
+ "id": "spanner.projects.instances.testIamPermissions",
+ "description": "Returns permissions that the caller has on the specified instance resource.\n\nAttempting this RPC on a non-existent Cloud Spanner instance resource will\nresult in a NOT_FOUND error if the user has `spanner.instances.list`\npermission on the containing Google Cloud Project. Otherwise returns an\nempty set of permissions.",
+ "request": {
+ "$ref": "TestIamPermissionsRequest"
+ }
+ }
+ }
+ },
+ "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"
+ },
+ "parameterOrder": [
+ "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\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"
+ },
+ "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"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/instanceConfigs"
+ },
+ "get": {
+ "path": "v1/{+name}",
+ "id": "spanner.projects.instanceConfigs.get",
+ "description": "Gets information about a particular instance configuration.",
+ "response": {
+ "$ref": "InstanceConfig"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "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}"
+ }
+ }
+ }
+ }
+ }
+ },
+ "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": {
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string",
+ "location": "query"
+ },
+ "upload_protocol": {
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "type": "string",
+ "location": "query"
+ },
+ "prettyPrint": {
+ "location": "query",
+ "description": "Returns response with indentations and line breaks.",
+ "type": "boolean",
+ "default": "true"
+ },
+ "uploadType": {
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string",
+ "location": "query"
+ },
+ "fields": {
+ "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"
+ }
+ },
+ "version": "v1",
+ "baseUrl": "https://spanner.googleapis.com/",
"kind": "discovery#restDescription",
"description": "Cloud Spanner is a managed, mission-critical, globally consistent and scalable relational database service.",
"servicePath": "",
@@ -9,6 +1262,168 @@
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
+ "CreateInstanceMetadata": {
+ "properties": {
+ "cancelTime": {
+ "description": "The time at which this operation was cancelled. If set, this operation is\nin the process of undoing itself (which is guaranteed to succeed) and\ncannot be cancelled again.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "endTime": {
+ "description": "The time at which this operation failed or was completed successfully.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "instance": {
+ "$ref": "Instance",
+ "description": "The instance being created."
+ },
+ "startTime": {
+ "description": "The time at which the\nCreateInstance request was\nreceived.",
+ "format": "google-datetime",
+ "type": "string"
+ }
+ },
+ "id": "CreateInstanceMetadata",
+ "description": "Metadata type for the operation returned by\nCreateInstance.",
+ "type": "object"
+ },
+ "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": {
+ "properties": {
+ "table": {
+ "description": "Required. The table whose rows will be deleted.",
+ "type": "string"
+ },
+ "keySet": {
+ "$ref": "KeySet",
+ "description": "Required. The primary keys of the rows within table to delete."
+ }
+ },
+ "id": "Delete",
+ "description": "Arguments to delete operations.",
+ "type": "object"
+ },
+ "CommitRequest": {
+ "properties": {
+ "singleUseTransaction": {
+ "description": "Execute mutations in a temporary transaction. Note that unlike\ncommit of a previously-started transaction, commit with a\ntemporary transaction is non-idempotent. That is, if the\n`CommitRequest` is sent to Cloud Spanner more than once (for\ninstance, due to retries in the application, or in the\ntransport library), it is possible that the mutations are\nexecuted more than once. If this is undesirable, use\nBeginTransaction and\nCommit instead.",
+ "$ref": "TransactionOptions"
+ },
+ "mutations": {
+ "description": "The mutations to be executed when this transaction commits. All\nmutations are applied atomically, in the order they appear in\nthis list.",
+ "type": "array",
+ "items": {
+ "$ref": "Mutation"
+ }
+ },
+ "transactionId": {
+ "description": "Commit a previously-started transaction.",
+ "format": "byte",
+ "type": "string"
+ }
+ },
+ "id": "CommitRequest",
+ "description": "The request for Commit.",
+ "type": "object"
+ },
+ "BeginTransactionRequest": {
+ "description": "The request for BeginTransaction.",
+ "type": "object",
+ "properties": {
+ "options": {
+ "description": "Required. Options for the new transaction.",
+ "$ref": "TransactionOptions"
+ }
+ },
+ "id": "BeginTransactionRequest"
+ },
+ "ListInstanceConfigsResponse": {
+ "description": "The response for ListInstanceConfigs.",
+ "type": "object",
+ "properties": {
+ "nextPageToken": {
+ "description": "`next_page_token` can be sent in a subsequent\nListInstanceConfigs call to\nfetch more of the matching instance configurations.",
+ "type": "string"
+ },
+ "instanceConfigs": {
+ "description": "The list of requested instance configurations.",
+ "type": "array",
+ "items": {
+ "$ref": "InstanceConfig"
+ }
+ }
+ },
+ "id": "ListInstanceConfigsResponse"
+ },
+ "GetIamPolicyRequest": {
+ "properties": {},
+ "id": "GetIamPolicyRequest",
+ "description": "Request message for `GetIamPolicy` method.",
+ "type": "object"
+ },
+ "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"
+ },
+ "CreateDatabaseMetadata": {
+ "description": "Metadata type for the operation returned by\nCreateDatabase.",
+ "type": "object",
+ "properties": {
+ "database": {
+ "description": "The database being created.",
+ "type": "string"
+ }
+ },
+ "id": "CreateDatabaseMetadata"
+ },
+ "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"
+ }
+ }
+ },
+ "id": "ListSessionsResponse"
+ },
"Session": {
"description": "A session in the Cloud Spanner API.",
"type": "object",
@@ -56,8 +1471,6 @@
"type": "object"
},
"KeyRange": {
- "description": "KeyRange represents a range of rows in a table or index.\n\nA range has a start key and an end key. These keys can be open or\nclosed, indicating if the range includes rows with that key.\n\nKeys are represented by lists, where the ith value in the list\ncorresponds to the ith component of the table or index primary key.\nIndividual values are encoded as described here.\n\nFor example, consider the following table definition:\n\n CREATE TABLE UserEvents (\n UserName STRING(MAX),\n EventDate STRING(10)\n ) PRIMARY KEY(UserName, EventDate);\n\nThe following keys name rows in this table:\n\n \"Bob\", \"2014-09-23\"\n\nSince the `UserEvents` table's `PRIMARY KEY` clause names two\ncolumns, each `UserEvents` key has two elements; the first is the\n`UserName`, and the second is the `EventDate`.\n\nKey ranges with multiple components are interpreted\nlexicographically by component using the table or index key's declared\nsort order. For example, the following range returns all events for\nuser `\"Bob\"` that occurred in the year 2015:\n\n \"start_closed\": [\"Bob\", \"2015-01-01\"]\n \"end_closed\": [\"Bob\", \"2015-12-31\"]\n\nStart and end keys can omit trailing key components. This affects the\ninclusion and exclusion of rows that exactly match the provided key\ncomponents: if the key is closed, then rows that exactly match the\nprovided components are included; if the key is open, then rows\nthat exactly match are not included.\n\nFor example, the following range includes all events for `\"Bob\"` that\noccurred during and after the year 2000:\n\n \"start_closed\": [\"Bob\", \"2000-01-01\"]\n \"end_closed\": [\"Bob\"]\n\nThe next example retrieves all events for `\"Bob\"`:\n\n \"start_closed\": [\"Bob\"]\n \"end_closed\": [\"Bob\"]\n\nTo retrieve events before the year 2000:\n\n \"start_closed\": [\"Bob\"]\n \"end_open\": [\"Bob\", \"2000-01-01\"]\n\nThe following range includes all rows in the table:\n\n \"start_closed\": []\n \"end_closed\": []\n\nThis range returns all users whose `UserName` begins with any\ncharacter from A to C:\n\n \"start_closed\": [\"A\"]\n \"end_open\": [\"D\"]\n\nThis range returns all users whose `UserName` begins with B:\n\n \"start_closed\": [\"B\"]\n \"end_open\": [\"C\"]\n\nKey ranges honor column sort order. For example, suppose a table is\ndefined as follows:\n\n CREATE TABLE DescendingSortedTable {\n Key INT64,\n ...\n ) PRIMARY KEY(Key DESC);\n\nThe following range retrieves all rows with key values between 1\nand 100 inclusive:\n\n \"start_closed\": [\"100\"]\n \"end_closed\": [\"1\"]\n\nNote that 100 is passed as the start, and 1 is passed as the end,\nbecause `Key` is a descending column in the schema.",
- "type": "object",
"properties": {
"endClosed": {
"description": "If the end is closed, then the range includes all rows whose\nfirst `len(end_closed)` key columns exactly match `end_closed`.",
@@ -88,7 +1501,9 @@
}
}
},
- "id": "KeyRange"
+ "id": "KeyRange",
+ "description": "KeyRange represents a range of rows in a table or index.\n\nA range has a start key and an end key. These keys can be open or\nclosed, indicating if the range includes rows with that key.\n\nKeys are represented by lists, where the ith value in the list\ncorresponds to the ith component of the table or index primary key.\nIndividual values are encoded as described here.\n\nFor example, consider the following table definition:\n\n CREATE TABLE UserEvents (\n UserName STRING(MAX),\n EventDate STRING(10)\n ) PRIMARY KEY(UserName, EventDate);\n\nThe following keys name rows in this table:\n\n \"Bob\", \"2014-09-23\"\n\nSince the `UserEvents` table's `PRIMARY KEY` clause names two\ncolumns, each `UserEvents` key has two elements; the first is the\n`UserName`, and the second is the `EventDate`.\n\nKey ranges with multiple components are interpreted\nlexicographically by component using the table or index key's declared\nsort order. For example, the following range returns all events for\nuser `\"Bob\"` that occurred in the year 2015:\n\n \"start_closed\": [\"Bob\", \"2015-01-01\"]\n \"end_closed\": [\"Bob\", \"2015-12-31\"]\n\nStart and end keys can omit trailing key components. This affects the\ninclusion and exclusion of rows that exactly match the provided key\ncomponents: if the key is closed, then rows that exactly match the\nprovided components are included; if the key is open, then rows\nthat exactly match are not included.\n\nFor example, the following range includes all events for `\"Bob\"` that\noccurred during and after the year 2000:\n\n \"start_closed\": [\"Bob\", \"2000-01-01\"]\n \"end_closed\": [\"Bob\"]\n\nThe next example retrieves all events for `\"Bob\"`:\n\n \"start_closed\": [\"Bob\"]\n \"end_closed\": [\"Bob\"]\n\nTo retrieve events before the year 2000:\n\n \"start_closed\": [\"Bob\"]\n \"end_open\": [\"Bob\", \"2000-01-01\"]\n\nThe following range includes all rows in the table:\n\n \"start_closed\": []\n \"end_closed\": []\n\nThis range returns all users whose `UserName` begins with any\ncharacter from A to C:\n\n \"start_closed\": [\"A\"]\n \"end_open\": [\"D\"]\n\nThis range returns all users whose `UserName` begins with B:\n\n \"start_closed\": [\"B\"]\n \"end_open\": [\"C\"]\n\nKey ranges honor column sort order. For example, suppose a table is\ndefined as follows:\n\n CREATE TABLE DescendingSortedTable {\n Key INT64,\n ...\n ) PRIMARY KEY(Key DESC);\n\nThe following range retrieves all rows with key values between 1\nand 100 inclusive:\n\n \"start_closed\": [\"100\"]\n \"end_closed\": [\"1\"]\n\nNote that 100 is passed as the start, and 1 is passed as the end,\nbecause `Key` is a descending column in the schema.",
+ "type": "object"
},
"ShortRepresentation": {
"description": "Condensed representation of a node and its subtree. Only present for\n`SCALAR` PlanNode(s).",
@@ -110,8 +1525,6 @@
"id": "ShortRepresentation"
},
"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*`",
@@ -122,7 +1535,9 @@
"type": "string"
}
},
- "id": "InstanceConfig"
+ "id": "InstanceConfig",
+ "description": "A possible configuration for a Cloud Spanner instance. Configurations\ndefine the geographic placement of nodes and their replication.",
+ "type": "object"
},
"UpdateInstanceRequest": {
"description": "The request for UpdateInstance.",
@@ -162,6 +1577,8 @@
"type": "object"
},
"CreateDatabaseRequest": {
+ "description": "The request for CreateDatabase.",
+ "type": "object",
"properties": {
"extraStatements": {
"description": "An optional list of DDL statements to run inside the newly created\ndatabase. Statements can create tables, indexes, etc. These\nstatements execute atomically with the creation of the database:\nif there is an error in any statement, the database is not created.",
@@ -175,9 +1592,7 @@
"type": "string"
}
},
- "id": "CreateDatabaseRequest",
- "description": "The request for CreateDatabase.",
- "type": "object"
+ "id": "CreateDatabaseRequest"
},
"CreateInstanceRequest": {
"properties": {
@@ -195,16 +1610,9 @@
"type": "object"
},
"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",
- "type": "string"
- },
"maxStaleness": {
"description": "Read data at a timestamp \u003e= `NOW - max_staleness`\nseconds. Guarantees that all writes that have committed more\nthan the specified number of seconds ago are visible. Because\nCloud Spanner chooses the exact timestamp, this mode works even if\nthe client's local clock is substantially skewed from Cloud Spanner\ncommit timestamps.\n\nUseful for reading the freshest data available at a nearby\nreplica, while bounding the possible staleness if the local\nreplica has fallen behind.\n\nNote that this option can only be used in single-use\ntransactions.",
"format": "google-duration",
@@ -223,13 +1631,22 @@
"description": "Executes all reads at a timestamp that is `exact_staleness`\nold. The timestamp is chosen soon after the read is started.\n\nGuarantees that all writes that have committed more than the\nspecified number of seconds ago are visible. Because Cloud Spanner\nchooses the exact timestamp, this mode works even if the client's\nlocal clock is substantially skewed from Cloud Spanner commit\ntimestamps.\n\nUseful for reading at nearby replicas without the distributed\ntimestamp negotiation overhead of `max_staleness`.",
"format": "google-duration",
"type": "string"
+ },
+ "strong": {
+ "description": "Read at a timestamp where all previously committed transactions\nare visible.",
+ "type": "boolean"
+ },
+ "minReadTimestamp": {
+ "description": "Executes all reads at a timestamp \u003e= `min_read_timestamp`.\n\nThis is useful for requesting fresher data than some previous\nread, or data that is fresh enough to observe the effects of some\npreviously committed transaction whose timestamp is known.\n\nNote that this option can only be used in single-use transactions.\n\nA timestamp in RFC3339 UTC \\\"Zulu\\\" format, accurate to nanoseconds.\nExample: `\"2014-10-02T15:01:23.045123456Z\"`.",
+ "format": "google-datetime",
+ "type": "string"
}
},
- "id": "ReadOnly",
- "description": "Message type to initiate a read-only transaction.",
- "type": "object"
+ "id": "ReadOnly"
},
"ExecuteSqlRequest": {
+ "description": "The request for ExecuteSql and\nExecuteStreamingSql.",
+ "type": "object",
"properties": {
"params": {
"additionalProperties": {
@@ -240,18 +1657,18 @@
"type": "object"
},
"queryMode": {
+ "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.",
+ "This mode returns both the query plan and the execution statistics along\nwith the result rows."
+ ],
"enum": [
"NORMAL",
"PLAN",
"PROFILE"
],
"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.",
- "This mode returns both the query plan and the execution statistics along\nwith the result rows."
- ]
+ "type": "string"
},
"transaction": {
"$ref": "TransactionSelector",
@@ -274,11 +1691,11 @@
"type": "string"
}
},
- "id": "ExecuteSqlRequest",
- "description": "The request for ExecuteSql and\nExecuteStreamingSql.",
- "type": "object"
+ "id": "ExecuteSqlRequest"
},
"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.",
@@ -298,32 +1715,10 @@
}
}
},
- "id": "Policy",
- "description": "Defines an Identity and Access Management (IAM) policy. It is used to\nspecify access control policies for Cloud Platform resources.\n\n\nA `Policy` consists of a list of `bindings`. A `Binding` binds a list of\n`members` to a `role`, where the members can be user accounts, Google groups,\nGoogle domains, and service accounts. A `role` is a named list of permissions\ndefined by IAM.\n\n**Example**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/owner\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-other-app@appspot.gserviceaccount.com\",\n ]\n },\n {\n \"role\": \"roles/viewer\",\n \"members\": [\"user:sean@example.com\"]\n }\n ]\n }\n\nFor a description of IAM and its features, see the\n[IAM developer's guide](https://cloud.google.com/iam).",
- "type": "object"
+ "id": "Policy"
},
"ReadRequest": {
"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": {
- "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.",
- "$ref": "KeySet"
- },
- "columns": {
- "description": "The columns of table to be returned for each row matching\nthis request.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
"transaction": {
"$ref": "TransactionSelector",
"description": "The transaction to use. If none is provided, the default is a\ntemporary read-only transaction with strong concurrency."
@@ -336,6 +1731,26 @@
"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."
+ },
+ "columns": {
+ "description": "The columns of table to be returned for each row matching\nthis request.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
}
},
"id": "ReadRequest",
@@ -371,19 +1786,15 @@
"type": "object"
},
"ReadWrite": {
- "description": "Message type to initiate a read-write transaction. Currently this\ntransaction type has no options.",
- "type": "object",
"properties": {},
- "id": "ReadWrite"
+ "id": "ReadWrite",
+ "description": "Message type to initiate a read-write transaction. Currently this\ntransaction type has no options.",
+ "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.",
@@ -397,8 +1808,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": {
@@ -407,41 +1818,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"
}
},
"id": "Operation"
},
- "ResultSet": {
- "description": "Results from Read or\nExecuteSql.",
+ "CreateSessionRequest": {
+ "description": "The request for CreateSession.",
"type": "object",
"properties": {
- "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."
- },
- "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.",
- "type": "array",
- "items": {
- "type": "array",
- "items": {
- "type": "any"
- }
- }
- },
- "metadata": {
- "description": "Metadata about the result set, such as row type information.",
- "$ref": "ResultSetMetadata"
+ "session": {
+ "$ref": "Session",
+ "description": "The session to create."
}
},
- "id": "ResultSet"
+ "id": "CreateSessionRequest"
},
"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",
@@ -457,22 +1856,56 @@
"description": "The status code, which should be an enum value of google.rpc.Code.",
"format": "int32",
"type": "integer"
+ },
+ "message": {
+ "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
+ "type": "string"
}
},
- "id": "Status",
- "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
+ "id": "Status"
+ },
+ "ResultSet": {
+ "properties": {
+ "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.",
+ "type": "array",
+ "items": {
+ "type": "array",
+ "items": {
+ "type": "any"
+ }
+ }
+ },
+ "metadata": {
+ "description": "Metadata about the result set, such as row type information.",
+ "$ref": "ResultSetMetadata"
+ },
+ "stats": {
+ "description": "Query plan and execution statistics for the query that produced this\nresult set. These can be requested by setting\nExecuteSqlRequest.query_mode.",
+ "$ref": "ResultSetStats"
+ }
+ },
+ "id": "ResultSet",
+ "description": "Results from Read or\nExecuteSql.",
"type": "object"
},
- "CreateSessionRequest": {
- "description": "The request for CreateSession.",
- "type": "object",
+ "Binding": {
"properties": {
- "session": {
- "description": "The session to create.",
- "$ref": "Session"
+ "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": "CreateSessionRequest"
+ "id": "Binding",
+ "description": "Associates `members` with a `role`.",
+ "type": "object"
},
"UpdateDatabaseDdlRequest": {
"description": "Enqueues the given DDL statements to be applied, in order but not\nnecessarily all at once, to the database schema at some point (or\npoints) in the future. The server checks that the statements\nare executable (syntactically valid, name tables that exist, etc.)\nbefore enqueueing them, but they may still fail upon\nlater execution (e.g., if a statement from another batch of\nstatements is applied first and it conflicts in some way, or if\nthere is some data-related problem like a `NULL` value in a column to\nwhich `NOT NULL` would be added). If a statement fails, all\nsubsequent statements in the batch are automatically cancelled.\n\nEach batch of statements is assigned a name which can be used with\nthe Operations API to monitor\nprogress. See the\noperation_id field for more\ndetails.",
@@ -492,26 +1925,25 @@
},
"id": "UpdateDatabaseDdlRequest"
},
- "Binding": {
- "description": "Associates `members` with a `role`.",
+ "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": {
- "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",
+ "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\"`.",
"type": "array",
"items": {
- "type": "string"
+ "type": "any"
}
},
- "role": {
- "description": "Role that is assigned to `members`.\nFor example, `roles/viewer`, `roles/editor`, or `roles/owner`.\nRequired",
- "type": "string"
- }
- },
- "id": "Binding"
- },
- "PartialResultSet": {
- "properties": {
"resumeToken": {
"description": "Streaming calls might be interrupted for a variety of reasons, such\nas TCP connection loss. If this occurs, the stream of results can\nbe resumed by re-sending the original request and including\n`resume_token`. Note that executing any other transaction in the\nsame session invalidates the token.",
"format": "byte",
@@ -520,54 +1952,13 @@
"stats": {
"$ref": "ResultSetStats",
"description": "Query plan and execution statistics for the query that produced this\nstreaming result set. These can be requested by setting\nExecuteSqlRequest.query_mode and are sent\nonly once with the last response in the stream."
- },
- "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"
- }
}
},
- "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"
- },
- "UpdateInstanceMetadata": {
- "description": "Metadata type for the operation returned by\nUpdateInstance.",
- "type": "object",
- "properties": {
- "cancelTime": {
- "description": "The time at which this operation was cancelled. If set, this operation is\nin the process of undoing itself (which is guaranteed to succeed) and\ncannot be cancelled again.",
- "format": "google-datetime",
- "type": "string"
- },
- "endTime": {
- "description": "The time at which this operation failed or was completed successfully.",
- "format": "google-datetime",
- "type": "string"
- },
- "instance": {
- "description": "The desired end state of the update.",
- "$ref": "Instance"
- },
- "startTime": {
- "description": "The time at which UpdateInstance\nrequest was received.",
- "format": "google-datetime",
- "type": "string"
- }
- },
- "id": "UpdateInstanceMetadata"
+ "id": "PartialResultSet"
},
"ListOperationsResponse": {
+ "description": "The response message for Operations.ListOperations.",
+ "type": "object",
"properties": {
"nextPageToken": {
"description": "The standard List next-page token.",
@@ -581,52 +1972,74 @@
}
}
},
- "id": "ListOperationsResponse",
- "description": "The response message for Operations.ListOperations.",
+ "id": "ListOperationsResponse"
+ },
+ "UpdateInstanceMetadata": {
+ "properties": {
+ "instance": {
+ "description": "The desired end state of the update.",
+ "$ref": "Instance"
+ },
+ "startTime": {
+ "description": "The time at which UpdateInstance\nrequest was received.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "cancelTime": {
+ "description": "The time at which this operation was cancelled. If set, this operation is\nin the process of undoing itself (which is guaranteed to succeed) and\ncannot be cancelled again.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "endTime": {
+ "description": "The time at which this operation failed or was completed successfully.",
+ "format": "google-datetime",
+ "type": "string"
+ }
+ },
+ "id": "UpdateInstanceMetadata",
+ "description": "Metadata type for the operation returned by\nUpdateInstance.",
"type": "object"
},
"ResultSetMetadata": {
- "description": "Metadata about a ResultSet or PartialResultSet.",
- "type": "object",
"properties": {
- "transaction": {
- "$ref": "Transaction",
- "description": "If the read or SQL query began a transaction as a side-effect, the\ninformation about the new transaction is yielded here."
- },
"rowType": {
"$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"
}
},
- "id": "ResultSetMetadata"
+ "id": "ResultSetMetadata",
+ "description": "Metadata about a ResultSet or PartialResultSet.",
+ "type": "object"
},
"TransactionSelector": {
+ "description": "This message is used to select the transaction in which a\nRead or\nExecuteSql call runs.\n\nSee TransactionOptions for more information about transactions.",
+ "type": "object",
"properties": {
- "singleUse": {
- "$ref": "TransactionOptions",
- "description": "Execute the read or SQL query in a temporary transaction.\nThis is the most efficient way to execute a transaction that\nconsists of a single SQL query."
- },
- "begin": {
- "$ref": "TransactionOptions",
- "description": "Begin a new transaction and execute this read or SQL query in\nit. The transaction ID of the new transaction is returned in\nResultSetMetadata.transaction, which is a Transaction."
- },
"id": {
"description": "Execute the read or SQL query in a previously-started transaction.",
"format": "byte",
"type": "string"
+ },
+ "singleUse": {
+ "description": "Execute the read or SQL query in a temporary transaction.\nThis is the most efficient way to execute a transaction that\nconsists of a single SQL query.",
+ "$ref": "TransactionOptions"
+ },
+ "begin": {
+ "$ref": "TransactionOptions",
+ "description": "Begin a new transaction and execute this read or SQL query in\nit. The transaction ID of the new transaction is returned in\nResultSetMetadata.transaction, which is a Transaction."
}
},
- "id": "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"
+ "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": {
"delete": {
- "$ref": "Delete",
- "description": "Delete rows from a table. Succeeds whether or not the named\nrows were present."
+ "description": "Delete rows from a table. Succeeds whether or not the named\nrows were present.",
+ "$ref": "Delete"
},
"insert": {
"description": "Insert new rows in a table. If any of the rows already exist,\nthe write or transaction fails with error `ALREADY_EXISTS`.",
@@ -645,10 +2058,21 @@
"$ref": "Write"
}
},
- "id": "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"
},
"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",
@@ -662,20 +2086,13 @@
"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",
- "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"
+ "id": "KeySet"
},
"GetDatabaseDdlResponse": {
+ "description": "The response for GetDatabaseDdl.",
+ "type": "object",
"properties": {
"statements": {
"description": "A list of formatted DDL statements defining the schema of the database\nspecified in the request.",
@@ -685,11 +2102,11 @@
}
}
},
- "id": "GetDatabaseDdlResponse",
- "description": "The response for GetDatabaseDdl.",
- "type": "object"
+ "id": "GetDatabaseDdlResponse"
},
"Database": {
+ "description": "A Cloud Spanner database.",
+ "type": "object",
"properties": {
"state": {
"enumDescriptions": [
@@ -710,24 +2127,20 @@
"type": "string"
}
},
- "id": "Database",
- "description": "A Cloud Spanner database.",
- "type": "object"
+ "id": "Database"
},
"SetIamPolicyRequest": {
"description": "Request message for `SetIamPolicy` method.",
"type": "object",
"properties": {
"policy": {
- "description": "REQUIRED: The complete policy to be applied to the `resource`. The size of\nthe policy is limited to a few 10s of KB. An empty policy is a\nvalid policy but certain Cloud Platform services (such as Projects)\nmight reject them.",
- "$ref": "Policy"
+ "$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.",
@@ -741,7 +2154,9 @@
}
}
},
- "id": "ListDatabasesResponse"
+ "id": "ListDatabasesResponse",
+ "description": "The response for ListDatabases.",
+ "type": "object"
},
"Instance": {
"description": "An isolated set of Cloud Spanner resources on which databases can be hosted.",
@@ -768,18 +2183,18 @@
"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"
+ "type": "string",
+ "enumDescriptions": [
+ "Not specified.",
+ "The instance is still being created. Resources may not be\navailable yet, and operations such as database creation may not\nwork.",
+ "The instance is fully created and ready to do work such as\ncreating databases."
+ ]
},
"name": {
"description": "Required. A unique identifier for the instance, which cannot be changed\nafter the instance is created. Values are of the form\n`projects/\u003cproject\u003e/instances/a-z*[a-z0-9]`. The final\nsegment of the name must be between 6 and 30 characters in length.",
@@ -789,8 +2204,6 @@
"id": "Instance"
},
"RollbackRequest": {
- "description": "The request for Rollback.",
- "type": "object",
"properties": {
"transactionId": {
"description": "Required. The transaction to roll back.",
@@ -798,26 +2211,30 @@
"type": "string"
}
},
- "id": "RollbackRequest"
+ "id": "RollbackRequest",
+ "description": "The request for Rollback.",
+ "type": "object"
},
"Transaction": {
+ "description": "A transaction.",
+ "type": "object",
"properties": {
- "readTimestamp": {
- "description": "For snapshot read-only transactions, the read timestamp chosen\nfor the transaction. Not returned by default: see\nTransactionOptions.ReadOnly.return_read_timestamp.\n\nA timestamp in RFC3339 UTC \\\"Zulu\\\" format, accurate to nanoseconds.\nExample: `\"2014-10-02T15:01:23.045123456Z\"`.",
- "format": "google-datetime",
- "type": "string"
- },
"id": {
"description": "`id` may be used to identify the transaction in subsequent\nRead,\nExecuteSql,\nCommit, or\nRollback calls.\n\nSingle-use read-only transactions do not have IDs, because\nsingle-use transactions do not support multiple requests.",
"format": "byte",
"type": "string"
+ },
+ "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",
- "description": "A transaction.",
- "type": "object"
+ "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.",
@@ -839,23 +2256,7 @@
"type": "string"
}
},
- "id": "UpdateDatabaseDdlMetadata",
- "description": "Metadata type for the operation returned by\nUpdateDatabaseDdl.",
- "type": "object"
- },
- "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"
+ "id": "UpdateDatabaseDdlMetadata"
},
"StructType": {
"description": "`StructType` defines the fields of a STRUCT type.",
@@ -871,20 +2272,53 @@
},
"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": {
"name": {
"description": "The name of the field. For reads, this is the column name. For\nSQL queries, it is the column alias (e.g., `\"Word\"` in the\nquery `\"SELECT 'hello' AS Word\"`), or the column name (e.g.,\n`\"ColName\"` in the query `\"SELECT ColName FROM Table\"`). Some\ncolumns might have an empty name (e.g., !\"SELECT\nUPPER(ColName)\"`). Note that a query result can contain\nmultiple fields with the same name.",
"type": "string"
},
"type": {
- "description": "The type of the field.",
- "$ref": "Type"
+ "$ref": "Type",
+ "description": "The type of the field."
}
},
- "id": "Field",
- "description": "Message representing a single field of a struct.",
- "type": "object"
+ "id": "Field"
+ },
+ "ResultSetStats": {
+ "description": "Additional statistics about a ResultSet or PartialResultSet.",
+ "type": "object",
+ "properties": {
+ "queryPlan": {
+ "$ref": "QueryPlan",
+ "description": "QueryPlan for the query associated with this result."
+ },
+ "queryStats": {
+ "additionalProperties": {
+ "description": "Properties of the object.",
+ "type": "any"
+ },
+ "description": "Aggregated statistics from the execution of the query. Only present when\nthe query is profiled. For example, a query could return the statistics as\nfollows:\n\n {\n \"rows_returned\": \"3\",\n \"elapsed_time\": \"1.22 secs\",\n \"cpu_time\": \"1.19 secs\"\n }",
+ "type": "object"
+ }
+ },
+ "id": "ResultSetStats"
},
"TestIamPermissionsRequest": {
"description": "Request message for `TestIamPermissions` method.",
@@ -900,25 +2334,6 @@
},
"id": "TestIamPermissionsRequest"
},
- "ResultSetStats": {
- "properties": {
- "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"
- },
- "queryPlan": {
- "$ref": "QueryPlan",
- "description": "QueryPlan for the query associated with this result."
- }
- },
- "id": "ResultSetStats",
- "description": "Additional statistics about a ResultSet or PartialResultSet.",
- "type": "object"
- },
"CommitResponse": {
"properties": {
"commitTimestamp": {
@@ -942,18 +2357,6 @@
"description": "If code == ARRAY, then `array_element_type`\nis the type of the array elements."
},
"code": {
- "enumDescriptions": [
- "Not specified.",
- "Encoded as JSON `true` or `false`.",
- "Encoded as `string`, in decimal format.",
- "Encoded as `number`, or the strings `\"NaN\"`, `\"Infinity\"`, or\n`\"-Infinity\"`.",
- "Encoded as `string` in RFC 3339 timestamp format. The time zone\nmust be present, and must be `\"Z\"`.",
- "Encoded as `string` in RFC 3339 date format.",
- "Encoded as `string`.",
- "Encoded as a base64-encoded `string`, as described in RFC 4648,\nsection 4.",
- "Encoded as `list`, where the list elements are represented\naccording to array_element_type.",
- "Encoded as `list`, where list element `i` is represented according\nto [struct_type.fields[i]][google.spanner.v1.StructType.fields]."
- ],
"enum": [
"TYPE_CODE_UNSPECIFIED",
"BOOL",
@@ -967,7 +2370,19 @@
"STRUCT"
],
"description": "Required. The TypeCode for this type.",
- "type": "string"
+ "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]."
+ ]
}
},
"id": "Type",
@@ -975,31 +2390,41 @@
"type": "object"
},
"PlanNode": {
- "description": "Node information for nodes appearing in a QueryPlan.plan_nodes.",
- "type": "object",
"properties": {
+ "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": {
+ "$ref": "ShortRepresentation",
+ "description": "Condensed representation for SCALAR nodes."
+ },
"index": {
"description": "The `PlanNode`'s index in node list.",
"format": "int32",
"type": "integer"
},
- "displayName": {
- "description": "The display name for the node.",
- "type": "string"
- },
"kind": {
+ "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"
],
"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."
- ]
+ "type": "string"
+ },
+ "displayName": {
+ "description": "The display name for the node.",
+ "type": "string"
},
"childLinks": {
"description": "List of child node `index`es and their relationship to this parent.",
@@ -1015,190 +2440,18 @@
},
"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": {
- "$ref": "ShortRepresentation",
- "description": "Condensed representation for SCALAR nodes."
}
},
- "id": "PlanNode"
- },
- "CreateInstanceMetadata": {
- "description": "Metadata type for the operation returned by\nCreateInstance.",
- "type": "object",
- "properties": {
- "instance": {
- "$ref": "Instance",
- "description": "The instance being created."
- },
- "startTime": {
- "description": "The time at which the\nCreateInstance request was\nreceived.",
- "format": "google-datetime",
- "type": "string"
- },
- "cancelTime": {
- "description": "The time at which this operation was cancelled. If set, this operation is\nin the process of undoing itself (which is guaranteed to succeed) and\ncannot be cancelled again.",
- "format": "google-datetime",
- "type": "string"
- },
- "endTime": {
- "description": "The time at which this operation failed or was completed successfully.",
- "format": "google-datetime",
- "type": "string"
- }
- },
- "id": "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": {
- "properties": {
- "nextPageToken": {
- "description": "`next_page_token` can be sent in a subsequent\nListInstanceConfigs call to\nfetch more of the matching instance configurations.",
- "type": "string"
- },
- "instanceConfigs": {
- "description": "The list of requested instance configurations.",
- "type": "array",
- "items": {
- "$ref": "InstanceConfig"
- }
- }
- },
- "id": "ListInstanceConfigsResponse",
- "description": "The response for ListInstanceConfigs.",
+ "id": "PlanNode",
+ "description": "Node information for nodes appearing in a QueryPlan.plan_nodes.",
"type": "object"
- },
- "BeginTransactionRequest": {
- "properties": {
- "options": {
- "description": "Required. Options for the new transaction.",
- "$ref": "TransactionOptions"
- }
- },
- "id": "BeginTransactionRequest",
- "description": "The request for BeginTransaction.",
- "type": "object"
- },
- "CommitRequest": {
- "description": "The request for Commit.",
- "type": "object",
- "properties": {
- "singleUseTransaction": {
- "$ref": "TransactionOptions",
- "description": "Execute mutations in a temporary transaction. Note that unlike\ncommit of a previously-started transaction, commit with a\ntemporary transaction is non-idempotent. That is, if the\n`CommitRequest` is sent to Cloud Spanner more than once (for\ninstance, due to retries in the application, or in the\ntransport library), it is possible that the mutations are\nexecuted more than once. If this is undesirable, use\nBeginTransaction and\nCommit instead."
- },
- "mutations": {
- "description": "The mutations to be executed when this transaction commits. All\nmutations are applied atomically, in the order they appear in\nthis list.",
- "type": "array",
- "items": {
- "$ref": "Mutation"
- }
- },
- "transactionId": {
- "description": "Commit a previously-started transaction.",
- "format": "byte",
- "type": "string"
- }
- },
- "id": "CommitRequest"
- },
- "TestIamPermissionsResponse": {
- "description": "Response message for `TestIamPermissions` method.",
- "type": "object",
- "properties": {
- "permissions": {
- "description": "A subset of `TestPermissionsRequest.permissions` that the caller is\nallowed.",
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "id": "TestIamPermissionsResponse"
- },
- "GetIamPolicyRequest": {
- "description": "Request message for `GetIamPolicy` method.",
- "type": "object",
- "properties": {},
- "id": "GetIamPolicyRequest"
- },
- "CreateDatabaseMetadata": {
- "properties": {
- "database": {
- "description": "The database being created.",
- "type": "string"
- }
- },
- "id": "CreateDatabaseMetadata",
- "description": "Metadata type for the operation returned by\nCreateDatabase.",
- "type": "object"
- },
- "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"
- }
- }
- },
- "id": "ListSessionsResponse"
}
},
+ "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": "Spanner",
"auth": {
"oauth2": {
@@ -1219,1258 +2472,5 @@
"ownerDomain": "google.com",
"name": "spanner",
"batchPath": "batch",
- "title": "Cloud Spanner API",
- "ownerName": "Google",
- "resources": {
- "projects": {
- "resources": {
- "instanceConfigs": {
- "methods": {
- "list": {
- "id": "spanner.projects.instanceConfigs.list",
- "path": "v1/{+parent}/instanceConfigs",
- "description": "Lists the supported instance configurations for a given project.",
- "httpMethod": "GET",
- "response": {
- "$ref": "ListInstanceConfigsResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "parameters": {
- "pageToken": {
- "description": "If non-empty, `page_token` should contain a\nnext_page_token\nfrom a previous ListInstanceConfigsResponse.",
- "type": "string",
- "location": "query"
- },
- "pageSize": {
- "location": "query",
- "description": "Number of instance configurations to be returned in the response. If 0 or\nless, defaults to the server's maximum allowed page size.",
- "format": "int32",
- "type": "integer"
- },
- "parent": {
- "pattern": "^projects/[^/]+$",
- "location": "path",
- "description": "Required. The name of the project for which a list of supported instance\nconfigurations is requested. Values are of the form\n`projects/\u003cproject\u003e`.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/spanner.admin"
- ],
- "flatPath": "v1/projects/{projectsId}/instanceConfigs"
- },
- "get": {
- "response": {
- "$ref": "InstanceConfig"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "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"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/spanner.admin"
- ],
- "flatPath": "v1/projects/{projectsId}/instanceConfigs/{instanceConfigsId}",
- "path": "v1/{+name}",
- "id": "spanner.projects.instanceConfigs.get",
- "description": "Gets information about a particular instance configuration."
- }
- }
- },
- "instances": {
- "resources": {
- "databases": {
- "methods": {
- "getIamPolicy": {
- "response": {
- "$ref": "Policy"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/spanner.admin"
- ],
- "parameters": {
- "resource": {
- "description": "REQUIRED: The Cloud Spanner resource for which the policy is being retrieved. The format is `projects/\u003cproject ID\u003e/instances/\u003cinstance ID\u003e` for instance resources and `projects/\u003cproject ID\u003e/instances/\u003cinstance ID\u003e/databases/\u003cdatabase ID\u003e` for database resources.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}: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"
- }
- },
- "get": {
- "description": "Gets the state of a Cloud Spanner database.",
- "response": {
- "$ref": "Database"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/spanner.admin"
- ],
- "parameters": {
- "name": {
- "description": "Required. The name of the requested 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"
- }
- },
- "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}",
- "path": "v1/{+name}",
- "id": "spanner.projects.instances.databases.get"
- },
- "dropDatabase": {
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "database"
- ],
- "httpMethod": "DELETE",
- "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 be dropped.",
- "required": true,
- "type": "string"
- }
- },
- "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": {
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "database"
- ],
- "httpMethod": "PATCH",
- "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"
- }
- },
- "testIamPermissions": {
- "response": {
- "$ref": "TestIamPermissionsResponse"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/spanner.admin"
- ],
- "parameters": {
- "resource": {
- "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+$",
- "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"
- }
- },
- "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}:testIamPermissions",
- "path": "v1/{+resource}:testIamPermissions",
- "id": "spanner.projects.instances.databases.testIamPermissions",
- "description": "Returns permissions that the caller has on the specified database resource.\n\nAttempting this RPC on a non-existent Cloud Spanner database will result in\na NOT_FOUND error if the user has `spanner.databases.list` permission on\nthe containing Cloud Spanner instance. Otherwise returns an empty set of\npermissions.",
- "request": {
- "$ref": "TestIamPermissionsRequest"
- }
- },
- "getDdl": {
- "response": {
- "$ref": "GetDatabaseDdlResponse"
- },
- "parameterOrder": [
- "database"
- ],
- "httpMethod": "GET",
- "parameters": {
- "database": {
- "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+$",
- "location": "path",
- "description": "Required. The database whose schema we wish to get.",
- "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}/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."
- },
- "list": {
- "response": {
- "$ref": "ListDatabasesResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "GET",
- "parameters": {
- "parent": {
- "description": "Required. The instance whose databases should be listed.\nValues are of the form `projects/\u003cproject\u003e/instances/\u003cinstance\u003e`.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/instances/[^/]+$",
- "location": "path"
- },
- "pageToken": {
- "description": "If non-empty, `page_token` should contain a\nnext_page_token from a\nprevious ListDatabasesResponse.",
- "type": "string",
- "location": "query"
- },
- "pageSize": {
- "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",
- "location": "query"
- }
- },
- "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",
- "description": "Lists Cloud Spanner databases."
- },
- "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": {
- "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"
- }
- },
- "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}:setIamPolicy",
- "path": "v1/{+resource}:setIamPolicy",
- "id": "spanner.projects.instances.databases.setIamPolicy",
- "description": "Sets the access control policy on a database resource. Replaces any\nexisting policy.\n\nAuthorization requires `spanner.databases.setIamPolicy` permission on\nresource.",
- "request": {
- "$ref": "SetIamPolicyRequest"
- }
- },
- "create": {
- "request": {
- "$ref": "CreateDatabaseRequest"
- },
- "description": "Creates a new Cloud Spanner database and starts to prepare it for serving.\nThe returned long-running operation will\nhave a name of the format `\u003cdatabase_name\u003e/operations/\u003coperation_id\u003e` and\ncan be used to track preparation of the database. The\nmetadata field type is\nCreateDatabaseMetadata. The\nresponse field type is\nDatabase, if successful.",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "POST",
- "parameters": {
- "parent": {
- "pattern": "^projects/[^/]+/instances/[^/]+$",
- "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"
- }
- },
- "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.create"
- }
- },
- "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": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/operations/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/spanner.admin"
- ],
- "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/operations/{operationsId}:cancel",
- "path": "v1/{+name}:cancel",
- "id": "spanner.projects.instances.databases.operations.cancel",
- "description": "Starts asynchronous cancellation on a long-running operation. The server\nmakes a best effort to cancel the operation, but success is not\nguaranteed. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`. Clients can use\nOperations.GetOperation or\nother methods to check whether the cancellation succeeded or whether the\noperation completed despite cancellation. On successful cancellation,\nthe operation is not deleted; instead, it becomes an operation with\nan Operation.error value with a google.rpc.Status.code of 1,\ncorresponding to `Code.CANCELLED`."
- },
- "delete": {
- "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/[^/]+/databases/[^/]+/operations/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/operations/{operationsId}",
- "path": "v1/{+name}",
- "id": "spanner.projects.instances.databases.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": {
- "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"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/spanner.admin"
- ],
- "parameters": {
- "filter": {
- "description": "The standard list filter.",
- "type": "string",
- "location": "query"
- },
- "name": {
- "description": "The name of the operation's parent resource.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/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"
- }
- },
- "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/operations"
- },
- "get": {
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/spanner.admin"
- ],
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/operations/[^/]+$",
- "location": "path",
- "description": "The name of the operation resource.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/operations/{operationsId}",
- "path": "v1/{+name}",
- "id": "spanner.projects.instances.databases.operations.get",
- "description": "Gets the latest state of a long-running operation. Clients can use this\nmethod to poll the operation result at intervals as recommended by the API\nservice."
- }
- }
- },
- "sessions": {
- "methods": {
- "delete": {
- "description": "Ends a session, releasing server resources associated with it.",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "DELETE",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/spanner.data"
- ],
- "parameters": {
- "name": {
- "description": "Required. The name of the session to delete.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/sessions/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions/{sessionsId}",
- "path": "v1/{+name}",
- "id": "spanner.projects.instances.databases.sessions.delete"
- },
- "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"
- },
- "response": {
- "$ref": "CommitResponse"
- },
- "parameterOrder": [
- "session"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/spanner.data"
- ],
- "parameters": {
- "session": {
- "description": "Required. The session in which the transaction to be committed is running.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/sessions/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions/{sessionsId}:commit",
- "path": "v1/{+session}:commit",
- "id": "spanner.projects.instances.databases.sessions.commit"
- },
- "beginTransaction": {
- "response": {
- "$ref": "Transaction"
- },
- "parameterOrder": [
- "session"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/spanner.data"
- ],
- "parameters": {
- "session": {
- "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/sessions/[^/]+$",
- "location": "path",
- "description": "Required. The session in which the transaction runs.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions/{sessionsId}:beginTransaction",
- "path": "v1/{+session}:beginTransaction",
- "id": "spanner.projects.instances.databases.sessions.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"
- }
- },
- "executeStreamingSql": {
- "response": {
- "$ref": "PartialResultSet"
- },
- "parameterOrder": [
- "session"
- ],
- "httpMethod": "POST",
- "parameters": {
- "session": {
- "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/sessions/[^/]+$",
- "location": "path",
- "description": "Required. The session in which the SQL query should be performed.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/spanner.data"
- ],
- "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions/{sessionsId}:executeStreamingSql",
- "path": "v1/{+session}:executeStreamingSql",
- "id": "spanner.projects.instances.databases.sessions.executeStreamingSql",
- "request": {
- "$ref": "ExecuteSqlRequest"
- },
- "description": "Like ExecuteSql, except returns the result\nset as a stream. Unlike ExecuteSql, there\nis no limit on the size of the returned result set. However, no\nindividual row in the result set can exceed 100 MiB, and no\ncolumn value can exceed 10 MiB."
- },
- "executeSql": {
- "id": "spanner.projects.instances.databases.sessions.executeSql",
- "path": "v1/{+session}: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",
- "parameterOrder": [
- "session"
- ],
- "response": {
- "$ref": "ResultSet"
- },
- "parameters": {
- "session": {
- "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/sessions/[^/]+$",
- "location": "path",
- "description": "Required. The session in which the SQL query should be performed.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/spanner.data"
- ],
- "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions/{sessionsId}:executeSql"
- },
- "list": {
- "description": "Lists all sessions in a given database.",
- "response": {
- "$ref": "ListSessionsResponse"
- },
- "parameterOrder": [
- "database"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/spanner.data"
- ],
- "parameters": {
- "database": {
- "description": "Required. The database in which to list sessions.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+$",
- "location": "path"
- },
- "filter": {
- "description": "An expression for filtering the results of the request. Filter rules are\ncase insensitive. The fields eligible for filtering are:\n\n * `labels.key` where key is the name of a label\n\nSome examples of using filters are:\n\n * `labels.env:*` --\u003e The session has the label \"env\".\n * `labels.env:dev` --\u003e The session has the label \"env\" and the value of\n the label contains the string \"dev\".",
- "type": "string",
- "location": "query"
- },
- "pageToken": {
- "description": "If non-empty, `page_token` should contain a\nnext_page_token from a previous\nListSessionsResponse.",
- "type": "string",
- "location": "query"
- },
- "pageSize": {
- "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"
- }
- },
- "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions",
- "path": "v1/{+database}/sessions",
- "id": "spanner.projects.instances.databases.sessions.list"
- },
- "streamingRead": {
- "httpMethod": "POST",
- "parameterOrder": [
- "session"
- ],
- "response": {
- "$ref": "PartialResultSet"
- },
- "parameters": {
- "session": {
- "description": "Required. The session in which the read should be performed.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/sessions/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/spanner.data"
- ],
- "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions/{sessionsId}:streamingRead",
- "id": "spanner.projects.instances.databases.sessions.streamingRead",
- "path": "v1/{+session}:streamingRead",
- "request": {
- "$ref": "ReadRequest"
- },
- "description": "Like Read, except returns the result set as a\nstream. Unlike Read, there is no limit on the\nsize of the returned result set. However, no individual row in\nthe result set can exceed 100 MiB, and no column value can exceed\n10 MiB."
- },
- "rollback": {
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "session"
- ],
- "httpMethod": "POST",
- "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 roll back is running.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/sessions/[^/]+$",
- "location": "path"
- }
- },
- "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"
- }
- },
- "create": {
- "description": "Creates a new session. A session can be used to perform\ntransactions that read and/or modify data in a Cloud Spanner database.\nSessions are meant to be reused for many consecutive\ntransactions.\n\nSessions can only execute one transaction at a time. To execute\nmultiple concurrent read-write/write-only transactions, create\nmultiple sessions. Note that standalone reads and queries use a\ntransaction internally, and count toward the one transaction\nlimit.\n\nCloud Spanner limits the number of sessions that can exist at any given\ntime; thus, it is a good idea to delete idle and/or unneeded sessions.\nAside from explicit deletes, Cloud Spanner can delete sessions for which no\noperations are sent for more than an hour. If a session is deleted,\nrequests to it return `NOT_FOUND`.\n\nIdle sessions can be kept alive by sending a trivial SQL query\nperiodically, e.g., `\"SELECT 1\"`.",
- "request": {
- "$ref": "CreateSessionRequest"
- },
- "response": {
- "$ref": "Session"
- },
- "parameterOrder": [
- "database"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/spanner.data"
- ],
- "parameters": {
- "database": {
- "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"
- },
- "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"
- },
- "parameterOrder": [
- "session"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/spanner.data"
- ],
- "parameters": {
- "session": {
- "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/sessions/[^/]+$",
- "location": "path",
- "description": "Required. The session in which the read should be performed.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions/{sessionsId}:read"
- },
- "get": {
- "httpMethod": "GET",
- "response": {
- "$ref": "Session"
- },
- "parameterOrder": [
- "name"
- ],
- "parameters": {
- "name": {
- "description": "Required. The name of the session to retrieve.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/sessions/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/spanner.data"
- ],
- "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions/{sessionsId}",
- "id": "spanner.projects.instances.databases.sessions.get",
- "path": "v1/{+name}",
- "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."
- }
- }
- }
- }
- },
- "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/spanner.admin"
- ],
- "parameters": {
- "name": {
- "description": "The name of the operation resource to be cancelled.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/instances/[^/]+/operations/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/operations/{operationsId}:cancel",
- "path": "v1/{+name}:cancel",
- "id": "spanner.projects.instances.operations.cancel"
- },
- "delete": {
- "httpMethod": "DELETE",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "name"
- ],
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/instances/[^/]+/operations/[^/]+$",
- "location": "path",
- "description": "The name of the operation resource to be deleted.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/spanner.admin"
- ],
- "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/operations/{operationsId}",
- "id": "spanner.projects.instances.operations.delete",
- "path": "v1/{+name}",
- "description": "Deletes a long-running operation. This method indicates that the client is\nno longer interested in the operation result. It does not cancel the\noperation. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`."
- },
- "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": {
- "pattern": "^projects/[^/]+/instances/[^/]+/operations$",
- "location": "path",
- "description": "The name of the operation's parent resource.",
- "required": true,
- "type": "string"
- },
- "pageToken": {
- "description": "The standard list page token.",
- "type": "string",
- "location": "query"
- },
- "pageSize": {
- "description": "The standard list page size.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- },
- "filter": {
- "location": "query",
- "description": "The standard list filter.",
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/spanner.admin"
- ],
- "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/operations",
- "id": "spanner.projects.instances.operations.list",
- "path": "v1/{+name}"
- },
- "get": {
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/spanner.admin"
- ],
- "parameters": {
- "name": {
- "description": "The name of the operation resource.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/instances/[^/]+/operations/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/operations/{operationsId}",
- "path": "v1/{+name}",
- "id": "spanner.projects.instances.operations.get",
- "description": "Gets the latest state of a long-running operation. Clients can use this\nmethod to poll the operation result at intervals as recommended by the API\nservice."
- }
- }
- }
- },
- "methods": {
- "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"
- },
- "response": {
- "$ref": "TestIamPermissionsResponse"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/spanner.admin"
- ],
- "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"
- }
- },
- "flatPath": "v1/projects/{projectsId}/instances/{instancesId}:testIamPermissions"
- },
- "delete": {
- "id": "spanner.projects.instances.delete",
- "path": "v1/{+name}",
- "description": "Deletes an instance.\n\nImmediately upon completion of the request:\n\n * Billing ceases for all of the instance's reserved resources.\n\nSoon afterward:\n\n * The instance and *all of its databases* immediately and\n irrevocably disappear from the API. All data in the databases\n is permanently deleted.",
- "httpMethod": "DELETE",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "name"
- ],
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/instances/[^/]+$",
- "location": "path",
- "description": "Required. The name of the instance to be deleted. Values are of the form\n`projects/\u003cproject\u003e/instances/\u003cinstance\u003e`",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/spanner.admin"
- ],
- "flatPath": "v1/projects/{projectsId}/instances/{instancesId}"
- },
- "list": {
- "httpMethod": "GET",
- "response": {
- "$ref": "ListInstancesResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "parameters": {
- "pageToken": {
- "location": "query",
- "description": "If non-empty, `page_token` should contain a\nnext_page_token from a\nprevious ListInstancesResponse.",
- "type": "string"
- },
- "pageSize": {
- "location": "query",
- "description": "Number of instances to be returned in the response. If 0 or less, defaults\nto the server's maximum allowed page size.",
- "format": "int32",
- "type": "integer"
- },
- "parent": {
- "description": "Required. The name of the project for which a list of instances is\nrequested. Values are of the form `projects/\u003cproject\u003e`.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+$",
- "location": "path"
- },
- "filter": {
- "location": "query",
- "description": "An expression for filtering the results of the request. Filter rules are\ncase insensitive. The fields eligible for filtering are:\n\n * `name`\n * `display_name`\n * `labels.key` where key is the name of a label\n\nSome examples of using filters are:\n\n * `name:*` --\u003e The instance has a name.\n * `name:Howl` --\u003e The instance's name contains the string \"howl\".\n * `name:HOWL` --\u003e Equivalent to above.\n * `NAME:howl` --\u003e Equivalent to above.\n * `labels.env:*` --\u003e The instance has the label \"env\".\n * `labels.env:dev` --\u003e The instance has the label \"env\" and the value of\n the label contains the string \"dev\".\n * `name:howl labels.env:dev` --\u003e The instance's name contains \"howl\" and\n it has the label \"env\" with its value\n containing \"dev\".",
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/spanner.admin"
- ],
- "flatPath": "v1/projects/{projectsId}/instances",
- "id": "spanner.projects.instances.list",
- "path": "v1/{+parent}/instances",
- "description": "Lists all instances in the given project."
- },
- "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.",
- "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"
- },
- "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.",
- "httpMethod": "POST",
- "parameterOrder": [
- "parent"
- ],
- "response": {
- "$ref": "Operation"
- },
- "parameters": {
- "parent": {
- "pattern": "^projects/[^/]+$",
- "location": "path",
- "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"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/spanner.admin"
- ],
- "flatPath": "v1/projects/{projectsId}/instances",
- "id": "spanner.projects.instances.create",
- "path": "v1/{+parent}/instances"
- },
- "getIamPolicy": {
- "httpMethod": "POST",
- "parameterOrder": [
- "resource"
- ],
- "response": {
- "$ref": "Policy"
- },
- "parameters": {
- "resource": {
- "pattern": "^projects/[^/]+/instances/[^/]+$",
- "location": "path",
- "description": "REQUIRED: The Cloud Spanner resource for which the policy is being retrieved. The format is `projects/\u003cproject ID\u003e/instances/\u003cinstance ID\u003e` for instance resources and `projects/\u003cproject ID\u003e/instances/\u003cinstance ID\u003e/databases/\u003cdatabase ID\u003e` for database resources.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/spanner.admin"
- ],
- "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": {
- "response": {
- "$ref": "Instance"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/spanner.admin"
- ],
- "parameters": {
- "name": {
- "description": "Required. The name of the requested instance. Values are of the form\n`projects/\u003cproject\u003e/instances/\u003cinstance\u003e`.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/instances/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1/projects/{projectsId}/instances/{instancesId}",
- "path": "v1/{+name}",
- "id": "spanner.projects.instances.get",
- "description": "Gets information about a particular instance."
- },
- "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"
- },
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "PATCH",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/spanner.admin"
- ],
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/instances/[^/]+$",
- "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"
- }
- },
- "flatPath": "v1/projects/{projectsId}/instances/{instancesId}",
- "path": "v1/{+name}",
- "id": "spanner.projects.instances.patch"
- }
- }
- }
- }
- }
- },
- "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": {
- "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"
- },
- "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"
- }
- },
- "version": "v1",
- "baseUrl": "https://spanner.googleapis.com/"
+ "title": "Cloud Spanner API"
}
diff --git a/speech/v1/speech-api.json b/speech/v1/speech-api.json
index 217e200..71082dd 100644
--- a/speech/v1/speech-api.json
+++ b/speech/v1/speech-api.json
@@ -1,22 +1,67 @@
{
+ "rootUrl": "https://speech.googleapis.com/",
+ "ownerDomain": "google.com",
+ "name": "speech",
+ "batchPath": "batch",
+ "title": "Google Cloud Speech API",
+ "ownerName": "Google",
"resources": {
- "operations": {
+ "speech": {
"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"
- },
+ "longrunningrecognize": {
"response": {
- "$ref": "Empty"
+ "$ref": "Operation"
},
- "parameterOrder": [
- "name"
- ],
+ "parameterOrder": [],
"httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
+ "parameters": {},
+ "flatPath": "v1/speech:longrunningrecognize",
+ "path": "v1/speech:longrunningrecognize",
+ "id": "speech.speech.longrunningrecognize",
+ "description": "Performs asynchronous speech recognition: receive results via the\ngoogle.longrunning.Operations interface. Returns either an\n`Operation.error` or an `Operation.response` which contains\na `LongRunningRecognizeResponse` message.",
+ "request": {
+ "$ref": "LongRunningRecognizeRequest"
+ }
+ },
+ "recognize": {
+ "flatPath": "v1/speech:recognize",
+ "id": "speech.speech.recognize",
+ "path": "v1/speech:recognize",
+ "request": {
+ "$ref": "RecognizeRequest"
+ },
+ "description": "Performs synchronous speech recognition: receive results after all audio\nhas been sent and processed.",
+ "httpMethod": "POST",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "RecognizeResponse"
+ },
+ "parameters": {},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ }
+ }
+ },
+ "operations": {
+ "methods": {
+ "cancel": {
+ "id": "speech.operations.cancel",
+ "path": "v1/operations/{+name}:cancel",
+ "request": {
+ "$ref": "CancelOperationRequest"
+ },
+ "description": "Starts asynchronous cancellation on a long-running operation. The server\nmakes a best effort to cancel the operation, but success is not\nguaranteed. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`. Clients can use\nOperations.GetOperation or\nother methods to check whether the cancellation succeeded or whether the\noperation completed despite cancellation. On successful cancellation,\nthe operation is not deleted; instead, it becomes an operation with\nan Operation.error value with a google.rpc.Status.code of 1,\ncorresponding to `Code.CANCELLED`.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Empty"
+ },
"parameters": {
"name": {
"location": "path",
@@ -26,13 +71,12 @@
"pattern": "^[^/]+$"
}
},
- "flatPath": "v1/operations/{operationsId}:cancel",
- "path": "v1/operations/{+name}:cancel",
- "id": "speech.operations.cancel"
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/operations/{operationsId}:cancel"
},
"delete": {
- "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"
@@ -43,17 +87,19 @@
"httpMethod": "DELETE",
"parameters": {
"name": {
- "location": "path",
"description": "The name of the operation resource to be deleted.",
"required": true,
"type": "string",
- "pattern": "^[^/]+$"
+ "pattern": "^[^/]+$",
+ "location": "path"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
- "flatPath": "v1/operations/{operationsId}"
+ "flatPath": "v1/operations/{operationsId}",
+ "path": "v1/operations/{+name}",
+ "id": "speech.operations.delete"
},
"list": {
"description": "Lists operations that match the specified filter in the request. If the\nserver doesn't support this method, it returns `UNIMPLEMENTED`.\n\nNOTE: the `name` binding allows API services to override the binding\nto use different resource name schemes, such as `users/*/operations`. To\noverride the binding, API services can add a binding such as\n`\"/v1/{name=users/*}/operations\"` to their service configuration.\nFor backwards compatibility, the default name includes the operations\ncollection id, however overriding users must ensure the name binding\nis the parent resource, without the operations collection id.",
@@ -64,10 +110,10 @@
"httpMethod": "GET",
"parameters": {
"pageSize": {
- "location": "query",
"description": "The standard list page size.",
"format": "int32",
- "type": "integer"
+ "type": "integer",
+ "location": "query"
},
"filter": {
"location": "query",
@@ -80,9 +126,9 @@
"location": "query"
},
"pageToken": {
- "location": "query",
"description": "The standard list page token.",
- "type": "string"
+ "type": "string",
+ "location": "query"
}
},
"scopes": [
@@ -93,110 +139,39 @@
"id": "speech.operations.list"
},
"get": {
- "httpMethod": "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": "^[^/]+$",
"location": "path",
"description": "The name of the operation resource.",
"required": true,
- "type": "string",
- "pattern": "^[^/]+$"
+ "type": "string"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
"flatPath": "v1/operations/{operationsId}",
- "id": "speech.operations.get",
"path": "v1/operations/{+name}",
- "description": "Gets the latest state of a long-running operation. Clients can use this\nmethod to poll the operation result at intervals as recommended by the API\nservice."
- }
- }
- },
- "speech": {
- "methods": {
- "longrunningrecognize": {
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "parameters": {},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/speech:longrunningrecognize",
- "path": "v1/speech:longrunningrecognize",
- "id": "speech.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"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {},
- "flatPath": "v1/speech:recognize"
+ "id": "speech.operations.get"
}
}
}
},
"parameters": {
- "alt": {
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query",
- "description": "Data format for response.",
- "default": "json",
- "enum": [
- "json",
- "media",
- "proto"
- ],
- "type": "string"
- },
- "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"
+ "default": "true",
+ "location": "query"
},
"bearer_token": {
"location": "query",
@@ -204,37 +179,39 @@
"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"
},
- "upload_protocol": {
- "location": "query",
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string"
- },
"prettyPrint": {
+ "location": "query",
"description": "Returns response with indentations and line breaks.",
"type": "boolean",
- "default": "true",
+ "default": "true"
+ },
+ "uploadType": {
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string",
"location": "query"
},
"fields": {
- "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"
},
"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"
@@ -243,178 +220,52 @@
"enum": [
"1",
"2"
+ ]
+ },
+ "alt": {
+ "description": "Data format for response.",
+ "default": "json",
+ "enum": [
+ "json",
+ "media",
+ "proto"
],
- "description": "V1 error format.",
+ "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": {
+ "description": "Available 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": "v1",
"baseUrl": "https://speech.googleapis.com/",
- "servicePath": "",
- "description": "Converts audio to text by applying powerful neural network models.",
"kind": "discovery#restDescription",
+ "description": "Converts audio to text by applying powerful neural network models.",
+ "servicePath": "",
"basePath": "",
"id": "speech:v1",
- "documentationLink": "https://cloud.google.com/speech/",
"revision": "20180102",
+ "documentationLink": "https://cloud.google.com/speech/",
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
- "CancelOperationRequest": {
- "description": "The request message for Operations.CancelOperation.",
- "type": "object",
- "properties": {},
- "id": "CancelOperationRequest"
- },
- "Operation": {
- "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
- "type": "object",
- "properties": {
- "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"
- },
- "RecognitionConfig": {
- "description": "Provides information to the recognizer that specifies how to process the\nrequest.",
- "type": "object",
- "properties": {
- "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"
- },
- "maxAlternatives": {
- "description": "*Optional* Maximum number of recognition hypotheses to be returned.\nSpecifically, the maximum number of `SpeechRecognitionAlternative` messages\nwithin each `SpeechRecognitionResult`.\nThe server may return fewer than `max_alternatives`.\nValid values are `0`-`30`. A value of `0` or `1` will return a maximum of\none. If omitted, will return a maximum of one.",
- "format": "int32",
- "type": "integer"
- },
- "languageCode": {
- "description": "*Required* The language of the supplied audio as a\n[BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag.\nExample: \"en-US\".\nSee [Language Support](https://cloud.google.com/speech/docs/languages)\nfor a list of the currently supported language codes.",
- "type": "string"
- },
- "profanityFilter": {
- "description": "*Optional* If set to `true`, the server will attempt to filter out\nprofanities, replacing all but the initial character in each filtered word\nwith asterisks, e.g. \"f***\". If set to `false` or omitted, profanities\nwon't be filtered out.",
- "type": "boolean"
- },
- "encoding": {
- "enumDescriptions": [
- "Not specified.",
- "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",
- "FLAC",
- "MULAW",
- "AMR",
- "AMR_WB",
- "OGG_OPUS",
- "SPEEX_WITH_HEADER_BYTE"
- ],
- "description": "*Required* Encoding of audio data sent in all `RecognitionAudio` messages.",
- "type": "string"
- },
- "speechContexts": {
- "description": "*Optional* A means to provide context to assist the speech recognition.",
- "type": "array",
- "items": {
- "$ref": "SpeechContext"
- }
- },
- "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"
- },
- "WordInfo": {
- "description": "Word-specific information for recognized words. Word information is only\nincluded in the response when certain request parameters are set, such\nas `enable_word_time_offsets`.",
- "type": "object",
- "properties": {
- "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",
- "type": "string"
- },
- "startTime": {
- "description": "*Output-only* Time offset relative to the beginning of the audio,\nand corresponding to the start of the spoken word.\nThis field is only set if `enable_word_time_offsets=true` and only\nin the top hypothesis.\nThis is an experimental feature and the accuracy of the time offset can\nvary.",
- "format": "google-duration",
- "type": "string"
- },
- "word": {
- "description": "*Output-only* The word corresponding to this set of information.",
- "type": "string"
- }
- },
- "id": "WordInfo"
- },
- "Status": {
- "properties": {
- "code": {
- "description": "The status code, which should be an enum value of google.rpc.Code.",
- "format": "int32",
- "type": "integer"
- },
- "message": {
- "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
- "type": "string"
- },
- "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",
- "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"
- },
- "Empty": {
- "properties": {},
- "id": "Empty",
- "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
- "type": "object"
- },
"RecognizeRequest": {
"description": "The top-level message sent by the client for the `Recognize` method.",
"type": "object",
@@ -430,38 +281,6 @@
},
"id": "RecognizeRequest"
},
- "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": {
"properties": {
"confidence": {
@@ -485,7 +304,41 @@
"description": "Alternative hypotheses (a.k.a. n-best list).",
"type": "object"
},
+ "ListOperationsResponse": {
+ "description": "The response message for Operations.ListOperations.",
+ "type": "object",
+ "properties": {
+ "nextPageToken": {
+ "description": "The standard List next-page token.",
+ "type": "string"
+ },
+ "operations": {
+ "description": "A list of operations that matches the specified filter in the request.",
+ "type": "array",
+ "items": {
+ "$ref": "Operation"
+ }
+ }
+ },
+ "id": "ListOperationsResponse"
+ },
+ "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"
+ },
"SpeechRecognitionResult": {
+ "description": "A speech recognition result corresponding to a portion of the audio.",
+ "type": "object",
"properties": {
"channelTag": {
"description": "For multi-channel audio, this is the channel number corresponding to the\nrecognized result for the audio from that channel.\nFor audio_channel_count = N, its output values can range from '0' to 'N-1'.",
@@ -500,9 +353,7 @@
}
}
},
- "id": "SpeechRecognitionResult",
- "description": "A speech recognition result corresponding to a portion of the audio.",
- "type": "object"
+ "id": "SpeechRecognitionResult"
},
"RecognitionAudio": {
"description": "Contains audio data in the encoding specified in the `RecognitionConfig`.\nEither `content` or `uri` must be supplied. Supplying both or neither\nreturns google.rpc.Code.INVALID_ARGUMENT. See\n[audio limits](https://cloud.google.com/speech/limits#content).",
@@ -536,8 +387,6 @@
"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.",
@@ -547,7 +396,164 @@
}
}
},
- "id": "RecognizeResponse"
+ "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"
+ },
+ "CancelOperationRequest": {
+ "description": "The request message for Operations.CancelOperation.",
+ "type": "object",
+ "properties": {},
+ "id": "CancelOperationRequest"
+ },
+ "Operation": {
+ "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
+ "type": "object",
+ "properties": {
+ "error": {
+ "$ref": "Status",
+ "description": "The error result of the operation in case of failure or cancellation."
+ },
+ "metadata": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "description": "Service-specific metadata associated with the operation. It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata. Any method that returns a\nlong-running operation should document the metadata type, if any.",
+ "type": "object"
+ },
+ "done": {
+ "description": "If the value is `false`, it means the operation is still in progress.\nIf `true`, the operation is completed, and either `error` or `response` is\navailable.",
+ "type": "boolean"
+ },
+ "response": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "description": "The normal response of the operation in case of success. If the original\nmethod returns no data on success, such as `Delete`, the response is\n`google.protobuf.Empty`. If the original method is standard\n`Get`/`Create`/`Update`, the response should be the resource. For other\nmethods, the response should have the type `XxxResponse`, where `Xxx`\nis the original method name. For example, if the original method name\nis `TakeSnapshot()`, the inferred response type is\n`TakeSnapshotResponse`.",
+ "type": "object"
+ },
+ "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"
+ },
+ "RecognitionConfig": {
+ "description": "Provides information to the recognizer that specifies how to process the\nrequest.",
+ "type": "object",
+ "properties": {
+ "maxAlternatives": {
+ "description": "*Optional* Maximum number of recognition hypotheses to be returned.\nSpecifically, the maximum number of `SpeechRecognitionAlternative` messages\nwithin each `SpeechRecognitionResult`.\nThe server may return fewer than `max_alternatives`.\nValid values are `0`-`30`. A value of `0` or `1` will return a maximum of\none. If omitted, will return a maximum of one.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "languageCode": {
+ "description": "*Required* The language of the supplied audio as a\n[BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag.\nExample: \"en-US\".\nSee [Language Support](https://cloud.google.com/speech/docs/languages)\nfor a list of the currently supported language codes.",
+ "type": "string"
+ },
+ "profanityFilter": {
+ "description": "*Optional* If set to `true`, the server will attempt to filter out\nprofanities, replacing all but the initial character in each filtered word\nwith asterisks, e.g. \"f***\". If set to `false` or omitted, profanities\nwon't be filtered out.",
+ "type": "boolean"
+ },
+ "speechContexts": {
+ "description": "*Optional* A means to provide context to assist the speech recognition.",
+ "type": "array",
+ "items": {
+ "$ref": "SpeechContext"
+ }
+ },
+ "encoding": {
+ "enumDescriptions": [
+ "Not specified.",
+ "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",
+ "FLAC",
+ "MULAW",
+ "AMR",
+ "AMR_WB",
+ "OGG_OPUS",
+ "SPEEX_WITH_HEADER_BYTE"
+ ],
+ "description": "*Required* Encoding of audio data sent in all `RecognitionAudio` messages.",
+ "type": "string"
+ },
+ "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"
+ }
+ },
+ "id": "RecognitionConfig"
+ },
+ "WordInfo": {
+ "description": "Word-specific information for recognized words. Word information is only\nincluded in the response when certain request parameters are set, such\nas `enable_word_time_offsets`.",
+ "type": "object",
+ "properties": {
+ "startTime": {
+ "description": "*Output-only* Time offset relative to the beginning of the audio,\nand corresponding to the start of the spoken word.\nThis field is only set if `enable_word_time_offsets=true` and only\nin the top hypothesis.\nThis is an experimental feature and the accuracy of the time offset can\nvary.",
+ "format": "google-duration",
+ "type": "string"
+ },
+ "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",
+ "type": "string"
+ }
+ },
+ "id": "WordInfo"
+ },
+ "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"
+ },
+ "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"
}
},
"icons": {
@@ -564,11 +570,5 @@
}
}
}
- },
- "rootUrl": "https://speech.googleapis.com/",
- "ownerDomain": "google.com",
- "name": "speech",
- "batchPath": "batch",
- "title": "Google Cloud Speech API",
- "ownerName": "Google"
+ }
}
diff --git a/speech/v1beta1/speech-api.json b/speech/v1beta1/speech-api.json
index bbbe903..17e1393 100644
--- a/speech/v1beta1/speech-api.json
+++ b/speech/v1beta1/speech-api.json
@@ -1,250 +1,4 @@
{
- "resources": {
- "operations": {
- "methods": {
- "list": {
- "description": "Lists operations that match the specified filter in the request. If the\nserver doesn't support this method, it returns `UNIMPLEMENTED`.\n\nNOTE: the `name` binding allows API services to override the binding\nto use different resource name schemes, such as `users/*/operations`. To\noverride the binding, API services can add a binding such as\n`\"/v1/{name=users/*}/operations\"` to their service configuration.\nFor backwards compatibility, the default name includes the operations\ncollection id, however overriding users must ensure the name binding\nis the parent resource, without the operations collection id.",
- "response": {
- "$ref": "ListOperationsResponse"
- },
- "parameterOrder": [],
- "httpMethod": "GET",
- "parameters": {
- "name": {
- "location": "query",
- "description": "The name of the operation's parent resource.",
- "type": "string"
- },
- "pageToken": {
- "location": "query",
- "description": "The standard list page token.",
- "type": "string"
- },
- "pageSize": {
- "description": "The standard list page size.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- },
- "filter": {
- "location": "query",
- "description": "The standard list filter.",
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta1/operations",
- "path": "v1beta1/operations",
- "id": "speech.operations.list"
- },
- "get": {
- "path": "v1beta1/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.",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "parameters": {
- "name": {
- "pattern": "^[^/]+$",
- "location": "path",
- "description": "The name of the operation resource.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta1/operations/{operationsId}"
- },
- "cancel": {
- "flatPath": "v1beta1/operations/{operationsId}:cancel",
- "path": "v1beta1/operations/{+name}:cancel",
- "id": "speech.operations.cancel",
- "description": "Starts asynchronous cancellation on a long-running operation. The server\nmakes a best effort to cancel the operation, but success is not\nguaranteed. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`. Clients can use\nOperations.GetOperation or\nother methods to check whether the cancellation succeeded or whether the\noperation completed despite cancellation. On successful cancellation,\nthe operation is not deleted; instead, it becomes an operation with\nan Operation.error value with a google.rpc.Status.code of 1,\ncorresponding to `Code.CANCELLED`.",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "POST",
- "parameters": {
- "name": {
- "location": "path",
- "description": "The name of the operation resource to be cancelled.",
- "required": true,
- "type": "string",
- "pattern": "^[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- },
- "delete": {
- "httpMethod": "DELETE",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "name"
- ],
- "parameters": {
- "name": {
- "location": "path",
- "description": "The name of the operation resource to be deleted.",
- "required": true,
- "type": "string",
- "pattern": "^[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta1/operations/{operationsId}",
- "id": "speech.operations.delete",
- "path": "v1beta1/operations/{+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`."
- }
- }
- },
- "speech": {
- "methods": {
- "syncrecognize": {
- "response": {
- "$ref": "SyncRecognizeResponse"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {},
- "flatPath": "v1beta1/speech:syncrecognize",
- "path": "v1beta1/speech:syncrecognize",
- "id": "speech.speech.syncrecognize",
- "description": "Performs synchronous speech recognition: receive results after all audio\nhas been sent and processed.",
- "request": {
- "$ref": "SyncRecognizeRequest"
- }
- },
- "asyncrecognize": {
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "parameters": {},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta1/speech:asyncrecognize",
- "path": "v1beta1/speech:asyncrecognize",
- "id": "speech.speech.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."
- }
- }
- }
- },
- "parameters": {
- "quotaUser": {
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string",
- "location": "query"
- },
- "pp": {
- "location": "query",
- "description": "Pretty-print response.",
- "type": "boolean",
- "default": "true"
- },
- "oauth_token": {
- "description": "OAuth 2.0 token for the current user.",
- "type": "string",
- "location": "query"
- },
- "bearer_token": {
- "location": "query",
- "description": "OAuth bearer token.",
- "type": "string"
- },
- "upload_protocol": {
- "location": "query",
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string"
- },
- "prettyPrint": {
- "location": "query",
- "description": "Returns response with indentations and line breaks.",
- "type": "boolean",
- "default": "true"
- },
- "uploadType": {
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string",
- "location": "query"
- },
- "fields": {
- "location": "query",
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string"
- },
- "$.xgafv": {
- "description": "V1 error format.",
- "type": "string",
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query",
- "enum": [
- "1",
- "2"
- ]
- },
- "callback": {
- "description": "JSONP",
- "type": "string",
- "location": "query"
- },
- "alt": {
- "enum": [
- "json",
- "media",
- "proto"
- ],
- "type": "string",
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query",
- "description": "Data format for response.",
- "default": "json"
- },
- "access_token": {
- "location": "query",
- "description": "OAuth access token.",
- "type": "string"
- },
- "key": {
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string",
- "location": "query"
- }
- },
"version": "v1beta1",
"baseUrl": "https://speech.googleapis.com/",
"kind": "discovery#restDescription",
@@ -257,200 +11,15 @@
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
- "SyncRecognizeRequest": {
- "description": "The top-level message sent by the client for the `SyncRecognize` method.",
- "type": "object",
- "properties": {
- "config": {
- "$ref": "RecognitionConfig",
- "description": "*Required* Provides information to the recognizer that specifies how to\nprocess the request."
- },
- "audio": {
- "$ref": "RecognitionAudio",
- "description": "*Required* The audio data to be recognized."
- }
- },
- "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": {
- "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"
- },
- "SyncRecognizeResponse": {
- "description": "The only message returned to the client by `SyncRecognize`. method. It\ncontains the result as zero or more sequential `SpeechRecognitionResult`\nmessages.",
- "type": "object",
- "properties": {
- "results": {
- "description": "*Output-only* Sequential list of transcription results corresponding to\nsequential portions of audio.",
- "type": "array",
- "items": {
- "$ref": "SpeechRecognitionResult"
- }
- }
- },
- "id": "SyncRecognizeResponse"
- },
- "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"
- },
- "SpeechRecognitionAlternative": {
- "description": "Alternative hypotheses (a.k.a. n-best list).",
- "type": "object",
- "properties": {
- "confidence": {
- "description": "*Output-only* The confidence estimate between 0.0 and 1.0. A higher number\nindicates an estimated greater likelihood that the recognized words are\ncorrect. This field is typically provided only for the top hypothesis, and\nonly for `is_final=true` results. Clients should not rely on the\n`confidence` field as it is not guaranteed to be accurate, or even set, in\nany of the results.\nThe default of 0.0 is a sentinel value indicating `confidence` was not set.",
- "format": "float",
- "type": "number"
- },
- "transcript": {
- "description": "*Output-only* Transcript text representing the words that the user spoke.",
- "type": "string"
- }
- },
- "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": {
- "description": "The response message for Operations.ListOperations.",
- "type": "object",
- "properties": {
- "nextPageToken": {
- "description": "The standard List next-page token.",
- "type": "string"
- },
- "operations": {
- "description": "A list of operations that matches the specified filter in the request.",
- "type": "array",
- "items": {
- "$ref": "Operation"
- }
- }
- },
- "id": "ListOperationsResponse"
- },
- "SpeechRecognitionResult": {
- "description": "A speech recognition result corresponding to a portion of the audio.",
- "type": "object",
- "properties": {
- "alternatives": {
- "description": "*Output-only* May contain one or more recognition hypotheses (up to the\nmaximum specified in `max_alternatives`).",
- "type": "array",
- "items": {
- "$ref": "SpeechRecognitionAlternative"
- }
- }
- },
- "id": "SpeechRecognitionResult"
- },
- "AsyncRecognizeRequest": {
- "description": "The top-level message sent by the client for the `AsyncRecognize` method.",
- "type": "object",
- "properties": {
- "config": {
- "$ref": "RecognitionConfig",
- "description": "*Required* Provides information to the recognizer that specifies how to\nprocess the request."
- },
- "audio": {
- "description": "*Required* The audio data to be recognized.",
- "$ref": "RecognitionAudio"
- }
- },
- "id": "AsyncRecognizeRequest"
- },
- "RecognitionAudio": {
- "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",
- "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"
- },
- "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"
- },
"RecognitionConfig": {
"description": "Provides information to the recognizer that specifies how to process the\nrequest.",
"type": "object",
"properties": {
+ "maxAlternatives": {
+ "description": "*Optional* Maximum number of recognition hypotheses to be returned.\nSpecifically, the maximum number of `SpeechRecognitionAlternative` messages\nwithin each `SpeechRecognitionResult`.\nThe server may return fewer than `max_alternatives`.\nValid values are `0`-`30`. A value of `0` or `1` will return a maximum of\none. If omitted, will return a maximum of one.",
+ "format": "int32",
+ "type": "integer"
+ },
"sampleRate": {
"description": "*Required* Sample rate in Hertz of the audio data sent in all\n`RecognitionAudio` messages. Valid values are: 8000-48000.\n16000 is optimal. For best results, set the sampling rate of the audio\nsource to 16000 Hz. If that's not possible, use the native sample rate of\nthe audio source (instead of re-sampling).",
"format": "int32",
@@ -487,21 +56,206 @@
],
"description": "*Required* Encoding of audio data sent in all `RecognitionAudio` messages.",
"type": "string"
- },
- "maxAlternatives": {
- "description": "*Optional* Maximum number of recognition hypotheses to be returned.\nSpecifically, the maximum number of `SpeechRecognitionAlternative` messages\nwithin each `SpeechRecognitionResult`.\nThe server may return fewer than `max_alternatives`.\nValid values are `0`-`30`. A value of `0` or `1` will return a maximum of\none. If omitted, will return a maximum of one.",
- "format": "int32",
- "type": "integer"
}
},
"id": "RecognitionConfig"
+ },
+ "SyncRecognizeRequest": {
+ "properties": {
+ "config": {
+ "$ref": "RecognitionConfig",
+ "description": "*Required* Provides information to the recognizer that specifies how to\nprocess the request."
+ },
+ "audio": {
+ "description": "*Required* The audio data to be recognized.",
+ "$ref": "RecognitionAudio"
+ }
+ },
+ "id": "SyncRecognizeRequest",
+ "description": "The top-level message sent by the client for the `SyncRecognize` method.",
+ "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"
+ },
+ "SyncRecognizeResponse": {
+ "description": "The only message returned to the client by `SyncRecognize`. method. It\ncontains the result as zero or more sequential `SpeechRecognitionResult`\nmessages.",
+ "type": "object",
+ "properties": {
+ "results": {
+ "description": "*Output-only* Sequential list of transcription results corresponding to\nsequential portions of audio.",
+ "type": "array",
+ "items": {
+ "$ref": "SpeechRecognitionResult"
+ }
+ }
+ },
+ "id": "SyncRecognizeResponse"
+ },
+ "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"
+ },
+ "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"
+ },
+ "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",
+ "properties": {
+ "confidence": {
+ "description": "*Output-only* The confidence estimate between 0.0 and 1.0. A higher number\nindicates an estimated greater likelihood that the recognized words are\ncorrect. This field is typically provided only for the top hypothesis, and\nonly for `is_final=true` results. Clients should not rely on the\n`confidence` field as it is not guaranteed to be accurate, or even set, in\nany of the results.\nThe default of 0.0 is a sentinel value indicating `confidence` was not set.",
+ "format": "float",
+ "type": "number"
+ },
+ "transcript": {
+ "description": "*Output-only* Transcript text representing the words that the user spoke.",
+ "type": "string"
+ }
+ },
+ "id": "SpeechRecognitionAlternative"
+ },
+ "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`).",
+ "type": "array",
+ "items": {
+ "$ref": "SpeechRecognitionAlternative"
+ }
+ }
+ },
+ "id": "SpeechRecognitionResult"
+ },
+ "RecognitionAudio": {
+ "description": "Contains audio data in the encoding specified in the `RecognitionConfig`.\nEither `content` or `uri` must be supplied. Supplying both or neither\nreturns google.rpc.Code.INVALID_ARGUMENT. See\n[audio limits](https://cloud.google.com/speech/limits#content).",
+ "type": "object",
+ "properties": {
+ "content": {
+ "description": "The audio data bytes encoded as specified in\n`RecognitionConfig`. Note: as with all bytes fields, protobuffers use a\npure binary representation, whereas JSON representations use base64.",
+ "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"
+ },
+ "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"
+ }
+ },
+ "id": "AsyncRecognizeRequest"
+ },
+ "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"
}
},
+ "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": "Speech",
"auth": {
"oauth2": {
@@ -517,5 +271,251 @@
"name": "speech",
"batchPath": "batch",
"title": "Google Cloud Speech API",
- "ownerName": "Google"
+ "ownerName": "Google",
+ "resources": {
+ "operations": {
+ "methods": {
+ "list": {
+ "description": "Lists operations that match the specified filter in the request. If the\nserver doesn't support this method, it returns `UNIMPLEMENTED`.\n\nNOTE: the `name` binding allows API services to override the binding\nto use different resource name schemes, such as `users/*/operations`. To\noverride the binding, API services can add a binding such as\n`\"/v1/{name=users/*}/operations\"` to their service configuration.\nFor backwards compatibility, the default name includes the operations\ncollection id, however overriding users must ensure the name binding\nis the parent resource, without the operations collection id.",
+ "response": {
+ "$ref": "ListOperationsResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "location": "query",
+ "description": "The name of the operation's parent resource.",
+ "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"
+ },
+ "filter": {
+ "description": "The standard list filter.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "flatPath": "v1beta1/operations",
+ "path": "v1beta1/operations",
+ "id": "speech.operations.list"
+ },
+ "get": {
+ "description": "Gets the latest state of a long-running operation. Clients can use this\nmethod to poll the operation result at intervals as recommended by the API\nservice.",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "name": {
+ "location": "path",
+ "description": "The name of the operation resource.",
+ "required": true,
+ "type": "string",
+ "pattern": "^[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta1/operations/{operationsId}",
+ "path": "v1beta1/operations/{+name}",
+ "id": "speech.operations.get"
+ },
+ "cancel": {
+ "flatPath": "v1beta1/operations/{operationsId}:cancel",
+ "path": "v1beta1/operations/{+name}:cancel",
+ "id": "speech.operations.cancel",
+ "description": "Starts asynchronous cancellation on a long-running operation. The server\nmakes a best effort to cancel the operation, but success is not\nguaranteed. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`. Clients can use\nOperations.GetOperation or\nother methods to check whether the cancellation succeeded or whether the\noperation completed despite cancellation. On successful cancellation,\nthe operation is not deleted; instead, it becomes an operation with\nan Operation.error value with a google.rpc.Status.code of 1,\ncorresponding to `Code.CANCELLED`.",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "POST",
+ "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"
+ ]
+ },
+ "delete": {
+ "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}",
+ "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`."
+ }
+ }
+ },
+ "speech": {
+ "methods": {
+ "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"
+ },
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {},
+ "flatPath": "v1beta1/speech:asyncrecognize",
+ "path": "v1beta1/speech:asyncrecognize",
+ "id": "speech.speech.asyncrecognize"
+ },
+ "syncrecognize": {
+ "response": {
+ "$ref": "SyncRecognizeResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {},
+ "flatPath": "v1beta1/speech:syncrecognize",
+ "path": "v1beta1/speech:syncrecognize",
+ "id": "speech.speech.syncrecognize",
+ "description": "Performs synchronous speech recognition: receive results after all audio\nhas been sent and processed.",
+ "request": {
+ "$ref": "SyncRecognizeRequest"
+ }
+ }
+ }
+ }
+ },
+ "parameters": {
+ "upload_protocol": {
+ "location": "query",
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "type": "string"
+ },
+ "prettyPrint": {
+ "location": "query",
+ "description": "Returns response with indentations and line breaks.",
+ "type": "boolean",
+ "default": "true"
+ },
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
+ "type": "string",
+ "location": "query"
+ },
+ "uploadType": {
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string",
+ "location": "query"
+ },
+ "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",
+ "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": {
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string",
+ "location": "query"
+ }
+ }
}
diff --git a/storage/v1/storage-api.json b/storage/v1/storage-api.json
index f1bfe21..595989a 100644
--- a/storage/v1/storage-api.json
+++ b/storage/v1/storage-api.json
@@ -23,7 +23,7 @@
"basePath": "/storage/v1/",
"rootUrl": "https://www.googleapis.com/",
"servicePath": "storage/v1/",
- "batchPath": "batch",
+ "batchPath": "batch/storage/v1",
"parameters": {
"alt": {
"type": "string",
diff --git a/storage/v1beta1/storage-api.json b/storage/v1beta1/storage-api.json
index 7adefa9..0749ed3 100644
--- a/storage/v1beta1/storage-api.json
+++ b/storage/v1beta1/storage-api.json
@@ -1,11 +1,11 @@
{
"kind": "discovery#restDescription",
- "etag": "\"YWOzh2SDasdU84ArJnpYek-OMdg/bcRJYHI3-5nsBo04628_tSK-f84\"",
+ "etag": "\"YWOzh2SDasdU84ArJnpYek-OMdg/MFBsd0cpXUnMtbb1xXb83mhHiCc\"",
"discoveryVersion": "v1",
"id": "storage:v1beta1",
"name": "storage",
"version": "v1beta1",
- "revision": "20170830",
+ "revision": "20171212",
"title": "Cloud Storage JSON API",
"description": "Lets you store and retrieve potentially-large, immutable data objects.",
"ownerDomain": "google.com",
@@ -23,7 +23,7 @@
"basePath": "/storage/v1beta1/",
"rootUrl": "https://www.googleapis.com/",
"servicePath": "storage/v1beta1/",
- "batchPath": "batch",
+ "batchPath": "batch/storage/v1beta1",
"parameters": {
"alt": {
"type": "string",
diff --git a/storagetransfer/v1/storagetransfer-api.json b/storagetransfer/v1/storagetransfer-api.json
index b977a14..e5da835 100644
--- a/storagetransfer/v1/storagetransfer-api.json
+++ b/storagetransfer/v1/storagetransfer-api.json
@@ -1,19 +1,47 @@
{
+ "revision": "20171221",
+ "documentationLink": "https://cloud.google.com/storage/transfer",
+ "id": "storagetransfer:v1",
"title": "Google Storage Transfer API",
"discoveryVersion": "v1",
"ownerName": "Google",
"version_module": true,
"resources": {
+ "googleServiceAccounts": {
+ "methods": {
+ "get": {
+ "description": "Returns the Google service account that is used by Storage Transfer\nService to access buckets in the project where transfers\nrun or in other projects. Each Google service account is associated\nwith one Google Cloud Platform Console project. Users\nshould add this service account to the Google Cloud Storage bucket\nACLs to grant access to Storage Transfer Service. This service\naccount is created and owned by Storage Transfer Service and can\nonly be used by Storage Transfer Service.",
+ "response": {
+ "$ref": "GoogleServiceAccount"
+ },
+ "parameterOrder": [
+ "projectId"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "projectId": {
+ "description": "The ID of the Google Cloud Platform Console project that the Google service\naccount is associated with.\nRequired.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/googleServiceAccounts/{projectId}",
+ "path": "v1/googleServiceAccounts/{projectId}",
+ "id": "storagetransfer.googleServiceAccounts.get"
+ }
+ }
+ },
"transferJobs": {
"methods": {
"patch": {
- "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"
},
- "description": "Updates a transfer job. Updating a job's transfer spec does not affect\ntransfer operations that are running already. Updating the scheduling\nof a job is not allowed.",
"response": {
"$ref": "TransferJob"
},
@@ -21,6 +49,9 @@
"jobName"
],
"httpMethod": "PATCH",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
"parameters": {
"jobName": {
"description": "The name of job to update.\nRequired.",
@@ -30,18 +61,18 @@
"location": "path"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
+ "flatPath": "v1/transferJobs/{transferJobsId}",
+ "path": "v1/{+jobName}",
+ "id": "storagetransfer.transferJobs.patch"
},
"get": {
- "httpMethod": "GET",
- "parameterOrder": [
- "jobName"
- ],
"response": {
"$ref": "TransferJob"
},
+ "parameterOrder": [
+ "jobName"
+ ],
+ "httpMethod": "GET",
"parameters": {
"jobName": {
"description": "The job to get.\nRequired.",
@@ -51,32 +82,29 @@
"location": "path"
},
"projectId": {
- "location": "query",
"description": "The ID of the Google Cloud Platform Console project that owns the job.\nRequired.",
- "type": "string"
+ "type": "string",
+ "location": "query"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v1/transferJobs/{transferJobsId}",
- "id": "storagetransfer.transferJobs.get",
"path": "v1/{+jobName}",
+ "id": "storagetransfer.transferJobs.get",
"description": "Gets a transfer job."
},
"list": {
+ "path": "v1/transferJobs",
+ "id": "storagetransfer.transferJobs.list",
+ "description": "Lists transfer jobs.",
"response": {
"$ref": "ListTransferJobsResponse"
},
"parameterOrder": [],
"httpMethod": "GET",
"parameters": {
- "pageSize": {
- "location": "query",
- "description": "The list page size. The max allowed value is 256.",
- "format": "int32",
- "type": "integer"
- },
"filter": {
"location": "query",
"description": "A list of query parameters specified as JSON text in the form of\n{\"project_id\":\"my_project_id\",\n\"job_names\":[\"jobid1\",\"jobid2\",...],\n\"job_statuses\":[\"status1\",\"status2\",...]}.\nSince `job_names` and `job_statuses` support multiple values, their values\nmust be specified with array notation. `project_id` is required. `job_names`\nand `job_statuses` are optional. The valid values for `job_statuses` are\ncase-insensitive: `ENABLED`, `DISABLED`, and `DELETED`.",
@@ -86,17 +114,26 @@
"location": "query",
"description": "The list page token.",
"type": "string"
+ },
+ "pageSize": {
+ "location": "query",
+ "description": "The list page size. The max allowed value is 256.",
+ "format": "int32",
+ "type": "integer"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
- "flatPath": "v1/transferJobs",
- "path": "v1/transferJobs",
- "id": "storagetransfer.transferJobs.list",
- "description": "Lists transfer jobs."
+ "flatPath": "v1/transferJobs"
},
"create": {
+ "path": "v1/transferJobs",
+ "id": "storagetransfer.transferJobs.create",
+ "request": {
+ "$ref": "TransferJob"
+ },
+ "description": "Creates a transfer job that runs periodically.",
"response": {
"$ref": "TransferJob"
},
@@ -106,126 +143,13 @@
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
- "flatPath": "v1/transferJobs",
- "path": "v1/transferJobs",
- "id": "storagetransfer.transferJobs.create",
- "request": {
- "$ref": "TransferJob"
- },
- "description": "Creates a transfer job that runs periodically."
+ "flatPath": "v1/transferJobs"
}
}
},
"transferOperations": {
"methods": {
- "resume": {
- "flatPath": "v1/transferOperations/{transferOperationsId}:resume",
- "id": "storagetransfer.transferOperations.resume",
- "path": "v1/{+name}:resume",
- "request": {
- "$ref": "ResumeTransferOperationRequest"
- },
- "description": "Resumes a transfer operation that is paused.",
- "httpMethod": "POST",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Empty"
- },
- "parameters": {
- "name": {
- "location": "path",
- "description": "The name of the transfer operation.\nRequired.",
- "required": true,
- "type": "string",
- "pattern": "^transferOperations/.+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- },
- "cancel": {
- "flatPath": "v1/transferOperations/{transferOperationsId}:cancel",
- "path": "v1/{+name}:cancel",
- "id": "storagetransfer.transferOperations.cancel",
- "description": "Cancels a transfer. Use the get method to check whether the cancellation succeeded or whether the operation completed despite cancellation.",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "POST",
- "parameters": {
- "name": {
- "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"
- ]
- },
- "get": {
- "description": "Gets the latest state of a long-running operation. Clients can use this\nmethod to poll the operation result at intervals as recommended by the API\nservice.",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "parameters": {
- "name": {
- "description": "The name of the operation resource.",
- "required": true,
- "type": "string",
- "pattern": "^transferOperations/.+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/transferOperations/{transferOperationsId}",
- "path": "v1/{+name}",
- "id": "storagetransfer.transferOperations.get"
- },
- "pause": {
- "flatPath": "v1/transferOperations/{transferOperationsId}:pause",
- "path": "v1/{+name}:pause",
- "id": "storagetransfer.transferOperations.pause",
- "description": "Pauses a transfer operation.",
- "request": {
- "$ref": "PauseTransferOperationRequest"
- },
- "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"
- }
- }
- },
"delete": {
- "flatPath": "v1/transferOperations/{transferOperationsId}",
"path": "v1/{+name}",
"id": "storagetransfer.transferOperations.delete",
"description": "This method is not supported and the server returns `UNIMPLEMENTED`.",
@@ -236,21 +160,21 @@
"name"
],
"httpMethod": "DELETE",
+ "parameters": {
+ "name": {
+ "pattern": "^transferOperations/.+$",
+ "location": "path",
+ "description": "The name of the operation resource to be deleted.",
+ "required": true,
+ "type": "string"
+ }
+ },
"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": "^transferOperations/.+$",
- "location": "path"
- }
- }
+ "flatPath": "v1/transferOperations/{transferOperationsId}"
},
"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"
},
@@ -259,12 +183,6 @@
],
"httpMethod": "GET",
"parameters": {
- "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 {\\\"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",
@@ -281,6 +199,12 @@
"location": "query",
"description": "The list page token.",
"type": "string"
+ },
+ "pageSize": {
+ "description": "The list page size. The max allowed value is 256.",
+ "format": "int32",
+ "type": "integer",
+ "location": "query"
}
},
"scopes": [
@@ -288,35 +212,114 @@
],
"flatPath": "v1/transferOperations",
"path": "v1/{+name}",
- "id": "storagetransfer.transferOperations.list"
- }
- }
- },
- "googleServiceAccounts": {
- "methods": {
- "get": {
- "description": "Returns the Google service account that is used by Storage Transfer\nService to access buckets in the project where transfers\nrun or in other projects. Each Google service account is associated\nwith one Google Cloud Platform Console project. Users\nshould add this service account to the Google Cloud Storage bucket\nACLs to grant access to Storage Transfer Service. This service\naccount is created and owned by Storage Transfer Service and can\nonly be used by Storage Transfer Service.",
+ "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": "GoogleServiceAccount"
+ "$ref": "Empty"
},
"parameterOrder": [
- "projectId"
+ "name"
],
- "httpMethod": "GET",
+ "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": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Empty"
+ },
"parameters": {
- "projectId": {
+ "name": {
+ "pattern": "^transferOperations/.+$",
"location": "path",
- "description": "The ID of the Google Cloud Platform Console project that the Google service\naccount is associated with.\nRequired.",
+ "description": "The name of the operation resource to be cancelled.",
"required": true,
"type": "string"
}
},
- "flatPath": "v1/googleServiceAccounts/{projectId}",
- "path": "v1/googleServiceAccounts/{projectId}",
- "id": "storagetransfer.googleServiceAccounts.get"
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/transferOperations/{transferOperationsId}:cancel",
+ "id": "storagetransfer.transferOperations.cancel",
+ "path": "v1/{+name}: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",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "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}"
+ },
+ "pause": {
+ "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}:pause",
+ "path": "v1/{+name}:pause",
+ "id": "storagetransfer.transferOperations.pause",
+ "request": {
+ "$ref": "PauseTransferOperationRequest"
+ },
+ "description": "Pauses a transfer operation."
}
}
}
@@ -333,19 +336,22 @@
"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": {
- "description": "V1 error format.",
+ "uploadType": {
+ "location": "query",
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string"
+ },
+ "callback": {
+ "description": "JSONP",
"type": "string",
+ "location": "query"
+ },
+ "$.xgafv": {
"enumDescriptions": [
"v1 error format",
"v2 error format"
@@ -354,14 +360,16 @@
"enum": [
"1",
"2"
- ]
- },
- "callback": {
- "location": "query",
- "description": "JSONP",
+ ],
+ "description": "V1 error format.",
"type": "string"
},
"alt": {
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
"type": "string",
"enumDescriptions": [
"Responses with Content-Type of application/json",
@@ -370,23 +378,18 @@
],
"location": "query",
"description": "Data format for response.",
- "default": "json",
- "enum": [
- "json",
- "media",
- "proto"
- ]
+ "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"
},
- "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.",
@@ -398,22 +401,122 @@
"default": "true",
"location": "query"
},
+ "bearer_token": {
+ "description": "OAuth bearer token.",
+ "type": "string",
+ "location": "query"
+ },
"oauth_token": {
"location": "query",
"description": "OAuth 2.0 token for the current user.",
"type": "string"
- },
- "bearer_token": {
- "location": "query",
- "description": "OAuth bearer token.",
- "type": "string"
}
},
"schemas": {
+ "ErrorLogEntry": {
+ "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",
+ "description": "An entry describing an error that has occurred.",
+ "type": "object"
+ },
+ "TransferJob": {
+ "description": "This resource represents the configuration of a transfer job that runs\nperiodically.",
+ "type": "object",
+ "properties": {
+ "schedule": {
+ "description": "Schedule specification.",
+ "$ref": "Schedule"
+ },
+ "deletionTime": {
+ "description": "This field cannot be changed by user requests.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "name": {
+ "description": "A globally unique name assigned by Storage Transfer Service when the\njob is created. This field should be left empty in requests to create a new\ntransfer job; otherwise, the requests result in an `INVALID_ARGUMENT`\nerror.",
+ "type": "string"
+ },
+ "projectId": {
+ "description": "The ID of the Google Cloud Platform Console project that owns the job.",
+ "type": "string"
+ },
+ "lastModificationTime": {
+ "description": "This field cannot be changed by user requests.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "description": {
+ "description": "A description provided by the user for the job. Its max length is 1024\nbytes when Unicode-encoded.",
+ "type": "string"
+ },
+ "transferSpec": {
+ "description": "Transfer specification.",
+ "$ref": "TransferSpec"
+ },
+ "creationTime": {
+ "description": "This field cannot be changed by user requests.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "status": {
+ "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",
+ "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."
+ ]
+ }
+ },
+ "id": "TransferJob"
+ },
+ "Schedule": {
+ "properties": {
+ "scheduleEndDate": {
+ "$ref": "Date",
+ "description": "The last day the recurring transfer will be run. If `scheduleEndDate`\nis the same as `scheduleStartDate`, the transfer will be executed only\nonce."
+ },
+ "startTimeOfDay": {
+ "description": "The time in UTC at which the transfer will be scheduled to start in a day.\nTransfers may start later than this time. If not specified, recurring and\none-time transfers that are scheduled to run today will run immediately;\nrecurring transfers that are scheduled to run on a future date will start\nat approximately midnight UTC on that date. Note that when configuring a\ntransfer with the Cloud Platform Console, the transfer's start time in a\nday is specified in your local timezone.",
+ "$ref": "TimeOfDay"
+ },
+ "scheduleStartDate": {
+ "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": {
+ "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",
@@ -423,11 +526,6 @@
"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"
@@ -436,38 +534,6 @@
"description": "A description of the execution of a transfer.",
"type": "object",
"properties": {
- "transferJobName": {
- "description": "The name of the transfer job that triggers this transfer operation.",
- "type": "string"
- },
- "transferSpec": {
- "$ref": "TransferSpec",
- "description": "Transfer specification.\nRequired."
- },
- "status": {
- "description": "Status of the transfer operation.",
- "type": "string",
- "enumDescriptions": [
- "Zero is an illegal value.",
- "In progress.",
- "Paused.",
- "Completed successfully.",
- "Terminated due to an unrecoverable failure.",
- "Aborted by the user."
- ],
- "enum": [
- "STATUS_UNSPECIFIED",
- "IN_PROGRESS",
- "PAUSED",
- "SUCCESS",
- "FAILED",
- "ABORTED"
- ]
- },
- "counters": {
- "description": "Information about the progress of the transfer operation.",
- "$ref": "TransferCounters"
- },
"errorBreakdowns": {
"description": "Summarizes errors encountered with sample error log entries.",
"type": "array",
@@ -492,24 +558,62 @@
"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": {
+ "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"
}
},
"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": {
"bucketName": {
"description": "S3 Bucket name (see\n[Creating a bucket](http://docs.aws.amazon.com/AmazonS3/latest/dev/create-bucket-get-location-example.html)).\nRequired.",
"type": "string"
},
"awsAccessKey": {
- "$ref": "AwsAccessKey",
- "description": "AWS access key used to sign the API requests to the AWS S3 bucket.\nPermissions on the bucket must be granted to the access ID of the\nAWS access key.\nRequired."
+ "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"
}
},
- "id": "AwsS3Data"
+ "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"
+ },
+ "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)).",
@@ -526,12 +630,6 @@
},
"id": "AwsAccessKey"
},
- "Empty": {
- "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
- "type": "object",
- "properties": {},
- "id": "Empty"
- },
"PauseTransferOperationRequest": {
"description": "Request passed to PauseTransferOperation.",
"type": "object",
@@ -542,6 +640,31 @@
"description": "A collection of counters that report the progress of a transfer operation.",
"type": "object",
"properties": {
+ "objectsFromSourceFailed": {
+ "description": "Objects in the data source that failed during the transfer.",
+ "format": "int64",
+ "type": "string"
+ },
+ "objectsCopiedToSink": {
+ "description": "Objects that are copied to the data sink.",
+ "format": "int64",
+ "type": "string"
+ },
+ "bytesFoundOnlyFromSink": {
+ "description": "Bytes found only in the data sink that are scheduled to be deleted.",
+ "format": "int64",
+ "type": "string"
+ },
+ "objectsDeletedFromSource": {
+ "description": "Objects that are deleted from the data source.",
+ "format": "int64",
+ "type": "string"
+ },
+ "bytesCopiedToSink": {
+ "description": "Bytes that are copied to the data sink.",
+ "format": "int64",
+ "type": "string"
+ },
"bytesFoundFromSource": {
"description": "Bytes found in the data source that are scheduled to be transferred,\nexcluding any that are filtered based on object conditions or skipped due\nto sync.",
"format": "int64",
@@ -567,13 +690,13 @@
"format": "int64",
"type": "string"
},
- "objectsFoundOnlyFromSink": {
- "description": "Objects found only in the data sink that are scheduled to be deleted.",
+ "objectsDeletedFromSink": {
+ "description": "Objects that are deleted from the data sink.",
"format": "int64",
"type": "string"
},
- "objectsDeletedFromSink": {
- "description": "Objects that are deleted from the data sink.",
+ "objectsFoundOnlyFromSink": {
+ "description": "Objects found only in the data sink that are scheduled to be deleted.",
"format": "int64",
"type": "string"
},
@@ -582,45 +705,20 @@
"format": "int64",
"type": "string"
},
- "bytesFailedToDeleteFromSink": {
- "description": "Bytes that failed to be deleted from the data sink.",
- "format": "int64",
- "type": "string"
- },
"bytesDeletedFromSink": {
"description": "Bytes that are deleted from the data sink.",
"format": "int64",
"type": "string"
},
+ "bytesFailedToDeleteFromSink": {
+ "description": "Bytes that failed to be deleted from the data sink.",
+ "format": "int64",
+ "type": "string"
+ },
"bytesFromSourceFailed": {
"description": "Bytes in the data source that failed during the transfer.",
"format": "int64",
"type": "string"
- },
- "objectsCopiedToSink": {
- "description": "Objects that are copied to the data sink.",
- "format": "int64",
- "type": "string"
- },
- "objectsFromSourceFailed": {
- "description": "Objects in the data source that failed during the transfer.",
- "format": "int64",
- "type": "string"
- },
- "bytesFoundOnlyFromSink": {
- "description": "Bytes found only in the data sink that are scheduled to be deleted.",
- "format": "int64",
- "type": "string"
- },
- "objectsDeletedFromSource": {
- "description": "Objects that are deleted from the data source.",
- "format": "int64",
- "type": "string"
- },
- "bytesCopiedToSink": {
- "description": "Bytes that are copied to the data sink.",
- "format": "int64",
- "type": "string"
}
},
"id": "TransferCounters"
@@ -630,6 +728,25 @@
"type": "object",
"properties": {
"errorCode": {
+ "enum": [
+ "OK",
+ "CANCELLED",
+ "UNKNOWN",
+ "INVALID_ARGUMENT",
+ "DEADLINE_EXCEEDED",
+ "NOT_FOUND",
+ "ALREADY_EXISTS",
+ "PERMISSION_DENIED",
+ "UNAUTHENTICATED",
+ "RESOURCE_EXHAUSTED",
+ "FAILED_PRECONDITION",
+ "ABORTED",
+ "OUT_OF_RANGE",
+ "UNIMPLEMENTED",
+ "INTERNAL",
+ "UNAVAILABLE",
+ "DATA_LOSS"
+ ],
"description": "Required.",
"type": "string",
"enumDescriptions": [
@@ -650,25 +767,6 @@
"Internal errors. This means that some invariants expected by the\nunderlying system have been broken. This error code is reserved\nfor serious errors.\n\nHTTP Mapping: 500 Internal Server Error",
"The service is currently unavailable. This is most likely a\ntransient condition, which can be corrected by retrying with\na backoff.\n\nSee the guidelines above for deciding between `FAILED_PRECONDITION`,\n`ABORTED`, and `UNAVAILABLE`.\n\nHTTP Mapping: 503 Service Unavailable",
"Unrecoverable data loss or corruption.\n\nHTTP Mapping: 500 Internal Server Error"
- ],
- "enum": [
- "OK",
- "CANCELLED",
- "UNKNOWN",
- "INVALID_ARGUMENT",
- "DEADLINE_EXCEEDED",
- "NOT_FOUND",
- "ALREADY_EXISTS",
- "PERMISSION_DENIED",
- "UNAUTHENTICATED",
- "RESOURCE_EXHAUSTED",
- "FAILED_PRECONDITION",
- "ABORTED",
- "OUT_OF_RANGE",
- "UNIMPLEMENTED",
- "INTERNAL",
- "UNAVAILABLE",
- "DATA_LOSS"
]
},
"errorCount": {
@@ -687,30 +785,28 @@
"id": "ErrorSummary"
},
"HttpData": {
- "description": "An HttpData specifies a list of objects on the web to be transferred over\nHTTP. The information of the objects to be transferred is contained in a\nfile referenced by a URL. The first line in the file must be\n\"TsvHttpData-1.0\", which specifies the format of the file. Subsequent lines\nspecify the information of the list of objects, one object per list entry.\nEach entry has the following tab-delimited fields:\n\n* HTTP URL - The location of the object.\n\n* Length - The size of the object in bytes.\n\n* MD5 - The base64-encoded MD5 hash of the object.\n\nFor an example of a valid TSV file, see\n[Transferring data from URLs](https://cloud.google.com/storage/transfer/create-url-list).\n\nWhen transferring data based on a URL list, keep the following in mind:\n\n* When an object located at `http(s)://hostname:port/\u003cURL-path\u003e` is transferred\nto a data sink, the name of the object at the data sink is\n`\u003chostname\u003e/\u003cURL-path\u003e`.\n\n* If the specified size of an object does not match the actual size of the\nobject fetched, the object will not be transferred.\n\n* If the specified MD5 does not match the MD5 computed from the transferred\nbytes, the object transfer will fail. For more information, see\n[Generating MD5 hashes](https://cloud.google.com/storage/transfer/#md5)\n\n* Ensure that each URL you specify is publicly accessible. For\nexample, in Google Cloud Storage you can\n[share an object publicly]\n(https://cloud.google.com/storage/docs/cloud-console#_sharingdata) and get\na link to it.\n\n* Storage Transfer Service obeys `robots.txt` rules and requires the source\nHTTP server to support `Range` requests and to return a `Content-Length`\nheader in each response.\n\n* [ObjectConditions](#ObjectConditions) have no effect when filtering objects\nto transfer.",
- "type": "object",
"properties": {
"listUrl": {
"description": "The URL that points to the file that stores the object list entries.\nThis file must allow public access. Currently, only URLs with HTTP and\nHTTPS schemes are supported.\nRequired.",
"type": "string"
}
},
- "id": "HttpData"
+ "id": "HttpData",
+ "description": "An HttpData specifies a list of objects on the web to be transferred over\nHTTP. The information of the objects to be transferred is contained in a\nfile referenced by a URL. The first line in the file must be\n\"TsvHttpData-1.0\", which specifies the format of the file. Subsequent lines\nspecify the information of the list of objects, one object per list entry.\nEach entry has the following tab-delimited fields:\n\n* HTTP URL - The location of the object.\n\n* Length - The size of the object in bytes.\n\n* MD5 - The base64-encoded MD5 hash of the object.\n\nFor an example of a valid TSV file, see\n[Transferring data from URLs](https://cloud.google.com/storage/transfer/create-url-list).\n\nWhen transferring data based on a URL list, keep the following in mind:\n\n* When an object located at `http(s)://hostname:port/\u003cURL-path\u003e` is transferred\nto a data sink, the name of the object at the data sink is\n`\u003chostname\u003e/\u003cURL-path\u003e`.\n\n* If the specified size of an object does not match the actual size of the\nobject fetched, the object will not be transferred.\n\n* If the specified MD5 does not match the MD5 computed from the transferred\nbytes, the object transfer will fail. For more information, see\n[Generating MD5 hashes](https://cloud.google.com/storage/transfer/#md5)\n\n* Ensure that each URL you specify is publicly accessible. For\nexample, in Google Cloud Storage you can\n[share an object publicly]\n(https://cloud.google.com/storage/docs/cloud-console#_sharingdata) and get\na link to it.\n\n* Storage Transfer Service obeys `robots.txt` rules and requires the source\nHTTP server to support `Range` requests and to return a `Content-Length`\nheader in each response.\n\n* [ObjectConditions](#ObjectConditions) have no effect when filtering objects\nto transfer.",
+ "type": "object"
},
"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"
+ "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"
},
"ListTransferJobsResponse": {
- "description": "Response from ListTransferJobs.",
- "type": "object",
"properties": {
"nextPageToken": {
"description": "The list next page token.",
@@ -724,7 +820,9 @@
}
}
},
- "id": "ListTransferJobsResponse"
+ "id": "ListTransferJobsResponse",
+ "description": "Response from ListTransferJobs.",
+ "type": "object"
},
"UpdateTransferJobRequest": {
"description": "Request passed to UpdateTransferJob.",
@@ -750,11 +848,6 @@
"description": "Conditions that determine which objects will be transferred.",
"type": "object",
"properties": {
- "maxTimeElapsedSinceLastModification": {
- "description": "`maxTimeElapsedSinceLastModification` is the complement to\n`minTimeElapsedSinceLastModification`.",
- "format": "google-duration",
- "type": "string"
- },
"includePrefixes": {
"description": "If `includePrefixes` is specified, objects that satisfy the object\nconditions must have names that start with one of the `includePrefixes`\nand that do not start with any of the `excludePrefixes`. If `includePrefixes`\nis not specified, all objects except those that have names starting with\none of the `excludePrefixes` must satisfy the object conditions.\n\nRequirements:\n\n * Each include-prefix and exclude-prefix can contain any sequence of\n Unicode characters, of max length 1024 bytes when UTF8-encoded, and\n must not contain Carriage Return or Line Feed characters. Wildcard\n matching and regular expression matching are not supported.\n\n * Each include-prefix and exclude-prefix must omit the leading slash.\n For example, to include the `requests.gz` object in a transfer from\n `s3://my-aws-bucket/logs/y=2015/requests.gz`, specify the include\n prefix as `logs/y=2015/requests.gz`.\n\n * None of the include-prefix or the exclude-prefix values can be empty,\n if specified.\n\n * Each include-prefix must include a distinct portion of the object\n namespace, i.e., no include-prefix may be a prefix of another\n include-prefix.\n\n * Each exclude-prefix must exclude a distinct portion of the object\n namespace, i.e., no exclude-prefix may be a prefix of another\n exclude-prefix.\n\n * If `includePrefixes` is specified, then each exclude-prefix must start\n with the value of a path explicitly included by `includePrefixes`.\n\nThe max size of `includePrefixes` is 1000.",
"type": "array",
@@ -773,6 +866,11 @@
"items": {
"type": "string"
}
+ },
+ "maxTimeElapsedSinceLastModification": {
+ "description": "`maxTimeElapsedSinceLastModification` is the complement to\n`minTimeElapsedSinceLastModification`.",
+ "format": "google-duration",
+ "type": "string"
}
},
"id": "ObjectConditions"
@@ -781,33 +879,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 originally returns it. If you use the default HTTP mapping, the `name` should have the format of `transferOperations/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": "Represents the transfer operation object.",
- "type": "object",
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
- }
+ },
+ "description": "Represents the transfer operation object.",
+ "type": "object"
+ },
+ "done": {
+ "description": "If the value is `false`, it means the operation is still in progress.\nIf `true`, the operation is completed, and either `error` or `response` is\navailable.",
+ "type": "boolean"
}
},
"id": "Operation"
@@ -832,9 +930,19 @@
"id": "TransferOptions"
},
"TransferSpec": {
- "description": "Configuration for running a transfer.",
- "type": "object",
"properties": {
+ "objectConditions": {
+ "$ref": "ObjectConditions",
+ "description": "Only objects that satisfy these object conditions are included in the set\nof data source and data sink objects. Object conditions based on\nobjects' `lastModificationTime` do not exclude objects in a data sink."
+ },
+ "gcsDataSink": {
+ "$ref": "GcsData",
+ "description": "A Google Cloud Storage data sink."
+ },
+ "gcsDataSource": {
+ "$ref": "GcsData",
+ "description": "A Google Cloud Storage data source."
+ },
"transferOptions": {
"$ref": "TransferOptions",
"description": "If the option `deleteObjectsUniqueInSink` is `true`, object conditions\nbased on objects' `lastModificationTime` are ignored and do not exclude\nobjects in a data source or a data sink."
@@ -846,27 +954,11 @@
"httpDataSource": {
"description": "An HTTP URL data source.",
"$ref": "HttpData"
- },
- "objectConditions": {
- "$ref": "ObjectConditions",
- "description": "Only objects that satisfy these object conditions are included in the set\nof data source and data sink objects. Object conditions based on\nobjects' `lastModificationTime` do not exclude objects in a data sink."
- },
- "gcsDataSink": {
- "description": "A Google Cloud Storage data sink.",
- "$ref": "GcsData"
- },
- "gcsDataSource": {
- "description": "A Google Cloud Storage data source.",
- "$ref": "GcsData"
}
},
- "id": "TransferSpec"
- },
- "ResumeTransferOperationRequest": {
- "description": "Request passed to ResumeTransferOperation.",
- "type": "object",
- "properties": {},
- "id": "ResumeTransferOperationRequest"
+ "id": "TransferSpec",
+ "description": "Configuration for running a transfer.",
+ "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.",
@@ -895,9 +987,13 @@
},
"id": "Status"
},
- "ListOperationsResponse": {
- "description": "The response message for Operations.ListOperations.",
+ "ResumeTransferOperationRequest": {
+ "description": "Request passed to ResumeTransferOperation.",
"type": "object",
+ "properties": {},
+ "id": "ResumeTransferOperationRequest"
+ },
+ "ListOperationsResponse": {
"properties": {
"nextPageToken": {
"description": "The standard List next-page token.",
@@ -911,7 +1007,9 @@
}
}
},
- "id": "ListOperationsResponse"
+ "id": "ListOperationsResponse",
+ "description": "The response message for Operations.ListOperations.",
+ "type": "object"
},
"GoogleServiceAccount": {
"description": "Google service account",
@@ -928,6 +1026,11 @@
"description": "Represents a time of day. The date and time zone are either not significant\nor are specified elsewhere. An API may choose to allow leap seconds. Related\ntypes are google.type.Date and `google.protobuf.Timestamp`.",
"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",
@@ -942,114 +1045,14 @@
"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": {
- "description": "Schedule specification.",
- "$ref": "Schedule"
- },
- "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": {
- "$ref": "Date",
- "description": "The first day the recurring transfer is scheduled to run. If\n`scheduleStartDate` is in the past, the transfer will run for the first\ntime on the following day.\nRequired."
- }
- },
- "id": "Schedule"
}
},
"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",
@@ -1070,8 +1073,5 @@
"basePath": "",
"ownerDomain": "google.com",
"name": "storagetransfer",
- "batchPath": "batch",
- "id": "storagetransfer:v1",
- "documentationLink": "https://cloud.google.com/storage/transfer",
- "revision": "20171221"
+ "batchPath": "batch"
}
diff --git a/streetviewpublish/v1/streetviewpublish-api.json b/streetviewpublish/v1/streetviewpublish-api.json
index 7279190..2d93060 100644
--- a/streetviewpublish/v1/streetviewpublish-api.json
+++ b/streetviewpublish/v1/streetviewpublish-api.json
@@ -1,376 +1,4 @@
{
- "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": "20171215",
- "discoveryVersion": "v1",
- "version_module": true,
- "schemas": {
- "Photo": {
- "type": "object",
- "properties": {
- "viewCount": {
- "type": "string",
- "description": "Output only. View count of the photo.",
- "format": "int64"
- },
- "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"
- },
- "connections": {
- "description": "Connections to other photos. A connection represents the link from this\nphoto to another photo.",
- "type": "array",
- "items": {
- "$ref": "Connection"
- }
- },
- "places": {
- "description": "Places where this photo belongs.",
- "type": "array",
- "items": {
- "$ref": "Place"
- }
- },
- "uploadReference": {
- "$ref": "UploadRef",
- "description": "Required when creating a photo. Input only. The resource URL where the\nphoto bytes are uploaded to."
- },
- "photoId": {
- "$ref": "PhotoId",
- "description": "Required when updating a photo. Output only when creating a photo.\nIdentifier for the photo, which is unique among all photos in\nGoogle."
- },
- "pose": {
- "$ref": "Pose",
- "description": "Pose of the photo."
- },
- "shareLink": {
- "description": "Output only. The share link for the photo.",
- "type": "string"
- },
- "captureTime": {
- "description": "Absolute time when the photo was captured.\nWhen the photo has no exif timestamp, this is used to set a timestamp in\nthe photo metadata.",
- "format": "google-datetime",
- "type": "string"
- },
- "thumbnailUrl": {
- "description": "Output only. The thumbnail URL for showing a preview of the given photo.",
- "type": "string"
- }
- },
- "id": "Photo",
- "description": "Photo is used to store 360 photos along with photo metadata."
- },
- "Operation": {
- "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
- "type": "object",
- "properties": {
- "name": {
- "description": "The server-assigned name, which is only unique within the same service that\noriginally returns it. If you use the default HTTP mapping, the\n`name` should have the format of `operations/some/unique/name`.",
- "type": "string"
- },
- "error": {
- "$ref": "Status",
- "description": "The error result of the operation in case of failure or cancellation."
- },
- "metadata": {
- "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"
- }
- },
- "id": "Operation"
- },
- "PhotoResponse": {
- "description": "Response payload for a single\nPhoto\nin batch operations including\nBatchGetPhotos\nand\nBatchUpdatePhotos.",
- "type": "object",
- "properties": {
- "status": {
- "description": "The status for the operation to get or update a single photo in the batch\nrequest.",
- "$ref": "Status"
- },
- "photo": {
- "$ref": "Photo",
- "description": "The Photo resource, if the request\nwas successful."
- }
- },
- "id": "PhotoResponse"
- },
- "Connection": {
- "description": "A connection is the link from a source photo to a destination photo.",
- "type": "object",
- "properties": {
- "target": {
- "$ref": "PhotoId",
- "description": "Required. The destination of the connection from the containing photo to\nanother photo."
- }
- },
- "id": "Connection"
- },
- "BatchUpdatePhotosResponse": {
- "description": "Response to batch update of metadata of one or more\nPhotos.",
- "type": "object",
- "properties": {
- "results": {
- "description": "List of results for each individual\nPhoto updated, in the same order as\nthe request.",
- "type": "array",
- "items": {
- "$ref": "PhotoResponse"
- }
- }
- },
- "id": "BatchUpdatePhotosResponse"
- },
- "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": {
- "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"
- }
- },
- "code": {
- "description": "The status code, which should be an enum value of google.rpc.Code.",
- "format": "int32",
- "type": "integer"
- }
- }
- },
- "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"
- },
- "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"
- },
- "UploadRef": {
- "description": "Upload reference for media files.",
- "type": "object",
- "properties": {
- "uploadUrl": {
- "description": "Required. An upload reference should be unique for each user. It follows\nthe form:\n\"https://streetviewpublish.googleapis.com/media/user/{account_id}/photo/{upload_reference}\"",
- "type": "string"
- }
- },
- "id": "UploadRef"
- },
- "Place": {
- "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"
- },
- "BatchGetPhotosResponse": {
- "description": "Response to batch get of Photos.",
- "type": "object",
- "properties": {
- "results": {
- "description": "List of results for each individual\nPhoto requested, in the same order as\nthe requests in\nBatchGetPhotos.",
- "type": "array",
- "items": {
- "$ref": "PhotoResponse"
- }
- }
- },
- "id": "BatchGetPhotosResponse"
- },
- "BatchDeletePhotosRequest": {
- "description": "Request to delete multiple Photos.",
- "type": "object",
- "properties": {
- "photoIds": {
- "description": "Required. IDs of the Photos. For HTTP\nGET requests, the URL query parameter should be\n`photoIds=\u003cid1\u003e&photoIds=\u003cid2\u003e&...`.",
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "id": "BatchDeletePhotosRequest"
- },
- "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"
- },
- "UpdatePhotoRequest": {
- "type": "object",
- "properties": {
- "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",
- "description": "Request to update the metadata of a\nPhoto. Updating the pixels of a photo\nis not supported."
- },
- "PhotoId": {
- "properties": {
- "id": {
- "description": "Required. A unique identifier for a photo.",
- "type": "string"
- }
- },
- "id": "PhotoId",
- "description": "Identifier for a Photo.",
- "type": "object"
- },
- "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"
- },
- "heading": {
- "description": "Compass heading, measured at the center of the photo in degrees clockwise\nfrom North. Value must be \u003e=0 and \u003c360.\nNaN indicates an unmeasured quantity.",
- "format": "double",
- "type": "number"
- },
- "altitude": {
- "description": "Altitude of the pose in meters above WGS84 ellipsoid.\nNaN indicates an unmeasured quantity.",
- "format": "double",
- "type": "number"
- },
- "pitch": {
- "description": "Pitch, measured at the center of the photo in degrees. Value must be \u003e=-90\nand \u003c= 90. A value of -90 means looking directly down, and a value of 90\nmeans looking directly up.\nNaN indicates an unmeasured quantity.",
- "format": "double",
- "type": "number"
- }
- },
- "id": "Pose"
- },
- "BatchUpdatePhotosRequest": {
- "id": "BatchUpdatePhotosRequest",
- "description": "Request to update the metadata of photos.\nUpdating the pixels of photos is not supported.",
- "type": "object",
- "properties": {
- "updatePhotoRequests": {
- "description": "Required. List of\nUpdatePhotoRequests.",
- "type": "array",
- "items": {
- "$ref": "UpdatePhotoRequest"
- }
- }
- }
- },
- "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"
- }
- }
- },
- "id": "ListPhotosResponse"
- }
- },
- "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": "Street View Publish",
"auth": {
"oauth2": {
@@ -389,175 +17,48 @@
"title": "Street View Publish API",
"ownerName": "Google",
"resources": {
- "photo": {
- "methods": {
- "delete": {
- "path": "v1/photo/{photoId}",
- "id": "streetviewpublish.photo.delete",
- "description": "Deletes a Photo and its metadata.\n\nThis method returns the following error codes:\n\n* google.rpc.Code.PERMISSION_DENIED if the requesting user did not\ncreate the requested photo.\n* google.rpc.Code.NOT_FOUND if the photo ID does not exist.",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "photoId"
- ],
- "httpMethod": "DELETE",
- "parameters": {
- "photoId": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "Required. ID of the Photo."
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/streetviewpublish"
- ],
- "flatPath": "v1/photo/{photoId}"
- },
- "get": {
- "httpMethod": "GET",
- "response": {
- "$ref": "Photo"
- },
- "parameterOrder": [
- "photoId"
- ],
- "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}",
- "id": "streetviewpublish.photo.get",
- "path": "v1/photo/{photoId}",
- "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."
- },
- "update": {
- "httpMethod": "PUT",
- "parameterOrder": [
- "id"
- ],
- "response": {
- "$ref": "Photo"
- },
- "parameters": {
- "id": {
- "location": "path",
- "description": "Required. A unique identifier for a photo.",
- "required": true,
- "type": "string"
- },
- "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"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/streetviewpublish"
- ],
- "flatPath": "v1/photo/{id}",
- "id": "streetviewpublish.photo.update",
- "path": "v1/photo/{id}",
- "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": {
- "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.",
- "response": {
- "$ref": "Photo"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "parameters": {},
- "scopes": [
- "https://www.googleapis.com/auth/streetviewpublish"
- ],
- "flatPath": "v1/photo",
- "path": "v1/photo",
- "id": "streetviewpublish.photo.create"
- },
- "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"
- },
- "httpMethod": "POST",
- "parameterOrder": [],
- "response": {
- "$ref": "UploadRef"
- },
- "scopes": [
- "https://www.googleapis.com/auth/streetviewpublish"
- ],
- "parameters": {},
- "flatPath": "v1/photo:startUpload",
- "id": "streetviewpublish.photo.startUpload",
- "path": "v1/photo:startUpload"
- }
- }
- },
"photos": {
"methods": {
"batchUpdate": {
- "httpMethod": "POST",
- "parameterOrder": [],
- "response": {
- "$ref": "BatchUpdatePhotosResponse"
- },
- "parameters": {},
- "scopes": [
- "https://www.googleapis.com/auth/streetviewpublish"
- ],
- "flatPath": "v1/photos:batchUpdate",
- "id": "streetviewpublish.photos.batchUpdate",
- "path": "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"
},
- "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"
+ "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": {
+ "flatPath": "v1/photos:batchDelete",
+ "path": "v1/photos:batchDelete",
+ "id": "streetviewpublish.photos.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",
- "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."
+ "parameters": {}
},
"batchGet": {
+ "path": "v1/photos:batchGet",
+ "id": "streetviewpublish.photos.batchGet",
+ "description": "Gets the metadata of the specified\nPhoto batch.\n\nNote that if\nBatchGetPhotos\nfails, either critical fields are missing or there was an authentication\nerror. Even if\nBatchGetPhotos\nsucceeds, there may have been failures for single photos in the batch.\nThese failures will be specified in each\nPhotoResponse.status\nin\nBatchGetPhotosResponse.results.\nSee\nGetPhoto\nfor specific failures that can occur per photo.",
"response": {
"$ref": "BatchGetPhotosResponse"
},
@@ -568,10 +69,10 @@
],
"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",
- "description": "Required. IDs of the Photos. For HTTP\nGET requests, the URL query parameter should be\n`photoIds=\u003cid1\u003e&photoIds=\u003cid2\u003e&...`."
+ "location": "query"
},
"view": {
"location": "query",
@@ -583,42 +84,40 @@
"type": "string"
}
},
- "flatPath": "v1/photos:batchGet",
- "path": "v1/photos:batchGet",
- "id": "streetviewpublish.photos.batchGet",
- "description": "Gets the metadata of the specified\nPhoto batch.\n\nNote that if\nBatchGetPhotos\nfails, either critical fields are missing or there was an authentication\nerror. Even if\nBatchGetPhotos\nsucceeds, there may have been failures for single photos in the batch.\nThese failures will be specified in each\nPhotoResponse.status\nin\nBatchGetPhotosResponse.results.\nSee\nGetPhoto\nfor specific failures that can occur per photo."
+ "flatPath": "v1/photos:batchGet"
},
"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",
"parameters": {
- "pageToken": {
+ "filter": {
"location": "query",
- "description": "The\nnextPageToken\nvalue returned from a previous\nListPhotos\nrequest, if any.",
+ "description": "The filter expression. For example: `placeId=ChIJj61dQgK6j4AR4GeTYWZsKWw`.\n\nThe only filter supported at the moment is `placeId`.",
"type": "string"
},
+ "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"
+ "type": "integer",
+ "location": "query"
},
"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"
- },
- "filter": {
- "location": "query",
- "description": "The filter expression. For example: `placeId=ChIJj61dQgK6j4AR4GeTYWZsKWw`.\n\nThe only filter supported at the moment is `placeId`.",
- "type": "string"
+ "type": "string",
+ "location": "query"
}
},
"scopes": [
@@ -626,37 +125,190 @@
],
"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"
+ "id": "streetviewpublish.photos.list"
+ }
+ }
+ },
+ "photo": {
+ "methods": {
+ "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}",
+ "path": "v1/photo/{id}",
+ "id": "streetviewpublish.photo.update"
+ },
+ "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"
+ },
+ "response": {
+ "$ref": "Photo"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/streetviewpublish"
+ ],
+ "parameters": {},
+ "flatPath": "v1/photo",
+ "path": "v1/photo",
+ "id": "streetviewpublish.photo.create"
+ },
+ "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",
+ "path": "v1/photo:startUpload",
+ "id": "streetviewpublish.photo.startUpload"
+ },
+ "delete": {
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "photoId"
+ ],
+ "httpMethod": "DELETE",
+ "scopes": [
+ "https://www.googleapis.com/auth/streetviewpublish"
+ ],
+ "parameters": {
+ "photoId": {
+ "location": "path",
+ "description": "Required. ID of the Photo.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "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": {
+ "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"
+ }
+ },
+ "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."
}
}
}
},
"parameters": {
- "upload_protocol": {
+ "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": "Upload protocol for media (e.g. \"raw\", \"multipart\")."
- },
- "prettyPrint": {
- "description": "Returns response with indentations and line breaks.",
- "type": "boolean",
- "default": "true",
"location": "query"
},
- "uploadType": {
+ "pp": {
"location": "query",
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "description": "Pretty-print response.",
+ "type": "boolean",
+ "default": "true"
+ },
+ "bearer_token": {
+ "location": "query",
+ "description": "OAuth bearer token.",
"type": "string"
},
- "fields": {
- "description": "Selector specifying which fields to include in a partial response.",
+ "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"
},
- "$.xgafv": {
- "description": "V1 error format.",
+ "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": {
+ "location": "query",
+ "description": "JSONP",
+ "type": "string"
+ },
+ "$.xgafv": {
"enumDescriptions": [
"v1 error format",
"v2 error format"
@@ -665,15 +317,11 @@
"enum": [
"1",
"2"
- ]
- },
- "callback": {
- "description": "JSONP",
- "type": "string",
- "location": "query"
+ ],
+ "description": "V1 error format.",
+ "type": "string"
},
"alt": {
- "location": "query",
"description": "Data format for response.",
"default": "json",
"enum": [
@@ -686,38 +334,390 @@
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
"Responses with Content-Type of application/x-protobuf"
- ]
- },
- "key": {
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string",
+ ],
"location": "query"
},
"access_token": {
- "type": "string",
"location": "query",
- "description": "OAuth access token."
- },
- "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"
- },
- "oauth_token": {
- "location": "query",
- "description": "OAuth 2.0 token for the current user.",
+ "description": "API key. 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"
- },
- "bearer_token": {
- "type": "string",
- "location": "query",
- "description": "OAuth bearer token."
}
+ },
+ "version": "v1",
+ "baseUrl": "https://streetviewpublish.googleapis.com/",
+ "kind": "discovery#restDescription",
+ "description": "Publishes 360 photos to Google Maps, along with position, orientation, and connectivity metadata. Apps can offer an interface for positioning, connecting, and uploading user-generated Street View images.\n",
+ "servicePath": "",
+ "basePath": "",
+ "id": "streetviewpublish:v1",
+ "documentationLink": "https://developers.google.com/streetview/publish/",
+ "revision": "20171215",
+ "discoveryVersion": "v1",
+ "version_module": true,
+ "schemas": {
+ "Operation": {
+ "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
+ "type": "object",
+ "properties": {
+ "response": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "description": "The normal response of the operation in case of success. If the original\nmethod returns no data on success, such as `Delete`, the response is\n`google.protobuf.Empty`. If the original method is standard\n`Get`/`Create`/`Update`, the response should be the resource. For other\nmethods, the response should have the type `XxxResponse`, where `Xxx`\nis the original method name. For example, if the original method name\nis `TakeSnapshot()`, the inferred response type is\n`TakeSnapshotResponse`.",
+ "type": "object"
+ },
+ "name": {
+ "description": "The server-assigned name, which is only unique within the same service that\noriginally returns it. If you use the default HTTP mapping, the\n`name` should have the format of `operations/some/unique/name`.",
+ "type": "string"
+ },
+ "error": {
+ "description": "The error result of the operation in case of failure or cancellation.",
+ "$ref": "Status"
+ },
+ "metadata": {
+ "description": "Service-specific metadata associated with the operation. It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata. Any method that returns a\nlong-running operation should document the metadata type, if any.",
+ "type": "object",
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ }
+ },
+ "done": {
+ "description": "If the value is `false`, it means the operation is still in progress.\nIf `true`, the operation is completed, and either `error` or `response` is\navailable.",
+ "type": "boolean"
+ }
+ },
+ "id": "Operation"
+ },
+ "PhotoResponse": {
+ "description": "Response payload for a single\nPhoto\nin batch operations including\nBatchGetPhotos\nand\nBatchUpdatePhotos.",
+ "type": "object",
+ "properties": {
+ "photo": {
+ "description": "The Photo resource, if the request\nwas successful.",
+ "$ref": "Photo"
+ },
+ "status": {
+ "description": "The status for the operation to get or update a single photo in the batch\nrequest.",
+ "$ref": "Status"
+ }
+ },
+ "id": "PhotoResponse"
+ },
+ "Connection": {
+ "properties": {
+ "target": {
+ "description": "Required. The destination of the connection from the containing photo to\nanother photo.",
+ "$ref": "PhotoId"
+ }
+ },
+ "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.",
+ "type": "object",
+ "properties": {
+ "results": {
+ "description": "List of results for each individual\nPhoto updated, in the same order as\nthe request.",
+ "type": "array",
+ "items": {
+ "$ref": "PhotoResponse"
+ }
+ }
+ },
+ "id": "BatchUpdatePhotosResponse"
+ },
+ "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"
+ },
+ "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": {
+ "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",
+ "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"
+ },
+ "BatchGetPhotosResponse": {
+ "description": "Response to batch get of Photos.",
+ "type": "object",
+ "properties": {
+ "results": {
+ "description": "List of results for each individual\nPhoto requested, in the same order as\nthe requests in\nBatchGetPhotos.",
+ "type": "array",
+ "items": {
+ "$ref": "PhotoResponse"
+ }
+ }
+ },
+ "id": "BatchGetPhotosResponse"
+ },
+ "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"
+ },
+ "UploadRef": {
+ "description": "Upload reference for media files.",
+ "type": "object",
+ "properties": {
+ "uploadUrl": {
+ "description": "Required. An upload reference should be unique for each user. It follows\nthe form:\n\"https://streetviewpublish.googleapis.com/media/user/{account_id}/photo/{upload_reference}\"",
+ "type": "string"
+ }
+ },
+ "id": "UploadRef"
+ },
+ "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"
+ },
+ "BatchDeletePhotosRequest": {
+ "properties": {
+ "photoIds": {
+ "description": "Required. IDs of the Photos. For HTTP\nGET requests, the URL query parameter should be\n`photoIds=\u003cid1\u003e&photoIds=\u003cid2\u003e&...`.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "id": "BatchDeletePhotosRequest",
+ "description": "Request to delete multiple Photos.",
+ "type": "object"
+ },
+ "UpdatePhotoRequest": {
+ "properties": {
+ "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": {
+ "description": "Required. Photo object containing the\nnew metadata.",
+ "$ref": "Photo"
+ }
+ },
+ "id": "UpdatePhotoRequest",
+ "description": "Request to update the metadata of a\nPhoto. Updating the pixels of a photo\nis not supported.",
+ "type": "object"
+ },
+ "Pose": {
+ "description": "Raw pose measurement for an entity.",
+ "type": "object",
+ "properties": {
+ "level": {
+ "$ref": "Level",
+ "description": "Level (the floor in a building) used to configure vertical navigation."
+ },
+ "heading": {
+ "description": "Compass heading, measured at the center of the photo in degrees clockwise\nfrom North. Value must be \u003e=0 and \u003c360.\nNaN indicates an unmeasured quantity.",
+ "format": "double",
+ "type": "number"
+ },
+ "altitude": {
+ "description": "Altitude of the pose in meters above WGS84 ellipsoid.\nNaN indicates an unmeasured quantity.",
+ "format": "double",
+ "type": "number"
+ },
+ "pitch": {
+ "description": "Pitch, measured at the center of the photo in degrees. Value must be \u003e=-90\nand \u003c= 90. A value of -90 means looking directly down, and a value of 90\nmeans looking directly up.\nNaN indicates an unmeasured quantity.",
+ "format": "double",
+ "type": "number"
+ },
+ "latLngPair": {
+ "$ref": "LatLng",
+ "description": "Latitude and longitude pair of the pose, as explained here:\nhttps://cloud.google.com/datastore/docs/reference/rest/Shared.Types/LatLng\nWhen creating a Photo, if the\nlatitude and longitude pair are not provided here, the geolocation from the\nexif header will be used. If the latitude and longitude pair is not\nprovided and cannot be found in the exif header, the create photo process\nwill fail."
+ },
+ "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"
+ },
+ "PhotoId": {
+ "properties": {
+ "id": {
+ "description": "Required. A unique identifier for a photo.",
+ "type": "string"
+ }
+ },
+ "id": "PhotoId",
+ "description": "Identifier for a Photo.",
+ "type": "object"
+ },
+ "BatchUpdatePhotosRequest": {
+ "properties": {
+ "updatePhotoRequests": {
+ "description": "Required. List of\nUpdatePhotoRequests.",
+ "type": "array",
+ "items": {
+ "$ref": "UpdatePhotoRequest"
+ }
+ }
+ },
+ "id": "BatchUpdatePhotosRequest",
+ "description": "Request to update the metadata of photos.\nUpdating the pixels of photos is not supported.",
+ "type": "object"
+ },
+ "ListPhotosResponse": {
+ "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"
+ }
+ }
+ },
+ "id": "ListPhotosResponse",
+ "description": "Response to list all photos that belong to a user.",
+ "type": "object"
+ },
+ "Photo": {
+ "properties": {
+ "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": {
+ "description": "Pose of the photo.",
+ "$ref": "Pose"
+ },
+ "shareLink": {
+ "description": "Output only. The share link for the photo.",
+ "type": "string"
+ },
+ "captureTime": {
+ "description": "Absolute time when the photo was captured.\nWhen the photo has no exif timestamp, this is used to set a timestamp in\nthe photo metadata.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "thumbnailUrl": {
+ "description": "Output only. The thumbnail URL for showing a preview of the given photo.",
+ "type": "string"
+ },
+ "viewCount": {
+ "description": "Output only. View count of the photo.",
+ "format": "int64",
+ "type": "string"
+ },
+ "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"
+ },
+ "connections": {
+ "description": "Connections to other photos. A connection represents the link from this\nphoto to another photo.",
+ "type": "array",
+ "items": {
+ "$ref": "Connection"
+ }
+ },
+ "places": {
+ "description": "Places where this photo belongs.",
+ "type": "array",
+ "items": {
+ "$ref": "Place"
+ }
+ }
+ },
+ "id": "Photo",
+ "description": "Photo is used to store 360 photos along with photo metadata.",
+ "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"
}
}
diff --git a/testing/v1/testing-api.json b/testing/v1/testing-api.json
index 074c76b..003483b 100644
--- a/testing/v1/testing-api.json
+++ b/testing/v1/testing-api.json
@@ -5,6 +5,7 @@
"testEnvironmentCatalog": {
"methods": {
"get": {
+ "description": "Get the catalog of supported test environments.\n\nMay return any of the following canonical error codes:\n\n- INVALID_ARGUMENT - if the request is malformed\n- NOT_FOUND - if the environment type does not exist\n- INTERNAL - if an internal error occurred",
"response": {
"$ref": "TestEnvironmentCatalog"
},
@@ -12,18 +13,13 @@
"environmentType"
],
"httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
"parameters": {
"projectId": {
+ "location": "query",
"description": "For authorization, the cloud project requesting the TestEnvironmentCatalog.\nOptional",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"environmentType": {
- "location": "path",
"enum": [
"ENVIRONMENT_TYPE_UNSPECIFIED",
"ANDROID",
@@ -31,13 +27,17 @@
],
"description": "The type of environment that should be listed.\nRequired",
"required": true,
- "type": "string"
+ "type": "string",
+ "location": "path"
}
},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
"flatPath": "v1/testEnvironmentCatalog/{environmentType}",
"path": "v1/testEnvironmentCatalog/{environmentType}",
- "id": "testing.testEnvironmentCatalog.get",
- "description": "Get the catalog of supported test environments.\n\nMay return any of the following canonical error codes:\n\n- INVALID_ARGUMENT - if the request is malformed\n- NOT_FOUND - if the environment type does not exist\n- INTERNAL - if an internal error occurred"
+ "id": "testing.testEnvironmentCatalog.get"
}
}
},
@@ -46,9 +46,6 @@
"testMatrices": {
"methods": {
"create": {
- "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"
@@ -70,32 +67,35 @@
"type": "string"
},
"projectId": {
- "location": "path",
"description": "The GCE project under which this job will run.",
"required": true,
- "type": "string"
+ "type": "string",
+ "location": "path"
}
- }
+ },
+ "flatPath": "v1/projects/{projectId}/testMatrices",
+ "path": "v1/projects/{projectId}/testMatrices",
+ "id": "testing.projects.testMatrices.create"
},
"cancel": {
+ "flatPath": "v1/projects/{projectId}/testMatrices/{testMatrixId}:cancel",
+ "id": "testing.projects.testMatrices.cancel",
+ "path": "v1/projects/{projectId}/testMatrices/{testMatrixId}: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"
- },
+ "httpMethod": "POST",
"parameterOrder": [
"projectId",
"testMatrixId"
],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
+ "response": {
+ "$ref": "CancelTestMatrixResponse"
+ },
"parameters": {
"projectId": {
- "location": "path",
"description": "Cloud project that owns the test.",
"required": true,
- "type": "string"
+ "type": "string",
+ "location": "path"
},
"testMatrixId": {
"location": "path",
@@ -104,14 +104,15 @@
"type": "string"
}
},
- "flatPath": "v1/projects/{projectId}/testMatrices/{testMatrixId}:cancel",
- "path": "v1/projects/{projectId}/testMatrices/{testMatrixId}:cancel",
- "id": "testing.projects.testMatrices.cancel"
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
},
"get": {
- "path": "v1/projects/{projectId}/testMatrices/{testMatrixId}",
"id": "testing.projects.testMatrices.get",
+ "path": "v1/projects/{projectId}/testMatrices/{testMatrixId}",
"description": "Check the status of a test matrix.\n\nMay return any of the following canonical error codes:\n\n- PERMISSION_DENIED - if the user is not authorized to read project\n- INVALID_ARGUMENT - if the request is malformed\n- NOT_FOUND - if the Test Matrix does not exist",
+ "httpMethod": "GET",
"response": {
"$ref": "TestMatrix"
},
@@ -119,19 +120,18 @@
"projectId",
"testMatrixId"
],
- "httpMethod": "GET",
"parameters": {
+ "testMatrixId": {
+ "description": "Unique test matrix id which was assigned by the service.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
"projectId": {
"description": "Cloud project that owns the test matrix.",
"required": true,
"type": "string",
"location": "path"
- },
- "testMatrixId": {
- "location": "path",
- "description": "Unique test matrix id which was assigned by the service.",
- "required": true,
- "type": "string"
}
},
"scopes": [
@@ -146,34 +146,68 @@
}
},
"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"
+ },
"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",
+ "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": {
"location": "query",
- "description": "OAuth 2.0 token for the current user.",
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
"type": "string"
},
+ "pp": {
+ "location": "query",
+ "description": "Pretty-print response.",
+ "type": "boolean",
+ "default": "true"
+ },
"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"
},
@@ -183,10 +217,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.",
@@ -197,943 +231,31 @@
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"type": "string",
"location": "query"
- },
- "$.xgafv": {
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query",
- "enum": [
- "1",
- "2"
- ],
- "description": "V1 error format.",
- "type": "string"
- },
- "callback": {
- "description": "JSONP",
- "type": "string",
- "location": "query"
- },
- "alt": {
- "description": "Data format for response.",
- "default": "json",
- "enum": [
- "json",
- "media",
- "proto"
- ],
- "type": "string",
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query"
}
},
"schemas": {
- "TestSetup": {
- "properties": {
- "account": {
- "description": "The device will be logged in on this account for the duration of the test.\nOptional",
- "$ref": "Account"
- },
- "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"
- },
- "environmentVariables": {
- "description": "Environment variables to set for the test (only applicable for\ninstrumentation tests).",
- "type": "array",
- "items": {
- "$ref": "EnvironmentVariable"
- }
- }
- },
- "id": "TestSetup",
- "description": "A description of how to set up the device prior to running the test",
- "type": "object"
- },
- "TestSpecification": {
- "properties": {
- "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"
- },
- "testSetup": {
- "$ref": "TestSetup",
- "description": "Test setup requirements e.g. files to install, bootstrap scripts\nOptional"
- },
- "androidRoboTest": {
- "$ref": "AndroidRoboTest",
- "description": "An Android robo test."
- },
- "androidTestLoop": {
- "$ref": "AndroidTestLoop",
- "description": "An Android Application with a Test Loop"
- },
- "androidInstrumentationTest": {
- "$ref": "AndroidInstrumentationTest",
- "description": "An Android instrumentation test."
- },
- "disablePerformanceMetrics": {
- "description": "Disables performance metrics recording; may reduce test latency.",
- "type": "boolean"
- },
- "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",
- "description": "A description of how to run the test.",
- "type": "object"
- },
- "TestMatrix": {
- "properties": {
- "environmentMatrix": {
- "$ref": "EnvironmentMatrix",
- "description": "How the host machine(s) are configured.\nRequired"
- },
- "testMatrixId": {
- "description": "Unique id set by the service.\n@OutputOnly",
- "type": "string"
- },
- "resultStorage": {
- "description": "Where the results for the matrix are written.\nRequired",
- "$ref": "ResultStorage"
- },
- "invalidMatrixDetails": {
- "enum": [
- "INVALID_MATRIX_DETAILS_UNSPECIFIED",
- "DETAILS_UNAVAILABLE",
- "MALFORMED_APK",
- "MALFORMED_TEST_APK",
- "NO_MANIFEST",
- "NO_PACKAGE_NAME",
- "TEST_SAME_AS_APP",
- "NO_INSTRUMENTATION",
- "NO_SIGNATURE",
- "INSTRUMENTATION_ORCHESTRATOR_INCOMPATIBLE",
- "NO_TEST_RUNNER_CLASS",
- "NO_LAUNCHER_ACTIVITY",
- "FORBIDDEN_PERMISSIONS",
- "INVALID_ROBO_DIRECTIVES",
- "TEST_LOOP_INTENT_FILTER_NOT_FOUND",
- "SCENARIO_LABEL_NOT_DECLARED",
- "SCENARIO_LABEL_MALFORMED",
- "SCENARIO_NOT_DECLARED",
- "DEVICE_ADMIN_RECEIVER",
- "TEST_ONLY_APK"
- ],
- "description": "Describes why the matrix is considered invalid.\nOnly useful for matrices in the INVALID state.\n@OutputOnly",
- "type": "string",
- "enumDescriptions": [
- "Do not use. For proto versioning only.",
- "The matrix is INVALID, but there are no further details available.",
- "The input app APK could not be parsed.",
- "The input test APK could not be parsed.",
- "The AndroidManifest.xml could not be found.",
- "The APK manifest does not declare a package name.",
- "The test package and app package are the same.",
- "The test apk does not declare an instrumentation.",
- "The input app apk does not have a signature.",
- "The test runner class specified by user or in the test APK's manifest file\nis not compatible with Android Test Orchestrator.\nOrchestrator is only compatible with AndroidJUnitRunner version 1.0 or\nhigher.\nOrchestrator can be disabled by using DO_NOT_USE_ORCHESTRATOR\nOrchestratorOption.",
- "The test APK does not contain the test runner class specified by user or in\nthe manifest file.\nThis can be caused by either of the following reasons:\n- the user provided a runner class name that's incorrect, or\n- the test runner isn't built into the test APK (might be in the app APK\ninstead).",
- "A main launcher activity could not be found.",
- "The app declares one or more permissions that are not allowed.",
- "There is a conflict in the provided robo_directives.",
- "There there is no test loop intent filter, or the one that is given is\nnot formatted correctly.",
- "The request contains a scenario label that was not declared in the\nmanifest.",
- "There was an error when parsing a label's value.",
- "The request contains a scenario number that was not declared in the\nmanifest.",
- "Device administrator applications are not allowed.",
- "The APK is marked as \"testOnly\"."
- ]
- },
- "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"
- },
- "projectId": {
- "description": "The cloud project that owns the test matrix.\n@OutputOnly",
- "type": "string"
- },
- "testSpecification": {
- "description": "How to run the test.\nRequired",
- "$ref": "TestSpecification"
- },
- "clientInfo": {
- "description": "Information about the client which invoked the test.\nOptional",
- "$ref": "ClientInfo"
- },
- "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"
- }
- },
- "id": "TestMatrix",
- "description": "A group of one or more TestExecutions, built by taking a\nproduct of values over a pre-defined set of axes.",
- "type": "object"
- },
- "ResultStorage": {
- "properties": {
- "toolResultsHistory": {
- "description": "The tool results history that contains the tool results execution that\nresults are written to.\n\nOptional, if not provided the service will choose an appropriate value.",
- "$ref": "ToolResultsHistory"
- },
- "googleCloudStorage": {
- "$ref": "GoogleCloudStorage",
- "description": "Required."
- },
- "toolResultsExecution": {
- "description": "The tool results execution that results are written to.\n@OutputOnly",
- "$ref": "ToolResultsExecution"
- }
- },
- "id": "ResultStorage",
- "description": "Locations where the results of running the test are stored.",
- "type": "object"
- },
- "AndroidVersion": {
- "description": "A version of the Android OS",
- "type": "object",
- "properties": {
- "apiLevel": {
- "description": "The API level for this Android version.\nExamples: 18, 19\n@OutputOnly",
- "format": "int32",
- "type": "integer"
- },
- "distribution": {
- "description": "Market share for this version.\n@OutputOnly",
- "$ref": "Distribution"
- },
- "releaseDate": {
- "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",
- "type": "string"
- },
- "tags": {
- "description": "Tags for this dimension.\nExamples: \"default\", \"preview\", \"deprecated\"",
- "type": "array",
- "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"
- },
- "FileReference": {
- "description": "A reference to a file, used for user inputs.",
- "type": "object",
- "properties": {
- "gcsPath": {
- "description": "A path to a file in Google Cloud Storage.\nExample: gs://build-app-1414623860166/app-debug-unaligned.apk",
- "type": "string"
- }
- },
- "id": "FileReference"
- },
- "LauncherActivityIntent": {
- "description": "Specifies an intent that starts the main launcher activity.",
- "type": "object",
- "properties": {},
- "id": "LauncherActivityIntent"
- },
- "TestDetails": {
- "properties": {
- "errorMessage": {
- "description": "If the TestState is ERROR, then this string will contain human-readable\ndetails about the error.\n@OutputOnly",
- "type": "string"
- },
- "progressMessages": {
- "description": "Human-readable, detailed descriptions of the test's progress.\nFor example: \"Provisioning a device\", \"Starting Test\".\n\nDuring the course of execution new data may be appended\nto the end of progress_messages.\n@OutputOnly",
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "id": "TestDetails",
- "description": "Additional details about the progress of the running test.",
- "type": "object"
- },
- "ToolResultsExecution": {
- "properties": {
- "executionId": {
- "description": "A tool results execution ID.\n@OutputOnly",
- "type": "string"
- },
- "projectId": {
- "description": "The cloud project that owns the tool results execution.\n@OutputOnly",
- "type": "string"
- },
- "historyId": {
- "description": "A tool results history ID.\n@OutputOnly",
- "type": "string"
- }
- },
- "id": "ToolResultsExecution",
- "description": "Represents a tool results execution resource.\n\nThis has the results of a TestMatrix.",
- "type": "object"
- },
- "ToolResultsHistory": {
- "properties": {
- "projectId": {
- "description": "The cloud project that owns the tool results history.\nRequired",
- "type": "string"
- },
- "historyId": {
- "description": "A tool results history ID.\nRequired",
- "type": "string"
- }
- },
- "id": "ToolResultsHistory",
- "description": "Represents a tool results history resource.",
- "type": "object"
- },
- "AndroidRoboTest": {
- "description": "A test of an android application that explores the application on a virtual\nor physical Android Device, finding culprits and crashes as it goes.",
- "type": "object",
- "properties": {
- "roboDirectives": {
- "description": "A set of directives Robo should apply during the crawl.\nThis allows users to customize the crawl. For example, the username and\npassword for a test account can be provided.\nOptional",
- "type": "array",
- "items": {
- "$ref": "RoboDirective"
- }
- },
- "maxDepth": {
- "description": "The max depth of the traversal stack Robo can explore. Needs to be at least\n2 to make Robo explore the app beyond the first activity.\nDefault is 50.\nOptional",
- "format": "int32",
- "type": "integer"
- },
- "appApk": {
- "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"
- },
- "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"
- }
- },
- "id": "AndroidRoboTest"
- },
- "Distribution": {
- "properties": {
- "marketShare": {
- "description": "The estimated fraction (0-1) of the total market with this configuration.\n@OutputOnly",
- "format": "double",
- "type": "number"
- },
- "measurementTime": {
- "description": "The time this distribution was measured.\n@OutputOnly",
- "format": "google-datetime",
- "type": "string"
- }
- },
- "id": "Distribution",
- "description": "Data about the relative number of devices running a\ngiven configuration of the Android platform.",
- "type": "object"
- },
- "Orientation": {
- "description": "Screen orientation of the device.",
- "type": "object",
- "properties": {
- "id": {
- "description": "The id for this orientation.\nExample: \"portrait\"\n@OutputOnly",
- "type": "string"
- },
- "tags": {
- "description": "Tags for this dimension.\nExamples: \"default\"",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "name": {
- "description": "A human-friendly name for this orientation.\nExample: \"portrait\"\n@OutputOnly",
- "type": "string"
- }
- },
- "id": "Orientation"
- },
- "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": {
- "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"
- },
- "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"
- }
- }
- },
- "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": {
- "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"
- },
- "ClientInfo": {
- "description": "Information about the client which invoked the test.",
- "type": "object",
- "properties": {
- "clientInfoDetails": {
- "description": "The list of detailed information about client.",
- "type": "array",
- "items": {
- "$ref": "ClientInfoDetail"
- }
- },
- "name": {
- "description": "Client name, such as gcloud.\nRequired",
- "type": "string"
- }
- },
- "id": "ClientInfo"
- },
- "EnvironmentMatrix": {
- "description": "The matrix of environments in which the test is to be executed.",
- "type": "object",
- "properties": {
- "androidDeviceList": {
- "description": "A list of Android devices; the test will be run only on the specified\ndevices.",
- "$ref": "AndroidDeviceList"
- },
- "androidMatrix": {
- "description": "A matrix of Android devices.",
- "$ref": "AndroidMatrix"
- }
- },
- "id": "EnvironmentMatrix"
- },
- "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"
- },
- "CancelTestMatrixResponse": {
- "description": "Response containing the current state of the specified test matrix.",
- "type": "object",
- "properties": {
- "testState": {
- "enumDescriptions": [
- "Do not use. For proto versioning only.",
- "The execution or matrix is being validated.",
- "The execution or matrix is waiting for resources to become available.",
- "The execution is currently being processed.\n\nCan only be set on an execution.",
- "The execution or matrix has terminated normally.\n\nOn a matrix this means that the matrix level processing completed normally,\nbut individual executions may be in an ERROR state.",
- "The execution or matrix has stopped because it encountered an\ninfrastructure failure.",
- "The execution was not run because it corresponds to a unsupported\nenvironment.\n\nCan only be set on an execution.",
- "The execution was not run because the provided inputs are incompatible with\nthe requested environment.\n\nExample: requested AndroidVersion is lower than APK's minSdkVersion\n\nCan only be set on an execution.",
- "The execution was not run because the provided inputs are incompatible with\nthe requested architecture.\n\nExample: requested device does not support running the native code in\nthe supplied APK\n\nCan only be set on an execution.",
- "The user cancelled the execution.\n\nCan only be set on an execution.",
- "The execution or matrix was not run because the provided inputs are not\nvalid.\n\nExamples: input file is not of the expected type, is malformed/corrupt, or\nwas flagged as malware"
- ],
- "enum": [
- "TEST_STATE_UNSPECIFIED",
- "VALIDATING",
- "PENDING",
- "RUNNING",
- "FINISHED",
- "ERROR",
- "UNSUPPORTED_ENVIRONMENT",
- "INCOMPATIBLE_ENVIRONMENT",
- "INCOMPATIBLE_ARCHITECTURE",
- "CANCELLED",
- "INVALID"
- ],
- "description": "The current rolled-up state of the test matrix.\nIf this state is already final, then the cancelation request will\nhave no effect.",
- "type": "string"
- }
- },
- "id": "CancelTestMatrixResponse"
- },
- "RoboStartingIntent": {
- "description": "Message for specifying the start activities to crawl",
- "type": "object",
- "properties": {
- "startActivity": {
- "$ref": "StartActivityIntent"
- },
- "launcherActivity": {
- "$ref": "LauncherActivityIntent"
- }
- },
- "id": "RoboStartingIntent"
- },
- "StartActivityIntent": {
- "properties": {
- "action": {
- "description": "Action name.\nRequired for START_ACTIVITY.",
- "type": "string"
- },
- "uri": {
- "description": "URI for the action.\nOptional.",
- "type": "string"
- },
- "categories": {
- "description": "Intent categories to set on the intent.\nOptional.",
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "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",
- "type": "object",
- "properties": {
- "googleAuto": {
- "description": "An automatic google login account",
- "$ref": "GoogleAuto"
- }
- },
- "id": "Account"
- },
- "TestEnvironmentCatalog": {
- "properties": {
- "androidDeviceCatalog": {
- "$ref": "AndroidDeviceCatalog",
- "description": "Android devices suitable for running Android Instrumentation Tests."
- },
- "networkConfigurationCatalog": {
- "$ref": "NetworkConfigurationCatalog",
- "description": "Supported network configurations"
- }
- },
- "id": "TestEnvironmentCatalog",
- "description": "A description of a test environment.",
- "type": "object"
- },
- "Locale": {
- "description": "A location/region designation for language.",
- "type": "object",
- "properties": {
- "region": {
- "description": "A human-friendly string representing the region for this locale.\nExample: \"United States\"\nNot present for every locale.\n@OutputOnly",
- "type": "string"
- },
- "name": {
- "description": "A human-friendly name for this language/locale.\nExample: \"English\"\n@OutputOnly",
- "type": "string"
- },
- "id": {
- "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"
- }
- }
- },
- "id": "Locale"
- },
- "ObbFile": {
- "description": "An opaque binary blob file to install on the device before the test starts",
- "type": "object",
- "properties": {
- "obbFileName": {
- "description": "OBB file name which must conform to the format as specified by\nAndroid\ne.g. [main|patch].0300110.com.example.android.obb\nwhich will be installed into\n \u003cshared-storage\u003e/Android/obb/\u003cpackage-name\u003e/\non the device\nRequired",
- "type": "string"
- },
- "obb": {
- "description": "Opaque Binary Blob (OBB) file(s) to install on the device\nRequired",
- "$ref": "FileReference"
- }
- },
- "id": "ObbFile"
- },
- "AndroidRuntimeConfiguration": {
- "properties": {
- "locales": {
- "description": "The set of available locales.\n@OutputOnly",
- "type": "array",
- "items": {
- "$ref": "Locale"
- }
- },
- "orientations": {
- "description": "The set of available orientations.\n@OutputOnly",
- "type": "array",
- "items": {
- "$ref": "Orientation"
- }
- }
- },
- "id": "AndroidRuntimeConfiguration",
- "description": "Configuration that can be selected at the time a test is run.",
- "type": "object"
- },
- "AndroidDevice": {
- "description": "A single Android device.",
- "type": "object",
- "properties": {
- "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"
- },
- "androidVersionId": {
- "description": "The id of the Android OS version to be used.\nUse the EnvironmentDiscoveryService to get supported options.\nRequired",
- "type": "string"
- },
- "orientation": {
- "description": "How the device is oriented during the test.\nUse the EnvironmentDiscoveryService to get supported options.\nRequired",
- "type": "string"
- }
- },
- "id": "AndroidDevice"
- },
- "NetworkConfiguration": {
- "properties": {
- "id": {
- "description": "The unique opaque id for this network traffic configuration\n@OutputOnly",
- "type": "string"
- },
- "upRule": {
- "$ref": "TrafficRule",
- "description": "The emulation rule applying to the upload traffic"
- },
- "downRule": {
- "$ref": "TrafficRule",
- "description": "The emulation rule applying to the download traffic"
- }
- },
- "id": "NetworkConfiguration",
- "type": "object"
- },
- "ToolResultsStep": {
- "description": "Represents a tool results step resource.\n\nThis has the results of a TestExecution.",
- "type": "object",
- "properties": {
- "stepId": {
- "description": "A tool results step ID.\n@OutputOnly",
- "type": "string"
- },
- "projectId": {
- "description": "The cloud project that owns the tool results step.\n@OutputOnly",
- "type": "string"
- },
- "historyId": {
- "description": "A tool results history ID.\n@OutputOnly",
- "type": "string"
- },
- "executionId": {
- "description": "A tool results execution ID.\n@OutputOnly",
- "type": "string"
- }
- },
- "id": "ToolResultsStep"
- },
- "TrafficRule": {
- "properties": {
- "delay": {
- "description": "Packet delay, must be \u003e= 0",
- "format": "google-duration",
- "type": "string"
- },
- "packetLossRatio": {
- "description": "Packet loss ratio (0.0 - 1.0)",
- "format": "float",
- "type": "number"
- },
- "burst": {
- "description": "Burst size in kbits",
- "format": "float",
- "type": "number"
- },
- "bandwidth": {
- "description": "Bandwidth in kbits/second",
- "format": "float",
- "type": "number"
- },
- "packetDuplicationRatio": {
- "description": "Packet duplication ratio (0.0 - 1.0)",
- "format": "float",
- "type": "number"
- }
- },
- "id": "TrafficRule",
- "description": "Network emulation parameters",
- "type": "object"
- },
- "AndroidInstrumentationTest": {
- "properties": {
- "orchestratorOption": {
- "enumDescriptions": [
- "This means that the server should choose the mode. And test will be run\nwithout orchestrator.\nUsing orchestrator is highly encouraged because of all the benefits it\noffers. And in the future, all instrumentation tests will be run with\norchestrator by default if preference unspecified.",
- "Run test using orchestrator.\n** Only compatible with AndroidJUnitRunner version 1.0 or higher! **\nRecommended.",
- "Run test without using orchestrator."
- ],
- "enum": [
- "ORCHESTRATOR_OPTION_UNSPECIFIED",
- "USE_ORCHESTRATOR",
- "DO_NOT_USE_ORCHESTRATOR"
- ],
- "description": "The option of whether running each test within its own invocation of\ninstrumentation with Android Test Orchestrator or not.\n** Orchestrator is only compatible with AndroidJUnitRunner version 1.0 or\nhigher! **\nOrchestrator offers the following benefits:\n - No shared state\n - Crashes are isolated\n - Logs are scoped per test\n\nSee\n\u003chttps://developer.android.com/training/testing/junit-runner.html#using-android-test-orchestrator\u003e\nfor more information about Android Test Orchestrator.\n\nOptional, if empty, test will be run without orchestrator.",
- "type": "string"
- },
- "testTargets": {
- "description": "Each target must be fully qualified with the package name or class name,\nin one of these formats:\n - \"package package_name\"\n - \"class package_name.class_name\"\n - \"class package_name.class_name#method_name\"\n\nOptional, if empty, all targets in the module will be run.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "testApk": {
- "$ref": "FileReference",
- "description": "The APK containing the test code to be executed.\nRequired"
- },
- "testRunnerClass": {
- "description": "The InstrumentationTestRunner class.\nOptional, default is determined by examining the application's manifest.",
- "type": "string"
- },
- "testPackageId": {
- "description": "The java package for the test to be executed.\nOptional, default is determined by examining the application's manifest.",
- "type": "string"
- },
- "appApk": {
- "$ref": "FileReference",
- "description": "The APK for the application under test.\nRequired"
- },
- "appPackageId": {
- "description": "The java package for the application under test.\nOptional, default is determined by examining the application's manifest.",
- "type": "string"
- }
- },
- "id": "AndroidInstrumentationTest",
- "description": "A test of an Android application that can control an Android component\nindependently of its normal lifecycle.\nAndroid instrumentation tests run an application APK and test APK inside the\nsame process on a virtual or physical AndroidDevice. They also specify\na test runner class, such as com.google.GoogleTestRunner, which can vary\non the specific instrumentation framework chosen.\n\nSee \u003chttp://developer.android.com/tools/testing/testing_android.html\u003e for\nmore information on types of Android tests.",
- "type": "object"
- },
- "DeviceFile": {
- "description": "A single device file description.",
- "type": "object",
- "properties": {
- "obbFile": {
- "description": "A reference to an opaque binary blob file",
- "$ref": "ObbFile"
- }
- },
- "id": "DeviceFile"
- },
- "ClientInfoDetail": {
- "description": "Key-value pair of detailed information about the client which invoked the\ntest. For example {'Version', '1.0'}, {'Release Track', 'BETA'}",
- "type": "object",
- "properties": {
- "key": {
- "description": "The key of detailed client information.\nRequired",
- "type": "string"
- },
- "value": {
- "description": "The value of detailed client information.\nRequired",
- "type": "string"
- }
- },
- "id": "ClientInfoDetail"
- },
"EnvironmentVariable": {
+ "description": "A key-value pair passed as an environment variable to the test",
+ "type": "object",
"properties": {
- "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",
- "description": "A key-value pair passed as an environment variable to the test",
- "type": "object"
+ "id": "EnvironmentVariable"
},
"Environment": {
"description": "The environment in which the test is run.",
"type": "object",
"properties": {
"androidDevice": {
- "description": "An Android device which must be used with an Android test.",
- "$ref": "AndroidDevice"
+ "$ref": "AndroidDevice",
+ "description": "An Android device which must be used with an Android test."
}
},
"id": "Environment"
@@ -1150,23 +272,20 @@
"id": "GoogleCloudStorage"
},
"TestExecution": {
- "description": "Specifies a single test to be executed in a single environment.",
- "type": "object",
"properties": {
+ "matrixId": {
+ "description": "Id of the containing TestMatrix.\n@OutputOnly",
+ "type": "string"
+ },
+ "testDetails": {
+ "description": "Additional details about the running test.\n@OutputOnly",
+ "$ref": "TestDetails"
+ },
+ "environment": {
+ "description": "How the host machine(s) are configured.\n@OutputOnly",
+ "$ref": "Environment"
+ },
"state": {
- "enumDescriptions": [
- "Do not use. For proto versioning only.",
- "The execution or matrix is being validated.",
- "The execution or matrix is waiting for resources to become available.",
- "The execution is currently being processed.\n\nCan only be set on an execution.",
- "The execution or matrix has terminated normally.\n\nOn a matrix this means that the matrix level processing completed normally,\nbut individual executions may be in an ERROR state.",
- "The execution or matrix has stopped because it encountered an\ninfrastructure failure.",
- "The execution was not run because it corresponds to a unsupported\nenvironment.\n\nCan only be set on an execution.",
- "The execution was not run because the provided inputs are incompatible with\nthe requested environment.\n\nExample: requested AndroidVersion is lower than APK's minSdkVersion\n\nCan only be set on an execution.",
- "The execution was not run because the provided inputs are incompatible with\nthe requested architecture.\n\nExample: requested device does not support running the native code in\nthe supplied APK\n\nCan only be set on an execution.",
- "The user cancelled the execution.\n\nCan only be set on an execution.",
- "The execution or matrix was not run because the provided inputs are not\nvalid.\n\nExamples: input file is not of the expected type, is malformed/corrupt, or\nwas flagged as malware"
- ],
"enum": [
"TEST_STATE_UNSPECIFIED",
"VALIDATING",
@@ -1181,11 +300,24 @@
"INVALID"
],
"description": "Indicates the current progress of the test execution (e.g., FINISHED).\n@OutputOnly",
- "type": "string"
+ "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"
+ ]
},
"toolResultsStep": {
- "$ref": "ToolResultsStep",
- "description": "Where the results for this execution are written.\n@OutputOnly"
+ "description": "Where the results for this execution are written.\n@OutputOnly",
+ "$ref": "ToolResultsStep"
},
"projectId": {
"description": "The cloud project that owns the test execution.\n@OutputOnly",
@@ -1203,34 +335,16 @@
"description": "The time this test execution was initially created.\n@OutputOnly",
"format": "google-datetime",
"type": "string"
- },
- "matrixId": {
- "description": "Id of the containing TestMatrix.\n@OutputOnly",
- "type": "string"
- },
- "testDetails": {
- "$ref": "TestDetails",
- "description": "Additional details about the running test.\n@OutputOnly"
- },
- "environment": {
- "$ref": "Environment",
- "description": "How the host machine(s) are configured.\n@OutputOnly"
}
},
- "id": "TestExecution"
+ "id": "TestExecution",
+ "description": "Specifies a single test to be executed in a single environment.",
+ "type": "object"
},
"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": {
- "resourceName": {
- "description": "The android resource name of the target UI element\nFor example,\n in Java: R.string.foo\n in xml: @string/foo\nOnly the “foo” part is needed.\nReference doc:\nhttps://developer.android.com/guide/topics/resources/accessing-resources.html\nRequired",
- "type": "string"
- },
- "inputText": {
- "description": "The text that Robo is directed to set. If left empty, the directive will be\ntreated as a CLICK on the element matching the resource_name.\nOptional",
- "type": "string"
- },
"actionType": {
"enumDescriptions": [
"DO NOT USE. For proto versioning only.",
@@ -1244,6 +358,14 @@
],
"description": "The type of action that Robo should perform on the specified element.\nRequired.",
"type": "string"
+ },
+ "resourceName": {
+ "description": "The android resource name of the target UI element\nFor example,\n in Java: R.string.foo\n in xml: @string/foo\nOnly the “foo” part is needed.\nReference doc:\nhttps://developer.android.com/guide/topics/resources/accessing-resources.html\nRequired",
+ "type": "string"
+ },
+ "inputText": {
+ "description": "The text that Robo is directed to set. If left empty, the directive will be\ntreated as a CLICK on the element matching the resource_name.\nOptional",
+ "type": "string"
}
},
"id": "RoboDirective"
@@ -1325,18 +447,18 @@
"type": "integer"
},
"form": {
+ "enumDescriptions": [
+ "Do not use. For proto versioning only.",
+ "A software stack that simulates the device",
+ "Actual hardware"
+ ],
"enum": [
"DEVICE_FORM_UNSPECIFIED",
"VIRTUAL",
"PHYSICAL"
],
"description": "Whether this device is virtual or physical.\n@OutputOnly",
- "type": "string",
- "enumDescriptions": [
- "Do not use. For proto versioning only.",
- "A software stack that simulates the device",
- "Actual hardware"
- ]
+ "type": "string"
},
"screenDensity": {
"description": "Screen density in DPI.\nThis corresponds to ro.sf.lcd_density\n@OutputOnly",
@@ -1359,6 +481,884 @@
}
},
"id": "AndroidModel"
+ },
+ "TestSetup": {
+ "description": "A description of how to set up the device prior to running the test",
+ "type": "object",
+ "properties": {
+ "networkProfile": {
+ "description": "The network traffic profile used for running the test.\nOptional",
+ "type": "string"
+ },
+ "environmentVariables": {
+ "description": "Environment variables to set for the test (only applicable for\ninstrumentation tests).",
+ "type": "array",
+ "items": {
+ "$ref": "EnvironmentVariable"
+ }
+ },
+ "account": {
+ "$ref": "Account",
+ "description": "The device will be logged in on this account for the duration of the test.\nOptional"
+ },
+ "directoriesToPull": {
+ "description": "List of directories on the device to upload to GCS at the end of the test;\nthey must be absolute paths under /sdcard or /data/local/tmp.\nPath names are restricted to characters a-z A-Z 0-9 _ - . + and /\n\nNote: The paths /sdcard and /data will be made available and treated as\nimplicit path substitutions. E.g. if /sdcard on a particular device does\nnot map to external storage, the system will replace it with the external\nstorage path prefix for that device.\n\nOptional",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "filesToPush": {
+ "description": "List of files to push to the device before starting the test.\n\nOptional",
+ "type": "array",
+ "items": {
+ "$ref": "DeviceFile"
+ }
+ }
+ },
+ "id": "TestSetup"
+ },
+ "TestSpecification": {
+ "description": "A description of how to run the test.",
+ "type": "object",
+ "properties": {
+ "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"
+ },
+ "testSetup": {
+ "$ref": "TestSetup",
+ "description": "Test setup requirements e.g. files to install, bootstrap scripts\nOptional"
+ },
+ "androidRoboTest": {
+ "$ref": "AndroidRoboTest",
+ "description": "An Android robo test."
+ },
+ "androidTestLoop": {
+ "description": "An Android Application with a Test Loop",
+ "$ref": "AndroidTestLoop"
+ },
+ "androidInstrumentationTest": {
+ "$ref": "AndroidInstrumentationTest",
+ "description": "An Android instrumentation test."
+ },
+ "disablePerformanceMetrics": {
+ "description": "Disables performance metrics recording; may reduce test latency.",
+ "type": "boolean"
+ },
+ "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"
+ },
+ "ResultStorage": {
+ "description": "Locations where the results of running the test are stored.",
+ "type": "object",
+ "properties": {
+ "toolResultsExecution": {
+ "description": "The tool results execution that results are written to.\n@OutputOnly",
+ "$ref": "ToolResultsExecution"
+ },
+ "toolResultsHistory": {
+ "description": "The tool results history that contains the tool results execution that\nresults are written to.\n\nOptional, if not provided the service will choose an appropriate value.",
+ "$ref": "ToolResultsHistory"
+ },
+ "googleCloudStorage": {
+ "description": "Required.",
+ "$ref": "GoogleCloudStorage"
+ }
+ },
+ "id": "ResultStorage"
+ },
+ "TestMatrix": {
+ "properties": {
+ "testMatrixId": {
+ "description": "Unique id set by the service.\n@OutputOnly",
+ "type": "string"
+ },
+ "resultStorage": {
+ "description": "Where the results for the matrix are written.\nRequired",
+ "$ref": "ResultStorage"
+ },
+ "invalidMatrixDetails": {
+ "enumDescriptions": [
+ "Do not use. For proto versioning only.",
+ "The matrix is INVALID, but there are no further details available.",
+ "The input app APK could not be parsed.",
+ "The input test APK could not be parsed.",
+ "The AndroidManifest.xml could not be found.",
+ "The APK manifest does not declare a package name.",
+ "The test package and app package are the same.",
+ "The test apk does not declare an instrumentation.",
+ "The input app apk does not have a signature.",
+ "The test runner class specified by user or in the test APK's manifest file\nis not compatible with Android Test Orchestrator.\nOrchestrator is only compatible with AndroidJUnitRunner version 1.0 or\nhigher.\nOrchestrator can be disabled by using DO_NOT_USE_ORCHESTRATOR\nOrchestratorOption.",
+ "The test APK does not contain the test runner class specified by user or in\nthe manifest file.\nThis can be caused by either of the following reasons:\n- the user provided a runner class name that's incorrect, or\n- the test runner isn't built into the test APK (might be in the app APK\ninstead).",
+ "A main launcher activity could not be found.",
+ "The app declares one or more permissions that are not allowed.",
+ "There is a conflict in the provided robo_directives.",
+ "There there is no test loop intent filter, or the one that is given is\nnot formatted correctly.",
+ "The request contains a scenario label that was not declared in the\nmanifest.",
+ "There was an error when parsing a label's value.",
+ "The request contains a scenario number that was not declared in the\nmanifest.",
+ "Device administrator applications are not allowed.",
+ "The APK is marked as \"testOnly\"."
+ ],
+ "enum": [
+ "INVALID_MATRIX_DETAILS_UNSPECIFIED",
+ "DETAILS_UNAVAILABLE",
+ "MALFORMED_APK",
+ "MALFORMED_TEST_APK",
+ "NO_MANIFEST",
+ "NO_PACKAGE_NAME",
+ "TEST_SAME_AS_APP",
+ "NO_INSTRUMENTATION",
+ "NO_SIGNATURE",
+ "INSTRUMENTATION_ORCHESTRATOR_INCOMPATIBLE",
+ "NO_TEST_RUNNER_CLASS",
+ "NO_LAUNCHER_ACTIVITY",
+ "FORBIDDEN_PERMISSIONS",
+ "INVALID_ROBO_DIRECTIVES",
+ "TEST_LOOP_INTENT_FILTER_NOT_FOUND",
+ "SCENARIO_LABEL_NOT_DECLARED",
+ "SCENARIO_LABEL_MALFORMED",
+ "SCENARIO_NOT_DECLARED",
+ "DEVICE_ADMIN_RECEIVER",
+ "TEST_ONLY_APK"
+ ],
+ "description": "Describes why the matrix is considered invalid.\nOnly useful for matrices in the INVALID state.\n@OutputOnly",
+ "type": "string"
+ },
+ "state": {
+ "description": "Indicates the current progress of the test matrix (e.g., FINISHED)\n@OutputOnly",
+ "type": "string",
+ "enumDescriptions": [
+ "Do not use. For proto versioning only.",
+ "The execution or matrix is being validated.",
+ "The execution or matrix is waiting for resources to become available.",
+ "The execution is currently being processed.\n\nCan only be set on an execution.",
+ "The execution or matrix has terminated normally.\n\nOn a matrix this means that the matrix level processing completed normally,\nbut individual executions may be in an ERROR state.",
+ "The execution or matrix has stopped because it encountered an\ninfrastructure failure.",
+ "The execution was not run because it corresponds to a unsupported\nenvironment.\n\nCan only be set on an execution.",
+ "The execution was not run because the provided inputs are incompatible with\nthe requested environment.\n\nExample: requested AndroidVersion is lower than APK's minSdkVersion\n\nCan only be set on an execution.",
+ "The execution was not run because the provided inputs are incompatible with\nthe requested architecture.\n\nExample: requested device does not support running the native code in\nthe supplied APK\n\nCan only be set on an execution.",
+ "The user cancelled the execution.\n\nCan only be set on an execution.",
+ "The execution or matrix was not run because the provided inputs are not\nvalid.\n\nExamples: input file is not of the expected type, is malformed/corrupt, or\nwas flagged as malware"
+ ],
+ "enum": [
+ "TEST_STATE_UNSPECIFIED",
+ "VALIDATING",
+ "PENDING",
+ "RUNNING",
+ "FINISHED",
+ "ERROR",
+ "UNSUPPORTED_ENVIRONMENT",
+ "INCOMPATIBLE_ENVIRONMENT",
+ "INCOMPATIBLE_ARCHITECTURE",
+ "CANCELLED",
+ "INVALID"
+ ]
+ },
+ "projectId": {
+ "description": "The cloud project that owns the test matrix.\n@OutputOnly",
+ "type": "string"
+ },
+ "testSpecification": {
+ "description": "How to run the test.\nRequired",
+ "$ref": "TestSpecification"
+ },
+ "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": {
+ "$ref": "EnvironmentMatrix",
+ "description": "How the host machine(s) are configured.\nRequired"
+ }
+ },
+ "id": "TestMatrix",
+ "description": "A group of one or more TestExecutions, built by taking a\nproduct of values over a pre-defined set of axes.",
+ "type": "object"
+ },
+ "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",
+ "type": "integer"
+ },
+ "distribution": {
+ "description": "Market share for this version.\n@OutputOnly",
+ "$ref": "Distribution"
+ },
+ "tags": {
+ "description": "Tags for this dimension.\nExamples: \"default\", \"preview\", \"deprecated\"",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "id": {
+ "description": "An opaque id for this Android version.\nUse this id to invoke the TestExecutionService.\n@OutputOnly",
+ "type": "string"
+ },
+ "releaseDate": {
+ "description": "The date this Android version became available in the market.\n@OutputOnly",
+ "$ref": "Date"
+ }
+ },
+ "id": "AndroidVersion"
+ },
+ "FileReference": {
+ "description": "A reference to a file, used for user inputs.",
+ "type": "object",
+ "properties": {
+ "gcsPath": {
+ "description": "A path to a file in Google Cloud Storage.\nExample: gs://build-app-1414623860166/app-debug-unaligned.apk",
+ "type": "string"
+ }
+ },
+ "id": "FileReference"
+ },
+ "LauncherActivityIntent": {
+ "description": "Specifies an intent that starts the main launcher activity.",
+ "type": "object",
+ "properties": {},
+ "id": "LauncherActivityIntent"
+ },
+ "TestDetails": {
+ "description": "Additional details about the progress of the running test.",
+ "type": "object",
+ "properties": {
+ "errorMessage": {
+ "description": "If the TestState is ERROR, then this string will contain human-readable\ndetails about the error.\n@OutputOnly",
+ "type": "string"
+ },
+ "progressMessages": {
+ "description": "Human-readable, detailed descriptions of the test's progress.\nFor example: \"Provisioning a device\", \"Starting Test\".\n\nDuring the course of execution new data may be appended\nto the end of progress_messages.\n@OutputOnly",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "id": "TestDetails"
+ },
+ "ToolResultsExecution": {
+ "properties": {
+ "executionId": {
+ "description": "A tool results execution ID.\n@OutputOnly",
+ "type": "string"
+ },
+ "projectId": {
+ "description": "The cloud project that owns the tool results execution.\n@OutputOnly",
+ "type": "string"
+ },
+ "historyId": {
+ "description": "A tool results history ID.\n@OutputOnly",
+ "type": "string"
+ }
+ },
+ "id": "ToolResultsExecution",
+ "description": "Represents a tool results execution resource.\n\nThis has the results of a TestMatrix.",
+ "type": "object"
+ },
+ "ToolResultsHistory": {
+ "properties": {
+ "projectId": {
+ "description": "The cloud project that owns the tool results history.\nRequired",
+ "type": "string"
+ },
+ "historyId": {
+ "description": "A tool results history ID.\nRequired",
+ "type": "string"
+ }
+ },
+ "id": "ToolResultsHistory",
+ "description": "Represents a tool results history resource.",
+ "type": "object"
+ },
+ "AndroidRoboTest": {
+ "properties": {
+ "maxDepth": {
+ "description": "The max depth of the traversal stack Robo can explore. Needs to be at least\n2 to make Robo explore the app beyond the first activity.\nDefault is 50.\nOptional",
+ "format": "int32",
+ "type": "integer"
+ },
+ "appPackageId": {
+ "description": "The java package for the application under test.\nOptional, default is determined by examining the application's manifest.",
+ "type": "string"
+ },
+ "appApk": {
+ "$ref": "FileReference",
+ "description": "The APK for the application under test.\nRequired"
+ },
+ "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"
+ }
+ },
+ "appInitialActivity": {
+ "description": "The initial activity that should be used to start the app.\nOptional",
+ "type": "string"
+ },
+ "maxSteps": {
+ "description": "The max number of steps Robo can execute.\nDefault is no limit.\nOptional",
+ "format": "int32",
+ "type": "integer"
+ },
+ "roboDirectives": {
+ "description": "A set of directives Robo should apply during the crawl.\nThis allows users to customize the crawl. For example, the username and\npassword for a test account can be provided.\nOptional",
+ "type": "array",
+ "items": {
+ "$ref": "RoboDirective"
+ }
+ }
+ },
+ "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": {
+ "properties": {
+ "measurementTime": {
+ "description": "The time this distribution was measured.\n@OutputOnly",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "marketShare": {
+ "description": "The estimated fraction (0-1) of the total market with this configuration.\n@OutputOnly",
+ "format": "double",
+ "type": "number"
+ }
+ },
+ "id": "Distribution",
+ "description": "Data about the relative number of devices running a\ngiven configuration of the Android platform.",
+ "type": "object"
+ },
+ "Orientation": {
+ "properties": {
+ "id": {
+ "description": "The id for this orientation.\nExample: \"portrait\"\n@OutputOnly",
+ "type": "string"
+ },
+ "tags": {
+ "description": "Tags for this dimension.\nExamples: \"default\"",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "name": {
+ "description": "A human-friendly name for this orientation.\nExample: \"portrait\"\n@OutputOnly",
+ "type": "string"
+ }
+ },
+ "id": "Orientation",
+ "description": "Screen orientation of the device.",
+ "type": "object"
+ },
+ "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": {
+ "$ref": "FileReference",
+ "description": "The APK for the application under test.\nRequired"
+ },
+ "appPackageId": {
+ "description": "The java package for the application under test.\nOptional, default is determined by examining the application's manifest.",
+ "type": "string"
+ }
+ },
+ "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": {
+ "description": "The currently supported Android devices.",
+ "type": "object",
+ "properties": {
+ "models": {
+ "description": "The set of supported Android device models.\n@OutputOnly",
+ "type": "array",
+ "items": {
+ "$ref": "AndroidModel"
+ }
+ },
+ "versions": {
+ "description": "The set of supported Android OS versions.\n@OutputOnly",
+ "type": "array",
+ "items": {
+ "$ref": "AndroidVersion"
+ }
+ },
+ "runtimeConfiguration": {
+ "$ref": "AndroidRuntimeConfiguration",
+ "description": "The set of supported runtime configurations.\n@OutputOnly"
+ }
+ },
+ "id": "AndroidDeviceCatalog"
+ },
+ "AndroidDeviceList": {
+ "description": "A list of Android device configurations in which the test is to be executed.",
+ "type": "object",
+ "properties": {
+ "androidDevices": {
+ "description": "A list of Android devices\nRequired",
+ "type": "array",
+ "items": {
+ "$ref": "AndroidDevice"
+ }
+ }
+ },
+ "id": "AndroidDeviceList"
+ },
+ "ClientInfo": {
+ "description": "Information about the client which invoked the test.",
+ "type": "object",
+ "properties": {
+ "clientInfoDetails": {
+ "description": "The list of detailed information about client.",
+ "type": "array",
+ "items": {
+ "$ref": "ClientInfoDetail"
+ }
+ },
+ "name": {
+ "description": "Client name, such as gcloud.\nRequired",
+ "type": "string"
+ }
+ },
+ "id": "ClientInfo"
+ },
+ "EnvironmentMatrix": {
+ "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"
+ }
+ },
+ "id": "EnvironmentMatrix"
+ },
+ "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"
+ },
+ "CancelTestMatrixResponse": {
+ "description": "Response containing the current state of the specified test matrix.",
+ "type": "object",
+ "properties": {
+ "testState": {
+ "enum": [
+ "TEST_STATE_UNSPECIFIED",
+ "VALIDATING",
+ "PENDING",
+ "RUNNING",
+ "FINISHED",
+ "ERROR",
+ "UNSUPPORTED_ENVIRONMENT",
+ "INCOMPATIBLE_ENVIRONMENT",
+ "INCOMPATIBLE_ARCHITECTURE",
+ "CANCELLED",
+ "INVALID"
+ ],
+ "description": "The current rolled-up state of the test matrix.\nIf this state is already final, then the cancelation request will\nhave no effect.",
+ "type": "string",
+ "enumDescriptions": [
+ "Do not use. For proto versioning only.",
+ "The execution or matrix is being validated.",
+ "The execution or matrix is waiting for resources to become available.",
+ "The execution is currently being processed.\n\nCan only be set on an execution.",
+ "The execution or matrix has terminated normally.\n\nOn a matrix this means that the matrix level processing completed normally,\nbut individual executions may be in an ERROR state.",
+ "The execution or matrix has stopped because it encountered an\ninfrastructure failure.",
+ "The execution was not run because it corresponds to a unsupported\nenvironment.\n\nCan only be set on an execution.",
+ "The execution was not run because the provided inputs are incompatible with\nthe requested environment.\n\nExample: requested AndroidVersion is lower than APK's minSdkVersion\n\nCan only be set on an execution.",
+ "The execution was not run because the provided inputs are incompatible with\nthe requested architecture.\n\nExample: requested device does not support running the native code in\nthe supplied APK\n\nCan only be set on an execution.",
+ "The user cancelled the execution.\n\nCan only be set on an execution.",
+ "The execution or matrix was not run because the provided inputs are not\nvalid.\n\nExamples: input file is not of the expected type, is malformed/corrupt, or\nwas flagged as malware"
+ ]
+ }
+ },
+ "id": "CancelTestMatrixResponse"
+ },
+ "RoboStartingIntent": {
+ "description": "Message for specifying the start activities to crawl",
+ "type": "object",
+ "properties": {
+ "startActivity": {
+ "$ref": "StartActivityIntent"
+ },
+ "launcherActivity": {
+ "$ref": "LauncherActivityIntent"
+ }
+ },
+ "id": "RoboStartingIntent"
+ },
+ "StartActivityIntent": {
+ "properties": {
+ "uri": {
+ "description": "URI for the action.\nOptional.",
+ "type": "string"
+ },
+ "categories": {
+ "description": "Intent categories to set on the intent.\nOptional.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "action": {
+ "description": "Action name.\nRequired for START_ACTIVITY.",
+ "type": "string"
+ }
+ },
+ "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",
+ "type": "object",
+ "properties": {
+ "googleAuto": {
+ "description": "An automatic google login account",
+ "$ref": "GoogleAuto"
+ }
+ },
+ "id": "Account"
+ },
+ "TestEnvironmentCatalog": {
+ "description": "A description of a test environment.",
+ "type": "object",
+ "properties": {
+ "androidDeviceCatalog": {
+ "$ref": "AndroidDeviceCatalog",
+ "description": "Android devices suitable for running Android Instrumentation Tests."
+ },
+ "networkConfigurationCatalog": {
+ "description": "Supported network configurations",
+ "$ref": "NetworkConfigurationCatalog"
+ }
+ },
+ "id": "TestEnvironmentCatalog"
+ },
+ "Locale": {
+ "properties": {
+ "name": {
+ "description": "A human-friendly name for this language/locale.\nExample: \"English\"\n@OutputOnly",
+ "type": "string"
+ },
+ "id": {
+ "description": "The id for this locale.\nExample: \"en_US\"\n@OutputOnly",
+ "type": "string"
+ },
+ "tags": {
+ "description": "Tags for this dimension.\nExamples: \"default\"",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "region": {
+ "description": "A human-friendly string representing the region for this locale.\nExample: \"United States\"\nNot present for every locale.\n@OutputOnly",
+ "type": "string"
+ }
+ },
+ "id": "Locale",
+ "description": "A location/region designation for language.",
+ "type": "object"
+ },
+ "ObbFile": {
+ "properties": {
+ "obbFileName": {
+ "description": "OBB file name which must conform to the format as specified by\nAndroid\ne.g. [main|patch].0300110.com.example.android.obb\nwhich will be installed into\n \u003cshared-storage\u003e/Android/obb/\u003cpackage-name\u003e/\non the device\nRequired",
+ "type": "string"
+ },
+ "obb": {
+ "$ref": "FileReference",
+ "description": "Opaque Binary Blob (OBB) file(s) to install on the device\nRequired"
+ }
+ },
+ "id": "ObbFile",
+ "description": "An opaque binary blob file to install on the device before the test starts",
+ "type": "object"
+ },
+ "AndroidRuntimeConfiguration": {
+ "properties": {
+ "orientations": {
+ "description": "The set of available orientations.\n@OutputOnly",
+ "type": "array",
+ "items": {
+ "$ref": "Orientation"
+ }
+ },
+ "locales": {
+ "description": "The set of available locales.\n@OutputOnly",
+ "type": "array",
+ "items": {
+ "$ref": "Locale"
+ }
+ }
+ },
+ "id": "AndroidRuntimeConfiguration",
+ "description": "Configuration that can be selected at the time a test is run.",
+ "type": "object"
+ },
+ "AndroidDevice": {
+ "description": "A single Android device.",
+ "type": "object",
+ "properties": {
+ "androidModelId": {
+ "description": "The id of the Android device to be used.\nUse the EnvironmentDiscoveryService to get supported options.\nRequired",
+ "type": "string"
+ },
+ "androidVersionId": {
+ "description": "The id of the Android OS version to be used.\nUse the EnvironmentDiscoveryService to get supported options.\nRequired",
+ "type": "string"
+ },
+ "orientation": {
+ "description": "How the device is oriented during the test.\nUse the EnvironmentDiscoveryService to get supported options.\nRequired",
+ "type": "string"
+ },
+ "locale": {
+ "description": "The locale the test device used for testing.\nUse the EnvironmentDiscoveryService to get supported options.\nRequired",
+ "type": "string"
+ }
+ },
+ "id": "AndroidDevice"
+ },
+ "NetworkConfiguration": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "description": "The unique opaque id for this network traffic configuration\n@OutputOnly",
+ "type": "string"
+ },
+ "upRule": {
+ "description": "The emulation rule applying to the upload traffic",
+ "$ref": "TrafficRule"
+ },
+ "downRule": {
+ "$ref": "TrafficRule",
+ "description": "The emulation rule applying to the download traffic"
+ }
+ },
+ "id": "NetworkConfiguration"
+ },
+ "ToolResultsStep": {
+ "description": "Represents a tool results step resource.\n\nThis has the results of a TestExecution.",
+ "type": "object",
+ "properties": {
+ "executionId": {
+ "description": "A tool results execution ID.\n@OutputOnly",
+ "type": "string"
+ },
+ "stepId": {
+ "description": "A tool results step ID.\n@OutputOnly",
+ "type": "string"
+ },
+ "projectId": {
+ "description": "The cloud project that owns the tool results step.\n@OutputOnly",
+ "type": "string"
+ },
+ "historyId": {
+ "description": "A tool results history ID.\n@OutputOnly",
+ "type": "string"
+ }
+ },
+ "id": "ToolResultsStep"
+ },
+ "TrafficRule": {
+ "description": "Network emulation parameters",
+ "type": "object",
+ "properties": {
+ "packetLossRatio": {
+ "description": "Packet loss ratio (0.0 - 1.0)",
+ "format": "float",
+ "type": "number"
+ },
+ "burst": {
+ "description": "Burst size in kbits",
+ "format": "float",
+ "type": "number"
+ },
+ "bandwidth": {
+ "description": "Bandwidth in kbits/second",
+ "format": "float",
+ "type": "number"
+ },
+ "packetDuplicationRatio": {
+ "description": "Packet duplication ratio (0.0 - 1.0)",
+ "format": "float",
+ "type": "number"
+ },
+ "delay": {
+ "description": "Packet delay, must be \u003e= 0",
+ "format": "google-duration",
+ "type": "string"
+ }
+ },
+ "id": "TrafficRule"
+ },
+ "AndroidInstrumentationTest": {
+ "properties": {
+ "orchestratorOption": {
+ "description": "The option of whether running each test within its own invocation of\ninstrumentation with Android Test Orchestrator or not.\n** Orchestrator is only compatible with AndroidJUnitRunner version 1.0 or\nhigher! **\nOrchestrator offers the following benefits:\n - No shared state\n - Crashes are isolated\n - Logs are scoped per test\n\nSee\n\u003chttps://developer.android.com/training/testing/junit-runner.html#using-android-test-orchestrator\u003e\nfor more information about Android Test Orchestrator.\n\nOptional, if empty, test will be run without orchestrator.",
+ "type": "string",
+ "enumDescriptions": [
+ "This means that the server should choose the mode. And test will be run\nwithout orchestrator.\nUsing orchestrator is highly encouraged because of all the benefits it\noffers. And in the future, all instrumentation tests will be run with\norchestrator by default if preference unspecified.",
+ "Run test using orchestrator.\n** Only compatible with AndroidJUnitRunner version 1.0 or higher! **\nRecommended.",
+ "Run test without using orchestrator."
+ ],
+ "enum": [
+ "ORCHESTRATOR_OPTION_UNSPECIFIED",
+ "USE_ORCHESTRATOR",
+ "DO_NOT_USE_ORCHESTRATOR"
+ ]
+ },
+ "testTargets": {
+ "description": "Each target must be fully qualified with the package name or class name,\nin one of these formats:\n - \"package package_name\"\n - \"class package_name.class_name\"\n - \"class package_name.class_name#method_name\"\n\nOptional, if empty, all targets in the module will be run.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "testApk": {
+ "description": "The APK containing the test code to be executed.\nRequired",
+ "$ref": "FileReference"
+ },
+ "testRunnerClass": {
+ "description": "The InstrumentationTestRunner class.\nOptional, default is determined by examining the application's manifest.",
+ "type": "string"
+ },
+ "testPackageId": {
+ "description": "The java package for the test to be executed.\nOptional, default is determined by examining the application's manifest.",
+ "type": "string"
+ },
+ "appApk": {
+ "$ref": "FileReference",
+ "description": "The APK for the application under test.\nRequired"
+ },
+ "appPackageId": {
+ "description": "The java package for the application under test.\nOptional, default is determined by examining the application's manifest.",
+ "type": "string"
+ }
+ },
+ "id": "AndroidInstrumentationTest",
+ "description": "A test of an Android application that can control an Android component\nindependently of its normal lifecycle.\nAndroid instrumentation tests run an application APK and test APK inside the\nsame process on a virtual or physical AndroidDevice. They also specify\na test runner class, such as com.google.GoogleTestRunner, which can vary\non the specific instrumentation framework chosen.\n\nSee \u003chttp://developer.android.com/tools/testing/testing_android.html\u003e for\nmore information on types of Android tests.",
+ "type": "object"
+ },
+ "DeviceFile": {
+ "description": "A single device file description.",
+ "type": "object",
+ "properties": {
+ "obbFile": {
+ "description": "A reference to an opaque binary blob file",
+ "$ref": "ObbFile"
+ }
+ },
+ "id": "DeviceFile"
+ },
+ "ClientInfoDetail": {
+ "description": "Key-value pair of detailed information about the client which invoked the\ntest. For example {'Version', '1.0'}, {'Release Track', 'BETA'}",
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "The value of detailed client information.\nRequired",
+ "type": "string"
+ },
+ "key": {
+ "description": "The key of detailed client information.\nRequired",
+ "type": "string"
+ }
+ },
+ "id": "ClientInfoDetail"
}
},
"protocol": "rest",
diff --git a/tpu/v1alpha1/tpu-api.json b/tpu/v1alpha1/tpu-api.json
index c30f3b1..64a078e 100644
--- a/tpu/v1alpha1/tpu-api.json
+++ b/tpu/v1alpha1/tpu-api.json
@@ -1,6 +1,593 @@
{
+ "canonicalName": "TPU",
+ "auth": {
+ "oauth2": {
+ "scopes": {
+ "https://www.googleapis.com/auth/cloud-platform": {
+ "description": "View and manage your data across Google Cloud Platform services"
+ }
+ }
+ }
+ },
+ "rootUrl": "https://tpu.googleapis.com/",
+ "ownerDomain": "google.com",
+ "name": "tpu",
+ "batchPath": "batch",
+ "fullyEncodeReservedExpansion": true,
+ "title": "Cloud TPU API",
+ "ownerName": "Google",
+ "resources": {
+ "projects": {
+ "resources": {
+ "locations": {
+ "methods": {
+ "list": {
+ "description": "Lists information about the supported locations for this service.",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "ListLocationsResponse"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The resource that owns the locations collection, if applicable.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+$",
+ "location": "path"
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "The standard list page token.",
+ "type": "string"
+ },
+ "pageSize": {
+ "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": "v1alpha1/projects/{projectsId}/locations",
+ "id": "tpu.projects.locations.list",
+ "path": "v1alpha1/{+name}/locations"
+ },
+ "get": {
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "Location"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "description": "Resource name for the location.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}",
+ "id": "tpu.projects.locations.get",
+ "path": "v1alpha1/{+name}",
+ "description": "Get information about a location."
+ }
+ },
+ "resources": {
+ "operations": {
+ "methods": {
+ "cancel": {
+ "path": "v1alpha1/{+name}:cancel",
+ "id": "tpu.projects.locations.operations.cancel",
+ "description": "Starts asynchronous cancellation on a long-running operation. The server\nmakes a best effort to cancel the operation, but success is not\nguaranteed. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`. Clients can use\nOperations.GetOperation or\nother methods to check whether the cancellation succeeded or whether the\noperation completed despite cancellation. On successful cancellation,\nthe operation is not deleted; instead, it becomes an operation with\nan Operation.error value with a google.rpc.Status.code of 1,\ncorresponding to `Code.CANCELLED`.",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "POST",
+ "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"
+ },
+ "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": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}",
+ "path": "v1alpha1/{+name}",
+ "id": "tpu.projects.locations.operations.delete"
+ },
+ "list": {
+ "description": "Lists operations that match the specified filter in the request. If the\nserver doesn't support this method, it returns `UNIMPLEMENTED`.\n\nNOTE: the `name` binding allows API services to override the binding\nto use different resource name schemes, such as `users/*/operations`. To\noverride the binding, API services can add a binding such as\n`\"/v1/{name=users/*}/operations\"` to their service configuration.\nFor backwards compatibility, the default name includes the operations\ncollection id, however overriding users must ensure the name binding\nis the parent resource, without the operations collection id.",
+ "response": {
+ "$ref": "ListOperationsResponse"
+ },
+ "parameterOrder": [
+ "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,
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+$",
+ "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": "v1alpha1/projects/{projectsId}/locations/{locationsId}/operations",
+ "path": "v1alpha1/{+name}/operations",
+ "id": "tpu.projects.locations.operations.list"
+ },
+ "get": {
+ "description": "Gets the latest state of a long-running operation. Clients can use this\nmethod to poll the operation result at intervals as recommended by the API\nservice.",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "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"
+ }
+ }
+ },
+ "nodes": {
+ "methods": {
+ "delete": {
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "DELETE",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+/locations/[^/]+/nodes/[^/]+$",
+ "location": "path",
+ "description": "The resource name.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/nodes/{nodesId}",
+ "path": "v1alpha1/{+name}",
+ "id": "tpu.projects.locations.nodes.delete",
+ "description": "Deletes a node."
+ },
+ "reset": {
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+/locations/[^/]+/nodes/[^/]+$",
+ "location": "path",
+ "description": "The resource name.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/nodes/{nodesId}:reset",
+ "path": "v1alpha1/{+name}:reset",
+ "id": "tpu.projects.locations.nodes.reset",
+ "request": {
+ "$ref": "ResetNodeRequest"
+ },
+ "description": "Resets a node, which stops and starts the VM."
+ },
+ "list": {
+ "response": {
+ "$ref": "ListNodesResponse"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "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"
+ },
+ "parent": {
+ "pattern": "^projects/[^/]+/locations/[^/]+$",
+ "location": "path",
+ "description": "The parent resource name.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/nodes",
+ "path": "v1alpha1/{+parent}/nodes",
+ "id": "tpu.projects.locations.nodes.list",
+ "description": "Lists nodes."
+ },
+ "create": {
+ "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 resource name.",
+ "required": true,
+ "type": "string"
+ },
+ "nodeId": {
+ "description": "The unqualified resource name.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/nodes",
+ "path": "v1alpha1/{+parent}/nodes",
+ "id": "tpu.projects.locations.nodes.create",
+ "description": "Creates a node.",
+ "request": {
+ "$ref": "Node"
+ }
+ },
+ "reimage": {
+ "request": {
+ "$ref": "ReimageNodeRequest"
+ },
+ "description": "Reimage a node's OS.",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+/locations/[^/]+/nodes/[^/]+$",
+ "location": "path",
+ "description": "The resource name.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/nodes/{nodesId}:reimage",
+ "path": "v1alpha1/{+name}:reimage",
+ "id": "tpu.projects.locations.nodes.reimage"
+ },
+ "get": {
+ "path": "v1alpha1/{+name}",
+ "id": "tpu.projects.locations.nodes.get",
+ "description": "Gets the details of a node.",
+ "response": {
+ "$ref": "Node"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+/locations/[^/]+/nodes/[^/]+$",
+ "location": "path",
+ "description": "The resource name.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/nodes/{nodesId}"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": {
+ "quotaUser": {
+ "location": "query",
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "type": "string"
+ },
+ "pp": {
+ "description": "Pretty-print response.",
+ "type": "boolean",
+ "default": "true",
+ "location": "query"
+ },
+ "bearer_token": {
+ "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": {
+ "location": "query",
+ "description": "Selector specifying which fields to include in a partial response.",
+ "type": "string"
+ },
+ "callback": {
+ "location": "query",
+ "description": "JSONP",
+ "type": "string"
+ },
+ "$.xgafv": {
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query",
+ "enum": [
+ "1",
+ "2"
+ ],
+ "description": "V1 error format.",
+ "type": "string"
+ },
+ "alt": {
+ "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"
+ }
+ },
+ "version": "v1alpha1",
+ "baseUrl": "https://tpu.googleapis.com/",
+ "kind": "discovery#restDescription",
+ "description": "TPU API provides customers with access to Google TPU technology.",
+ "servicePath": "",
+ "basePath": "",
+ "id": "tpu:v1alpha1",
+ "documentationLink": "https://cloud.google.com/tpu/",
+ "revision": "20171218",
+ "discoveryVersion": "v1",
+ "version_module": true,
"schemas": {
+ "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"
+ }
+ }
+ },
+ "id": "ListNodesResponse"
+ },
+ "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"
+ },
+ "Empty": {
+ "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
+ "type": "object",
+ "properties": {},
+ "id": "Empty"
+ },
+ "ReimageNodeRequest": {
+ "description": "Request for ReimageNode.",
+ "type": "object",
+ "properties": {
+ "tensorflowVersion": {
+ "description": "The version for reimage to create.",
+ "type": "string"
+ }
+ },
+ "id": "ReimageNodeRequest"
+ },
+ "Location": {
+ "description": "A resource that represents Google Cloud Platform location.",
+ "type": "object",
+ "properties": {
+ "labels": {
+ "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"
+ },
"ListOperationsResponse": {
+ "description": "The response message for Operations.ListOperations.",
+ "type": "object",
"properties": {
"nextPageToken": {
"description": "The standard List next-page token.",
@@ -14,27 +601,12 @@
}
}
},
- "id": "ListOperationsResponse",
- "description": "The response message for Operations.ListOperations.",
- "type": "object"
+ "id": "ListOperationsResponse"
},
"OperationMetadata": {
"description": "Represents the metadata of the long-running operation.",
"type": "object",
"properties": {
- "endTime": {
- "description": "[Output only] The time the operation finished running.",
- "format": "google-datetime",
- "type": "string"
- },
- "cancelRequested": {
- "description": "[Output only] Identifies whether the user has requested cancellation\nof the operation. Operations that have successfully been cancelled\nhave Operation.error value with a google.rpc.Status.code of 1,\ncorresponding to `Code.CANCELLED`.",
- "type": "boolean"
- },
- "verb": {
- "description": "[Output only] Name of the verb executed by the operation.",
- "type": "string"
- },
"createTime": {
"description": "[Output only] The time the operation was created.",
"format": "google-datetime",
@@ -51,22 +623,35 @@
"target": {
"description": "[Output only] Server-defined resource path for the target of the operation.",
"type": "string"
+ },
+ "endTime": {
+ "description": "[Output only] The time the operation finished running.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "cancelRequested": {
+ "description": "[Output only] Identifies whether the user has requested cancellation\nof the operation. Operations that have successfully been cancelled\nhave Operation.error value with a google.rpc.Status.code of 1,\ncorresponding to `Code.CANCELLED`.",
+ "type": "boolean"
+ },
+ "verb": {
+ "description": "[Output only] Name of the verb executed by the operation.",
+ "type": "string"
}
},
"id": "OperationMetadata"
},
"ListLocationsResponse": {
"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",
@@ -83,6 +668,42 @@
"description": "A TPU instance.",
"type": "object",
"properties": {
+ "port": {
+ "description": "Output only.\nDEPRECATED! Use network_endpoints instead.\nThe network port for the TPU Node as visible to GCE instances.",
+ "type": "string"
+ },
+ "serviceAccount": {
+ "description": "Output only.\nThe service account used to run the tensor flow services within the node.\nTo share resources, including Google Cloud Storage data, with the\nTensorflow job running in the Node, this account must have permissions to\nthat data.",
+ "type": "string"
+ },
+ "healthDescription": {
+ "description": "Output only.\nIf this field is populated, it contains a description of why the TPU Node\nis unhealthy.",
+ "type": "string"
+ },
+ "network": {
+ "description": "The name of a network they wish to peer the TPU node to. It must be a\npreexisting GCE network inside of the project on which this API has been\nactivated. If none is provided, \"default\" will be used.",
+ "type": "string"
+ },
+ "health": {
+ "enum": [
+ "HEALTH_UNSPECIFIED",
+ "HEALTHY",
+ "UNHEALTHY",
+ "TIMEOUT"
+ ],
+ "description": "The health status of the TPU node.",
+ "type": "string",
+ "enumDescriptions": [
+ "Health status is unknown: not initialized or failed to retrieve.",
+ "The resource is healthy.",
+ "The resource is unhealthy.",
+ "The resource is unresponsive."
+ ]
+ },
+ "ipAddress": {
+ "description": "Output only.\nDEPRECATED! Use network_endpoints instead.\nThe network address for the TPU Node as visible to GCE instances.",
+ "type": "string"
+ },
"createTime": {
"description": "Output only.\nThe time when the node was created.",
"format": "google-datetime",
@@ -136,47 +757,13 @@
"acceleratorType": {
"description": "The type of hardware accelerators associated with this node.\nRequired.",
"type": "string"
- },
- "port": {
- "description": "Output only.\nDEPRECATED! Use network_endpoints instead.\nThe network port for the TPU Node as visible to GCE instances.",
- "type": "string"
- },
- "serviceAccount": {
- "description": "Output only.\nThe service account used to run the tensor flow services within the node.\nTo share resources, including Google Cloud Storage data, with the\nTensorflow job running in the Node, this account must have permissions to\nthat data.",
- "type": "string"
- },
- "network": {
- "description": "The name of a network they wish to peer the TPU node to. It must be a\npreexisting GCE network inside of the project on which this API has been\nactivated. If none is provided, \"default\" will be used.",
- "type": "string"
- },
- "healthDescription": {
- "description": "Output only.\nIf this field is populated, it contains a description of why the TPU Node\nis unhealthy.",
- "type": "string"
- },
- "health": {
- "description": "The health status of the TPU node.",
- "type": "string",
- "enumDescriptions": [
- "Health status is unknown: not initialized or failed to retrieve.",
- "The resource is healthy.",
- "The resource is unhealthy.",
- "The resource is unresponsive."
- ],
- "enum": [
- "HEALTH_UNSPECIFIED",
- "HEALTHY",
- "UNHEALTHY",
- "TIMEOUT"
- ]
- },
- "ipAddress": {
- "description": "Output only.\nDEPRECATED! Use network_endpoints instead.\nThe network address for the TPU Node as visible to GCE instances.",
- "type": "string"
}
},
"id": "Node"
},
"NetworkEndpoint": {
+ "description": "A network endpoint over which a TPU worker can be reached.",
+ "type": "object",
"properties": {
"ipAddress": {
"description": "The IP address of this network endpoint.",
@@ -188,9 +775,7 @@
"type": "integer"
}
},
- "id": "NetworkEndpoint",
- "description": "A network endpoint over which a TPU worker can be reached.",
- "type": "object"
+ "id": "NetworkEndpoint"
},
"Operation": {
"description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
@@ -226,596 +811,11 @@
}
},
"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"
- }
- }
- },
- "id": "ListNodesResponse"
- },
- "Status": {
- "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
- "type": "object",
- "properties": {
- "details": {
- "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.",
- "type": "array",
- "items": {
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- },
- "type": "object"
- }
- },
- "code": {
- "description": "The status code, which should be an enum value of google.rpc.Code.",
- "format": "int32",
- "type": "integer"
- },
- "message": {
- "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
- "type": "string"
- }
- },
- "id": "Status"
- },
- "Empty": {
- "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
- "type": "object",
- "properties": {},
- "id": "Empty"
- },
- "ReimageNodeRequest": {
- "properties": {
- "tensorflowVersion": {
- "description": "The version for reimage to create.",
- "type": "string"
- }
- },
- "id": "ReimageNodeRequest",
- "description": "Request for ReimageNode.",
- "type": "object"
- },
- "Location": {
- "properties": {
- "locationId": {
- "description": "The canonical id for this location. For example: `\"us-east1\"`.",
- "type": "string"
- },
- "metadata": {
- "description": "Service-specific metadata. For example the available capacity at the given\nlocation.",
- "type": "object",
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- }
- },
- "labels": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "Cross-service attributes for the location. For example\n\n {\"cloud.googleapis.com/region\": \"us-east1\"}",
- "type": "object"
- },
- "name": {
- "description": "Resource name for the location, which may vary between implementations.\nFor example: `\"projects/example-project/locations/us-east1\"`",
- "type": "string"
- }
- },
- "id": "Location",
- "description": "A resource that represents Google Cloud Platform location.",
- "type": "object"
}
},
"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": "TPU",
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/cloud-platform": {
- "description": "View and manage your data across Google Cloud Platform services"
- }
- }
- }
- },
- "rootUrl": "https://tpu.googleapis.com/",
- "ownerDomain": "google.com",
- "name": "tpu",
- "batchPath": "batch",
- "fullyEncodeReservedExpansion": true,
- "title": "Cloud TPU 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": {
- "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"
- },
- "pageToken": {
- "location": "query",
- "description": "The standard list page token.",
- "type": "string"
- },
- "pageSize": {
- "description": "The standard list page size.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1alpha1/projects/{projectsId}/locations",
- "path": "v1alpha1/{+name}/locations",
- "id": "tpu.projects.locations.list"
- },
- "get": {
- "description": "Get information about a location.",
- "httpMethod": "GET",
- "response": {
- "$ref": "Location"
- },
- "parameterOrder": [
- "name"
- ],
- "parameters": {
- "name": {
- "description": "Resource name for the location.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}",
- "id": "tpu.projects.locations.get",
- "path": "v1alpha1/{+name}"
- }
- },
- "resources": {
- "operations": {
- "methods": {
- "cancel": {
- "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",
- "description": "Starts asynchronous cancellation on a long-running operation. The server\nmakes a best effort to cancel the operation, but success is not\nguaranteed. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`. Clients can use\nOperations.GetOperation or\nother methods to check whether the cancellation succeeded or whether the\noperation completed despite cancellation. On successful cancellation,\nthe operation is not deleted; instead, it becomes an operation with\nan Operation.error value with a google.rpc.Status.code of 1,\ncorresponding to `Code.CANCELLED`."
- },
- "delete": {
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "DELETE",
- "parameters": {
- "name": {
- "location": "path",
- "description": "The name of the operation resource to be deleted.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}",
- "path": "v1alpha1/{+name}",
- "id": "tpu.projects.locations.operations.delete",
- "description": "Deletes a long-running operation. This method indicates that the client is\nno longer interested in the operation result. It does not cancel the\noperation. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`."
- },
- "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",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "pageSize": {
- "description": "The standard list page size.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- },
- "filter": {
- "description": "The standard list filter.",
- "type": "string",
- "location": "query"
- },
- "name": {
- "description": "The name of the operation's parent resource.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+$",
- "location": "path"
- },
- "pageToken": {
- "location": "query",
- "description": "The standard list page token.",
- "type": "string"
- }
- }
- },
- "get": {
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "parameters": {
- "name": {
- "description": "The name of the operation resource.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}",
- "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": {
- "create": {
- "httpMethod": "POST",
- "parameterOrder": [
- "parent"
- ],
- "response": {
- "$ref": "Operation"
- },
- "parameters": {
- "parent": {
- "description": "The parent resource name.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+$",
- "location": "path"
- },
- "nodeId": {
- "description": "The unqualified resource name.",
- "type": "string",
- "location": "query"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/nodes",
- "id": "tpu.projects.locations.nodes.create",
- "path": "v1alpha1/{+parent}/nodes",
- "request": {
- "$ref": "Node"
- },
- "description": "Creates a node."
- },
- "reimage": {
- "httpMethod": "POST",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Operation"
- },
- "parameters": {
- "name": {
- "description": "The resource name.",
- "required": true,
- "type": "string",
- "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",
- "request": {
- "$ref": "ReimageNodeRequest"
- },
- "description": "Reimage a node's OS."
- },
- "get": {
- "response": {
- "$ref": "Node"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/locations/[^/]+/nodes/[^/]+$",
- "location": "path",
- "description": "The resource name.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/nodes/{nodesId}",
- "path": "v1alpha1/{+name}",
- "id": "tpu.projects.locations.nodes.get",
- "description": "Gets the details of a node."
- },
- "delete": {
- "description": "Deletes a node.",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "DELETE",
- "parameters": {
- "name": {
- "location": "path",
- "description": "The resource name.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+/nodes/[^/]+$"
- }
- },
- "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": {
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "POST",
- "parameters": {
- "name": {
- "location": "path",
- "description": "The resource name.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+/nodes/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/nodes/{nodesId}:reset",
- "path": "v1alpha1/{+name}:reset",
- "id": "tpu.projects.locations.nodes.reset",
- "request": {
- "$ref": "ResetNodeRequest"
- },
- "description": "Resets a node, which stops and starts the VM."
- },
- "list": {
- "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/nodes",
- "path": "v1alpha1/{+parent}/nodes",
- "id": "tpu.projects.locations.nodes.list",
- "description": "Lists nodes.",
- "response": {
- "$ref": "ListNodesResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "pageSize": {
- "description": "The maximum number of items to return.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- },
- "parent": {
- "description": "The parent resource name.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+$",
- "location": "path"
- },
- "pageToken": {
- "location": "query",
- "description": "The next_page_token value returned from a previous List request, if any.",
- "type": "string"
- }
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "parameters": {
- "upload_protocol": {
- "location": "query",
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string"
- },
- "prettyPrint": {
- "description": "Returns response with indentations and line breaks.",
- "type": "boolean",
- "default": "true",
- "location": "query"
- },
- "uploadType": {
- "location": "query",
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string"
- },
- "fields": {
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string",
- "location": "query"
- },
- "$.xgafv": {
- "description": "V1 error format.",
- "type": "string",
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query",
- "enum": [
- "1",
- "2"
- ]
- },
- "callback": {
- "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": {
- "location": "query",
- "description": "OAuth access token.",
- "type": "string"
- },
- "key": {
- "location": "query",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string"
- },
- "quotaUser": {
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string",
- "location": "query"
- },
- "pp": {
- "location": "query",
- "description": "Pretty-print response.",
- "type": "boolean",
- "default": "true"
- },
- "oauth_token": {
- "description": "OAuth 2.0 token for the current user.",
- "type": "string",
- "location": "query"
- },
- "bearer_token": {
- "location": "query",
- "description": "OAuth bearer token.",
- "type": "string"
- }
- },
- "version": "v1alpha1",
- "baseUrl": "https://tpu.googleapis.com/",
- "kind": "discovery#restDescription",
- "description": "TPU API provides customers with access to Google TPU technology.",
- "servicePath": "",
- "basePath": "",
- "id": "tpu:v1alpha1",
- "documentationLink": "https://cloud.google.com/tpu/",
- "revision": "20171218",
- "discoveryVersion": "v1",
- "version_module": true
+ }
}
diff --git a/translate/v2/translate-api.json b/translate/v2/translate-api.json
index 57bdd00..8b7c46b 100644
--- a/translate/v2/translate-api.json
+++ b/translate/v2/translate-api.json
@@ -1,15 +1,287 @@
{
- "servicePath": "language/translate/",
- "description": "The Google Cloud Translation API lets websites and programs integrate with\n Google Translate programmatically.",
+ "canonicalName": "Translate",
+ "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-translation": {
+ "description": "Translate text from one language to another using Google Translate"
+ }
+ }
+ }
+ },
+ "rootUrl": "https://translation.googleapis.com/",
+ "ownerDomain": "google.com",
+ "name": "translate",
+ "batchPath": "batch/translate",
+ "title": "Google Cloud Translation API",
+ "features": [
+ "dataWrapper"
+ ],
+ "ownerName": "Google",
+ "resources": {
+ "languages": {
+ "methods": {
+ "list": {
+ "path": "v2/languages",
+ "id": "language.languages.list",
+ "description": "Returns a list of supported languages for translation.",
+ "response": {
+ "$ref": "LanguagesListResponse"
+ },
+ "httpMethod": "GET",
+ "parameters": {
+ "target": {
+ "location": "query",
+ "description": "The language to use to return localized, human readable names of supported\nlanguages.",
+ "type": "string"
+ },
+ "model": {
+ "description": "The model type for which supported languages should be returned.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-translation",
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ }
+ }
+ },
+ "translations": {
+ "methods": {
+ "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."
+ },
+ "list": {
+ "description": "Translates input text, returning translated text.",
+ "response": {
+ "$ref": "TranslationsListResponse"
+ },
+ "parameterOrder": [
+ "q",
+ "target"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "cid": {
+ "type": "string",
+ "repeated": true,
+ "location": "query",
+ "description": "The customization id for translate"
+ },
+ "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",
+ "description": "The input text to translate. Repeat this parameter to perform translation\noperations on multiple text inputs.",
+ "type": "string",
+ "required": true
+ },
+ "source": {
+ "description": "The language of the source text, set to one of the language codes listed in\nLanguage Support. If the source language is not specified, the API will\nattempt to identify the source language automatically and return it within\nthe response.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-translation",
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "path": "v2",
+ "id": "language.translations.list"
+ }
+ }
+ },
+ "detections": {
+ "methods": {
+ "list": {
+ "path": "v2/detect",
+ "id": "language.detections.list",
+ "description": "Detects the language of text within a request.",
+ "response": {
+ "$ref": "DetectionsListResponse"
+ },
+ "parameterOrder": [
+ "q"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-translation",
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "q": {
+ "repeated": true,
+ "location": "query",
+ "description": "The input text upon which to perform language detection. Repeat this\nparameter to perform language detection on multiple text inputs.",
+ "type": "string",
+ "required": true
+ }
+ }
+ },
+ "detect": {
+ "response": {
+ "$ref": "DetectionsListResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "parameters": {},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-translation",
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "path": "v2/detect",
+ "id": "language.detections.detect",
+ "description": "Detects the language of text within a request.",
+ "request": {
+ "$ref": "DetectLanguageRequest"
+ }
+ }
+ }
+ }
+ },
+ "parameters": {
+ "key": {
+ "location": "query",
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "type": "string"
+ },
+ "access_token": {
+ "description": "OAuth access token.",
+ "type": "string",
+ "location": "query"
+ },
+ "quotaUser": {
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.",
+ "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": {
+ "type": "string",
+ "location": "query",
+ "description": "OAuth bearer token."
+ },
+ "upload_protocol": {
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "type": "string",
+ "location": "query"
+ },
+ "prettyPrint": {
+ "location": "query",
+ "description": "Returns response with indentations and line breaks.",
+ "type": "boolean",
+ "default": "true"
+ },
+ "uploadType": {
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string",
+ "location": "query"
+ },
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
+ "type": "string",
+ "location": "query"
+ },
+ "$.xgafv": {
+ "location": "query",
+ "enum": [
+ "1",
+ "2"
+ ],
+ "description": "V1 error format.",
+ "type": "string",
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ]
+ },
+ "callback": {
+ "type": "string",
+ "location": "query",
+ "description": "JSONP"
+ },
+ "alt": {
+ "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": "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/",
"basePath": "/language/translate/",
- "revision": "20170525",
- "documentationLink": "https://code.google.com/apis/language/translate/v2/getting_started.html",
"id": "translate:v2",
+ "documentationLink": "https://code.google.com/apis/language/translate/v2/getting_started.html",
+ "revision": "20170525",
"discoveryVersion": "v1",
"schemas": {
"LanguagesListResponse": {
- "type": "object",
"properties": {
"languages": {
"description": "List of source/target languages supported by the translation API. If target parameter is unspecified, the list is sorted by the ASCII code point order of the language code. If target parameter is specified, the list is sorted by the collation order of the language name in the target language.",
@@ -19,32 +291,13 @@
}
}
},
- "id": "LanguagesListResponse"
- },
- "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",
+ "id": "LanguagesListResponse",
"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.",
@@ -59,12 +312,30 @@
"description": "The language we detected.",
"type": "string"
}
+ },
+ "type": "object"
+ },
+ "id": "DetectionsResource"
+ },
+ "TranslationsResource": {
+ "properties": {
+ "model": {
+ "type": "string",
+ "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."
+ },
+ "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"
}
- }
+ },
+ "id": "TranslationsResource",
+ "type": "object"
},
"TranslationsListResponse": {
- "description": "The main language translation response message.",
- "type": "object",
"properties": {
"translations": {
"description": "Translations contains list of translation results of given text",
@@ -74,14 +345,12 @@
}
}
},
- "id": "TranslationsListResponse"
+ "id": "TranslationsListResponse",
+ "description": "The main language translation response message.",
+ "type": "object"
},
"TranslateTextRequest": {
"properties": {
- "model": {
- "description": "The `model` type requested for this translation. Valid values are\nlisted in public documentation.",
- "type": "string"
- },
"target": {
"description": "The language to use for translation of the input text, set to one of the\nlanguage codes listed in Language Support.",
"type": "string"
@@ -100,6 +369,10 @@
"source": {
"description": "The language of the source text, set to one of the language codes listed in\nLanguage Support. If the source language is not specified, the API will\nattempt to identify the source language automatically and return it within\nthe response.",
"type": "string"
+ },
+ "model": {
+ "description": "The `model` type requested for this translation. Valid values are\nlisted in public documentation.",
+ "type": "string"
}
},
"id": "TranslateTextRequest",
@@ -135,6 +408,7 @@
"id": "LanguagesResource"
},
"DetectionsListResponse": {
+ "type": "object",
"properties": {
"detections": {
"description": "A detections contains detection results of several text",
@@ -144,297 +418,23 @@
}
}
},
- "id": "DetectionsListResponse",
- "type": "object"
+ "id": "DetectionsListResponse"
},
"GetSupportedLanguagesRequest": {
+ "description": "The request message for discovering supported languages.",
+ "type": "object",
"properties": {
"target": {
"description": "The language to use to return localized, human readable names of supported\nlanguages.",
"type": "string"
}
},
- "id": "GetSupportedLanguagesRequest",
- "description": "The request message for discovering supported languages.",
- "type": "object"
+ "id": "GetSupportedLanguagesRequest"
}
},
+ "protocol": "rest",
"icons": {
"x16": "https://www.google.com/images/icons/product/translate-16.png",
"x32": "https://www.google.com/images/icons/product/translate-32.png"
- },
- "protocol": "rest",
- "canonicalName": "Translate",
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/cloud-platform": {
- "description": "View and manage your data across Google Cloud Platform services"
- },
- "https://www.googleapis.com/auth/cloud-translation": {
- "description": "Translate text from one language to another using Google Translate"
- }
- }
- }
- },
- "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": {
- "response": {
- "$ref": "DetectionsListResponse"
- },
- "parameterOrder": [
- "q"
- ],
- "httpMethod": "GET",
- "parameters": {
- "q": {
- "repeated": true,
- "location": "query",
- "description": "The input text upon which to perform language detection. Repeat this\nparameter to perform language detection on multiple text inputs.",
- "type": "string",
- "required": true
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-translation",
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "path": "v2/detect",
- "id": "language.detections.list",
- "description": "Detects the language of text within a request."
- },
- "detect": {
- "response": {
- "$ref": "DetectionsListResponse"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "parameters": {},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-translation",
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "path": "v2/detect",
- "id": "language.detections.detect",
- "description": "Detects the language of text within a request.",
- "request": {
- "$ref": "DetectLanguageRequest"
- }
- }
- }
- },
- "languages": {
- "methods": {
- "list": {
- "response": {
- "$ref": "LanguagesListResponse"
- },
- "httpMethod": "GET",
- "parameters": {
- "target": {
- "location": "query",
- "description": "The language to use to return localized, human readable names of supported\nlanguages.",
- "type": "string"
- },
- "model": {
- "location": "query",
- "description": "The model type for which supported languages should be returned.",
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-translation",
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "path": "v2/languages",
- "id": "language.languages.list",
- "description": "Returns a list of supported languages for translation."
- }
- }
- },
- "translations": {
- "methods": {
- "translate": {
- "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",
- "request": {
- "$ref": "TranslateTextRequest"
- },
- "description": "Translates input text, returning translated text."
- },
- "list": {
- "description": "Translates input text, returning translated text.",
- "response": {
- "$ref": "TranslationsListResponse"
- },
- "parameterOrder": [
- "q",
- "target"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-translation",
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "model": {
- "location": "query",
- "description": "The `model` type requested for this translation. Valid values are\nlisted in public documentation.",
- "type": "string"
- },
- "q": {
- "description": "The input text to translate. Repeat this parameter to perform translation\noperations on multiple text inputs.",
- "type": "string",
- "required": true,
- "repeated": true,
- "location": "query"
- },
- "source": {
- "description": "The language of the source text, set to one of the language codes listed in\nLanguage Support. If the source language is not specified, the API will\nattempt to identify the source language automatically and return it within\nthe response.",
- "type": "string",
- "location": "query"
- },
- "cid": {
- "description": "The customization id for translate",
- "type": "string",
- "repeated": true,
- "location": "query"
- },
- "target": {
- "location": "query",
- "description": "The language to use for translation of the input text, set to one of the\nlanguage codes listed in Language Support.",
- "type": "string",
- "required": true
- },
- "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"
- }
- },
- "path": "v2",
- "id": "language.translations.list"
- }
- }
- }
- },
- "parameters": {
- "upload_protocol": {
- "location": "query",
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string"
- },
- "prettyPrint": {
- "description": "Returns response with indentations and line breaks.",
- "type": "boolean",
- "default": "true",
- "location": "query"
- },
- "uploadType": {
- "location": "query",
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string"
- },
- "fields": {
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string",
- "location": "query"
- },
- "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": {
- "description": "API key. 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. Overrides userIp if both are provided.",
- "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": "v2",
- "baseUrl": "https://translation.googleapis.com/language/translate/"
+ }
}
diff --git a/vault/v1/vault-api.json b/vault/v1/vault-api.json
index d164977..a878412 100644
--- a/vault/v1/vault-api.json
+++ b/vault/v1/vault-api.json
@@ -1,4 +1,6 @@
{
+ "version": "v1",
+ "baseUrl": "https://vault.googleapis.com/",
"kind": "discovery#restDescription",
"description": "Archiving and eDiscovery for G Suite.",
"servicePath": "",
@@ -9,15 +11,181 @@
"discoveryVersion": "v1",
"version_module": true,
"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"
+ },
+ "CloseMatterRequest": {
+ "properties": {},
+ "id": "CloseMatterRequest",
+ "description": "Close a matter by ID.",
+ "type": "object"
+ },
+ "ReopenMatterRequest": {
+ "description": "Reopen a matter by ID.",
+ "type": "object",
+ "properties": {},
+ "id": "ReopenMatterRequest"
+ },
+ "RemoveMatterPermissionsRequest": {
+ "type": "object",
+ "properties": {
+ "accountId": {
+ "description": "The account ID.",
+ "type": "string"
+ }
+ },
+ "id": "RemoveMatterPermissionsRequest",
+ "description": "Remove an account as a matter collaborator."
+ },
+ "MatterPermission": {
+ "description": "Currently each matter only has one owner, and all others are collaborators.\nWhen an account is purged, its corresponding MatterPermission resources\ncease to exist.",
+ "type": "object",
+ "properties": {
+ "role": {
+ "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"
+ ]
+ },
+ "accountId": {
+ "type": "string",
+ "description": "The account id, as provided by \u003ca href=\"https://developers.google.com/admin-sdk/\"\u003eAdmin SDK\u003c/a\u003e."
+ }
+ },
+ "id": "MatterPermission"
+ },
+ "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": {
+ "type": "string",
+ "description": "The start time range for the search query. These timestamps are in GMT and\nrounded down to the start of the given date.",
+ "format": "google-datetime"
+ },
+ "terms": {
+ "description": "The search terms for the hold.",
+ "type": "string"
+ }
+ },
+ "id": "HeldMailQuery"
+ },
+ "CloseMatterResponse": {
+ "description": "Response to a CloseMatterRequest.",
+ "type": "object",
+ "properties": {
+ "matter": {
+ "description": "The updated matter, with state CLOSED.",
+ "$ref": "Matter"
+ }
+ },
+ "id": "CloseMatterResponse"
+ },
+ "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": {
+ "id": "HeldGroupsQuery",
+ "description": "Query options for group holds.",
+ "type": "object",
+ "properties": {
+ "endTime": {
+ "type": "string",
+ "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"
+ },
+ "startTime": {
+ "type": "string",
+ "description": "The start time range for the search query. These timestamps are in GMT and\nrounded down to the start of the given date.",
+ "format": "google-datetime"
+ },
+ "terms": {
+ "description": "The search terms for the hold.",
+ "type": "string"
+ }
+ }
+ },
+ "HeldOrgUnit": {
+ "description": "A organizational unit being held in a particular hold.\nThis structure is immutable.",
+ "type": "object",
+ "properties": {
+ "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"
+ },
+ "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": {
+ "matterPermission": {
+ "$ref": "MatterPermission",
+ "description": "The MatterPermission to add."
+ },
+ "ccMe": {
+ "description": "Only relevant if send_emails is true.\nTrue to CC requestor in the email message.\nFalse to not CC requestor.",
+ "type": "boolean"
+ },
+ "sendEmails": {
+ "description": "True to send notification email to the added account.\nFalse to not send notification email.",
+ "type": "boolean"
+ }
+ },
+ "id": "AddMatterPermissionsRequest"
+ },
"Matter": {
- "id": "Matter",
"description": "Represents a matter.",
"type": "object",
"properties": {
- "description": {
- "description": "The description of the matter.",
- "type": "string"
- },
"matterId": {
"description": "The matter ID which is generated by the server.\nShould be blank when creating a new matter.",
"type": "string"
@@ -39,8 +207,8 @@
]
},
"name": {
- "description": "The name of the matter.",
- "type": "string"
+ "type": "string",
+ "description": "The name of the matter."
},
"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.",
@@ -48,39 +216,50 @@
"items": {
"$ref": "MatterPermission"
}
- }
- }
- },
- "HeldAccount": {
- "properties": {
- "holdTime": {
- "type": "string",
- "description": "When the account was put on hold.",
- "format": "google-datetime"
},
- "accountId": {
- "description": "The account's ID as provided by the\n\u003ca href=\"https://developers.google.com/admin-sdk/\"\u003eAdmin SDK\u003c/a\u003e.",
+ "description": {
+ "description": "The description of the matter.",
"type": "string"
}
},
+ "id": "Matter"
+ },
+ "HeldAccount": {
"id": "HeldAccount",
"description": "An account being held in a particular hold. This structure is immutable.\nThis can be either a single user or a google group, depending on the corpus.",
- "type": "object"
- },
- "ReopenMatterResponse": {
- "id": "ReopenMatterResponse",
- "description": "Response to a ReopenMatterRequest.",
"type": "object",
"properties": {
- "matter": {
- "description": "The updated matter, with state OPEN.",
- "$ref": "Matter"
+ "accountId": {
+ "description": "The account's ID as provided by the\n\u003ca href=\"https://developers.google.com/admin-sdk/\"\u003eAdmin SDK\u003c/a\u003e.",
+ "type": "string"
+ },
+ "holdTime": {
+ "description": "When the account was put on hold.",
+ "format": "google-datetime",
+ "type": "string"
}
}
},
+ "ReopenMatterResponse": {
+ "properties": {
+ "matter": {
+ "$ref": "Matter",
+ "description": "The updated matter, with state OPEN."
+ }
+ },
+ "id": "ReopenMatterResponse",
+ "description": "Response to a ReopenMatterRequest.",
+ "type": "object"
+ },
"CorpusQuery": {
+ "id": "CorpusQuery",
+ "description": "Corpus specific queries.",
"type": "object",
"properties": {
+ "driveQuery": {
+ "$ref": "HeldDriveQuery",
+ "description": "Details pertaining to Drive holds. If set, corpus must be Drive."
+ },
"mailQuery": {
"$ref": "HeldMailQuery",
"description": "Details pertaining to mail holds. If set, corpus must be mail."
@@ -88,34 +267,22 @@
"groupsQuery": {
"description": "Details pertaining to Groups holds. If set, corpus must be Groups.",
"$ref": "HeldGroupsQuery"
- },
- "driveQuery": {
- "description": "Details pertaining to Drive holds. If set, corpus must be Drive.",
- "$ref": "HeldDriveQuery"
}
- },
- "id": "CorpusQuery",
- "description": "Corpus specific queries."
+ }
},
"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": {
"query": {
- "description": "The corpus-specific query. If set, the corpusQuery must match corpus\ntype.",
- "$ref": "CorpusQuery"
+ "$ref": "CorpusQuery",
+ "description": "The corpus-specific query. If set, the corpusQuery must match corpus\ntype."
},
"orgUnit": {
- "$ref": "HeldOrgUnit",
- "description": "If set, the hold applies to all members of the organizational unit and\naccounts must be empty. This property is mutable. For groups holds,\nset the accounts field."
+ "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.",
+ "$ref": "HeldOrgUnit"
},
"corpus": {
- "enum": [
- "CORPUS_TYPE_UNSPECIFIED",
- "DRIVE",
- "MAIL",
- "GROUPS"
- ],
"description": "The corpus to be searched.",
"type": "string",
"enumDescriptions": [
@@ -123,6 +290,12 @@
"Drive.",
"Mail.",
"Groups."
+ ],
+ "enum": [
+ "CORPUS_TYPE_UNSPECIFIED",
+ "DRIVE",
+ "MAIL",
+ "GROUPS"
]
},
"updateTime": {
@@ -135,8 +308,8 @@
"type": "string"
},
"holdId": {
- "type": "string",
- "description": "The unique immutable ID of the hold. Assigned during creation."
+ "description": "The unique immutable ID of the hold. Assigned during creation.",
+ "type": "string"
},
"accounts": {
"description": "If set, the hold applies to the enumerated accounts and org_unit must be\nempty.",
@@ -160,8 +333,8 @@
}
},
"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"
+ "type": "string",
+ "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."
}
},
"id": "ListHoldsResponse"
@@ -185,177 +358,6 @@
"type": "object",
"properties": {},
"id": "UndeleteMatterRequest"
- },
- "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"
- },
- "CloseMatterRequest": {
- "description": "Close a matter by ID.",
- "type": "object",
- "properties": {},
- "id": "CloseMatterRequest"
- },
- "ReopenMatterRequest": {
- "id": "ReopenMatterRequest",
- "description": "Reopen a matter by ID.",
- "type": "object",
- "properties": {}
- },
- "RemoveMatterPermissionsRequest": {
- "type": "object",
- "properties": {
- "accountId": {
- "description": "The account ID.",
- "type": "string"
- }
- },
- "id": "RemoveMatterPermissionsRequest",
- "description": "Remove an account as a matter collaborator."
- },
- "MatterPermission": {
- "description": "Currently each matter only has one owner, and all others are collaborators.\nWhen an account is purged, its corresponding MatterPermission resources\ncease to exist.",
- "type": "object",
- "properties": {
- "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."
- ]
- },
- "accountId": {
- "description": "The account id, as provided by \u003ca href=\"https://developers.google.com/admin-sdk/\"\u003eAdmin SDK\u003c/a\u003e.",
- "type": "string"
- }
- },
- "id": "MatterPermission"
- },
- "ListMattersResponse": {
- "id": "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"
- }
- }
- },
- "HeldMailQuery": {
- "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",
- "description": "Query options for mail holds."
- },
- "CloseMatterResponse": {
- "type": "object",
- "properties": {
- "matter": {
- "$ref": "Matter",
- "description": "The updated matter, with state CLOSED."
- }
- },
- "id": "CloseMatterResponse",
- "description": "Response to a CloseMatterRequest."
- },
- "HeldDriveQuery": {
- "type": "object",
- "properties": {
- "includeTeamDriveFiles": {
- "description": "If true, include files in Team Drives in the hold.",
- "type": "boolean"
- }
- },
- "id": "HeldDriveQuery",
- "description": "Query options for drive holds."
- },
- "HeldGroupsQuery": {
- "id": "HeldGroupsQuery",
- "description": "Query options for group 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": {
- "type": "string",
- "description": "The start time range for the search query. These timestamps are in GMT and\nrounded down to the start of the given date.",
- "format": "google-datetime"
- },
- "terms": {
- "description": "The search terms for the hold.",
- "type": "string"
- }
- }
- },
- "HeldOrgUnit": {
- "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"
- }
- },
- "id": "HeldOrgUnit",
- "description": "A organizational unit being held in a particular hold.\nThis structure is immutable.",
- "type": "object"
- },
- "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": {
- "description": "True to send notification email to the added account.\nFalse to not send notification email.",
- "type": "boolean"
- },
- "matterPermission": {
- "description": "The MatterPermission to add.",
- "$ref": "MatterPermission"
- },
- "ccMe": {
- "description": "Only relevant if send_emails is true.\nTrue to CC requestor in the email message.\nFalse to not CC requestor.",
- "type": "boolean"
- }
- },
- "id": "AddMatterPermissionsRequest"
}
},
"protocol": "rest",
@@ -367,11 +369,11 @@
"auth": {
"oauth2": {
"scopes": {
- "https://www.googleapis.com/auth/ediscovery.readonly": {
- "description": "View your eDiscovery data"
- },
"https://www.googleapis.com/auth/ediscovery": {
"description": "Manage your eDiscovery data"
+ },
+ "https://www.googleapis.com/auth/ediscovery.readonly": {
+ "description": "View your eDiscovery data"
}
}
}
@@ -386,57 +388,6 @@
"resources": {
"matters": {
"methods": {
- "update": {
- "description": "Updates the specified matter.\nThis updates only the name and description of the matter, identified by\nmatter id. Changes to any other fields are ignored.\nReturns the default view of the matter.",
- "request": {
- "$ref": "Matter"
- },
- "response": {
- "$ref": "Matter"
- },
- "parameterOrder": [
- "matterId"
- ],
- "httpMethod": "PUT",
- "scopes": [
- "https://www.googleapis.com/auth/ediscovery"
- ],
- "parameters": {
- "matterId": {
- "description": "The matter ID.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "flatPath": "v1/matters/{matterId}",
- "path": "v1/matters/{matterId}",
- "id": "vault.matters.update"
- },
- "delete": {
- "description": "Deletes the specified matter. Returns matter with updated state.",
- "httpMethod": "DELETE",
- "response": {
- "$ref": "Matter"
- },
- "parameterOrder": [
- "matterId"
- ],
- "parameters": {
- "matterId": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "The matter ID"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/ediscovery"
- ],
- "flatPath": "v1/matters/{matterId}",
- "id": "vault.matters.delete",
- "path": "v1/matters/{matterId}"
- },
"addPermissions": {
"path": "v1/matters/{matterId}:addPermissions",
"id": "vault.matters.addPermissions",
@@ -499,14 +450,14 @@
"location": "query"
},
"view": {
- "location": "query",
"enum": [
"VIEW_UNSPECIFIED",
"BASIC",
"FULL"
],
"description": "Specifies which parts of the matter to return in response.",
- "type": "string"
+ "type": "string",
+ "location": "query"
}
},
"flatPath": "v1/matters",
@@ -514,8 +465,6 @@
"path": "v1/matters"
},
"create": {
- "path": "v1/matters",
- "id": "vault.matters.create",
"request": {
"$ref": "Matter"
},
@@ -529,20 +478,11 @@
"scopes": [
"https://www.googleapis.com/auth/ediscovery"
],
- "flatPath": "v1/matters"
+ "flatPath": "v1/matters",
+ "path": "v1/matters",
+ "id": "vault.matters.create"
},
"reopen": {
- "parameters": {
- "matterId": {
- "description": "The matter ID.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/ediscovery"
- ],
"flatPath": "v1/matters/{matterId}:reopen",
"path": "v1/matters/{matterId}:reopen",
"id": "vault.matters.reopen",
@@ -556,9 +496,23 @@
"parameterOrder": [
"matterId"
],
- "httpMethod": "POST"
+ "httpMethod": "POST",
+ "parameters": {
+ "matterId": {
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "description": "The matter ID."
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/ediscovery"
+ ]
},
"removePermissions": {
+ "flatPath": "v1/matters/{matterId}:removePermissions",
+ "path": "v1/matters/{matterId}:removePermissions",
+ "id": "vault.matters.removePermissions",
"request": {
"$ref": "RemoveMatterPermissionsRequest"
},
@@ -572,20 +526,24 @@
"httpMethod": "POST",
"parameters": {
"matterId": {
- "location": "path",
"description": "The matter ID.",
"required": true,
- "type": "string"
+ "type": "string",
+ "location": "path"
}
},
"scopes": [
"https://www.googleapis.com/auth/ediscovery"
- ],
- "flatPath": "v1/matters/{matterId}:removePermissions",
- "path": "v1/matters/{matterId}:removePermissions",
- "id": "vault.matters.removePermissions"
+ ]
},
"close": {
+ "flatPath": "v1/matters/{matterId}:close",
+ "path": "v1/matters/{matterId}:close",
+ "id": "vault.matters.close",
+ "description": "Closes the specified matter. Returns matter with updated state.",
+ "request": {
+ "$ref": "CloseMatterRequest"
+ },
"response": {
"$ref": "CloseMatterResponse"
},
@@ -598,18 +556,11 @@
],
"parameters": {
"matterId": {
+ "location": "path",
"description": "The matter ID.",
"required": true,
- "type": "string",
- "location": "path"
+ "type": "string"
}
- },
- "flatPath": "v1/matters/{matterId}:close",
- "path": "v1/matters/{matterId}:close",
- "id": "vault.matters.close",
- "description": "Closes the specified matter. Returns matter with updated state.",
- "request": {
- "$ref": "CloseMatterRequest"
}
},
"undelete": {
@@ -640,7 +591,6 @@
}
},
"get": {
- "description": "Gets the specified matter.",
"httpMethod": "GET",
"response": {
"$ref": "Matter"
@@ -660,10 +610,10 @@
]
},
"matterId": {
+ "location": "path",
"description": "The matter ID.",
"required": true,
- "type": "string",
- "location": "path"
+ "type": "string"
}
},
"scopes": [
@@ -672,44 +622,68 @@
],
"flatPath": "v1/matters/{matterId}",
"id": "vault.matters.get",
- "path": "v1/matters/{matterId}"
+ "path": "v1/matters/{matterId}",
+ "description": "Gets the specified matter."
+ },
+ "update": {
+ "flatPath": "v1/matters/{matterId}",
+ "path": "v1/matters/{matterId}",
+ "id": "vault.matters.update",
+ "description": "Updates the specified matter.\nThis updates only the name and description of the matter, identified by\nmatter id. Changes to any other fields are ignored.\nReturns the default view of the matter.",
+ "request": {
+ "$ref": "Matter"
+ },
+ "response": {
+ "$ref": "Matter"
+ },
+ "parameterOrder": [
+ "matterId"
+ ],
+ "httpMethod": "PUT",
+ "scopes": [
+ "https://www.googleapis.com/auth/ediscovery"
+ ],
+ "parameters": {
+ "matterId": {
+ "location": "path",
+ "description": "The matter ID.",
+ "required": true,
+ "type": "string"
+ }
+ }
+ },
+ "delete": {
+ "httpMethod": "DELETE",
+ "response": {
+ "$ref": "Matter"
+ },
+ "parameterOrder": [
+ "matterId"
+ ],
+ "parameters": {
+ "matterId": {
+ "location": "path",
+ "description": "The matter ID",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/ediscovery"
+ ],
+ "flatPath": "v1/matters/{matterId}",
+ "id": "vault.matters.delete",
+ "path": "v1/matters/{matterId}",
+ "description": "Deletes the specified matter. Returns matter with updated state."
}
},
"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": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "The matter ID."
- },
- "holdId": {
- "description": "The hold ID.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "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": {
+ "id": "vault.matters.holds.get",
+ "path": "v1/matters/{matterId}/holds/{holdId}",
+ "description": "Gets a hold by ID.",
"httpMethod": "GET",
"parameterOrder": [
"matterId",
@@ -719,14 +693,14 @@
"$ref": "Hold"
},
"parameters": {
- "matterId": {
- "location": "path",
- "description": "The matter ID.",
- "required": true,
- "type": "string"
- },
"holdId": {
- "description": "The hold ID.",
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "description": "The hold ID."
+ },
+ "matterId": {
+ "description": "The matter ID.",
"required": true,
"type": "string",
"location": "path"
@@ -736,13 +710,9 @@
"https://www.googleapis.com/auth/ediscovery",
"https://www.googleapis.com/auth/ediscovery.readonly"
],
- "flatPath": "v1/matters/{matterId}/holds/{holdId}",
- "id": "vault.matters.holds.get",
- "path": "v1/matters/{matterId}/holds/{holdId}",
- "description": "Gets a hold by ID."
+ "flatPath": "v1/matters/{matterId}/holds/{holdId}"
},
"list": {
- "description": "Lists holds within a matter. An empty page token in ListHoldsResponse\ndenotes no more holds to list.",
"response": {
"$ref": "ListHoldsResponse"
},
@@ -755,29 +725,34 @@
"https://www.googleapis.com/auth/ediscovery.readonly"
],
"parameters": {
- "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",
- "location": "query"
+ "type": "string"
},
"pageSize": {
"location": "query",
"description": "The number of holds to return in the response, between 0 and 100 inclusive.\nLeaving this empty, or as 0, is the same as page_size = 100.",
"format": "int32",
"type": "integer"
+ },
+ "matterId": {
+ "location": "path",
+ "description": "The matter ID.",
+ "required": true,
+ "type": "string"
}
},
"flatPath": "v1/matters/{matterId}/holds",
"path": "v1/matters/{matterId}/holds",
- "id": "vault.matters.holds.list"
+ "id": "vault.matters.holds.list",
+ "description": "Lists holds within a matter. An empty page token in ListHoldsResponse\ndenotes no more holds to list."
},
"update": {
+ "request": {
+ "$ref": "Hold"
+ },
+ "description": "Updates the OU and/or query parameters of a hold. You cannot add accounts\nto a hold that covers an OU, nor can you add OUs to a hold that covers\nindividual accounts. Accounts listed in the hold will be ignored.",
"httpMethod": "PUT",
"parameterOrder": [
"matterId",
@@ -787,17 +762,17 @@
"$ref": "Hold"
},
"parameters": {
- "matterId": {
- "location": "path",
- "description": "The matter ID.",
- "required": true,
- "type": "string"
- },
"holdId": {
"description": "The ID of the hold.",
"required": true,
"type": "string",
"location": "path"
+ },
+ "matterId": {
+ "location": "path",
+ "description": "The matter ID.",
+ "required": true,
+ "type": "string"
}
},
"scopes": [
@@ -805,15 +780,9 @@
],
"flatPath": "v1/matters/{matterId}/holds/{holdId}",
"id": "vault.matters.holds.update",
- "path": "v1/matters/{matterId}/holds/{holdId}",
- "request": {
- "$ref": "Hold"
- },
- "description": "Updates the OU and/or query parameters of a hold. You cannot add accounts\nto a hold that covers an OU, nor can you add OUs to a hold that covers\nindividual accounts. Accounts listed in the hold will be ignored."
+ "path": "v1/matters/{matterId}/holds/{holdId}"
},
"create": {
- "path": "v1/matters/{matterId}/holds",
- "id": "vault.matters.holds.create",
"request": {
"$ref": "Hold"
},
@@ -836,16 +805,46 @@
"scopes": [
"https://www.googleapis.com/auth/ediscovery"
],
- "flatPath": "v1/matters/{matterId}/holds"
+ "flatPath": "v1/matters/{matterId}/holds",
+ "path": "v1/matters/{matterId}/holds",
+ "id": "vault.matters.holds.create"
+ },
+ "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": {
+ "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}",
+ "path": "v1/matters/{matterId}/holds/{holdId}",
+ "id": "vault.matters.holds.delete"
}
},
"resources": {
"accounts": {
"methods": {
"delete": {
- "path": "v1/matters/{matterId}/holds/{holdId}/accounts/{accountId}",
- "id": "vault.matters.holds.accounts.delete",
- "description": "Removes a HeldAccount from a hold. If this request leaves the hold with\nno held accounts, the hold will not apply to any accounts.",
"response": {
"$ref": "Empty"
},
@@ -859,12 +858,6 @@
"https://www.googleapis.com/auth/ediscovery"
],
"parameters": {
- "matterId": {
- "location": "path",
- "description": "The matter ID.",
- "required": true,
- "type": "string"
- },
"holdId": {
"location": "path",
"description": "The hold ID.",
@@ -872,15 +865,25 @@
"type": "string"
},
"accountId": {
+ "location": "path",
"description": "The ID of the account to remove from the hold.",
"required": true,
+ "type": "string"
+ },
+ "matterId": {
+ "required": true,
"type": "string",
- "location": "path"
+ "location": "path",
+ "description": "The matter ID."
}
},
- "flatPath": "v1/matters/{matterId}/holds/{holdId}/accounts/{accountId}"
+ "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": {
+ "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"
},
@@ -890,14 +893,14 @@
],
"httpMethod": "GET",
"parameters": {
- "matterId": {
- "description": "The matter ID.",
+ "holdId": {
+ "description": "The hold ID.",
"required": true,
"type": "string",
"location": "path"
},
- "holdId": {
- "description": "The hold ID.",
+ "matterId": {
+ "description": "The matter ID.",
"required": true,
"type": "string",
"location": "path"
@@ -909,8 +912,7 @@
],
"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."
+ "id": "vault.matters.holds.accounts.list"
},
"create": {
"httpMethod": "POST",
@@ -922,14 +924,14 @@
"$ref": "HeldAccount"
},
"parameters": {
- "holdId": {
+ "matterId": {
"location": "path",
- "description": "The hold ID.",
+ "description": "The matter ID.",
"required": true,
"type": "string"
},
- "matterId": {
- "description": "The matter ID.",
+ "holdId": {
+ "description": "The hold ID.",
"required": true,
"type": "string",
"location": "path"
@@ -954,30 +956,17 @@
}
},
"parameters": {
- "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": {
- "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.",
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"type": "string"
},
- "$.xgafv": {
- "description": "V1 error format.",
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
"type": "string",
+ "location": "query"
+ },
+ "$.xgafv": {
"enumDescriptions": [
"v1 error format",
"v2 error format"
@@ -986,16 +975,16 @@
"enum": [
"1",
"2"
- ]
- },
- "callback": {
- "location": "query",
- "description": "JSONP",
+ ],
+ "description": "V1 error format.",
"type": "string"
},
- "alt": {
+ "callback": {
+ "type": "string",
"location": "query",
- "description": "Data format for response.",
+ "description": "JSONP"
+ },
+ "alt": {
"default": "json",
"enum": [
"json",
@@ -1007,7 +996,9 @@
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
"Responses with Content-Type of application/x-protobuf"
- ]
+ ],
+ "location": "query",
+ "description": "Data format for response."
},
"key": {
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
@@ -1015,9 +1006,9 @@
"location": "query"
},
"access_token": {
+ "type": "string",
"location": "query",
- "description": "OAuth access token.",
- "type": "string"
+ "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.",
@@ -1025,22 +1016,31 @@
"location": "query"
},
"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"
+ "type": "string",
+ "location": "query"
},
"bearer_token": {
- "location": "query",
"description": "OAuth bearer token.",
+ "type": "string",
+ "location": "query"
+ },
+ "upload_protocol": {
+ "location": "query",
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"type": "string"
+ },
+ "prettyPrint": {
+ "description": "Returns response with indentations and line breaks.",
+ "type": "boolean",
+ "default": "true",
+ "location": "query"
}
- },
- "version": "v1",
- "baseUrl": "https://vault.googleapis.com/"
+ }
}
diff --git a/videointelligence/v1beta1/videointelligence-api.json b/videointelligence/v1beta1/videointelligence-api.json
index b1bebab..ced11f1 100644
--- a/videointelligence/v1beta1/videointelligence-api.json
+++ b/videointelligence/v1beta1/videointelligence-api.json
@@ -1,70 +1,42 @@
{
+ "fullyEncodeReservedExpansion": true,
+ "title": "Cloud Video Intelligence API",
+ "ownerName": "Google",
"resources": {
"videos": {
"methods": {
"annotate": {
- "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).",
"response": {
"$ref": "GoogleLongrunning_Operation"
},
"parameterOrder": [],
"httpMethod": "POST",
- "parameters": {},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
- ]
+ ],
+ "parameters": {},
+ "flatPath": "v1beta1/videos:annotate"
}
}
}
},
"parameters": {
- "key": {
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string",
- "location": "query"
- },
- "access_token": {
- "description": "OAuth access token.",
- "type": "string",
- "location": "query"
- },
- "quotaUser": {
- "description": "Available 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",
"location": "query"
},
"prettyPrint": {
+ "location": "query",
"description": "Returns response with indentations and line breaks.",
"type": "boolean",
- "default": "true",
- "location": "query"
+ "default": "true"
},
"fields": {
"location": "query",
@@ -72,14 +44,14 @@
"type": "string"
},
"uploadType": {
+ "location": "query",
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"callback": {
+ "location": "query",
"description": "JSONP",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"$.xgafv": {
"enumDescriptions": [
@@ -95,12 +67,6 @@
"type": "string"
},
"alt": {
- "enum": [
- "json",
- "media",
- "proto"
- ],
- "type": "string",
"enumDescriptions": [
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
@@ -108,320 +74,72 @@
],
"location": "query",
"description": "Data format for response.",
- "default": "json"
+ "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": {
+ "location": "query",
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "type": "string"
+ },
+ "pp": {
+ "description": "Pretty-print response.",
+ "type": "boolean",
+ "default": "true",
+ "location": "query"
+ },
+ "bearer_token": {
+ "location": "query",
+ "description": "OAuth bearer token.",
+ "type": "string"
+ },
+ "oauth_token": {
+ "location": "query",
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string"
}
},
"version": "v1beta1",
"baseUrl": "https://videointelligence.googleapis.com/",
- "servicePath": "",
- "description": "Cloud Video Intelligence API.",
"kind": "discovery#restDescription",
+ "description": "Cloud Video Intelligence API.",
+ "servicePath": "",
"basePath": "",
- "id": "videointelligence:v1beta1",
- "documentationLink": "https://cloud.google.com/video-intelligence/docs/",
"revision": "20171122",
+ "documentationLink": "https://cloud.google.com/video-intelligence/docs/",
+ "id": "videointelligence:v1beta1",
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
- "GoogleCloudVideointelligenceV1_AnnotateVideoProgress": {
- "description": "Video annotation progress. Included in the `metadata`\nfield of the `Operation` returned by the `GetOperation`\ncall of the `google::longrunning::Operations` service.",
- "type": "object",
- "properties": {
- "annotationProgress": {
- "description": "Progress metadata for all videos specified in `AnnotateVideoRequest`.",
- "type": "array",
- "items": {
- "$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": {
- "error": {
- "$ref": "GoogleRpc_Status",
- "description": "The error result of the operation in case of failure or cancellation."
- },
- "metadata": {
- "description": "Service-specific metadata associated with the operation. It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata. Any method that returns a\nlong-running operation should document the metadata type, if any.",
- "type": "object",
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- }
- },
- "done": {
- "description": "If the value is `false`, it means the operation is still in progress.\nIf `true`, the operation is completed, and either `error` or `response` is\navailable.",
- "type": "boolean"
- },
- "response": {
- "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": "GoogleLongrunning_Operation"
- },
- "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"
- },
- "shotAnnotations": {
- "description": "Shot annotations. Each shot is represented as a video segment.",
- "type": "array",
- "items": {
- "$ref": "GoogleCloudVideointelligenceV1beta1_VideoSegment"
- }
- },
- "inputUri": {
- "description": "Video file location in\n[Google Cloud Storage](https://cloud.google.com/storage/).",
- "type": "string"
- },
- "safeSearchAnnotations": {
- "description": "Safe search annotations.",
- "type": "array",
- "items": {
- "$ref": "GoogleCloudVideointelligenceV1beta1_SafeSearchAnnotation"
- }
- },
- "labelAnnotations": {
- "description": "Label annotations. There is exactly one element for each unique label.",
- "type": "array",
- "items": {
- "$ref": "GoogleCloudVideointelligenceV1beta1_LabelAnnotation"
- }
- }
- },
- "id": "GoogleCloudVideointelligenceV1beta1_VideoAnnotationResults"
- },
- "GoogleCloudVideointelligenceV1beta2_VideoAnnotationProgress": {
- "description": "Annotation progress for a single video.",
- "type": "object",
- "properties": {
- "progressPercent": {
- "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"
- },
- "inputUri": {
- "description": "Video file location in\n[Google Cloud Storage](https://cloud.google.com/storage/).",
- "type": "string"
- }
- },
- "id": "GoogleCloudVideointelligenceV1beta2_VideoAnnotationProgress"
- },
- "GoogleCloudVideointelligenceV1_AnnotateVideoResponse": {
- "description": "Video annotation response. Included in the `response`\nfield of the `Operation` returned by the `GetOperation`\ncall of the `google::longrunning::Operations` service.",
- "type": "object",
- "properties": {
- "annotationResults": {
- "description": "Annotation results for all videos specified in `AnnotateVideoRequest`.",
- "type": "array",
- "items": {
- "$ref": "GoogleCloudVideointelligenceV1_VideoAnnotationResults"
- }
- }
- },
- "id": "GoogleCloudVideointelligenceV1_AnnotateVideoResponse"
- },
- "GoogleCloudVideointelligenceV1beta1_AnnotateVideoResponse": {
- "description": "Video annotation response. Included in the `response`\nfield of the `Operation` returned by the `GetOperation`\ncall of the `google::longrunning::Operations` service.",
- "type": "object",
- "properties": {
- "annotationResults": {
- "description": "Annotation results for all videos specified in `AnnotateVideoRequest`.",
- "type": "array",
- "items": {
- "$ref": "GoogleCloudVideointelligenceV1beta1_VideoAnnotationResults"
- }
- }
- },
- "id": "GoogleCloudVideointelligenceV1beta1_AnnotateVideoResponse"
- },
- "GoogleCloudVideointelligenceV1_LabelSegment": {
- "description": "Video segment level annotation results for label detection.",
- "type": "object",
- "properties": {
- "segment": {
- "$ref": "GoogleCloudVideointelligenceV1_VideoSegment",
- "description": "Video segment where a label was detected."
- },
- "confidence": {
- "description": "Confidence that the label is accurate. Range: [0, 1].",
- "format": "float",
- "type": "number"
- }
- },
- "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",
- "type": "integer"
- },
- "updateTime": {
- "description": "Time of the most recent update.",
- "format": "google-datetime",
- "type": "string"
- },
- "startTime": {
- "description": "Time when the request was received.",
- "format": "google-datetime",
- "type": "string"
- }
- },
- "id": "GoogleCloudVideointelligenceV1beta1_VideoAnnotationProgress"
- },
- "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": {
- "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"
- },
- "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"
- }
- },
- "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": {
- "confidence": {
- "description": "Confidence that the label is accurate. Range: [0, 1].",
- "format": "float",
- "type": "number"
- },
- "segment": {
- "$ref": "GoogleCloudVideointelligenceV1beta2_VideoSegment",
- "description": "Video segment where a label was detected."
- }
- },
- "id": "GoogleCloudVideointelligenceV1beta2_LabelSegment"
- },
"GoogleCloudVideointelligenceV1beta2_LabelAnnotation": {
"description": "Label annotation.",
"type": "object",
"properties": {
+ "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": {
- "description": "Detected entity.",
- "$ref": "GoogleCloudVideointelligenceV1beta2_Entity"
+ "$ref": "GoogleCloudVideointelligenceV1beta2_Entity",
+ "description": "Detected entity."
},
"frames": {
"description": "All video frames where a label was detected.",
@@ -436,13 +154,6 @@
"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"
- }
}
},
"id": "GoogleCloudVideointelligenceV1beta2_LabelAnnotation"
@@ -451,7 +162,27 @@
"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": {
- "violent": {
+ "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": {
"enumDescriptions": [
"Unknown likelihood.",
"Very unlikely.",
@@ -468,7 +199,12 @@
"LIKELY",
"VERY_LIKELY"
],
- "description": "Likelihood of violent content.",
+ "description": "Likelihood of racy content.",
+ "type": "string"
+ },
+ "timeOffset": {
+ "description": "Video time offset in microseconds.",
+ "format": "int64",
"type": "string"
},
"spoof": {
@@ -491,69 +227,44 @@
"description": "Likelihood that an obvious modification was made to the original\nversion to make it appear funny or offensive.",
"type": "string"
},
+ "violent": {
+ "enum": [
+ "UNKNOWN",
+ "VERY_UNLIKELY",
+ "UNLIKELY",
+ "POSSIBLE",
+ "LIKELY",
+ "VERY_LIKELY"
+ ],
+ "description": "Likelihood of violent content.",
+ "type": "string",
+ "enumDescriptions": [
+ "Unknown likelihood.",
+ "Very unlikely.",
+ "Unlikely.",
+ "Possible.",
+ "Likely.",
+ "Very likely."
+ ]
+ },
"medical": {
+ "enumDescriptions": [
+ "Unknown likelihood.",
+ "Very unlikely.",
+ "Unlikely.",
+ "Possible.",
+ "Likely.",
+ "Very likely."
+ ],
+ "enum": [
+ "UNKNOWN",
+ "VERY_UNLIKELY",
+ "UNLIKELY",
+ "POSSIBLE",
+ "LIKELY",
+ "VERY_LIKELY"
+ ],
"description": "Likelihood of medical content.",
- "type": "string",
- "enumDescriptions": [
- "Unknown likelihood.",
- "Very unlikely.",
- "Unlikely.",
- "Possible.",
- "Likely.",
- "Very likely."
- ],
- "enum": [
- "UNKNOWN",
- "VERY_UNLIKELY",
- "UNLIKELY",
- "POSSIBLE",
- "LIKELY",
- "VERY_LIKELY"
- ]
- },
- "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": {
- "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"
}
},
@@ -574,9 +285,11 @@
"id": "GoogleCloudVideointelligenceV1beta1_AnnotateVideoProgress"
},
"GoogleCloudVideointelligenceV1_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"
@@ -584,22 +297,16 @@
"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"
+ "id": "GoogleCloudVideointelligenceV1_Entity",
+ "description": "Detected entity from video analysis.",
+ "type": "object"
},
"GoogleCloudVideointelligenceV1beta2_Entity": {
"description": "Detected entity from video analysis.",
"type": "object",
"properties": {
- "languageCode": {
- "description": "Language code for `description` in BCP-47 format.",
- "type": "string"
- },
"entityId": {
"description": "Opaque entity ID. Some IDs may be available in\n[Google Knowledge Graph Search\nAPI](https://developers.google.com/knowledge-graph/).",
"type": "string"
@@ -607,13 +314,15 @@
"description": {
"description": "Textual description, e.g. `Fixed-gear bicycle`.",
"type": "string"
+ },
+ "languageCode": {
+ "description": "Language code for `description` in BCP-47 format.",
+ "type": "string"
}
},
"id": "GoogleCloudVideointelligenceV1beta2_Entity"
},
"GoogleCloudVideointelligenceV1beta2_VideoSegment": {
- "description": "Video segment.",
- "type": "object",
"properties": {
"endTimeOffset": {
"description": "Time-offset, relative to the beginning of the video,\ncorresponding to the end of the segment (inclusive).",
@@ -626,12 +335,19 @@
"type": "string"
}
},
- "id": "GoogleCloudVideointelligenceV1beta2_VideoSegment"
+ "id": "GoogleCloudVideointelligenceV1beta2_VideoSegment",
+ "description": "Video segment.",
+ "type": "object"
},
"GoogleCloudVideointelligenceV1_VideoAnnotationResults": {
- "description": "Annotation results for a single video.",
- "type": "object",
"properties": {
+ "shotAnnotations": {
+ "description": "Shot annotations. Each shot is represented as a video segment.",
+ "type": "array",
+ "items": {
+ "$ref": "GoogleCloudVideointelligenceV1_VideoSegment"
+ }
+ },
"shotLabelAnnotations": {
"description": "Label annotations on shot level.\nThere is exactly one element for each unique label.",
"type": "array",
@@ -640,8 +356,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.",
@@ -654,10 +370,6 @@
"description": "Video file location in\n[Google Cloud Storage](https://cloud.google.com/storage/).",
"type": "string"
},
- "explicitAnnotation": {
- "$ref": "GoogleCloudVideointelligenceV1_ExplicitContentAnnotation",
- "description": "Explicit content annotation."
- },
"segmentLabelAnnotations": {
"description": "Label annotations on video level or user specified segment level.\nThere is exactly one element for each unique label.",
"type": "array",
@@ -665,19 +377,16 @@
"$ref": "GoogleCloudVideointelligenceV1_LabelAnnotation"
}
},
- "shotAnnotations": {
- "description": "Shot annotations. Each shot is represented as a video segment.",
- "type": "array",
- "items": {
- "$ref": "GoogleCloudVideointelligenceV1_VideoSegment"
- }
+ "explicitAnnotation": {
+ "$ref": "GoogleCloudVideointelligenceV1_ExplicitContentAnnotation",
+ "description": "Explicit content annotation."
}
},
- "id": "GoogleCloudVideointelligenceV1_VideoAnnotationResults"
+ "id": "GoogleCloudVideointelligenceV1_VideoAnnotationResults",
+ "description": "Annotation results for a single video.",
+ "type": "object"
},
"GoogleCloudVideointelligenceV1beta2_AnnotateVideoResponse": {
- "description": "Video annotation response. Included in the `response`\nfield of the `Operation` returned by the `GetOperation`\ncall of the `google::longrunning::Operations` service.",
- "type": "object",
"properties": {
"annotationResults": {
"description": "Annotation results for all videos specified in `AnnotateVideoRequest`.",
@@ -687,12 +396,21 @@
}
}
},
- "id": "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"
},
"GoogleCloudVideointelligenceV1beta1_LabelAnnotation": {
"description": "Label annotation.",
"type": "object",
"properties": {
+ "locations": {
+ "description": "Where the label was detected and with what confidence.",
+ "type": "array",
+ "items": {
+ "$ref": "GoogleCloudVideointelligenceV1beta1_LabelLocation"
+ }
+ },
"languageCode": {
"description": "Language code for `description` in BCP-47 format.",
"type": "string"
@@ -700,13 +418,6 @@
"description": {
"description": "Textual description, e.g. `Fixed-gear bicycle`.",
"type": "string"
- },
- "locations": {
- "description": "Where the label was detected and with what confidence.",
- "type": "array",
- "items": {
- "$ref": "GoogleCloudVideointelligenceV1beta1_LabelLocation"
- }
}
},
"id": "GoogleCloudVideointelligenceV1beta1_LabelAnnotation"
@@ -715,10 +426,6 @@
"description": "Video context and/or feature-specific parameters.",
"type": "object",
"properties": {
- "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",
@@ -735,6 +442,8 @@
"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.",
@@ -746,21 +455,32 @@
"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"
}
},
"id": "GoogleCloudVideointelligenceV1beta1_VideoContext"
},
"GoogleCloudVideointelligenceV1_LabelAnnotation": {
- "description": "Label annotation.",
- "type": "object",
"properties": {
+ "entity": {
+ "$ref": "GoogleCloudVideointelligenceV1_Entity",
+ "description": "Detected entity."
+ },
+ "frames": {
+ "description": "All video frames where a label was detected.",
+ "type": "array",
+ "items": {
+ "$ref": "GoogleCloudVideointelligenceV1_LabelFrame"
+ }
+ },
"segments": {
"description": "All video segments where a label was detected.",
"type": "array",
@@ -774,20 +494,11 @@
"items": {
"$ref": "GoogleCloudVideointelligenceV1_Entity"
}
- },
- "entity": {
- "$ref": "GoogleCloudVideointelligenceV1_Entity",
- "description": "Detected entity."
- },
- "frames": {
- "description": "All video frames where a label was detected.",
- "type": "array",
- "items": {
- "$ref": "GoogleCloudVideointelligenceV1_LabelFrame"
- }
}
},
- "id": "GoogleCloudVideointelligenceV1_LabelAnnotation"
+ "id": "GoogleCloudVideointelligenceV1_LabelAnnotation",
+ "description": "Label annotation.",
+ "type": "object"
},
"GoogleRpc_Status": {
"description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
@@ -854,24 +565,6 @@
"description": "Annotation results for a single video.",
"type": "object",
"properties": {
- "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"
- }
- },
- "explicitAnnotation": {
- "description": "Explicit content annotation.",
- "$ref": "GoogleCloudVideointelligenceV1beta2_ExplicitContentAnnotation"
- },
- "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",
@@ -880,8 +573,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.",
@@ -893,6 +586,24 @@
"inputUri": {
"description": "Video file location in\n[Google Cloud Storage](https://cloud.google.com/storage/).",
"type": "string"
+ },
+ "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"
+ }
+ },
+ "explicitAnnotation": {
+ "$ref": "GoogleCloudVideointelligenceV1beta2_ExplicitContentAnnotation",
+ "description": "Explicit content annotation."
+ },
+ "shotAnnotations": {
+ "description": "Shot annotations. Each shot is represented as a video segment.",
+ "type": "array",
+ "items": {
+ "$ref": "GoogleCloudVideointelligenceV1beta2_VideoSegment"
+ }
}
},
"id": "GoogleCloudVideointelligenceV1beta2_VideoAnnotationResults"
@@ -901,9 +612,14 @@
"description": "Label location.",
"type": "object",
"properties": {
+ "confidence": {
+ "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"
+ "$ref": "GoogleCloudVideointelligenceV1beta1_VideoSegment",
+ "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)."
},
"level": {
"enumDescriptions": [
@@ -922,11 +638,6 @@
],
"description": "Label level.",
"type": "string"
- },
- "confidence": {
- "description": "Confidence that the label is accurate. Range: [0, 1].",
- "format": "float",
- "type": "number"
}
},
"id": "GoogleCloudVideointelligenceV1beta1_LabelLocation"
@@ -967,6 +678,8 @@
"type": "object",
"properties": {
"pornographyLikelihood": {
+ "description": "Likelihood of the pornography content..",
+ "type": "string",
"enumDescriptions": [
"Unspecified likelihood.",
"Very unlikely.",
@@ -982,9 +695,7 @@
"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.",
@@ -1009,8 +720,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`.",
@@ -1020,7 +729,9 @@
}
}
},
- "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": {
"description": "Annotation progress for a single video.",
@@ -1047,12 +758,304 @@
}
},
"id": "GoogleCloudVideointelligenceV1_VideoAnnotationProgress"
+ },
+ "GoogleCloudVideointelligenceV1_AnnotateVideoProgress": {
+ "properties": {
+ "annotationProgress": {
+ "description": "Progress metadata for all videos specified in `AnnotateVideoRequest`.",
+ "type": "array",
+ "items": {
+ "$ref": "GoogleCloudVideointelligenceV1_VideoAnnotationProgress"
+ }
+ }
+ },
+ "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"
+ },
+ "GoogleLongrunning_Operation": {
+ "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
+ "type": "object",
+ "properties": {
+ "response": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "description": "The normal response of the operation in case of success. If the original\nmethod returns no data on success, such as `Delete`, the response is\n`google.protobuf.Empty`. If the original method is standard\n`Get`/`Create`/`Update`, the response should be the resource. For other\nmethods, the response should have the type `XxxResponse`, where `Xxx`\nis the original method name. For example, if the original method name\nis `TakeSnapshot()`, the inferred response type is\n`TakeSnapshotResponse`.",
+ "type": "object"
+ },
+ "name": {
+ "description": "The server-assigned name, which is only unique within the same service that\noriginally returns it. If you use the default HTTP mapping, the\n`name` should have the format of `operations/some/unique/name`.",
+ "type": "string"
+ },
+ "error": {
+ "description": "The error result of the operation in case of failure or cancellation.",
+ "$ref": "GoogleRpc_Status"
+ },
+ "metadata": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "description": "Service-specific metadata associated with the operation. It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata. Any method that returns a\nlong-running operation should document the metadata type, if any.",
+ "type": "object"
+ },
+ "done": {
+ "description": "If the value is `false`, it means the operation is still in progress.\nIf `true`, the operation is completed, and either `error` or `response` is\navailable.",
+ "type": "boolean"
+ }
+ },
+ "id": "GoogleLongrunning_Operation"
+ },
+ "GoogleCloudVideointelligenceV1beta2_VideoAnnotationProgress": {
+ "description": "Annotation progress for a single video.",
+ "type": "object",
+ "properties": {
+ "progressPercent": {
+ "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"
+ },
+ "inputUri": {
+ "description": "Video file location in\n[Google Cloud Storage](https://cloud.google.com/storage/).",
+ "type": "string"
+ }
+ },
+ "id": "GoogleCloudVideointelligenceV1beta2_VideoAnnotationProgress"
+ },
+ "GoogleCloudVideointelligenceV1beta1_VideoAnnotationResults": {
+ "description": "Annotation results for a single video.",
+ "type": "object",
+ "properties": {
+ "labelAnnotations": {
+ "description": "Label annotations. There is exactly one element for each unique label.",
+ "type": "array",
+ "items": {
+ "$ref": "GoogleCloudVideointelligenceV1beta1_LabelAnnotation"
+ }
+ },
+ "error": {
+ "description": "If set, indicates an error. Note that for a single `AnnotateVideoRequest`\nsome videos may succeed and some may fail.",
+ "$ref": "GoogleRpc_Status"
+ },
+ "shotAnnotations": {
+ "description": "Shot annotations. Each shot is represented as a video segment.",
+ "type": "array",
+ "items": {
+ "$ref": "GoogleCloudVideointelligenceV1beta1_VideoSegment"
+ }
+ },
+ "inputUri": {
+ "description": "Video file location in\n[Google Cloud Storage](https://cloud.google.com/storage/).",
+ "type": "string"
+ },
+ "safeSearchAnnotations": {
+ "description": "Safe search annotations.",
+ "type": "array",
+ "items": {
+ "$ref": "GoogleCloudVideointelligenceV1beta1_SafeSearchAnnotation"
+ }
+ }
+ },
+ "id": "GoogleCloudVideointelligenceV1beta1_VideoAnnotationResults"
+ },
+ "GoogleCloudVideointelligenceV1_AnnotateVideoResponse": {
+ "properties": {
+ "annotationResults": {
+ "description": "Annotation results for all videos specified in `AnnotateVideoRequest`.",
+ "type": "array",
+ "items": {
+ "$ref": "GoogleCloudVideointelligenceV1_VideoAnnotationResults"
+ }
+ }
+ },
+ "id": "GoogleCloudVideointelligenceV1_AnnotateVideoResponse",
+ "description": "Video annotation response. Included in the `response`\nfield of the `Operation` returned by the `GetOperation`\ncall of the `google::longrunning::Operations` service.",
+ "type": "object"
+ },
+ "GoogleCloudVideointelligenceV1beta1_AnnotateVideoResponse": {
+ "description": "Video annotation response. Included in the `response`\nfield of the `Operation` returned by the `GetOperation`\ncall of the `google::longrunning::Operations` service.",
+ "type": "object",
+ "properties": {
+ "annotationResults": {
+ "description": "Annotation results for all videos specified in `AnnotateVideoRequest`.",
+ "type": "array",
+ "items": {
+ "$ref": "GoogleCloudVideointelligenceV1beta1_VideoAnnotationResults"
+ }
+ }
+ },
+ "id": "GoogleCloudVideointelligenceV1beta1_AnnotateVideoResponse"
+ },
+ "GoogleCloudVideointelligenceV1_LabelSegment": {
+ "description": "Video segment level annotation results for label detection.",
+ "type": "object",
+ "properties": {
+ "confidence": {
+ "description": "Confidence that the label is accurate. Range: [0, 1].",
+ "format": "float",
+ "type": "number"
+ },
+ "segment": {
+ "$ref": "GoogleCloudVideointelligenceV1_VideoSegment",
+ "description": "Video segment where a label was detected."
+ }
+ },
+ "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",
+ "type": "integer"
+ },
+ "updateTime": {
+ "description": "Time of the most recent update.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "startTime": {
+ "description": "Time when the request was received.",
+ "format": "google-datetime",
+ "type": "string"
+ }
+ },
+ "id": "GoogleCloudVideointelligenceV1beta1_VideoAnnotationProgress"
+ },
+ "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": {
+ "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": {
+ "enum": [
+ "FEATURE_UNSPECIFIED",
+ "LABEL_DETECTION",
+ "SHOT_CHANGE_DETECTION",
+ "SAFE_SEARCH_DETECTION"
+ ],
+ "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"
+ },
+ "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",
+ "description": "Video annotation request.",
+ "type": "object"
+ },
+ "GoogleCloudVideointelligenceV1beta1_VideoSegment": {
+ "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",
+ "description": "Video segment.",
+ "type": "object"
+ },
+ "GoogleCloudVideointelligenceV1beta2_LabelSegment": {
+ "description": "Video segment level annotation results for label detection.",
+ "type": "object",
+ "properties": {
+ "confidence": {
+ "description": "Confidence that the label is accurate. Range: [0, 1].",
+ "format": "float",
+ "type": "number"
+ },
+ "segment": {
+ "$ref": "GoogleCloudVideointelligenceV1beta2_VideoSegment",
+ "description": "Video segment where a label was detected."
+ }
+ },
+ "id": "GoogleCloudVideointelligenceV1beta2_LabelSegment"
}
},
"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 Video Intelligence",
"auth": {
@@ -1067,8 +1070,5 @@
"rootUrl": "https://videointelligence.googleapis.com/",
"ownerDomain": "google.com",
"name": "videointelligence",
- "batchPath": "batch",
- "fullyEncodeReservedExpansion": true,
- "title": "Cloud Video Intelligence API",
- "ownerName": "Google"
+ "batchPath": "batch"
}
diff --git a/vision/v1/vision-api.json b/vision/v1/vision-api.json
index bb90e61..8756440 100644
--- a/vision/v1/vision-api.json
+++ b/vision/v1/vision-api.json
@@ -9,67 +9,23 @@
},
"parameterOrder": [],
"httpMethod": "POST",
- "parameters": {},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-vision"
],
+ "parameters": {},
"flatPath": "v1/images:annotate",
"path": "v1/images:annotate",
"id": "vision.images.annotate",
+ "description": "Run image detection and annotation for a batch of images.",
"request": {
"$ref": "BatchAnnotateImagesRequest"
- },
- "description": "Run image detection and annotation for a batch of images."
+ }
}
}
}
},
"parameters": {
- "callback": {
- "description": "JSONP",
- "type": "string",
- "location": "query"
- },
- "$.xgafv": {
- "description": "V1 error format.",
- "type": "string",
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query",
- "enum": [
- "1",
- "2"
- ]
- },
- "alt": {
- "type": "string",
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query",
- "description": "Data format for response.",
- "default": "json",
- "enum": [
- "json",
- "media",
- "proto"
- ]
- },
- "key": {
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string",
- "location": "query"
- },
- "access_token": {
- "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",
@@ -81,20 +37,20 @@
"default": "true",
"location": "query"
},
+ "oauth_token": {
+ "location": "query",
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string"
+ },
"bearer_token": {
"location": "query",
"description": "OAuth bearer token.",
"type": "string"
},
- "oauth_token": {
- "description": "OAuth 2.0 token for the current user.",
- "type": "string",
- "location": "query"
- },
"upload_protocol": {
+ "type": "string",
"location": "query",
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string"
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")."
},
"prettyPrint": {
"location": "query",
@@ -108,16 +64,60 @@
"type": "string"
},
"uploadType": {
- "location": "query",
"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": {
+ "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": {
+ "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://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": "",
+ "description": "Integrates Google Vision features, including image labeling, face, logo, and landmark detection, optical character recognition (OCR), and detection of explicit content, into applications.",
+ "kind": "discovery#restDescription",
"basePath": "",
"id": "vision:v1",
"documentationLink": "https://cloud.google.com/vision/",
@@ -125,178 +125,40 @@
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
- "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": {
- "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",
- "LANDMARK_DETECTION",
- "LOGO_DETECTION",
- "LABEL_DETECTION",
- "TEXT_DETECTION",
- "DOCUMENT_TEXT_DETECTION",
- "SAFE_SEARCH_DETECTION",
- "IMAGE_PROPERTIES",
- "CROP_HINTS",
- "WEB_DETECTION"
- ],
- "description": "The feature type.",
- "type": "string"
- },
- "maxResults": {
- "description": "Maximum number of results of this type.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "Feature"
- },
- "ImageProperties": {
- "description": "Stores image properties, such as dominant colors.",
- "type": "object",
- "properties": {
- "dominantColors": {
- "$ref": "DominantColorsAnnotation",
- "description": "If present, dominant colors completed successfully."
- }
- },
- "id": "ImageProperties"
- },
- "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": {
- "adult": {
- "enum": [
- "UNKNOWN",
- "VERY_UNLIKELY",
- "UNLIKELY",
- "POSSIBLE",
- "LIKELY",
- "VERY_LIKELY"
- ],
- "description": "Represents the adult content likelihood for the image. Adult content may\ncontain elements such as nudity, pornographic images or cartoons, or\nsexual activities.",
- "type": "string",
- "enumDescriptions": [
- "Unknown likelihood.",
- "It is very unlikely that the image belongs to the specified vertical.",
- "It is unlikely that the image belongs to the specified vertical.",
- "It is possible that the image belongs to the specified vertical.",
- "It is likely that the image belongs to the specified vertical.",
- "It is very likely that the image belongs to the specified vertical."
- ]
- },
- "spoof": {
- "enum": [
- "UNKNOWN",
- "VERY_UNLIKELY",
- "UNLIKELY",
- "POSSIBLE",
- "LIKELY",
- "VERY_LIKELY"
- ],
- "description": "Spoof likelihood. The likelihood that an modification\nwas made to the image's canonical version to make it appear\nfunny or offensive.",
- "type": "string",
- "enumDescriptions": [
- "Unknown likelihood.",
- "It is very unlikely that the image belongs to the specified vertical.",
- "It is unlikely that the image belongs to the specified vertical.",
- "It is possible that the image belongs to the specified vertical.",
- "It is likely that the image belongs to the specified vertical.",
- "It is very likely that the image belongs to the specified vertical."
- ]
- },
- "medical": {
- "description": "Likelihood that this is a medical image.",
- "type": "string",
- "enumDescriptions": [
- "Unknown likelihood.",
- "It is very unlikely that the image belongs to the specified vertical.",
- "It is unlikely that the image belongs to the specified vertical.",
- "It is possible that the image belongs to the specified vertical.",
- "It is likely that the image belongs to the specified vertical.",
- "It is very likely that the image belongs to the specified vertical."
- ],
- "enum": [
- "UNKNOWN",
- "VERY_UNLIKELY",
- "UNLIKELY",
- "POSSIBLE",
- "LIKELY",
- "VERY_LIKELY"
- ]
- },
- "violence": {
- "description": "Likelihood that this image contains violent content.",
- "type": "string",
- "enumDescriptions": [
- "Unknown likelihood.",
- "It is very unlikely that the image belongs to the specified vertical.",
- "It is unlikely that the image belongs to the specified vertical.",
- "It is possible that the image belongs to the specified vertical.",
- "It is likely that the image belongs to the specified vertical.",
- "It is very likely that the image belongs to the specified vertical."
- ],
- "enum": [
- "UNKNOWN",
- "VERY_UNLIKELY",
- "UNLIKELY",
- "POSSIBLE",
- "LIKELY",
- "VERY_LIKELY"
- ]
- }
- },
- "id": "SafeSearchAnnotation"
- },
- "DominantColorsAnnotation": {
- "description": "Set of dominant colors and their corresponding scores.",
- "type": "object",
- "properties": {
- "colors": {
- "description": "RGB color values with their score and pixel fraction.",
- "type": "array",
- "items": {
- "$ref": "ColorInfo"
- }
- }
- },
- "id": "DominantColorsAnnotation"
- },
"TextAnnotation": {
"description": "TextAnnotation contains a structured representation of OCR extracted text.\nThe hierarchy of an OCR extracted text structure is like this:\n TextAnnotation -\u003e Page -\u003e Block -\u003e Paragraph -\u003e Word -\u003e Symbol\nEach structural component, starting from Page, may further have their own\nproperties. Properties describe detected languages, breaks etc.. Please refer\nto the TextAnnotation.TextProperty message definition below for more\ndetail.",
"type": "object",
"properties": {
+ "text": {
+ "description": "UTF-8 text detected on the pages.",
+ "type": "string"
+ },
"pages": {
"description": "List of pages detected by OCR.",
"type": "array",
"items": {
"$ref": "Page"
}
- },
- "text": {
- "description": "UTF-8 text detected on the pages.",
- "type": "string"
}
},
"id": "TextAnnotation"
},
+ "DetectedLanguage": {
+ "description": "Detected language for a structural component.",
+ "type": "object",
+ "properties": {
+ "languageCode": {
+ "description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more\ninformation, see\nhttp://www.unicode.org/reports/tr35/#Unicode_locale_identifier.",
+ "type": "string"
+ },
+ "confidence": {
+ "description": "Confidence of detected language. Range [0, 1].",
+ "format": "float",
+ "type": "number"
+ }
+ },
+ "id": "DetectedLanguage"
+ },
"Vertex": {
"description": "A vertex represents a 2D point in the image.\nNOTE: the vertex coordinates are in the same scale as the original image.",
"type": "object",
@@ -314,22 +176,6 @@
},
"id": "Vertex"
},
- "DetectedLanguage": {
- "description": "Detected language for a structural component.",
- "type": "object",
- "properties": {
- "languageCode": {
- "description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more\ninformation, see\nhttp://www.unicode.org/reports/tr35/#Unicode_locale_identifier.",
- "type": "string"
- },
- "confidence": {
- "description": "Confidence of detected language. Range [0, 1].",
- "format": "float",
- "type": "number"
- }
- },
- "id": "DetectedLanguage"
- },
"WebEntity": {
"description": "Entity deduced from similar images on the Internet.",
"type": "object",
@@ -368,24 +214,62 @@
"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"
},
"AnnotateImageResponse": {
- "description": "Response to an image annotation request.",
- "type": "object",
"properties": {
+ "landmarkAnnotations": {
+ "type": "array",
+ "items": {
+ "$ref": "EntityAnnotation"
+ },
+ "description": "If present, landmark detection has completed successfully."
+ },
+ "textAnnotations": {
+ "description": "If present, text (OCR) detection has completed successfully.",
+ "type": "array",
+ "items": {
+ "$ref": "EntityAnnotation"
+ }
+ },
+ "imagePropertiesAnnotation": {
+ "$ref": "ImageProperties",
+ "description": "If present, image properties were extracted successfully."
+ },
+ "faceAnnotations": {
+ "description": "If present, face detection has completed successfully.",
+ "type": "array",
+ "items": {
+ "$ref": "FaceAnnotation"
+ }
+ },
+ "logoAnnotations": {
+ "description": "If present, logo detection has completed successfully.",
+ "type": "array",
+ "items": {
+ "$ref": "EntityAnnotation"
+ }
+ },
+ "webDetection": {
+ "description": "If present, web detection has completed successfully.",
+ "$ref": "WebDetection"
+ },
+ "cropHintsAnnotation": {
+ "$ref": "CropHintsAnnotation",
+ "description": "If present, crop hints have completed successfully."
+ },
"labelAnnotations": {
"description": "If present, label detection has completed successfully.",
"type": "array",
@@ -398,55 +282,17 @@
"description": "If present, safe-search annotation has completed successfully."
},
"error": {
- "$ref": "Status",
- "description": "If set, represents the error message for the operation.\nNote that filled-in image annotations are guaranteed to be\ncorrect, even when `error` is set."
+ "description": "If set, represents the error message for the operation.\nNote that filled-in image annotations are guaranteed to be\ncorrect, even when `error` is set.",
+ "$ref": "Status"
},
"fullTextAnnotation": {
"$ref": "TextAnnotation",
"description": "If present, text (OCR) detection or document (OCR) text detection has\ncompleted successfully.\nThis annotation provides the structural hierarchy for the OCR detected\ntext."
- },
- "landmarkAnnotations": {
- "description": "If present, landmark detection has completed successfully.",
- "type": "array",
- "items": {
- "$ref": "EntityAnnotation"
- }
- },
- "textAnnotations": {
- "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"
}
},
- "id": "AnnotateImageResponse"
+ "id": "AnnotateImageResponse",
+ "description": "Response to an image annotation request.",
+ "type": "object"
},
"CropHintsParams": {
"description": "Parameters for crop hints annotation request.",
@@ -464,8 +310,6 @@
"id": "CropHintsParams"
},
"Block": {
- "description": "Logical element on the page.",
- "type": "object",
"properties": {
"property": {
"$ref": "TextProperty",
@@ -492,8 +336,8 @@
]
},
"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)."
+ "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).",
@@ -503,40 +347,13 @@
}
}
},
- "id": "Block"
- },
- "Property": {
- "description": "A `Property` consists of a user-supplied name/value pair.",
- "type": "object",
- "properties": {
- "value": {
- "description": "Value of the property.",
- "type": "string"
- },
- "uint64Value": {
- "description": "Value of numeric properties.",
- "format": "uint64",
- "type": "string"
- },
- "name": {
- "description": "Name of the property.",
- "type": "string"
- }
- },
- "id": "Property"
- },
- "LocationInfo": {
- "description": "Detected entity location information.",
- "type": "object",
- "properties": {
- "latLng": {
- "$ref": "LatLng",
- "description": "lat/long location coordinates."
- }
- },
- "id": "LocationInfo"
+ "id": "Block",
+ "description": "Logical element on the page.",
+ "type": "object"
},
"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.",
@@ -553,11 +370,11 @@
}
},
"fullMatchingImages": {
- "description": "Fully matching images from the Internet.\nCan include resized copies of the query image.",
"type": "array",
"items": {
"$ref": "WebImage"
- }
+ },
+ "description": "Fully matching images from the Internet.\nCan include resized copies of the query image."
},
"webEntities": {
"description": "Deduced entities from similar images on the Internet.",
@@ -574,13 +391,9 @@
}
}
},
- "id": "WebDetection",
- "description": "Relevant information for the image from the Internet.",
- "type": "object"
+ "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.",
@@ -590,9 +403,12 @@
}
}
},
- "id": "BatchAnnotateImagesResponse"
+ "id": "BatchAnnotateImagesResponse",
+ "description": "Response to a batch image annotation request.",
+ "type": "object"
},
"ImageSource": {
+ "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.",
@@ -604,27 +420,57 @@
}
},
"id": "ImageSource",
- "description": "External image source (Google Cloud Storage image location).",
- "type": "object"
+ "description": "External image source (Google Cloud Storage image location)."
+ },
+ "LocationInfo": {
+ "description": "Detected entity location information.",
+ "type": "object",
+ "properties": {
+ "latLng": {
+ "description": "lat/long location coordinates.",
+ "$ref": "LatLng"
+ }
+ },
+ "id": "LocationInfo"
+ },
+ "Property": {
+ "description": "A `Property` consists of a user-supplied name/value pair.",
+ "type": "object",
+ "properties": {
+ "value": {
+ "type": "string",
+ "description": "Value of the property."
+ },
+ "uint64Value": {
+ "type": "string",
+ "description": "Value of numeric properties.",
+ "format": "uint64"
+ },
+ "name": {
+ "description": "Name of the property.",
+ "type": "string"
+ }
+ },
+ "id": "Property"
},
"Position": {
"description": "A 3D position in the image, used primarily for Face detection landmarks.\nA valid Position must have both x and y coordinates.\nThe position coordinates are in the same scale as the original image.",
"type": "object",
"properties": {
- "y": {
- "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": {
+ "description": "Y coordinate.",
+ "format": "float",
+ "type": "number"
}
},
"id": "Position"
@@ -639,8 +485,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].",
@@ -654,14 +500,14 @@
"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"
+ },
+ "url": {
+ "description": "The result web page URL.",
+ "type": "string"
}
},
"id": "WebPage"
@@ -670,6 +516,11 @@
"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",
@@ -682,9 +533,9 @@
"type": "string"
},
"confidence": {
+ "type": "number",
"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].",
- "format": "float",
- "type": "number"
+ "format": "float"
},
"locale": {
"description": "The language code for the locale in which the entity textual\n`description` is expressed.",
@@ -709,17 +560,11 @@
"items": {
"$ref": "Property"
}
- },
- "score": {
- "description": "Overall score of the result. Range [0, 1].",
- "format": "float",
- "type": "number"
}
},
"id": "EntityAnnotation"
},
"CropHint": {
- "description": "Single crop hint that is used to generate a new crop when serving an image.",
"type": "object",
"properties": {
"confidence": {
@@ -737,12 +582,17 @@
"description": "The bounding polygon for the crop region. The coordinates of the bounding\nbox are in the original image's scale, as returned in `ImageParams`."
}
},
- "id": "CropHint"
+ "id": "CropHint",
+ "description": "Single crop hint that is used to generate a new crop when serving an image."
},
"Landmark": {
"description": "A face-specific landmark (for example, a face feature).",
"type": "object",
"properties": {
+ "position": {
+ "description": "Face landmark position.",
+ "$ref": "Position"
+ },
"type": {
"enumDescriptions": [
"Unknown face landmark detected. Should not be filled.",
@@ -820,10 +670,6 @@
],
"description": "Face landmark type.",
"type": "string"
- },
- "position": {
- "$ref": "Position",
- "description": "Face landmark position."
}
},
"id": "Landmark"
@@ -832,39 +678,39 @@
"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": {
- "description": "The result image URL.",
- "type": "string"
}
},
"id": "WebImage"
},
"Word": {
+ "id": "Word",
"description": "A word representation.",
"type": "object",
"properties": {
- "property": {
- "description": "Additional information detected for the word.",
- "$ref": "TextProperty"
- },
- "boundingBox": {
- "description": "The bounding box for the word.\nThe vertices are in the order of top-left, top-right, bottom-right,\nbottom-left. When a rotation of the bounding box is detected the rotation\nis represented as around the top-left corner as defined when the text is\nread in the 'natural' orientation.\nFor example:\n * when the text is horizontal it might look like:\n 0----1\n | |\n 3----2\n * when it's rotated 180 degrees around the top-left corner it becomes:\n 2----3\n | |\n 1----0\n and the vertice order will still be (0, 1, 2, 3).",
- "$ref": "BoundingPoly"
- },
"symbols": {
"description": "List of symbols in the word.\nThe order of the symbols follows the natural reading order.",
"type": "array",
"items": {
"$ref": "Symbol"
}
+ },
+ "property": {
+ "$ref": "TextProperty",
+ "description": "Additional information detected for the word."
+ },
+ "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)."
}
- },
- "id": "Word"
+ }
},
"Image": {
"description": "Client image to perform Google Cloud Vision API tasks over.",
@@ -876,23 +722,21 @@
"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": "ImageSource"
+ "$ref": "ImageSource",
+ "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": "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"
+ "$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.",
@@ -902,12 +746,109 @@
}
}
},
- "id": "Paragraph"
+ "id": "Paragraph",
+ "description": "Structural unit of text representing a number of words in certain order.",
+ "type": "object"
},
"FaceAnnotation": {
"description": "A face annotation object contains the results of face detection.",
"type": "object",
"properties": {
+ "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."
+ ]
+ },
+ "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",
+ "UNLIKELY",
+ "POSSIBLE",
+ "LIKELY",
+ "VERY_LIKELY"
+ ],
+ "description": "Under-exposed likelihood.",
+ "type": "string"
+ },
+ "panAngle": {
+ "description": "Yaw angle, which indicates the leftward/rightward angle that the face is\npointing relative to the vertical plane perpendicular to the image. Range\n[-180,180].",
+ "format": "float",
+ "type": "number"
+ },
+ "detectionConfidence": {
+ "description": "Detection confidence. Range [0, 1].",
+ "format": "float",
+ "type": "number"
+ },
+ "blurredLikelihood": {
+ "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": {
"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"
@@ -943,10 +884,12 @@
"type": "number"
},
"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"
+ "$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": {
+ "description": "Anger likelihood.",
+ "type": "string",
"enumDescriptions": [
"Unknown likelihood.",
"It is very unlikely that the image belongs to the specified vertical.",
@@ -962,9 +905,7 @@
"POSSIBLE",
"LIKELY",
"VERY_LIKELY"
- ],
- "description": "Anger likelihood.",
- "type": "string"
+ ]
},
"landmarks": {
"description": "Detected face landmarks.",
@@ -974,6 +915,14 @@
}
},
"surpriseLikelihood": {
+ "enum": [
+ "UNKNOWN",
+ "VERY_UNLIKELY",
+ "UNLIKELY",
+ "POSSIBLE",
+ "LIKELY",
+ "VERY_LIKELY"
+ ],
"description": "Surprise likelihood.",
"type": "string",
"enumDescriptions": [
@@ -983,109 +932,6 @@
"It is possible that the image belongs to the specified vertical.",
"It is likely that the image belongs to the specified vertical.",
"It is very likely that the image belongs to the specified vertical."
- ],
- "enum": [
- "UNKNOWN",
- "VERY_UNLIKELY",
- "UNLIKELY",
- "POSSIBLE",
- "LIKELY",
- "VERY_LIKELY"
- ]
- },
- "landmarkingConfidence": {
- "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"
- },
- "underExposedLikelihood": {
- "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."
- ],
- "enum": [
- "UNKNOWN",
- "VERY_UNLIKELY",
- "UNLIKELY",
- "POSSIBLE",
- "LIKELY",
- "VERY_LIKELY"
- ]
- },
- "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": {
- "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.",
- "type": "string"
- },
- "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."
]
}
},
@@ -1109,13 +955,7 @@
"description": "Detected start or end of a structural component.",
"type": "object",
"properties": {
- "isPrefix": {
- "description": "True if break prepends the element.",
- "type": "boolean"
- },
"type": {
- "description": "Detected break type.",
- "type": "string",
"enumDescriptions": [
"Unknown break label type.",
"Regular space.",
@@ -1131,41 +971,47 @@
"EOL_SURE_SPACE",
"HYPHEN",
"LINE_BREAK"
- ]
+ ],
+ "description": "Detected break type.",
+ "type": "string"
+ },
+ "isPrefix": {
+ "description": "True if break prepends the element.",
+ "type": "boolean"
}
},
"id": "DetectedBreak"
},
"ImageContext": {
- "description": "Image context and/or feature-specific parameters.",
"type": "object",
"properties": {
- "latLongRect": {
- "$ref": "LatLongRect",
- "description": "lat/long rectangle that specifies the location of the image."
- },
- "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"
}
+ },
+ "latLongRect": {
+ "$ref": "LatLongRect",
+ "description": "lat/long rectangle that specifies the location of the image."
+ },
+ "cropHintsParams": {
+ "description": "Parameters for crop hints annotation request.",
+ "$ref": "CropHintsParams"
}
},
- "id": "ImageContext"
+ "id": "ImageContext",
+ "description": "Image context and/or feature-specific parameters."
},
"Page": {
"description": "Detected page from OCR.",
"type": "object",
"properties": {
"width": {
+ "type": "integer",
"description": "Page width in pixels.",
- "format": "int32",
- "type": "integer"
+ "format": "int32"
},
"blocks": {
"description": "List of blocks of text, images etc on this page.",
@@ -1190,13 +1036,9 @@
"description": "Request for performing Google Cloud Vision API tasks over a user-provided\nimage, with user-requested features.",
"type": "object",
"properties": {
- "imageContext": {
- "description": "Additional context that may accompany the image.",
- "$ref": "ImageContext"
- },
"image": {
- "description": "The image to be processed.",
- "$ref": "Image"
+ "$ref": "Image",
+ "description": "The image to be processed."
},
"features": {
"description": "Requested features.",
@@ -1204,36 +1046,55 @@
"items": {
"$ref": "Feature"
}
+ },
+ "imageContext": {
+ "description": "Additional context that may accompany the image.",
+ "$ref": "ImageContext"
}
},
"id": "AnnotateImageRequest"
},
"Status": {
- "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
"type": "object",
"properties": {
"details": {
"description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.",
"type": "array",
"items": {
+ "type": "object",
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
- },
- "type": "object"
+ }
}
},
"code": {
+ "type": "integer",
"description": "The status code, which should be an enum value of google.rpc.Code.",
- "format": "int32",
- "type": "integer"
+ "format": "int32"
},
"message": {
"description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
"type": "string"
}
},
- "id": "Status"
+ "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": {
+ "id": "LatLongRect",
+ "description": "Rectangle determined by min and max `LatLng` pairs.",
+ "type": "object",
+ "properties": {
+ "minLatLng": {
+ "description": "Min lat/long pair.",
+ "$ref": "LatLng"
+ },
+ "maxLatLng": {
+ "$ref": "LatLng",
+ "description": "Max lat/long pair."
+ }
+ }
},
"Symbol": {
"properties": {
@@ -1246,31 +1107,15 @@
"description": "Additional information detected for the symbol."
},
"boundingBox": {
- "description": "The bounding box for the symbol.\nThe vertices are in the order of top-left, top-right, bottom-right,\nbottom-left. When a rotation of the bounding box is detected the rotation\nis represented as around the top-left corner as defined when the text is\nread in the 'natural' orientation.\nFor example:\n * when the text is horizontal it might look like:\n 0----1\n | |\n 3----2\n * when it's rotated 180 degrees around the top-left corner it becomes:\n 2----3\n | |\n 1----0\n and the vertice order will still be (0, 1, 2, 3).",
- "$ref": "BoundingPoly"
+ "$ref": "BoundingPoly",
+ "description": "The bounding box for the symbol.\nThe vertices are in the order of top-left, top-right, bottom-right,\nbottom-left. When a rotation of the bounding box is detected the rotation\nis represented as around the top-left corner as defined when the text is\nread in the 'natural' orientation.\nFor example:\n * when the text is horizontal it might look like:\n 0----1\n | |\n 3----2\n * when it's rotated 180 degrees around the top-left corner it becomes:\n 2----3\n | |\n 1----0\n and the vertice order will still be (0, 1, 2, 3)."
}
},
"id": "Symbol",
"description": "A single symbol representation.",
"type": "object"
},
- "LatLongRect": {
- "properties": {
- "minLatLng": {
- "$ref": "LatLng",
- "description": "Min lat/long pair."
- },
- "maxLatLng": {
- "$ref": "LatLng",
- "description": "Max lat/long pair."
- }
- },
- "id": "LatLongRect",
- "description": "Rectangle determined by min and max `LatLng` pairs.",
- "type": "object"
- },
"CropHintsAnnotation": {
- "description": "Set of crop hints that are used to generate new crops when serving images.",
"type": "object",
"properties": {
"cropHints": {
@@ -1281,11 +1126,10 @@
}
}
},
- "id": "CropHintsAnnotation"
+ "id": "CropHintsAnnotation",
+ "description": "Set of crop hints that are used to generate new crops when serving images."
},
"LatLng": {
- "description": "An object representing a latitude/longitude pair. This is expressed as a pair\nof doubles representing degrees latitude and degrees longitude. Unless\nspecified otherwise, this must conform to the\n\u003ca href=\"http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf\"\u003eWGS84\nstandard\u003c/a\u003e. Values must be within normalized ranges.",
- "type": "object",
"properties": {
"latitude": {
"description": "The latitude in degrees. It must be in the range [-90.0, +90.0].",
@@ -1298,7 +1142,9 @@
"type": "number"
}
},
- "id": "LatLng"
+ "id": "LatLng",
+ "description": "An object representing a latitude/longitude pair. This is expressed as a pair\nof doubles representing degrees latitude and degrees longitude. Unless\nspecified otherwise, this must conform to the\n\u003ca href=\"http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf\"\u003eWGS84\nstandard\u003c/a\u003e. Values must be within normalized ranges.",
+ "type": "object"
},
"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 // ...",
@@ -1326,22 +1172,176 @@
}
},
"id": "Color"
+ },
+ "ImageProperties": {
+ "id": "ImageProperties",
+ "description": "Stores image properties, such as dominant colors.",
+ "type": "object",
+ "properties": {
+ "dominantColors": {
+ "$ref": "DominantColorsAnnotation",
+ "description": "If present, dominant colors completed successfully."
+ }
+ }
+ },
+ "Feature": {
+ "properties": {
+ "type": {
+ "description": "The feature type.",
+ "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."
+ ],
+ "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": {
+ "description": "Maximum number of results of this type.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "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"
+ },
+ "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": {
+ "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",
+ "UNLIKELY",
+ "POSSIBLE",
+ "LIKELY",
+ "VERY_LIKELY"
+ ],
+ "description": "Likelihood that this is a medical image.",
+ "type": "string"
+ },
+ "violence": {
+ "enumDescriptions": [
+ "Unknown likelihood.",
+ "It is very unlikely that the image belongs to the specified vertical.",
+ "It is unlikely that the image belongs to the specified vertical.",
+ "It is possible that the image belongs to the specified vertical.",
+ "It is likely that the image belongs to the specified vertical.",
+ "It is very likely that the image belongs to the specified vertical."
+ ],
+ "enum": [
+ "UNKNOWN",
+ "VERY_UNLIKELY",
+ "UNLIKELY",
+ "POSSIBLE",
+ "LIKELY",
+ "VERY_LIKELY"
+ ],
+ "description": "Likelihood that this image contains violent content.",
+ "type": "string"
+ },
+ "adult": {
+ "enumDescriptions": [
+ "Unknown likelihood.",
+ "It is very unlikely that the image belongs to the specified vertical.",
+ "It is unlikely that the image belongs to the specified vertical.",
+ "It is possible that the image belongs to the specified vertical.",
+ "It is likely that the image belongs to the specified vertical.",
+ "It is very likely that the image belongs to the specified vertical."
+ ],
+ "enum": [
+ "UNKNOWN",
+ "VERY_UNLIKELY",
+ "UNLIKELY",
+ "POSSIBLE",
+ "LIKELY",
+ "VERY_LIKELY"
+ ],
+ "description": "Represents the adult content likelihood for the image. Adult content may\ncontain elements such as nudity, pornographic images or cartoons, or\nsexual activities.",
+ "type": "string"
+ },
+ "spoof": {
+ "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": "Spoof likelihood. The likelihood that an modification\nwas made to the image's canonical version to make it appear\nfunny or offensive."
+ }
+ }
+ },
+ "DominantColorsAnnotation": {
+ "properties": {
+ "colors": {
+ "description": "RGB color values with their score and pixel fraction.",
+ "type": "array",
+ "items": {
+ "$ref": "ColorInfo"
+ }
+ }
+ },
+ "id": "DominantColorsAnnotation",
+ "description": "Set of dominant colors and their corresponding scores.",
+ "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": "Vision",
"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"
}
}
}
diff --git a/vision/v1p1beta1/vision-api.json b/vision/v1p1beta1/vision-api.json
index 03d9ecc..9eef53c 100644
--- a/vision/v1p1beta1/vision-api.json
+++ b/vision/v1p1beta1/vision-api.json
@@ -1,4 +1,123 @@
{
+ "ownerName": "Google",
+ "resources": {
+ "images": {
+ "methods": {
+ "annotate": {
+ "response": {
+ "$ref": "GoogleCloudVisionV1p1beta1BatchAnnotateImagesResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-vision"
+ ],
+ "parameters": {},
+ "flatPath": "v1p1beta1/images:annotate",
+ "path": "v1p1beta1/images:annotate",
+ "id": "vision.images.annotate",
+ "description": "Run image detection and annotation for a batch of images.",
+ "request": {
+ "$ref": "GoogleCloudVisionV1p1beta1BatchAnnotateImagesRequest"
+ }
+ }
+ }
+ }
+ },
+ "parameters": {
+ "quotaUser": {
+ "location": "query",
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "type": "string"
+ },
+ "pp": {
+ "location": "query",
+ "description": "Pretty-print response.",
+ "type": "boolean",
+ "default": "true"
+ },
+ "bearer_token": {
+ "location": "query",
+ "description": "OAuth bearer token.",
+ "type": "string"
+ },
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string",
+ "location": "query"
+ },
+ "upload_protocol": {
+ "location": "query",
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "type": "string"
+ },
+ "prettyPrint": {
+ "location": "query",
+ "description": "Returns response with indentations and line breaks.",
+ "type": "boolean",
+ "default": "true"
+ },
+ "fields": {
+ "location": "query",
+ "description": "Selector specifying which fields to include in a partial response.",
+ "type": "string"
+ },
+ "uploadType": {
+ "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": {
+ "location": "query",
+ "description": "OAuth access token.",
+ "type": "string"
+ },
+ "key": {
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "version": "v1p1beta1",
+ "baseUrl": "https://vision.googleapis.com/",
+ "servicePath": "",
+ "description": "Integrates Google Vision features, including image labeling, face, logo, and landmark detection, optical character recognition (OCR), and detection of explicit content, into applications.",
+ "kind": "discovery#restDescription",
"basePath": "",
"id": "vision:v1p1beta1",
"documentationLink": "https://cloud.google.com/vision/",
@@ -6,10 +125,28 @@
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
+ "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"
+ }
+ }
+ },
+ "id": "GoogleCloudVisionV1p1beta1CropHintsAnnotation"
+ },
"GoogleCloudVisionV1p1beta1Property": {
"description": "A `Property` consists of a user-supplied name/value pair.",
"type": "object",
"properties": {
+ "value": {
+ "description": "Value of the property.",
+ "type": "string"
+ },
"uint64Value": {
"description": "Value of numeric properties.",
"format": "uint64",
@@ -18,10 +155,6 @@
"name": {
"description": "Name of the property.",
"type": "string"
- },
- "value": {
- "description": "Value of the property.",
- "type": "string"
}
},
"id": "GoogleCloudVisionV1p1beta1Property"
@@ -53,24 +186,22 @@
"type": "object"
},
"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": {
- "description": "The result image URL.",
- "type": "string"
}
},
- "id": "GoogleCloudVisionV1p1beta1WebDetectionWebImage"
+ "id": "GoogleCloudVisionV1p1beta1WebDetectionWebImage",
+ "description": "Metadata for online images.",
+ "type": "object"
},
"GoogleCloudVisionV1p1beta1BatchAnnotateImagesResponse": {
- "description": "Response to a batch image annotation request.",
- "type": "object",
"properties": {
"responses": {
"description": "Individual responses to image annotation requests within the batch.",
@@ -80,10 +211,11 @@
}
}
},
- "id": "GoogleCloudVisionV1p1beta1BatchAnnotateImagesResponse"
+ "id": "GoogleCloudVisionV1p1beta1BatchAnnotateImagesResponse",
+ "description": "Response to a batch image annotation request.",
+ "type": "object"
},
"GoogleCloudVisionV1p1beta1WebDetectionWebLabel": {
- "type": "object",
"properties": {
"label": {
"description": "Label for extra metadata.",
@@ -95,11 +227,10 @@
}
},
"id": "GoogleCloudVisionV1p1beta1WebDetectionWebLabel",
- "description": "Label to provide extra metadata for the web detection."
+ "description": "Label to provide extra metadata for the web detection.",
+ "type": "object"
},
"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.",
@@ -111,68 +242,65 @@
"type": "number"
}
},
- "id": "GoogleCloudVisionV1p1beta1TextAnnotationDetectedLanguage"
+ "id": "GoogleCloudVisionV1p1beta1TextAnnotationDetectedLanguage",
+ "description": "Detected language for a structural component.",
+ "type": "object"
},
"GoogleCloudVisionV1p1beta1Symbol": {
- "description": "A single symbol representation.",
- "type": "object",
"properties": {
- "text": {
- "description": "The actual UTF-8 representation of the symbol.",
- "type": "string"
- },
- "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)."
+ "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"
+ },
+ "property": {
+ "description": "Additional information detected for the symbol.",
+ "$ref": "GoogleCloudVisionV1p1beta1TextAnnotationTextProperty"
}
},
- "id": "GoogleCloudVisionV1p1beta1Symbol"
- },
- "GoogleCloudVisionV1p1beta1ImageProperties": {
- "properties": {
- "dominantColors": {
- "$ref": "GoogleCloudVisionV1p1beta1DominantColorsAnnotation",
- "description": "If present, dominant colors completed successfully."
- }
- },
- "id": "GoogleCloudVisionV1p1beta1ImageProperties",
- "description": "Stores image properties, such as dominant colors.",
+ "id": "GoogleCloudVisionV1p1beta1Symbol",
+ "description": "A single symbol representation.",
"type": "object"
},
- "GoogleCloudVisionV1p1beta1Image": {
- "description": "Client image to perform Google Cloud Vision API tasks over.",
+ "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": {
+ "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": {
- "$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."
+ "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"
+ "id": "GoogleCloudVisionV1p1beta1Image",
+ "description": "Client image to perform Google Cloud Vision API tasks over.",
+ "type": "object"
},
"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": {
- "score": {
- "description": "Image-specific score for this color. Value in range [0, 1].",
- "format": "float",
- "type": "number"
- },
"pixelFraction": {
"description": "The fraction of pixels the color occupies in the image.\nValue in range [0, 1].",
"format": "float",
@@ -181,12 +309,16 @@
"color": {
"$ref": "Color",
"description": "RGB components of the color."
+ },
+ "score": {
+ "description": "Image-specific score for this color. Value in range [0, 1].",
+ "format": "float",
+ "type": "number"
}
},
"id": "GoogleCloudVisionV1p1beta1ColorInfo"
},
"GoogleCloudVisionV1p1beta1WebDetectionWebEntity": {
- "type": "object",
"properties": {
"entityId": {
"description": "Opaque entity ID.",
@@ -203,18 +335,16 @@
}
},
"id": "GoogleCloudVisionV1p1beta1WebDetectionWebEntity",
- "description": "Entity deduced from similar images on the Internet."
+ "description": "Entity deduced from similar images on the Internet.",
+ "type": "object"
},
"GoogleCloudVisionV1p1beta1FaceAnnotationLandmark": {
- "description": "A face-specific landmark (for example, a face feature).",
- "type": "object",
"properties": {
"position": {
- "description": "Face landmark position.",
- "$ref": "GoogleCloudVisionV1p1beta1Position"
+ "$ref": "GoogleCloudVisionV1p1beta1Position",
+ "description": "Face landmark position."
},
"type": {
- "type": "string",
"enumDescriptions": [
"Unknown face landmark detected. Should not be filled.",
"Left eye.",
@@ -289,15 +419,30 @@
"CHIN_LEFT_GONION",
"CHIN_RIGHT_GONION"
],
- "description": "Face landmark type."
+ "description": "Face landmark type.",
+ "type": "string"
}
},
- "id": "GoogleCloudVisionV1p1beta1FaceAnnotationLandmark"
+ "id": "GoogleCloudVisionV1p1beta1FaceAnnotationLandmark",
+ "description": "A face-specific landmark (for example, a face feature).",
+ "type": "object"
},
"GoogleCloudVisionV1p1beta1WebDetection": {
- "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": "GoogleCloudVisionV1p1beta1WebDetectionWebImage"
+ }
+ },
+ "visuallySimilarImages": {
+ "description": "The visually similar image results.",
+ "type": "array",
+ "items": {
+ "$ref": "GoogleCloudVisionV1p1beta1WebDetectionWebImage"
+ }
+ },
"bestGuessLabels": {
"description": "Best guess text labels for the request image.",
"type": "array",
@@ -320,31 +465,18 @@
}
},
"pagesWithMatchingImages": {
+ "description": "Web pages containing the matching images from the Internet.",
"type": "array",
"items": {
"$ref": "GoogleCloudVisionV1p1beta1WebDetectionWebPage"
- },
- "description": "Web pages containing the matching images from the Internet."
- },
- "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"
- }
- },
- "visuallySimilarImages": {
- "description": "The visually similar image results.",
- "type": "array",
- "items": {
- "$ref": "GoogleCloudVisionV1p1beta1WebDetectionWebImage"
}
}
},
- "id": "GoogleCloudVisionV1p1beta1WebDetection"
+ "id": "GoogleCloudVisionV1p1beta1WebDetection",
+ "description": "Relevant information for the image from the Internet.",
+ "type": "object"
},
"GoogleCloudVisionV1p1beta1AnnotateImageResponse": {
- "id": "GoogleCloudVisionV1p1beta1AnnotateImageResponse",
"description": "Response to an image annotation request.",
"type": "object",
"properties": {
@@ -356,11 +488,11 @@
}
},
"textAnnotations": {
+ "description": "If present, text (OCR) detection has completed successfully.",
"type": "array",
"items": {
"$ref": "GoogleCloudVisionV1p1beta1EntityAnnotation"
- },
- "description": "If present, text (OCR) detection has completed successfully."
+ }
},
"imagePropertiesAnnotation": {
"description": "If present, image properties were extracted successfully.",
@@ -396,31 +528,134 @@
}
},
"safeSearchAnnotation": {
- "$ref": "GoogleCloudVisionV1p1beta1SafeSearchAnnotation",
- "description": "If present, safe-search annotation has completed successfully."
+ "description": "If present, safe-search annotation has completed successfully.",
+ "$ref": "GoogleCloudVisionV1p1beta1SafeSearchAnnotation"
},
"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."
+ "description": "If set, represents the error message for the operation.\nNote that filled-in image annotations are guaranteed to be\ncorrect, even when `error` is set.",
+ "$ref": "Status"
},
"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"
+ },
+ "GoogleCloudVisionV1p1beta1SafeSearchAnnotation": {
+ "properties": {
+ "spoof": {
+ "enum": [
+ "UNKNOWN",
+ "VERY_UNLIKELY",
+ "UNLIKELY",
+ "POSSIBLE",
+ "LIKELY",
+ "VERY_LIKELY"
+ ],
+ "description": "Spoof likelihood. The likelihood that an modification\nwas made to the image's canonical version to make it appear\nfunny or offensive.",
+ "type": "string",
+ "enumDescriptions": [
+ "Unknown likelihood.",
+ "It is very unlikely that the image belongs to the specified vertical.",
+ "It is unlikely that the image belongs to the specified vertical.",
+ "It is possible that the image belongs to the specified vertical.",
+ "It is likely that the image belongs to the specified vertical.",
+ "It is very likely that the image belongs to the specified vertical."
+ ]
+ },
+ "medical": {
+ "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 is a medical image.",
+ "type": "string"
+ },
+ "racy": {
+ "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",
+ "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": {
+ "enumDescriptions": [
+ "Unknown likelihood.",
+ "It is very unlikely that the image belongs to the specified vertical.",
+ "It is unlikely that the image belongs to the specified vertical.",
+ "It is possible that the image belongs to the specified vertical.",
+ "It is likely that the image belongs to the specified vertical.",
+ "It is very likely that the image belongs to the specified vertical."
+ ],
+ "enum": [
+ "UNKNOWN",
+ "VERY_UNLIKELY",
+ "UNLIKELY",
+ "POSSIBLE",
+ "LIKELY",
+ "VERY_LIKELY"
+ ],
+ "description": "Likelihood that this image contains violent content.",
+ "type": "string"
+ },
+ "adult": {
+ "enum": [
+ "UNKNOWN",
+ "VERY_UNLIKELY",
+ "UNLIKELY",
+ "POSSIBLE",
+ "LIKELY",
+ "VERY_LIKELY"
+ ],
+ "description": "Represents the adult content likelihood for the image. Adult content may\ncontain elements such as nudity, pornographic images or cartoons, or\nsexual activities.",
+ "type": "string",
+ "enumDescriptions": [
+ "Unknown likelihood.",
+ "It is very unlikely that the image belongs to the specified vertical.",
+ "It is unlikely that the image belongs to the specified vertical.",
+ "It is possible that the image belongs to the specified vertical.",
+ "It is likely that the image belongs to the specified vertical.",
+ "It is very likely that the image belongs to the specified vertical."
+ ]
+ }
+ },
+ "id": "GoogleCloudVisionV1p1beta1SafeSearchAnnotation",
+ "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"
},
"GoogleCloudVisionV1p1beta1FaceAnnotation": {
"description": "A face annotation object contains the results of face detection.",
"type": "object",
"properties": {
- "tiltAngle": {
- "description": "Pitch angle, which indicates the upwards/downwards angle that the face is\npointing relative to the image's horizontal plane. Range [-180,180].",
- "format": "float",
- "type": "number"
- },
"fdBoundingPoly": {
- "$ref": "GoogleCloudVisionV1p1beta1BoundingPoly",
- "description": "The `fd_bounding_poly` bounding polygon is tighter than the\n`boundingPoly`, and encloses only the skin part of the face. Typically, it\nis used to eliminate the face from any image analysis that detects the\n\"amount of skin\" visible in an image. It is not based on the\nlandmarker results, only on the initial face detection, hence\nthe \u003ccode\u003efd\u003c/code\u003e (face detection) prefix."
+ "description": "The `fd_bounding_poly` bounding polygon is tighter than the\n`boundingPoly`, and encloses only the skin part of the face. Typically, it\nis used to eliminate the face from any image analysis that detects the\n\"amount of skin\" visible in an image. It is not based on the\nlandmarker results, only on the initial face detection, hence\nthe \u003ccode\u003efd\u003c/code\u003e (face detection) prefix.",
+ "$ref": "GoogleCloudVisionV1p1beta1BoundingPoly"
},
"angerLikelihood": {
"enum": [
@@ -450,14 +685,6 @@
}
},
"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",
@@ -467,23 +694,6 @@
"VERY_LIKELY"
],
"description": "Surprise likelihood.",
- "type": "string"
- },
- "landmarkingConfidence": {
- "type": "number",
- "description": "Face landmarking confidence. Range [0, 1].",
- "format": "float"
- },
- "joyLikelihood": {
- "enum": [
- "UNKNOWN",
- "VERY_UNLIKELY",
- "UNLIKELY",
- "POSSIBLE",
- "LIKELY",
- "VERY_LIKELY"
- ],
- "description": "Joy likelihood.",
"type": "string",
"enumDescriptions": [
"Unknown likelihood.",
@@ -494,8 +704,12 @@
"It is very likely that the image belongs to the specified vertical."
]
},
- "underExposedLikelihood": {
- "type": "string",
+ "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.",
@@ -512,19 +726,20 @@
"LIKELY",
"VERY_LIKELY"
],
- "description": "Under-exposed likelihood."
+ "description": "Joy likelihood.",
+ "type": "string"
},
- "panAngle": {
- "description": "Yaw angle, which indicates the leftward/rightward angle that the face is\npointing relative to the vertical plane perpendicular to the image. Range\n[-180,180].",
- "format": "float",
- "type": "number"
- },
- "detectionConfidence": {
- "type": "number",
- "description": "Detection confidence. Range [0, 1].",
- "format": "float"
- },
- "blurredLikelihood": {
+ "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.",
@@ -532,7 +747,19 @@
"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",
@@ -542,7 +769,15 @@
"VERY_LIKELY"
],
"description": "Blurred likelihood.",
- "type": "string"
+ "type": "string",
+ "enumDescriptions": [
+ "Unknown likelihood.",
+ "It is very unlikely that the image belongs to the specified vertical.",
+ "It is unlikely that the image belongs to the specified vertical.",
+ "It is possible that the image belongs to the specified vertical.",
+ "It is likely that the image belongs to the specified vertical.",
+ "It is very likely that the image belongs to the specified vertical."
+ ]
},
"headwearLikelihood": {
"enumDescriptions": [
@@ -574,14 +809,6 @@
"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",
@@ -591,123 +818,41 @@
"VERY_LIKELY"
],
"description": "Sorrow likelihood.",
- "type": "string"
+ "type": "string",
+ "enumDescriptions": [
+ "Unknown likelihood.",
+ "It is very unlikely that the image belongs to the specified vertical.",
+ "It is unlikely that the image belongs to the specified vertical.",
+ "It is possible that the image belongs to the specified vertical.",
+ "It is likely that the image belongs to the specified vertical.",
+ "It is very likely that the image belongs to the specified vertical."
+ ]
+ },
+ "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"
},
- "GoogleCloudVisionV1p1beta1SafeSearchAnnotation": {
- "description": "Set of features pertaining to the image, computed by computer vision\nmethods over safe-search verticals (for example, adult, spoof, medical,\nviolence).",
- "type": "object",
- "properties": {
- "adult": {
- "enum": [
- "UNKNOWN",
- "VERY_UNLIKELY",
- "UNLIKELY",
- "POSSIBLE",
- "LIKELY",
- "VERY_LIKELY"
- ],
- "description": "Represents the adult content likelihood for the image. Adult content may\ncontain elements such as nudity, pornographic images or cartoons, or\nsexual activities.",
- "type": "string",
- "enumDescriptions": [
- "Unknown likelihood.",
- "It is very unlikely that the image belongs to the specified vertical.",
- "It is unlikely that the image belongs to the specified vertical.",
- "It is possible that the image belongs to the specified vertical.",
- "It is likely that the image belongs to the specified vertical.",
- "It is very likely that the image belongs to the specified vertical."
- ]
- },
- "spoof": {
- "enum": [
- "UNKNOWN",
- "VERY_UNLIKELY",
- "UNLIKELY",
- "POSSIBLE",
- "LIKELY",
- "VERY_LIKELY"
- ],
- "description": "Spoof likelihood. The likelihood that an modification\nwas made to the image's canonical version to make it appear\nfunny or offensive.",
- "type": "string",
- "enumDescriptions": [
- "Unknown likelihood.",
- "It is very unlikely that the image belongs to the specified vertical.",
- "It is unlikely that the image belongs to the specified vertical.",
- "It is possible that the image belongs to the specified vertical.",
- "It is likely that the image belongs to the specified vertical.",
- "It is very likely that the image belongs to the specified vertical."
- ]
- },
- "medical": {
- "enum": [
- "UNKNOWN",
- "VERY_UNLIKELY",
- "UNLIKELY",
- "POSSIBLE",
- "LIKELY",
- "VERY_LIKELY"
- ],
- "description": "Likelihood that this is a medical image.",
- "type": "string",
- "enumDescriptions": [
- "Unknown likelihood.",
- "It is very unlikely that the image belongs to the specified vertical.",
- "It is unlikely that the image belongs to the specified vertical.",
- "It is possible that the image belongs to the specified vertical.",
- "It is likely that the image belongs to the specified vertical.",
- "It is very likely that the image belongs to the specified vertical."
- ]
- },
- "racy": {
- "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",
- "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": {
- "enum": [
- "UNKNOWN",
- "VERY_UNLIKELY",
- "UNLIKELY",
- "POSSIBLE",
- "LIKELY",
- "VERY_LIKELY"
- ],
- "description": "Likelihood that this image contains violent content.",
- "type": "string",
- "enumDescriptions": [
- "Unknown likelihood.",
- "It is very unlikely that the image belongs to the specified vertical.",
- "It is unlikely that the image belongs to the specified vertical.",
- "It is possible that the image belongs to the specified vertical.",
- "It is likely that the image belongs to the specified vertical.",
- "It is very likely that the image belongs to the specified vertical."
- ]
- }
- },
- "id": "GoogleCloudVisionV1p1beta1SafeSearchAnnotation"
- },
"GoogleCloudVisionV1p1beta1TextAnnotationDetectedBreak": {
"description": "Detected start or end of a structural component.",
"type": "object",
"properties": {
+ "isPrefix": {
+ "description": "True if break prepends the element.",
+ "type": "boolean"
+ },
"type": {
+ "enum": [
+ "UNKNOWN",
+ "SPACE",
+ "SURE_SPACE",
+ "EOL_SURE_SPACE",
+ "HYPHEN",
+ "LINE_BREAK"
+ ],
"description": "Detected break type.",
"type": "string",
"enumDescriptions": [
@@ -717,29 +862,16 @@
"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"
]
- },
- "isPrefix": {
- "description": "True if break prepends the element.",
- "type": "boolean"
}
},
"id": "GoogleCloudVisionV1p1beta1TextAnnotationDetectedBreak"
},
"GoogleCloudVisionV1p1beta1AnnotateImageRequest": {
- "type": "object",
"properties": {
"imageContext": {
- "$ref": "GoogleCloudVisionV1p1beta1ImageContext",
- "description": "Additional context that may accompany the image."
+ "description": "Additional context that may accompany the image.",
+ "$ref": "GoogleCloudVisionV1p1beta1ImageContext"
},
"image": {
"$ref": "GoogleCloudVisionV1p1beta1Image",
@@ -754,25 +886,16 @@
}
},
"id": "GoogleCloudVisionV1p1beta1AnnotateImageRequest",
- "description": "Request for performing Google Cloud Vision API tasks over a user-provided\nimage, with user-requested features."
+ "description": "Request for performing Google Cloud Vision API tasks over a user-provided\nimage, with user-requested features.",
+ "type": "object"
},
"GoogleCloudVisionV1p1beta1Block": {
- "description": "Logical element on the page.",
- "type": "object",
"properties": {
"property": {
"$ref": "GoogleCloudVisionV1p1beta1TextAnnotationTextProperty",
"description": "Additional information detected for the block."
},
"blockType": {
- "enumDescriptions": [
- "Unknown block type.",
- "Regular text block.",
- "Table block.",
- "Image block.",
- "Horizontal/vertical line box.",
- "Barcode block."
- ],
"enum": [
"UNKNOWN",
"TEXT",
@@ -782,7 +905,15 @@
"BARCODE"
],
"description": "Detected block type (text, image etc) for this block.",
- "type": "string"
+ "type": "string",
+ "enumDescriptions": [
+ "Unknown block type.",
+ "Regular text block.",
+ "Table block.",
+ "Image block.",
+ "Horizontal/vertical line box.",
+ "Barcode block."
+ ]
},
"boundingBox": {
"description": "The bounding box for the block.\nThe vertices are in the order of top-left, top-right, bottom-right,\nbottom-left. When a rotation of the bounding box is detected the rotation\nis represented as around the top-left corner as defined when the text is\nread in the 'natural' orientation.\nFor example:\n * 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).",
@@ -801,7 +932,9 @@
}
}
},
- "id": "GoogleCloudVisionV1p1beta1Block"
+ "id": "GoogleCloudVisionV1p1beta1Block",
+ "description": "Logical element on the page.",
+ "type": "object"
},
"GoogleCloudVisionV1p1beta1Page": {
"properties": {
@@ -828,8 +961,8 @@
}
},
"property": {
- "$ref": "GoogleCloudVisionV1p1beta1TextAnnotationTextProperty",
- "description": "Additional information detected on the page."
+ "description": "Additional information detected on the page.",
+ "$ref": "GoogleCloudVisionV1p1beta1TextAnnotationTextProperty"
}
},
"id": "GoogleCloudVisionV1p1beta1Page",
@@ -838,10 +971,6 @@
},
"GoogleCloudVisionV1p1beta1Paragraph": {
"properties": {
- "property": {
- "$ref": "GoogleCloudVisionV1p1beta1TextAnnotationTextProperty",
- "description": "Additional information detected for the paragraph."
- },
"boundingBox": {
"$ref": "GoogleCloudVisionV1p1beta1BoundingPoly",
"description": "The bounding box for the paragraph.\nThe vertices are in the order of top-left, top-right, bottom-right,\nbottom-left. When a rotation of the bounding box is detected the rotation\nis represented as around the top-left corner as defined when the text is\nread in the 'natural' orientation.\nFor example:\n * when the text is horizontal it might look like:\n 0----1\n | |\n 3----2\n * when it's rotated 180 degrees around the top-left corner it becomes:\n 2----3\n | |\n 1----0\n and the vertice order will still be (0, 1, 2, 3)."
@@ -857,6 +986,10 @@
"items": {
"$ref": "GoogleCloudVisionV1p1beta1Word"
}
+ },
+ "property": {
+ "description": "Additional information detected for the paragraph.",
+ "$ref": "GoogleCloudVisionV1p1beta1TextAnnotationTextProperty"
}
},
"id": "GoogleCloudVisionV1p1beta1Paragraph",
@@ -864,7 +997,6 @@
"type": "object"
},
"GoogleCloudVisionV1p1beta1EntityAnnotation": {
- "id": "GoogleCloudVisionV1p1beta1EntityAnnotation",
"description": "Set of detected entity features.",
"type": "object",
"properties": {
@@ -913,10 +1045,10 @@
"$ref": "GoogleCloudVisionV1p1beta1Property"
}
}
- }
+ },
+ "id": "GoogleCloudVisionV1p1beta1EntityAnnotation"
},
"GoogleCloudVisionV1p1beta1TextAnnotation": {
- "id": "GoogleCloudVisionV1p1beta1TextAnnotation",
"description": "TextAnnotation contains a structured representation of OCR extracted text.\nThe hierarchy of an OCR extracted text structure is like this:\n TextAnnotation -\u003e Page -\u003e Block -\u003e Paragraph -\u003e Word -\u003e Symbol\nEach structural component, starting from Page, may further have their own\nproperties. Properties describe detected languages, breaks etc.. Please refer\nto the TextAnnotation.TextProperty message definition below for more\ndetail.",
"type": "object",
"properties": {
@@ -931,7 +1063,8 @@
"description": "UTF-8 text detected on the pages.",
"type": "string"
}
- }
+ },
+ "id": "GoogleCloudVisionV1p1beta1TextAnnotation"
},
"GoogleCloudVisionV1p1beta1BoundingPoly": {
"properties": {
@@ -970,12 +1103,23 @@
"type": "object",
"properties": {
"latLng": {
- "$ref": "LatLng",
- "description": "lat/long location coordinates."
+ "description": "lat/long location coordinates.",
+ "$ref": "LatLng"
}
},
"id": "GoogleCloudVisionV1p1beta1LocationInfo"
},
+ "GoogleCloudVisionV1p1beta1WebDetectionParams": {
+ "description": "Parameters for web detection request.",
+ "type": "object",
+ "properties": {
+ "includeGeoResults": {
+ "description": "Whether to include results derived from the geo information in the image.",
+ "type": "boolean"
+ }
+ },
+ "id": "GoogleCloudVisionV1p1beta1WebDetectionParams"
+ },
"GoogleCloudVisionV1p1beta1BatchAnnotateImagesRequest": {
"description": "Multiple image annotation requests are batched into a single service call.",
"type": "object",
@@ -990,20 +1134,64 @@
},
"id": "GoogleCloudVisionV1p1beta1BatchAnnotateImagesRequest"
},
- "GoogleCloudVisionV1p1beta1WebDetectionParams": {
- "description": "Parameters for web detection request.",
+ "GoogleCloudVisionV1p1beta1ImageSource": {
+ "description": "External image source (Google Cloud Storage image location).",
"type": "object",
"properties": {
- "includeGeoResults": {
- "type": "boolean",
- "description": "Whether to include results derived from the geo information in the image."
+ "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": "GoogleCloudVisionV1p1beta1WebDetectionParams"
+ "id": "GoogleCloudVisionV1p1beta1ImageSource"
+ },
+ "GoogleCloudVisionV1p1beta1CropHintsParams": {
+ "description": "Parameters for crop hints annotation request.",
+ "type": "object",
+ "properties": {
+ "aspectRatios": {
+ "description": "Aspect ratios in floats, representing the ratio of the width to the height\nof the image. For example, if the desired aspect ratio is 4/3, the\ncorresponding float value should be 1.33333. If not specified, the\nbest possible crop is returned. The number of provided aspect ratios is\nlimited to a maximum of 16; any aspect ratios provided after the 16th are\nignored.",
+ "type": "array",
+ "items": {
+ "format": "float",
+ "type": "number"
+ }
+ }
+ },
+ "id": "GoogleCloudVisionV1p1beta1CropHintsParams"
+ },
+ "GoogleCloudVisionV1p1beta1Word": {
+ "description": "A word representation.",
+ "type": "object",
+ "properties": {
+ "property": {
+ "$ref": "GoogleCloudVisionV1p1beta1TextAnnotationTextProperty",
+ "description": "Additional information detected for the word."
+ },
+ "boundingBox": {
+ "$ref": "GoogleCloudVisionV1p1beta1BoundingPoly",
+ "description": "The bounding box for the word.\nThe vertices are in the order of top-left, top-right, bottom-right,\nbottom-left. When a rotation of the bounding box is detected the rotation\nis represented as around the top-left corner as defined when the text is\nread in the 'natural' orientation.\nFor example:\n * when the text is horizontal it might look like:\n 0----1\n | |\n 3----2\n * when it's rotated 180 degrees around the top-left corner it becomes:\n 2----3\n | |\n 1----0\n and the vertice order will still be (0, 1, 2, 3)."
+ },
+ "confidence": {
+ "description": "Confidence of the OCR results for the word. Range [0, 1].",
+ "format": "float",
+ "type": "number"
+ },
+ "symbols": {
+ "description": "List of symbols in the word.\nThe order of the symbols follows the natural reading order.",
+ "type": "array",
+ "items": {
+ "$ref": "GoogleCloudVisionV1p1beta1Symbol"
+ }
+ }
+ },
+ "id": "GoogleCloudVisionV1p1beta1Word"
},
"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.",
@@ -1022,100 +1210,45 @@
"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."
+ "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"
- },
- "GoogleCloudVisionV1p1beta1Word": {
- "properties": {
- "symbols": {
- "description": "List of symbols in the word.\nThe order of the symbols follows the natural reading order.",
- "type": "array",
- "items": {
- "$ref": "GoogleCloudVisionV1p1beta1Symbol"
- }
- },
- "property": {
- "description": "Additional information detected for the word.",
- "$ref": "GoogleCloudVisionV1p1beta1TextAnnotationTextProperty"
- },
- "boundingBox": {
- "$ref": "GoogleCloudVisionV1p1beta1BoundingPoly",
- "description": "The bounding box for the word.\nThe vertices are in the order of top-left, top-right, bottom-right,\nbottom-left. When a rotation of the bounding box is detected the rotation\nis represented as around the top-left corner as defined when the text is\nread in the 'natural' orientation.\nFor example:\n * when the text is horizontal it might look like:\n 0----1\n | |\n 3----2\n * when it's rotated 180 degrees around the top-left corner it becomes:\n 2----3\n | |\n 1----0\n and the vertice order will still be (0, 1, 2, 3)."
- },
- "confidence": {
- "type": "number",
- "description": "Confidence of the OCR results for the word. Range [0, 1].",
- "format": "float"
- }
- },
- "id": "GoogleCloudVisionV1p1beta1Word",
- "description": "A word representation.",
+ "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"
},
- "GoogleCloudVisionV1p1beta1CropHintsParams": {
- "description": "Parameters for crop hints annotation request.",
- "type": "object",
- "properties": {
- "aspectRatios": {
- "description": "Aspect ratios in floats, representing the ratio of the width to the height\nof the image. For example, if the desired aspect ratio is 4/3, the\ncorresponding float value should be 1.33333. If not specified, the\nbest possible crop is returned. The number of provided aspect ratios is\nlimited to a maximum of 16; any aspect ratios provided after the 16th are\nignored.",
- "type": "array",
- "items": {
- "type": "number",
- "format": "float"
- }
- }
- },
- "id": "GoogleCloudVisionV1p1beta1CropHintsParams"
- },
- "GoogleCloudVisionV1p1beta1ImageSource": {
- "id": "GoogleCloudVisionV1p1beta1ImageSource",
- "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"
- }
- }
- },
- "GoogleCloudVisionV1p1beta1LatLongRect": {
- "type": "object",
- "properties": {
- "minLatLng": {
- "$ref": "LatLng",
- "description": "Min lat/long pair."
- },
- "maxLatLng": {
- "$ref": "LatLng",
- "description": "Max lat/long pair."
- }
- },
- "id": "GoogleCloudVisionV1p1beta1LatLongRect",
- "description": "Rectangle determined by min and max `LatLng` pairs."
- },
"GoogleCloudVisionV1p1beta1Vertex": {
- "description": "A vertex represents a 2D point in the image.\nNOTE: the vertex coordinates are in the same scale as the original image.",
- "type": "object",
"properties": {
- "x": {
- "description": "X coordinate.",
- "format": "int32",
- "type": "integer"
- },
"y": {
"description": "Y coordinate.",
"format": "int32",
"type": "integer"
+ },
+ "x": {
+ "description": "X coordinate.",
+ "format": "int32",
+ "type": "integer"
}
},
- "id": "GoogleCloudVisionV1p1beta1Vertex"
+ "id": "GoogleCloudVisionV1p1beta1Vertex",
+ "description": "A vertex represents a 2D point in the image.\nNOTE: the vertex coordinates are in the same scale as the original image.",
+ "type": "object"
+ },
+ "GoogleCloudVisionV1p1beta1LatLongRect": {
+ "description": "Rectangle determined by min and max `LatLng` pairs.",
+ "type": "object",
+ "properties": {
+ "maxLatLng": {
+ "description": "Max lat/long pair.",
+ "$ref": "LatLng"
+ },
+ "minLatLng": {
+ "$ref": "LatLng",
+ "description": "Min lat/long pair."
+ }
+ },
+ "id": "GoogleCloudVisionV1p1beta1LatLongRect"
},
"GoogleCloudVisionV1p1beta1DominantColorsAnnotation": {
"description": "Set of dominant colors and their corresponding scores.",
@@ -1132,6 +1265,8 @@
"id": "GoogleCloudVisionV1p1beta1DominantColorsAnnotation"
},
"GoogleCloudVisionV1p1beta1WebDetectionWebPage": {
+ "description": "Metadata for web pages.",
+ "type": "object",
"properties": {
"pageTitle": {
"description": "Title for the web page, may contain HTML markups.",
@@ -1145,9 +1280,9 @@
}
},
"score": {
- "type": "number",
"description": "(Deprecated) Overall relevancy score for the web page.",
- "format": "float"
+ "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.",
@@ -1161,35 +1296,26 @@
"type": "string"
}
},
- "id": "GoogleCloudVisionV1p1beta1WebDetectionWebPage",
- "description": "Metadata for web pages.",
- "type": "object"
- },
- "GoogleCloudVisionV1p1beta1CropHint": {
- "id": "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": {
- "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": "GoogleCloudVisionV1p1beta1WebDetectionWebPage"
},
"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",
"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": [
@@ -1204,19 +1330,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": {
@@ -1229,12 +1342,30 @@
"type": "string"
}
},
- "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."
+ "id": "GoogleCloudVisionV1p1beta1Feature"
+ },
+ "GoogleCloudVisionV1p1beta1CropHint": {
+ "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": {
+ "$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",
+ "description": "Single crop hint that is used to generate a new crop when serving an image.",
+ "type": "object"
},
"LatLng": {
- "description": "An object representing a latitude/longitude pair. This is expressed as a pair\nof doubles representing degrees latitude and degrees longitude. Unless\nspecified otherwise, this must conform to the\n\u003ca href=\"http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf\"\u003eWGS84\nstandard\u003c/a\u003e. Values must be within normalized ranges.",
- "type": "object",
"properties": {
"latitude": {
"description": "The latitude in degrees. It must be in the range [-90.0, +90.0].",
@@ -1247,10 +1378,33 @@
"type": "number"
}
},
- "id": "LatLng"
+ "id": "LatLng",
+ "description": "An object representing a latitude/longitude pair. This is expressed as a pair\nof doubles representing degrees latitude and degrees longitude. Unless\nspecified otherwise, this must conform to the\n\u003ca href=\"http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf\"\u003eWGS84\nstandard\u003c/a\u003e. Values must be within normalized ranges.",
+ "type": "object"
+ },
+ "GoogleCloudVisionV1p1beta1Position": {
+ "properties": {
+ "y": {
+ "description": "Y coordinate.",
+ "format": "float",
+ "type": "number"
+ },
+ "x": {
+ "description": "X coordinate.",
+ "format": "float",
+ "type": "number"
+ },
+ "z": {
+ "description": "Z coordinate (or depth).",
+ "format": "float",
+ "type": "number"
+ }
+ },
+ "id": "GoogleCloudVisionV1p1beta1Position",
+ "description": "A 3D position in the image, used primarily for Face detection landmarks.\nA valid Position must have both x and y coordinates.\nThe position coordinates are in the same scale as the original image.",
+ "type": "object"
},
"Color": {
- "type": "object",
"properties": {
"red": {
"description": "The amount of red in the color as a value in the interval [0, 1].",
@@ -1274,59 +1428,24 @@
}
},
"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 // ..."
- },
- "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": {
- "description": "X coordinate.",
- "format": "float",
- "type": "number"
- },
- "z": {
- "description": "Z coordinate (or depth).",
- "format": "float",
- "type": "number"
- }
- },
- "id": "GoogleCloudVisionV1p1beta1Position"
- },
- "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"
- }
- }
- },
- "id": "GoogleCloudVisionV1p1beta1CropHintsAnnotation"
+ "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"
}
},
+ "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": "Vision",
"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"
}
}
}
@@ -1336,124 +1455,5 @@
"name": "vision",
"batchPath": "batch",
"fullyEncodeReservedExpansion": true,
- "title": "Google Cloud Vision API",
- "ownerName": "Google",
- "resources": {
- "images": {
- "methods": {
- "annotate": {
- "parameters": {},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-vision"
- ],
- "flatPath": "v1p1beta1/images:annotate",
- "path": "v1p1beta1/images:annotate",
- "id": "vision.images.annotate",
- "request": {
- "$ref": "GoogleCloudVisionV1p1beta1BatchAnnotateImagesRequest"
- },
- "description": "Run image detection and annotation for a batch of images.",
- "response": {
- "$ref": "GoogleCloudVisionV1p1beta1BatchAnnotateImagesResponse"
- },
- "parameterOrder": [],
- "httpMethod": "POST"
- }
- }
- }
- },
- "parameters": {
- "quotaUser": {
- "location": "query",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string"
- },
- "pp": {
- "description": "Pretty-print response.",
- "type": "boolean",
- "default": "true",
- "location": "query"
- },
- "oauth_token": {
- "location": "query",
- "description": "OAuth 2.0 token for the current user.",
- "type": "string"
- },
- "bearer_token": {
- "location": "query",
- "description": "OAuth bearer token.",
- "type": "string"
- },
- "upload_protocol": {
- "location": "query",
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string"
- },
- "prettyPrint": {
- "description": "Returns response with indentations and line breaks.",
- "type": "boolean",
- "default": "true",
- "location": "query"
- },
- "fields": {
- "location": "query",
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string"
- },
- "uploadType": {
- "location": "query",
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string"
- },
- "callback": {
- "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": {
- "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": {
- "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": "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": ""
+ "title": "Google Cloud Vision API"
}
diff --git a/youtubereporting/v1/youtubereporting-api.json b/youtubereporting/v1/youtubereporting-api.json
index 587780e..4a03201 100644
--- a/youtubereporting/v1/youtubereporting-api.json
+++ b/youtubereporting/v1/youtubereporting-api.json
@@ -1,286 +1,38 @@
{
+ "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",
- "revision": "20171219",
- "documentationLink": "https://developers.google.com/youtube/reporting/v1/reports/",
"id": "youtubereporting:v1",
+ "documentationLink": "https://developers.google.com/youtube/reporting/v1/reports/",
+ "revision": "20171219",
"title": "YouTube Reporting API",
- "discoveryVersion": "v1",
"ownerName": "Google",
+ "discoveryVersion": "v1",
"resources": {
- "jobs": {
- "methods": {
- "create": {
- "description": "Creates a job and returns it.",
- "request": {
- "$ref": "Job"
- },
- "response": {
- "$ref": "Job"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/yt-analytics-monetary.readonly",
- "https://www.googleapis.com/auth/yt-analytics.readonly"
- ],
- "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"
- }
- },
- "flatPath": "v1/jobs",
- "path": "v1/jobs",
- "id": "youtubereporting.jobs.create"
- },
- "delete": {
- "flatPath": "v1/jobs/{jobId}",
- "path": "v1/jobs/{jobId}",
- "id": "youtubereporting.jobs.delete",
- "description": "Deletes a job.",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "jobId"
- ],
- "httpMethod": "DELETE",
- "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"
- }
- }
- },
- "list": {
- "description": "Lists jobs.",
- "httpMethod": "GET",
- "parameterOrder": [],
- "response": {
- "$ref": "ListJobsResponse"
- },
- "parameters": {
- "pageToken": {
- "description": "A token identifying a page of results the server should return. Typically,\nthis is the value of\nListReportTypesResponse.next_page_token\nreturned in response to the previous call to the `ListJobs` method.",
- "type": "string",
- "location": "query"
- },
- "includeSystemManaged": {
- "description": "If set to true, also system-managed jobs will be returned; otherwise only\nuser-created jobs will be returned. System-managed jobs can neither be\nmodified nor deleted.",
- "type": "boolean",
- "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"
- },
- "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"
- ],
- "flatPath": "v1/jobs",
- "id": "youtubereporting.jobs.list",
- "path": "v1/jobs"
- },
- "get": {
- "response": {
- "$ref": "Job"
- },
- "parameterOrder": [
- "jobId"
- ],
- "httpMethod": "GET",
- "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 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"
- }
- },
- "flatPath": "v1/jobs/{jobId}",
- "path": "v1/jobs/{jobId}",
- "id": "youtubereporting.jobs.get",
- "description": "Gets a job."
- }
- },
- "resources": {
- "reports": {
- "methods": {
- "list": {
- "response": {
- "$ref": "ListReportsResponse"
- },
- "parameterOrder": [
- "jobId"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/yt-analytics-monetary.readonly",
- "https://www.googleapis.com/auth/yt-analytics.readonly"
- ],
- "parameters": {
- "jobId": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "The ID of the job."
- },
- "createdAfter": {
- "description": "If set, only reports created after the specified date/time are returned.",
- "format": "google-datetime",
- "type": "string",
- "location": "query"
- },
- "startTimeAtOrAfter": {
- "description": "If set, only reports whose start time is greater than or equal the\nspecified date/time are returned.",
- "format": "google-datetime",
- "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\nListReportsResponse.next_page_token\nreturned in response to the previous call to the `ListReports` method.",
- "type": "string"
- },
- "pageSize": {
- "description": "Requested page size. Server may return fewer report types than requested.\nIf unspecified, server will pick an appropriate default.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- },
- "onBehalfOfContentOwner": {
- "description": "The content owner's external ID on which behalf the user is acting on. If\nnot set, the user is acting for himself (his own channel).",
- "type": "string",
- "location": "query"
- },
- "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"
- }
- },
- "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": {
- "parameters": {
- "onBehalfOfContentOwner": {
- "type": "string",
- "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)."
- },
- "reportId": {
- "description": "The ID of the report to retrieve.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "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}",
- "id": "youtubereporting.jobs.reports.get",
- "path": "v1/jobs/{jobId}/reports/{reportId}",
- "description": "Gets the metadata of a specific report.",
- "httpMethod": "GET",
- "response": {
- "$ref": "Report"
- },
- "parameterOrder": [
- "jobId",
- "reportId"
- ]
- }
- }
- }
- }
- },
- "reportTypes": {
- "methods": {
- "list": {
- "description": "Lists report types.",
- "response": {
- "$ref": "ListReportTypesResponse"
- },
- "parameterOrder": [],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/yt-analytics-monetary.readonly",
- "https://www.googleapis.com/auth/yt-analytics.readonly"
- ],
- "parameters": {
- "pageToken": {
- "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"
- },
- "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.",
- "type": "boolean",
- "location": "query"
- },
- "pageSize": {
- "description": "Requested page size. Server may return fewer report types than requested.\nIf unspecified, server will pick an appropriate default.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- },
- "onBehalfOfContentOwner": {
- "type": "string",
- "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)."
- }
- },
- "flatPath": "v1/reportTypes",
- "path": "v1/reportTypes",
- "id": "youtubereporting.reportTypes.list"
- }
- }
- },
"media": {
"methods": {
"download": {
+ "description": "Method for media download. Download is supported\non the URI `/v1/media/{+name}?alt=media`.",
+ "supportsMediaDownload": true,
"response": {
"$ref": "GdataMedia"
},
@@ -303,39 +55,314 @@
],
"flatPath": "v1/media/{mediaId}",
"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
+ "id": "youtubereporting.media.download"
+ }
+ }
+ },
+ "jobs": {
+ "methods": {
+ "list": {
+ "description": "Lists jobs.",
+ "response": {
+ "$ref": "ListJobsResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/yt-analytics-monetary.readonly",
+ "https://www.googleapis.com/auth/yt-analytics.readonly"
+ ],
+ "parameters": {
+ "pageToken": {
+ "description": "A token identifying a page of results the server should return. Typically,\nthis is the value of\nListReportTypesResponse.next_page_token\nreturned in response to the previous call to the `ListJobs` method.",
+ "type": "string",
+ "location": "query"
+ },
+ "includeSystemManaged": {
+ "description": "If set to true, also system-managed jobs will be returned; otherwise only\nuser-created jobs will be returned. System-managed jobs can neither be\nmodified nor deleted.",
+ "type": "boolean",
+ "location": "query"
+ },
+ "pageSize": {
+ "description": "Requested page size. Server may return fewer jobs than requested.\nIf unspecified, server will pick an appropriate default.",
+ "format": "int32",
+ "type": "integer",
+ "location": "query"
+ },
+ "onBehalfOfContentOwner": {
+ "description": "The content owner's external ID on which behalf the user is acting on. If\nnot set, the user is acting for himself (his own channel).",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "flatPath": "v1/jobs",
+ "path": "v1/jobs",
+ "id": "youtubereporting.jobs.list"
+ },
+ "get": {
+ "description": "Gets a job.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "jobId"
+ ],
+ "response": {
+ "$ref": "Job"
+ },
+ "parameters": {
+ "jobId": {
+ "description": "The ID of the job to retrieve.",
+ "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"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/yt-analytics-monetary.readonly",
+ "https://www.googleapis.com/auth/yt-analytics.readonly"
+ ],
+ "flatPath": "v1/jobs/{jobId}",
+ "id": "youtubereporting.jobs.get",
+ "path": "v1/jobs/{jobId}"
+ },
+ "create": {
+ "response": {
+ "$ref": "Job"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/yt-analytics-monetary.readonly",
+ "https://www.googleapis.com/auth/yt-analytics.readonly"
+ ],
+ "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"
+ }
+ },
+ "flatPath": "v1/jobs",
+ "path": "v1/jobs",
+ "id": "youtubereporting.jobs.create",
+ "description": "Creates a job and returns it.",
+ "request": {
+ "$ref": "Job"
+ }
+ },
+ "delete": {
+ "flatPath": "v1/jobs/{jobId}",
+ "path": "v1/jobs/{jobId}",
+ "id": "youtubereporting.jobs.delete",
+ "description": "Deletes a job.",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "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"
+ ]
+ }
+ },
+ "resources": {
+ "reports": {
+ "methods": {
+ "list": {
+ "description": "Lists reports created by a specific job.\nReturns NOT_FOUND if the job does not exist.",
+ "response": {
+ "$ref": "ListReportsResponse"
+ },
+ "parameterOrder": [
+ "jobId"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/yt-analytics-monetary.readonly",
+ "https://www.googleapis.com/auth/yt-analytics.readonly"
+ ],
+ "parameters": {
+ "createdAfter": {
+ "description": "If set, only reports created after the specified date/time are returned.",
+ "format": "google-datetime",
+ "type": "string",
+ "location": "query"
+ },
+ "pageToken": {
+ "description": "A token identifying a page of results the server should return. Typically,\nthis is the value of\nListReportsResponse.next_page_token\nreturned in response to the previous call to the `ListReports` method.",
+ "type": "string",
+ "location": "query"
+ },
+ "startTimeAtOrAfter": {
+ "location": "query",
+ "description": "If set, only reports whose start time is greater than or equal the\nspecified date/time are returned.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "Requested page size. Server may return fewer report types than requested.\nIf unspecified, server will pick an appropriate default.",
+ "format": "int32",
+ "type": "integer",
+ "location": "query"
+ },
+ "onBehalfOfContentOwner": {
+ "description": "The content owner's external ID on which behalf the user is acting on. If\nnot set, the user is acting for himself (his own channel).",
+ "type": "string",
+ "location": "query"
+ },
+ "startTimeBefore": {
+ "location": "query",
+ "description": "If set, only reports whose start time is smaller than the specified\ndate/time are returned.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "jobId": {
+ "description": "The ID of the job.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/jobs/{jobId}/reports",
+ "path": "v1/jobs/{jobId}/reports",
+ "id": "youtubereporting.jobs.reports.list"
+ },
+ "get": {
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "jobId",
+ "reportId"
+ ],
+ "response": {
+ "$ref": "Report"
+ },
+ "parameters": {
+ "reportId": {
+ "location": "path",
+ "description": "The ID of the report to retrieve.",
+ "required": true,
+ "type": "string"
+ },
+ "jobId": {
+ "description": "The ID of the job.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "onBehalfOfContentOwner": {
+ "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/jobs/{jobId}/reports/{reportId}",
+ "id": "youtubereporting.jobs.reports.get",
+ "path": "v1/jobs/{jobId}/reports/{reportId}",
+ "description": "Gets the metadata of a specific report."
+ }
+ }
+ }
+ }
+ },
+ "reportTypes": {
+ "methods": {
+ "list": {
+ "description": "Lists report types.",
+ "response": {
+ "$ref": "ListReportTypesResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "GET",
+ "parameters": {
+ "pageToken": {
+ "description": "A token identifying a page of results the server should return. Typically,\nthis is the value of\nListReportTypesResponse.next_page_token\nreturned in response to the previous call to the `ListReportTypes` method.",
+ "type": "string",
+ "location": "query"
+ },
+ "includeSystemManaged": {
+ "location": "query",
+ "description": "If set to true, also system-managed report types will be returned;\notherwise only the report types that can be used to create new reporting\njobs will be returned.",
+ "type": "boolean"
+ },
+ "pageSize": {
+ "location": "query",
+ "description": "Requested page size. Server may return fewer report types than requested.\nIf unspecified, server will pick an appropriate default.",
+ "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",
+ "path": "v1/reportTypes",
+ "id": "youtubereporting.reportTypes.list"
}
}
}
},
"parameters": {
+ "pp": {
+ "location": "query",
+ "description": "Pretty-print response.",
+ "type": "boolean",
+ "default": "true"
+ },
"oauth_token": {
+ "location": "query",
"description": "OAuth 2.0 token for the current user.",
+ "type": "string"
+ },
+ "bearer_token": {
+ "description": "OAuth bearer token.",
"type": "string",
"location": "query"
},
- "bearer_token": {
- "location": "query",
- "description": "OAuth bearer token.",
- "type": "string"
- },
"upload_protocol": {
- "location": "query",
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"prettyPrint": {
- "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\").",
@@ -343,17 +370,17 @@
"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": {
"description": "JSONP",
@@ -361,11 +388,6 @@
"location": "query"
},
"alt": {
- "enum": [
- "json",
- "media",
- "proto"
- ],
"type": "string",
"enumDescriptions": [
"Responses with Content-Type of application/json",
@@ -374,7 +396,12 @@
],
"location": "query",
"description": "Data format for response.",
- "default": "json"
+ "default": "json",
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ]
},
"access_token": {
"description": "OAuth access token.",
@@ -387,139 +414,20 @@
"location": "query"
},
"quotaUser": {
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string",
- "location": "query"
- },
- "pp": {
"location": "query",
- "description": "Pretty-print response.",
- "type": "boolean",
- "default": "true"
+ "description": "Available 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"
}
},
"schemas": {
- "Report": {
- "type": "object",
- "properties": {
- "createTime": {
- "description": "The date/time when this report was created.",
- "format": "google-datetime",
- "type": "string"
- },
- "jobId": {
- "type": "string",
- "description": "The ID of the job that created this report."
- },
- "id": {
- "type": "string",
- "description": "The server-generated ID of the report."
- },
- "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"
- }
- },
- "id": "Report",
- "description": "A report's metadata including the URL from which the report itself can be\ndownloaded."
- },
- "GdataDiffChecksumsResponse": {
- "description": "gdata",
- "type": "object",
- "properties": {
- "checksumsLocation": {
- "description": "gdata",
- "$ref": "GdataCompositeMedia"
- },
- "objectSizeBytes": {
- "type": "string",
- "description": "gdata",
- "format": "int64"
- },
- "objectLocation": {
- "$ref": "GdataCompositeMedia",
- "description": "gdata"
- },
- "objectVersion": {
- "type": "string",
- "description": "gdata"
- },
- "chunkSizeBytes": {
- "type": "string",
- "description": "gdata",
- "format": "int64"
- }
- },
- "id": "GdataDiffChecksumsResponse"
- },
- "GdataDownloadParameters": {
- "id": "GdataDownloadParameters",
- "description": "gdata",
- "type": "object",
- "properties": {
- "ignoreRange": {
- "description": "gdata",
- "type": "boolean"
- },
- "allowGzipCompression": {
- "description": "gdata",
- "type": "boolean"
- }
- }
- },
- "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"
- },
- "id": {
- "description": "The server-generated ID of the job (max. 40 characters).",
- "type": "string"
- },
- "systemManaged": {
- "description": "True if this a system-managed job that cannot be modified by the user;\notherwise false.",
- "type": "boolean"
- }
- },
- "id": "Job"
- },
"GdataObjectId": {
- "id": "GdataObjectId",
"description": "gdata",
"type": "object",
"properties": {
+ "bucketName": {
+ "description": "gdata",
+ "type": "string"
+ },
"generation": {
"description": "gdata",
"format": "int64",
@@ -528,35 +436,36 @@
"objectName": {
"description": "gdata",
"type": "string"
- },
- "bucketName": {
- "type": "string",
- "description": "gdata"
}
- }
+ },
+ "id": "GdataObjectId"
},
"GdataMedia": {
"description": "gdata",
"type": "object",
"properties": {
- "sha1Hash": {
+ "diffChecksumsResponse": {
"description": "gdata",
- "format": "byte",
- "type": "string"
+ "$ref": "GdataDiffChecksumsResponse"
},
"crc32cHash": {
"description": "gdata",
"format": "uint32",
"type": "integer"
},
+ "sha1Hash": {
+ "description": "gdata",
+ "format": "byte",
+ "type": "string"
+ },
"length": {
"description": "gdata",
"format": "int64",
"type": "string"
},
"contentTypeInfo": {
- "description": "gdata",
- "$ref": "GdataContentTypeInfo"
+ "$ref": "GdataContentTypeInfo",
+ "description": "gdata"
},
"contentType": {
"description": "gdata",
@@ -588,8 +497,8 @@
"type": "string"
},
"diffVersionResponse": {
- "description": "gdata",
- "$ref": "GdataDiffVersionResponse"
+ "$ref": "GdataDiffVersionResponse",
+ "description": "gdata"
},
"timestamp": {
"description": "gdata",
@@ -609,8 +518,8 @@
"type": "string"
},
"blobstore2Info": {
- "$ref": "GdataBlobstore2Info",
- "description": "gdata"
+ "description": "gdata",
+ "$ref": "GdataBlobstore2Info"
},
"hashVerified": {
"description": "gdata",
@@ -634,22 +543,22 @@
"format": "byte",
"type": "string"
},
- "algorithm": {
- "description": "gdata",
- "type": "string"
- },
"sha256Hash": {
"description": "gdata",
"format": "byte",
"type": "string"
},
+ "algorithm": {
+ "description": "gdata",
+ "type": "string"
+ },
"objectId": {
"$ref": "GdataObjectId",
"description": "gdata"
},
"path": {
- "type": "string",
- "description": "gdata"
+ "description": "gdata",
+ "type": "string"
},
"bigstoreObjectRef": {
"description": "gdata",
@@ -657,6 +566,21 @@
"type": "string"
},
"referenceType": {
+ "enumDescriptions": [
+ "gdata",
+ "gdata",
+ "gdata",
+ "gdata",
+ "gdata",
+ "gdata",
+ "gdata",
+ "gdata",
+ "gdata",
+ "gdata",
+ "gdata",
+ "gdata",
+ "gdata"
+ ],
"enum": [
"PATH",
"BLOB_REF",
@@ -673,22 +597,7 @@
"ARBITRARY_BYTES"
],
"description": "gdata",
- "type": "string",
- "enumDescriptions": [
- "gdata",
- "gdata",
- "gdata",
- "gdata",
- "gdata",
- "gdata",
- "gdata",
- "gdata",
- "gdata",
- "gdata",
- "gdata",
- "gdata",
- "gdata"
- ]
+ "type": "string"
},
"inline": {
"description": "gdata",
@@ -696,18 +605,13 @@
"type": "string"
},
"diffUploadRequest": {
- "$ref": "GdataDiffUploadRequest",
- "description": "gdata"
- },
- "diffChecksumsResponse": {
"description": "gdata",
- "$ref": "GdataDiffChecksumsResponse"
+ "$ref": "GdataDiffUploadRequest"
}
},
"id": "GdataMedia"
},
"GdataDiffVersionResponse": {
- "id": "GdataDiffVersionResponse",
"description": "gdata",
"type": "object",
"properties": {
@@ -716,19 +620,20 @@
"type": "string"
},
"objectSizeBytes": {
- "type": "string",
"description": "gdata",
- "format": "int64"
+ "format": "int64",
+ "type": "string"
}
- }
+ },
+ "id": "GdataDiffVersionResponse"
},
"GdataDiffDownloadResponse": {
"description": "gdata",
"type": "object",
"properties": {
"objectLocation": {
- "$ref": "GdataCompositeMedia",
- "description": "gdata"
+ "description": "gdata",
+ "$ref": "GdataCompositeMedia"
}
},
"id": "GdataDiffDownloadResponse"
@@ -737,17 +642,17 @@
"description": "gdata",
"type": "object",
"properties": {
- "checksumsInfo": {
- "$ref": "GdataCompositeMedia",
- "description": "gdata"
- },
"objectVersion": {
"description": "gdata",
"type": "string"
},
"objectInfo": {
- "description": "gdata",
- "$ref": "GdataCompositeMedia"
+ "$ref": "GdataCompositeMedia",
+ "description": "gdata"
+ },
+ "checksumsInfo": {
+ "$ref": "GdataCompositeMedia",
+ "description": "gdata"
}
},
"id": "GdataDiffUploadRequest"
@@ -756,33 +661,35 @@
"description": "gdata",
"type": "object",
"properties": {
- "blobGeneration": {
- "type": "string",
- "description": "gdata",
- "format": "int64"
- },
- "blobId": {
- "description": "gdata",
- "type": "string"
- },
"downloadReadHandle": {
"description": "gdata",
"format": "byte",
"type": "string"
},
"readToken": {
- "type": "string",
- "description": "gdata"
+ "description": "gdata",
+ "type": "string"
},
"uploadMetadataContainer": {
"description": "gdata",
"format": "byte",
"type": "string"
+ },
+ "blobGeneration": {
+ "description": "gdata",
+ "format": "int64",
+ "type": "string"
+ },
+ "blobId": {
+ "description": "gdata",
+ "type": "string"
}
},
"id": "GdataBlobstore2Info"
},
"ListReportTypesResponse": {
+ "description": "Response message for ReportingService.ListReportTypes.",
+ "type": "object",
"properties": {
"reportTypes": {
"description": "The list of report types.",
@@ -796,9 +703,7 @@
"type": "string"
}
},
- "id": "ListReportTypesResponse",
- "description": "Response message for ReportingService.ListReportTypes.",
- "type": "object"
+ "id": "ListReportTypesResponse"
},
"ReportType": {
"description": "A report type.",
@@ -831,28 +736,50 @@
"id": "Empty"
},
"ListJobsResponse": {
- "id": "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"
}
+ },
+ "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": {
- "id": "GdataCompositeMedia",
"description": "gdata",
"type": "object",
"properties": {
+ "md5Hash": {
+ "description": "gdata",
+ "format": "byte",
+ "type": "string"
+ },
+ "inline": {
+ "description": "gdata",
+ "format": "byte",
+ "type": "string"
+ },
+ "blobstore2Info": {
+ "$ref": "GdataBlobstore2Info",
+ "description": "gdata"
+ },
+ "blobRef": {
+ "description": "gdata",
+ "format": "byte",
+ "type": "string"
+ },
+ "objectId": {
+ "description": "gdata",
+ "$ref": "GdataObjectId"
+ },
"crc32cHash": {
"description": "gdata",
"format": "uint32",
@@ -878,13 +805,6 @@
"type": "string"
},
"referenceType": {
- "enum": [
- "PATH",
- "BLOB_REF",
- "INLINE",
- "BIGSTORE_REF",
- "COSMO_BINARY_REFERENCE"
- ],
"description": "gdata",
"type": "string",
"enumDescriptions": [
@@ -893,40 +813,25 @@
"gdata",
"gdata",
"gdata"
+ ],
+ "enum": [
+ "PATH",
+ "BLOB_REF",
+ "INLINE",
+ "BIGSTORE_REF",
+ "COSMO_BINARY_REFERENCE"
]
- },
- "md5Hash": {
- "description": "gdata",
- "format": "byte",
- "type": "string"
- },
- "inline": {
- "description": "gdata",
- "format": "byte",
- "type": "string"
- },
- "blobstore2Info": {
- "description": "gdata",
- "$ref": "GdataBlobstore2Info"
- },
- "blobRef": {
- "description": "gdata",
- "format": "byte",
- "type": "string"
- },
- "objectId": {
- "$ref": "GdataObjectId",
- "description": "gdata"
}
- }
+ },
+ "id": "GdataCompositeMedia"
},
"ListReportsResponse": {
"description": "Response message for ReportingService.ListReports.",
"type": "object",
"properties": {
"nextPageToken": {
- "type": "string",
- "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."
+ "description": "A token to retrieve next page of results.\nPass this value in the\nListReportsRequest.page_token\nfield in the subsequent call to `ListReports` method to retrieve the next\npage of results.",
+ "type": "string"
},
"reports": {
"description": "The list of report types.",
@@ -939,7 +844,6 @@
"id": "ListReportsResponse"
},
"GdataContentTypeInfo": {
- "id": "GdataContentTypeInfo",
"description": "gdata",
"type": "object",
"properties": {
@@ -960,52 +864,148 @@
"type": "string"
},
"fromFileName": {
- "type": "string",
- "description": "gdata"
+ "description": "gdata",
+ "type": "string"
}
- }
+ },
+ "id": "GdataContentTypeInfo"
},
"GdataDiffUploadResponse": {
"description": "gdata",
"type": "object",
"properties": {
+ "objectVersion": {
+ "description": "gdata",
+ "type": "string"
+ },
"originalObject": {
+ "$ref": "GdataCompositeMedia",
+ "description": "gdata"
+ }
+ },
+ "id": "GdataDiffUploadResponse"
+ },
+ "GdataDiffChecksumsResponse": {
+ "description": "gdata",
+ "type": "object",
+ "properties": {
+ "checksumsLocation": {
+ "$ref": "GdataCompositeMedia",
+ "description": "gdata"
+ },
+ "objectSizeBytes": {
+ "description": "gdata",
+ "format": "int64",
+ "type": "string"
+ },
+ "objectLocation": {
"description": "gdata",
"$ref": "GdataCompositeMedia"
},
"objectVersion": {
"description": "gdata",
"type": "string"
+ },
+ "chunkSizeBytes": {
+ "description": "gdata",
+ "format": "int64",
+ "type": "string"
}
},
- "id": "GdataDiffUploadResponse"
+ "id": "GdataDiffChecksumsResponse"
+ },
+ "Report": {
+ "description": "A report's metadata including the URL from which the report itself can be\ndownloaded.",
+ "type": "object",
+ "properties": {
+ "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": {
+ "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"
+ }
+ },
+ "id": "Report"
+ },
+ "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"
}
},
"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://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"
+ "version": "v1"
}
